ADC Home > Reference Library > Reference > Darwin > Kernel Framework Reference

---

IOFWAsyncStreamListener

Overview

---

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.

---

getFlags

---

get the flags of listener.

public

UInt32 getFlags(); 

Parameters

none.

Return Value

flags.

---

getOverrunCounter

---

get overrun counter from the DCL program.

public

UInt32 getOverrunCounter(); 

Parameters

none.

Return Value

returns the counter value.

---

getReceiver

---

private

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.

public

inline void* getRefCon();

Parameters

none.

Return Value

fRefCon refcon passed during initialization.

---

initAll

---

Creates an AsyncStream client for an Isoch channel.

public

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

---

private

void invokeClients(
    UInt8 *buffer ); 

Discussion

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

---

IsNotificationOn

---

checks the notification state.

public

inline bool IsNotificationOn();

Return Value

true if ON, else false

---

setFlags

---

set flags for the listener.

public

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

public

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.

public

inline void TurnOffNotification();

Return Value

none.

---

TurnOnNotification

---

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)

Did this document help you? Yes: Tell us what works for you. It’s good, but: Report typos, inaccuracies, and so forth. It wasn’t helpful: Tell us what would have helped.

 

Last Updated: 2008-12-19