IOFireWireReadQuadletCommandInterface

Overview

IOFireWireReadQuadletCommandInterface -- IOFireWireLib quadlet read command object.

Discussion

Obsolete; do not use. Use IOFireWireReadCommandInterface v2 or newer and its function SetMaxPacket()

Functions

Cancel

Cancel command execution

GetStatus

Return command completion status.

GetTargetAddress

Get command target address.

GetTransferredBytes

Return number of bytes transferred by this command object when it last completed execution.

IsExecuting

Is this command object currently executing?

SetCallback

Set the completion handler to be called once the command completes asynchronous execution .

SetGeneration

Set FireWire bus generation for which the command object shall be valid. If the failOnReset attribute has been set, the command will only be considered for execution during the bus generation specified by this function.

SetQuads

Set destination for read data

SetRefCon

Set the user refCon value. This is the user defined value that will be passed in the refCon argument to the completion function.

SetTarget

Set command target address

Submit

SubmitWithRefconAndCallback

Set the command refCon value and callback handler, and submit the command to FireWire for execution.

Cancel command execution

IOReturn ( *Cancel)(
    IOFireWireLibCommandRef self,
    IOReturn reason);  

Parameters

Return Value

An IOReturn result code

Discussion

Availability: (for interfaces obtained with ID)

Return command completion status.

IOReturn ( *GetStatus)(
    IOFireWireLibCommandRef self);  

Parameters

Return Value

An IOReturn error code indicating the completion error (if any) returned the last time this command object was executed

Discussion

Availability: (for interfaces obtained with ID)

Get command target address.

void ( *GetTargetAddress)(
    IOFireWireLibCommandRef self,
    FWAddress *outAddr);  

Parameters

Discussion

Availability: (for interfaces obtained with ID)

Return number of bytes transferred by this command object when it last completed execution.

UInt32 ( *GetTransferredBytes)(
    IOFireWireLibCommandRef self);  

Parameters

Return Value

A UInt32 containing the bytes transferred value

Discussion

Availability: (for interfaces obtained with ID)

Is this command object currently executing?

const Boolean (*IsExecuting)(IOFireWireLibCommandRef self);  

Parameters

Return Value

Returns true if the command object is executing.

Discussion

Availability: (for interfaces obtained with ID)

Set the completion handler to be called once the command completes asynchronous execution .

void ( *SetCallback)(
    IOFireWireLibCommandRef self,
    IOFireWireLibCommandCallback inCallback);  

Parameters

Discussion

Availability: (for interfaces obtained with ID)

Set FireWire bus generation for which the command object shall be valid. If the failOnReset attribute has been set, the command will only be considered for execution during the bus generation specified by this function.

void ( *SetGeneration)(
    IOFireWireLibCommandRef self,
    UInt32 generation);  

Parameters

Discussion

Availability: (for interfaces obtained with ID)

Set destination for read data

void ( *SetQuads)(
    IOFireWireLibReadQuadletCommandRef self,
    UInt32 inQuads[],
    UInt32 inNumQuads);  

Parameters

Set the user refCon value. This is the user defined value that will be passed in the refCon argument to the completion function.

void ( *SetRefCon)(
    IOFireWireLibCommandRef self,
    void *refCon);  

Discussion

Availability: (for interfaces obtained with ID)

Set command target address

void ( *SetTarget)(
    IOFireWireLibCommandRef self,
    const FWAddress* addr);  

Parameters

Discussion

Availability: (for interfaces obtained with ID)

IOReturn ( *Submit)(
    IOFireWireLibCommandRef self);  

Discussion

Description forthcoming

Set the command refCon value and callback handler, and submit the command to FireWire for execution.

IOReturn ( *SubmitWithRefconAndCallback)(
    IOFireWireLibCommandRef self,
    void *refCon,
    IOFireWireLibCommandCallback inCallback);  

Parameters

Return Value

An IOReturn result code indicating whether or not the command was successfully submitted

Discussion

Availability: (for interfaces obtained with ID)

Member Data

revision

version

UInt32 revision;  

Discussion

Interface revision.

UInt32 version;  

Discussion

Interface version.

Last Updated: 2009-10-15