IOFireWireRemoteIsochPortInterface

Declared In:

Overview

Description forthcoming


Functions

AllocatePort

The method is called when the port should configure its associated hardware to prepare to send or receive isochronous data on the channel number and at the speed specified.

GetRefCon

Get reference value associated with this port.

GetSupported

The method is called to determine which FireWire isochronous channels and speed this port supports.

ReleasePort

The method is called to release the hardware after the channel has been stopped.

SetAllocatePortHandler
SetGetSupportedHandler
SetRefCon

Set reference value associated with this port.

SetReleasePortHandler
SetStartHandler
SetStopHandler
Start

The method is called when the port is to begin talking or listening.

Stop

The method is called when the port is to stop talking or listening.

AllocatePort

The method is called when the port should configure its associated hardware to prepare to send or receive isochronous data on the channel number and at the speed specified. 

IOReturn ( *AllocatePort) (
    IOFireWireLibIsochPortRef self,
    IOFWSpeed speed,
    UInt32 chan );
Parameters
self

The isoch port interface to use.

speed

Channel speed

chan

Channel number (-63)

Return Value

Return kIOReturnSuccess on success, other return any other IOReturn error code.

Discussion

This method is called by the channel object to which a port has been added. Subclasses of IOFireWireIsochPortInterface override this method to support specific hardware. Do not call this method directly.

GetRefCon

Get reference value associated with this port. 

void* ( *GetRefCon) (
    IOFireWireLibIsochPortRef self);
Parameters
self

The isoch port interface to use.

Return Value

The port refcon value.

Discussion

Set the reference value with SetRefCon()

GetSupported

The method is called to determine which FireWire isochronous channels and speed this port supports. 

IOReturn ( *GetSupported) (
    IOFireWireLibIsochPortRef self,
    IOFWSpeed *maxSpeed,
    UInt64 *chanSupported );
Parameters
self

The isoch port interface to use.

maxSpeed

A pointer to an IOFWSpeed which should be filled with the maximum speed this port can talk or listen.

chanSupported

A pointer to a UInt64 which should be filled with a bitmask representing the FireWire bus isochonous channels on which the port can talk or listen. Set '1' for supported, '' for unsupported.

Return Value

Return kIOReturnSuccess on success, other return any other IOReturn error code.

Discussion

This method is called by the channel object to which a port has been added. Subclasses of IOFireWireIsochPortInterface override this method to support specific hardware. Do not call this method directly.

ReleasePort

The method is called to release the hardware after the channel has been stopped. 

IOReturn ( *ReleasePort) (
    IOFireWireLibIsochPortRef self );
Parameters
self

The isoch port interface to use.

Return Value

Return kIOReturnSuccess on success, other return any other IOReturn error code.

Discussion

This method is called by the channel object to which a port has been added. Subclasses of IOFireWireIsochPortInterface override this method to support specific hardware. Do not call this method directly.

SetAllocatePortHandler

IOFireWireLibIsochPortAllocateCallback ( *SetAllocatePortHandler) (
    IOFireWireLibRemoteIsochPortRef self,
    IOFireWireLibIsochPortAllocateCallback inHandler);
Discussion

Description forthcoming

SetGetSupportedHandler

IOFireWireLibIsochPortGetSupportedCallback ( *SetGetSupportedHandler) (
    IOFireWireLibRemoteIsochPortRef self,
    IOFireWireLibIsochPortGetSupportedCallback inHandler);
Discussion

Description forthcoming

SetRefCon

Set reference value associated with this port. 

void ( *SetRefCon) (
    IOFireWireLibIsochPortRef self,
    void *inRefCon);
Parameters
self

The isoch port interface to use.

inRefCon

The new reference value.

Discussion

Retrieve the reference value with GetRefCon()

SetReleasePortHandler

IOFireWireLibIsochPortCallback ( *SetReleasePortHandler)(
    IOFireWireLibRemoteIsochPortRef self,
    IOFireWireLibIsochPortCallback inHandler);
Discussion

Description forthcoming

SetStartHandler

IOFireWireLibIsochPortCallback ( *SetStartHandler)(
    IOFireWireLibRemoteIsochPortRef self,
    IOFireWireLibIsochPortCallback inHandler);
Discussion

Description forthcoming

SetStopHandler

IOFireWireLibIsochPortCallback ( *SetStopHandler)(
    IOFireWireLibRemoteIsochPortRef self,
    IOFireWireLibIsochPortCallback inHandler);
Discussion

Description forthcoming

Start

The method is called when the port is to begin talking or listening. 

IOReturn ( *Start) (
    IOFireWireLibIsochPortRef self );
Parameters
self

The isoch port interface to use.

Return Value

Return kIOReturnSuccess on success, other return any other IOReturn error code.

Discussion

This method is called by the channel object to which a port has been added. Subclasses of IOFireWireIsochPortInterface override this method to support specific hardware. Do not call this method directly.

Stop

The method is called when the port is to stop talking or listening. 

IOReturn ( *Stop) (
    IOFireWireLibIsochPortRef self );
Parameters
self

The isoch port interface to use.

Return Value

Return kIOReturnSuccess on success, other return any other IOReturn error code.

Discussion

This method is called by the channel object to which a port has been added. Subclasses of IOFireWireIsochPortInterface override this method to support specific hardware. Do not call this method directly.

Member Data

revision
version

revision

UInt32 revision;
Discussion

Interface revision.

version

UInt32 version;
Discussion

Interface version.

 

Did this document help you? Yes It's good, but... Not helpful...

 

Last Updated: 2009-10-15