IOFWAsyncStreamListener

Overview

Use the links in the table of contents to the left to access the documentation.

Functions

getFlags

get the flags of listener.

getOverrunCounter

get overrun counter from the DCL program.

getReceiver

getRefCon

get the refcon specific to this listener.

initAll

Creates an AsyncStream client for an Isoch channel.

invokeClients

IsNotificationOn

checks the notification state.

setFlags

set flags for the listener.

setListenerHandler

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

TurnOffNotification

Turns off client callback notification.

TurnOnNotification

Turns on client callback notification.

get the flags of listener.

public

UInt32 getFlags(); 

Parameters

Return Value

flags.

get overrun counter from the DCL program.

public

UInt32 getOverrunCounter(); 

Parameters

Return Value

returns the counter value.

private

inline IOFWAsyncStreamReceiver *getReceiver();

Discussion

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

get the refcon specific to this listener.

public

inline void* getRefCon();

Parameters

Return Value

fRefCon refcon passed during initialization.

Creates an AsyncStream client for an Isoch channel.

public

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

Parameters

Return Value

returns true on success, else false.

private

void invokeClients(
    UInt8 *buffer ); 

Discussion

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

checks the notification state.

public

inline bool IsNotificationOn();

Return Value

true if ON, else false

set flags for the listener.

public

void setFlags(
    UInt32 flags ); 

Parameters

Return Value

none.

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

public

const FWAsyncStreamReceiveCallback setListenerHandler( FWAsyncStreamReceiveCallback inReceiver ); 

Parameters

Return Value

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

Turns off client callback notification.

public

inline void TurnOffNotification();

Return Value

none.

Turns on client callback notification.

public

inline void TurnOnNotification();

Return Value

none.

Structs and Unions

ExpansionData

protected

struct ExpansionData {
}; 

Discussion

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

Member Data

reserved

protected

ExpansionData *reserved; 

Discussion

Reserved for future use. (Internal use only)

Last Updated: 2009-10-14