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

IOFireWireLibPHYPacketListenerInterface

Declared In:

IOFireWireLib.h

Overview

Represents and provides management functions for a phy packet listener object.

Functions

ClientCommandIsComplete: Notify the PHY packet listener object that a packet notification handler has completed.
GetFlags: get the flags of listener.
GetRefCon: Returns the user refCon value for thisinterface.
NotificationIsOn: Is notification on?
SetFlags: set flags for the listener.
SetListenerCallback: Set the callback that should be called to handle incoming phy packets
SetRefCon: Sets the user refCon value for this interface.
SetSkippedPacketCallback: Set the callback that should be called when incoming phy packets are dropped by the listener space.
TurnOffNotification: Turn packet notification off.
TurnOnNotification: Try to turn on packet notifications for this listener.

ClientCommandIsComplete

Notify the PHY packet listener object that a packet notification handler has completed.

void ( *ClientCommandIsComplete)(
    IOFireWireLibPHYPacketListenerRef self,
    FWClientCommandID commandID );

Parameters

self: The PHY packet listener object.
commandID: The ID of the packet notification being completed. This is the same ID that was passed when a packet notification handler is called.

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)(
    IOFireWireLibPHYPacketListenerRef self );

Parameters

self: The PHY packet listener object.

Return Value

flags No current flags are defined.

GetRefCon

Returns the user refCon value for thisinterface.

void* ( *GetRefCon)(
    IOFireWireLibPHYPacketListenerRef self );

Parameters

self: The PHY packet listener object.

Return Value

returns the refcon

NotificationIsOn

Is notification on?

Boolean ( *NotificationIsOn)(
    IOFireWireLibPHYPacketListenerRef self );

Parameters

self: The PHY packet listener object.

Return Value

Returns true if packet notifications for this listener are active

SetFlags

set flags for the listener.

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

Parameters

self: The PHY packet listener object.
flags: No current flags are defined.

SetListenerCallback

Set the callback that should be called to handle incoming phy packets

void ( *SetListenerCallback)(
    IOFireWireLibPHYPacketListenerRef self,
    IOFireWireLibPHYPacketCallback inCallback );

Parameters

self: The PHY packet listener object.
inCallback: The callback to set.

SetRefCon

Sets the user refCon value for this interface.

void ( *SetRefCon)(
    IOFireWireLibPHYPacketListenerRef self,
    void *refcon );

Parameters

self: The PHY packet listener object.
refcon: the refcon

SetSkippedPacketCallback

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

void ( *SetSkippedPacketCallback)(
    IOFireWireLibPHYPacketListenerRef self,
    IOFireWireLibPHYPacketSkippedCallback inCallback );

Parameters

self: The PHY packet listener object.
inCallback: The callback to set.

TurnOffNotification

Turn packet notification off.

void ( *TurnOffNotification)(
    IOFireWireLibPHYPacketListenerRef self );

Parameters

self: The PHY packet listener object.

TurnOnNotification

Try to turn on packet notifications for this listener.

IOReturn ( *TurnOnNotification)(
    IOFireWireLibPHYPacketListenerRef self );

Parameters

self: The PHY packet listener object.

Return Value

Returns kIOReturnSuccess if successful

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: 2009-02-23