IOFireWireIsochChannelInterface

Overview

FireWire user client isochronous channel object.

Discussion

IOFireWireIsochChannelInterface is an abstract representataion of a FireWire bus isochronous channel. This interface coordinates starting and stopping traffic on a FireWire bus isochronous channel and can optionally communicate with the IRM to automatically allocate bandwidth and channel numbers. When using automatic IRM allocation, the channel interface reallocates its bandwidth and channel reservation after each bus reset.

Isochronous port interfaces representing FireWire isochronous talkers and listeners must be added to the channel using SetTalker() and AddListener()

Functions

AddListener

Modify the transfer size of a transfer packet DCL (send or receive)

AllocateChannel

Prepare all hardware to begin sending or receiving isochronous data.

ClientCommandIsComplete

GetRefCon

Set reference value associated with this channel.

NotificationIsOn

ReleaseChannel

Release all hardware after stopping the isochronous channel.

SetChannelForceStopHandler

Set the channel force stop handler.

SetRefCon

Set reference value associated with this channel.

SetTalker

Set the talker port for this channel.

Start

Start the channel.

Stop

Stop the channel.

TurnOffNotification

TurnOnNotification

Modify the transfer size of a transfer packet DCL (send or receive)

IOReturn ( *AddListener) (
    IOFireWireLibIsochChannelRef self,
    IOFireWireLibIsochPortRef listener );  

Parameters

Return Value

Returns an IOReturn error code.

Discussion

Allows you to modify transfer packet DCLs after they have been compiled and while the DCL program is still running. The transfer size can be set to any size less than or equal to the size set when the DCL program was compiled (including 0).

Availability: IOFireWireLocalIsochPortInterface_v3 and newer.

Prepare all hardware to begin sending or receiving isochronous data.

IOReturn ( *AllocateChannel) (
    IOFireWireLibIsochChannelRef self );  

Parameters

Return Value

Returns an IOReturn error code.

Discussion

Calling this function will result in all listener and talker ports on this isochronous channel having their AllocatePort method called.

void ( *ClientCommandIsComplete) (
    IOFireWireLibIsochChannelRef self,
    FWClientCommandID commandID,
    IOReturn status);  

Discussion

Description forthcoming

Set reference value associated with this channel.

void* ( *GetRefCon) (
    IOFireWireLibIsochChannelRef self);  

Parameters

Discussion

Retrieve the reference value with SetRefCon()

Boolean ( *NotificationIsOn) (
    IOFireWireLibIsochChannelRef self);  

Discussion

Description forthcoming

Release all hardware after stopping the isochronous channel.

IOReturn ( *ReleaseChannel) (
    IOFireWireLibIsochChannelRef self );  

Parameters

Return Value

Returns an IOReturn error code.

Discussion

Calling this function will result in all listener and talker ports on this isochronous channel having their ReleasePort method called.

Set the channel force stop handler.

IOFireWireIsochChannelForceStopHandler ( *SetChannelForceStopHandler) (
    IOFireWireLibIsochChannelRef self,
    IOFireWireIsochChannelForceStopHandler stopProc);  

Parameters

Return Value

Returns the previously set handler or NULL is no handler was set.

Discussion

The specified callback is called when the channel is stopped and cannot be restarted automatically.

Set reference value associated with this channel.

void ( *SetRefCon) (
    IOFireWireLibIsochChannelRef self,
    void *stopProcRefCon);  

Parameters

Discussion

Retrieve the reference value with GetRefCon()

Set the talker port for this channel.

IOReturn ( *SetTalker) (
    IOFireWireLibIsochChannelRef self,
    IOFireWireLibIsochPortRef talker );  

Parameters

Return Value

Returns an IOReturn error code.

Start the channel.

IOReturn ( *Start) (
    IOFireWireLibIsochChannelRef self );  

Parameters

Return Value

Returns an IOReturn error code.

Discussion

Calling this function will result in all listener and talker ports on this isochronous channel having their Start method called.

Stop the channel.

IOReturn ( *Stop) (
    IOFireWireLibIsochChannelRef self );  

Parameters

Return Value

Returns an IOReturn error code.

Discussion

Calling this function will result in all listener and talker ports on this isochronous channel having their Stop method called.

void ( *TurnOffNotification) (
    IOFireWireLibIsochChannelRef self);  

Discussion

Description forthcoming

Boolean ( *TurnOnNotification) (
    IOFireWireLibIsochChannelRef self);  

Discussion

Description forthcoming

Member Data

revision

version

UInt32 revision;  

Discussion

Interface revision.

UInt32 version;  

Discussion

Interface version.

Last Updated: 2009-10-15