ADC Home > Reference Library > Reference > Hardware & Drivers > I/O Kit Framework Reference

IOFireWireLibIsoch.h

Includes:

Overview

This header contains definitions for interfaces you use to communicate with FireWire isochronous channel objects.

COM Interfaces

IOFireWireDCLCommandPoolInterface
IOFireWireIsochChannelInterface: FireWire user client isochronous channel object.
IOFireWireIsochPortInterface: FireWire user client isochronous port interface.
IOFireWireLocalIsochPortInterface: FireWire user client local isochronous port object.
IOFireWireNuDCLPoolInterface

Functions

ClientCommandIsComplete: Notify the async stream object that a packet notification handler has completed.
GetFlags: get the flags of listener.
GetOverrunCounter: get overrun counter from the DCL program.
GetRefCon: Returns the user refCon value for this async stream interface.
NotificationIsOn: Is notification on?
SetFlags: set flags for the listener.
SetListenerHandler: Set the callback that should be called to handle incoming async stream packets
SetSkippedPacketHandler: Set the callback that should be called when incoming packets are dropped by the address space.
TurnOffNotification: Force packet notification off.
TurnOnNotification: Try to turn on packet notifications for this channel.

ClientCommandIsComplete

Notify the async stream object that a packet notification handler has completed.

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

Parameters

self: The async stream interface to use.
commandID: The ID of the packet notification being completed. This is the same ID that was passed when a packet notification handler is called.
status: The completion status of the packet handler

Discussion

Packet notifications are received one at a time, in order. This function must be called after a packet handler has completed its work.

GetFlags

get the flags of listener.

UInt32 ( *GetFlags)(
    IOFWAsyncStreamListenerInterfaceRef self);

Parameters

self: The async stream interface to use.

Return Value

flags.

GetOverrunCounter

get overrun counter from the DCL program.

UInt32 ( *GetOverrunCounter)(
    IOFWAsyncStreamListenerInterfaceRef self);

Parameters

self: The async stream interface to use.

Return Value

returns the counter value.

GetRefCon

Returns the user refCon value for this async stream interface.

void* ( *GetRefCon)(
    IOFWAsyncStreamListenerInterfaceRef self);

Parameters

self: The async stream interface to use.

Return Value

returns the callback object.

NotificationIsOn

Is notification on?

Boolean ( *NotificationIsOn)(
    IOFWAsyncStreamListenerInterfaceRef self);

Parameters

self: The async stream interface to use.

Return Value

Returns true if packet notifications for this channel are active

SetFlags

set flags for the listener.

void ( *SetFlags)(
    IOFWAsyncStreamListenerInterfaceRef self,
    UInt32 flags );

Parameters

self: The async stream interface to use.
flags: indicate performance metrics.

Return Value

none.

SetListenerHandler

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

const IOFWAsyncStreamListenerHandler ( *SetListenerHandler)(
    IOFWAsyncStreamListenerInterfaceRef self,
    IOFWAsyncStreamListenerHandler inReceiver);

Parameters

self: The async stream interface to use.
inReceiver: The callback to set.

Return Value

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

SetSkippedPacketHandler

Set the callback that should be called when incoming packets are dropped by the address space.

const IOFWAsyncStreamListenerSkippedPacketHandler ( *SetSkippedPacketHandler)(
    IOFWAsyncStreamListenerInterfaceRef self,
    IOFWAsyncStreamListenerSkippedPacketHandler inHandler);

Parameters

self: The address space interface to use.
inHandler: The callback to set.

Return Value

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

TurnOffNotification

Force packet notification off.

void ( *TurnOffNotification)(
    IOFWAsyncStreamListenerInterfaceRef self);

Parameters

self: The async stream interface to use.

TurnOnNotification

Try to turn on packet notifications for this channel.

Boolean ( *TurnOnNotification)(
    IOFWAsyncStreamListenerInterfaceRef self);

Parameters

self: The async stream interface to use.

Return Value

Returns true upon success

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-03-11