Mac Developer Library

Developer

IOFWAsyncStreamListener Class Reference

Options
Deployment Target:

On This Page
Language:

IOFWAsyncStreamListener

Inheritance


  • IOFWAsyncStreamListener

Conforms To


Not Applicable

Import Statement


Not Applicable

Objective-C

@import Kernel;

Availability


Available in OS X v10.5 and later.

  • get the flags of listener.

    Declaration

    C++

    UInt32 getFlags();

    Parameters

    none.

    Return Value

    flags.

  • get overrun counter from the DCL program.

    Declaration

    C++

    UInt32 getOverrunCounter();

    Parameters

    none.

    Return Value

    returns the counter value.

  • Declaration

    C++

    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.

    Declaration

    C++

    inline void* getRefCon();

    Parameters

    none.

    Return Value

    fRefCon refcon passed during initialization.

  • Creates an AsyncStream client for an Isoch channel.

    Declaration

    C++

    bool initAll( IOFireWireController *control, UInt32channel, FWAsyncStreamReceiveCallbackproc, void *obj );

    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.

  • Declaration

    C++

    void invokeClients( UInt8 *buffer );

    Discussion

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

  • checks the notification state.

    Declaration

    C++

    inline bool IsNotificationOn();

    Return Value

    true if ON, else false

  • set flags for the listener.

    Declaration

    C++

    void setFlags( UInt32flags );

    Parameters

    flags

    indicate performance metrics.

    Return Value

    none.

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

    Declaration

    C++

    const FWAsyncStreamReceiveCallback setListenerHandler( FWAsyncStreamReceiveCallbackinReceiver );

    Parameters

    inReceiver

    The callback to set.

    Return Value

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

  • Turns off client callback notification.

    Declaration

    C++

    inline void TurnOffNotification();

    Return Value

    none.

  • Turns on client callback notification.

    Declaration

    C++

    inline void TurnOnNotification();

    Return Value

    none.

Data Types

  • Declaration

    C++

    struct ExpansionData { };

    Discussion

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

Instance Variables

  • Reserved for future use. (Internal use only)

    Declaration

    C++

    ExpansionData *reserved;