IOFWAsyncStreamListener

Inherits from
OSObject
Availability
Available in OS X v10.5 and later.
Declared in
IOFWAsyncStreamListener.h

Overview

Tasks

Miscellaneous

Instance Methods

getFlags

get the flags of listener.

UInt32 getFlags();
Parameters
none.
Return Value

flags.

getOverrunCounter

get overrun counter from the DCL program.

UInt32 getOverrunCounter();
Parameters
none.
Return Value

returns the counter value.

getReceiver

inline IOFWAsyncStreamReceiver *getReceiver();
Discussion

function getReceiver abstract Returns the Async Stream receiver object which tracks multiple IOFWAsyncStreamListeners for the same Isoc channel.

getRefCon

get the refcon specific to this listener.

inline void* getRefCon();
Parameters
none.
Return Value

fRefCon refcon passed during initialization.

initAll

Creates an AsyncStream client for an Isoch channel.

bool initAll( IOFireWireController *control, UInt32 channel, FWAsyncStreamReceiveCallback proc, void *refcon );
Parameters
control

Points to IOFireWireController.

channel

Isoch channel for listening.

proc

Callback on packet reception.

obj

Client's callback object.

Return Value

returns true on success, else false.

invokeClients

void invokeClients( UInt8 *buffer );
Discussion

function invokeClients abstract Invokes client's callback function with fRefCon.

IsNotificationOn

checks the notification state.

inline bool IsNotificationOn();
Return Value

true if ON, else false

setFlags

set flags for the listener.

void setFlags( UInt32 flags );
Parameters
flags

indicate performance metrics.

Return Value

none.

setListenerHandler

Set the callback that should be called to handle incoming async stream packets

const FWAsyncStreamReceiveCallback setListenerHandler( FWAsyncStreamReceiveCallback inReceiver );
Parameters
inReceiver

The callback to set.

Return Value

Returns the callback that was previously set or nil for none.

TurnOffNotification

Turns off client callback notification.

inline void TurnOffNotification();
Return Value

none.

TurnOnNotification

Turns on client callback notification.

inline void TurnOnNotification();
Return Value

none.

ExpansionData

struct ExpansionData {
};
Discussion

This structure will be used to expand the capablilties of the class in the future.

Instance Variables

reserved

ExpansionData *reserved;

Reserved for future use. (Internal use only)