Mac Dev Center Mac OS X Reference Library Drivers, Kernel, & Hardware: User-Space Device Access I/O Kit Framework Reference
|
IOFireWireWriteCommandInterface |
Declared In: |
IOFireWireLib block read command object.
Represents an object that is configured and submitted to issue synchronous and asynchronous block read commands.
This interface contains all methods of IOFireWireCommandInterface. This interface will contain all v2 methods of IOFireWireCommandInterface when instantiated as v2 or newer.
Cancel command execution
Gets the most recently received ack code for this transaction.
Set the command refCon value and callback handler, and submit the command to FireWire for execution.
Gets the refcon associated with this command
Gets the most recently received response code for this transaction.
Return command completion status.
Get command target address.
Return number of bytes transferred by this command object when it last completed execution.
Is this command object currently executing?
Set the buffer where read data should be stored.
Set the completion handler to be called once the command completes asynchronous execution .
Set flags governing this command's execution.
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.
Set the maximum size in bytes of packets transferred by this command.
Gets the most recently received ack code for this transaction.
Sets the maximum number of retries for this command.
Set the user refCon value. This is the user defined value that will be passed in the refCon argument to the completion function.
Set command target address
Sets the duration of the timeout for this command.
Set the command refCon value and callback handler, and submit the command to FireWire for execution.
Cancel |
Cancel command execution
IOReturn ( *Cancel)( IOFireWireLibCommandRef self, IOReturn reason);
self
The command object interface of interest
An IOReturn result code
Availability: (for interfaces obtained with ID)
kIOFireWireReadCommandInterfaceID |
YES | |
kIOFireWireReadCommandInterfaceID_v2 |
YES | |
kIOFireWireWriteCommandInterfaceID |
YES | |
kIOFireWireWriteCommandInterfaceID_v2 |
YES | |
kIOFireWireReadQuadletCommandInterfaceID |
YES | |
kIOFireWireWriteQuadletCommandInterfaceID |
YES | |
kIOFireWireCompareSwapCommandInterfaceID |
YES | |
kIOFireWireAsyncStreamCommandInterfaceID |
YES |
GetAckCode |
Gets the most recently received ack code for this transaction.
UInt32 ( *GetAckCode)( IOFireWireLibCommandRef self );
self
A reference to the command
The FireWire ack code.
GetBuffer |
Set the command refCon value and callback handler, and submit the command to FireWire for execution.
self
The command object interface of interest
Availability: (for interfaces obtained with ID)
kIOFireWireReadCommandInterfaceID |
NO | |
kIOFireWireReadCommandInterfaceID_v2 |
YES | |
kIOFireWireWriteCommandInterfaceID |
NO | |
kIOFireWireWriteCommandInterfaceID_v2 |
YES | |
kIOFireWireReadQuadletCommandInterfaceID |
NO | |
kIOFireWireWriteQuadletCommandInterfaceID |
NO | |
kIOFireWireCompareSwapCommandInterfaceID |
NO | |
kIOFireWireAsyncStreamCommandInterfaceID |
YES |
GetRefCon |
Gets the refcon associated with this command
void * ( *GetRefCon)( IOFireWireLibCommandRef self );
self
A reference to the command
void
GetResponseCode |
Gets the most recently received response code for this transaction.
UInt32 ( *GetResponseCode)( IOFireWireLibCommandRef self );
self
A reference to the command
The FireWire response code.
GetStatus |
Return command completion status.
IOReturn ( *GetStatus)( IOFireWireLibCommandRef self);
self
The command object interface of interest
An IOReturn error code indicating the completion error (if any) returned the last time this command object was executed
Availability: (for interfaces obtained with ID)
kIOFireWireReadCommandInterfaceID |
YES | |
kIOFireWireReadCommandInterfaceID_v2 |
YES | |
kIOFireWireWriteCommandInterfaceID |
YES | |
kIOFireWireWriteCommandInterfaceID_v2 |
YES | |
kIOFireWireReadQuadletCommandInterfaceID |
YES | |
kIOFireWireWriteQuadletCommandInterfaceID |
YES | |
kIOFireWireCompareSwapCommandInterfaceID |
YES | |
kIOFireWireAsyncStreamCommandInterfaceID |
YES |
GetTargetAddress |
Get command target address.
void ( *GetTargetAddress)( IOFireWireLibCommandRef self, FWAddress *outAddr);
self
The command object interface of interest
outAddr
A pointer to an FWAddress to contain the function result.
Availability: (for interfaces obtained with ID)
kIOFireWireReadCommandInterfaceID |
YES | |
kIOFireWireReadCommandInterfaceID_v2 |
YES | |
kIOFireWireWriteCommandInterfaceID |
YES | |
kIOFireWireWriteCommandInterfaceID_v2 |
YES | |
kIOFireWireReadQuadletCommandInterfaceID |
YES | |
kIOFireWireWriteQuadletCommandInterfaceID |
YES | |
kIOFireWireCompareSwapCommandInterfaceID |
YES | |
kIOFireWireAsyncStreamCommandInterfaceID |
NO |
GetTransferredBytes |
Return number of bytes transferred by this command object when it last completed execution.
UInt32 ( *GetTransferredBytes)( IOFireWireLibCommandRef self);
self
The command object interface of interest
A UInt32 containing the bytes transferred value
Availability: (for interfaces obtained with ID)
kIOFireWireReadCommandInterfaceID |
YES | |
kIOFireWireReadCommandInterfaceID_v2 |
YES | |
kIOFireWireWriteCommandInterfaceID |
YES | |
kIOFireWireWriteCommandInterfaceID_v2 |
YES | |
kIOFireWireReadQuadletCommandInterfaceID |
YES | |
kIOFireWireWriteQuadletCommandInterfaceID |
YES | |
kIOFireWireCompareSwapCommandInterfaceID |
YES | |
kIOFireWireAsyncStreamCommandInterfaceID |
YES |
IsExecuting |
Is this command object currently executing?
const Boolean (*IsExecuting)(IOFireWireLibCommandRef self);
self
The command object interface of interest
Returns true if the command object is executing.
Availability: (for interfaces obtained with ID)
kIOFireWireReadCommandInterfaceID |
YES | |
kIOFireWireReadCommandInterfaceID_v2 |
YES | |
kIOFireWireWriteCommandInterfaceID |
YES | |
kIOFireWireWriteCommandInterfaceID_v2 |
YES | |
kIOFireWireReadQuadletCommandInterfaceID |
YES | |
kIOFireWireWriteQuadletCommandInterfaceID |
YES | |
kIOFireWireCompareSwapCommandInterfaceID |
YES | |
kIOFireWireAsyncStreamCommandInterfaceID |
YES |
SetBuffer |
Set the buffer where read data should be stored.
self
The command object interface of interest
size
Size in bytes of the receive buffer.
buf
A pointer to the receive buffer.
Availability: (for interfaces obtained with ID)
kIOFireWireReadCommandInterfaceID |
NO | |
kIOFireWireReadCommandInterfaceID_v2 |
YES | |
kIOFireWireWriteCommandInterfaceID |
NO | |
kIOFireWireWriteCommandInterfaceID_v2 |
YES | |
kIOFireWireReadQuadletCommandInterfaceID |
NO | |
kIOFireWireWriteQuadletCommandInterfaceID |
NO | |
kIOFireWireCompareSwapCommandInterfaceID |
NO | |
kIOFireWireAsyncStreamCommandInterfaceID |
YES |
SetCallback |
Set the completion handler to be called once the command completes asynchronous execution .
void ( *SetCallback)( IOFireWireLibCommandRef self, IOFireWireLibCommandCallback inCallback);
self
The command object interface of interest
inCallback
A callback handler. Passing nil forces the command object to execute synchronously.
Availability: (for interfaces obtained with ID)
kIOFireWireReadCommandInterfaceID |
YES | |
kIOFireWireReadCommandInterfaceID_v2 |
YES | |
kIOFireWireWriteCommandInterfaceID |
YES | |
kIOFireWireWriteCommandInterfaceID_v2 |
YES | |
kIOFireWireReadQuadletCommandInterfaceID |
YES | |
kIOFireWireWriteQuadletCommandInterfaceID |
YES | |
kIOFireWireCompareSwapCommandInterfaceID |
YES | |
kIOFireWireAsyncStreamCommandInterfaceID |
YES |
SetFlags |
Set flags governing this command's execution.
void ( *SetFlags)( IOFireWireLibCommandRef self, UInt32 inFlags);
self
The command object interface of interest
inFlags
A UInt32 with bits set corresponding to the flags that should be set
for this command object. The following values may be used:
Availability: (for interfaces obtained with ID)
kIOFireWireReadCommandInterfaceID |
NO | |
kIOFireWireReadCommandInterfaceID_v2 |
YES | |
kIOFireWireWriteCommandInterfaceID |
NO | |
kIOFireWireWriteCommandInterfaceID_v2 |
YES | |
kIOFireWireReadQuadletCommandInterfaceID |
NO | |
kIOFireWireWriteQuadletCommandInterfaceID |
NO | |
kIOFireWireCompareSwapCommandInterfaceID |
NO | |
kIOFireWireAsyncStreamCommandInterfaceID |
YES |
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.
void ( *SetGeneration)( IOFireWireLibCommandRef self, UInt32 generation);
self
The command object interface of interest
generation
A bus generation. The current bus generation can be obtained from IOFireWireDeviceInterface::GetBusGeneration().
Availability: (for interfaces obtained with ID)
kIOFireWireReadCommandInterfaceID |
YES | |
kIOFireWireReadCommandInterfaceID_v2 |
YES | |
kIOFireWireWriteCommandInterfaceID |
YES | |
kIOFireWireWriteCommandInterfaceID_v2 |
YES | |
kIOFireWireReadQuadletCommandInterfaceID |
YES | |
kIOFireWireWriteQuadletCommandInterfaceID |
YES | |
kIOFireWireCompareSwapCommandInterfaceID |
YES | |
kIOFireWireAsyncStreamCommandInterfaceID |
YES |
SetMaxPacket |
Set the maximum size in bytes of packets transferred by this command.
IOReturn ( *SetMaxPacket)( IOFireWireLibCommandRef self, IOByteCount maxPacketSize);
self
The command object interface of interest
maxPacketSize
Size in bytes of largest packet that should be transferred by this command.
An IOReturn result code indicating whether or not the command was successfully submitted
Availability: (for interfaces obtained with ID)
kIOFireWireReadCommandInterfaceID |
NO | |
kIOFireWireReadCommandInterfaceID_v2 |
YES | |
kIOFireWireWriteCommandInterfaceID |
NO | |
kIOFireWireWriteCommandInterfaceID_v2 |
YES | |
kIOFireWireReadQuadletCommandInterfaceID |
NO | |
kIOFireWireWriteQuadletCommandInterfaceID |
NO | |
kIOFireWireCompareSwapCommandInterfaceID |
NO | |
kIOFireWireAsyncStreamCommandInterfaceID |
YES |
SetMaxPacketSpeed |
Gets the most recently received ack code for this transaction.
void ( *SetMaxPacketSpeed)( IOFireWireLibCommandRef self, IOFWSpeed speed );
self
A reference to the command
speed
the desired maximum packet speed
void
SetMaxRetryCount |
Sets the maximum number of retries for this command.
void ( *SetMaxRetryCount)( IOFireWireLibCommandRef self, UInt32 count );
self
A reference to the command
count
The number of retires
void
SetRefCon |
Set the user refCon value. This is the user defined value that will be passed in the refCon argument to the completion function.
Availability: (for interfaces obtained with ID)
kIOFireWireReadCommandInterfaceID |
YES | |
kIOFireWireReadCommandInterfaceID_v2 |
YES | |
kIOFireWireWriteCommandInterfaceID |
YES | |
kIOFireWireWriteCommandInterfaceID_v2 |
YES | |
kIOFireWireReadQuadletCommandInterfaceID |
YES | |
kIOFireWireWriteQuadletCommandInterfaceID |
YES | |
kIOFireWireCompareSwapCommandInterfaceID |
YES | |
kIOFireWireAsyncStreamCommandInterfaceID |
YES |
SetTarget |
Set command target address
void ( *SetTarget)( IOFireWireLibCommandRef self, const FWAddress* addr);
self
The command object interface of interest
addr
A pointer to an FWAddress.
Availability: (for interfaces obtained with ID)
kIOFireWireReadCommandInterfaceID |
YES | |
kIOFireWireReadCommandInterfaceID_v2 |
YES | |
kIOFireWireWriteCommandInterfaceID |
YES | |
kIOFireWireWriteCommandInterfaceID_v2 |
YES | |
kIOFireWireReadQuadletCommandInterfaceID |
YES | |
kIOFireWireWriteQuadletCommandInterfaceID |
YES | |
kIOFireWireCompareSwapCommandInterfaceID |
YES | |
kIOFireWireAsyncStreamCommandInterfaceID |
NO |
SetTimeoutDuration |
Sets the duration of the timeout for this command.
void ( *SetTimeoutDuration)( IOFireWireLibCommandRef self, UInt32 duration );
self
A reference to the command
duration
A timeout value in microseconds
void
Submit |
IOReturn ( *Submit)( IOFireWireLibCommandRef self);
Description forthcoming
SubmitWithRefconAndCallback |
Set the command refCon value and callback handler, and submit the command to FireWire for execution.
IOReturn ( *SubmitWithRefconAndCallback)( IOFireWireLibCommandRef self, void *refCon, IOFireWireLibCommandCallback inCallback);
self
The command object interface of interest
An IOReturn result code indicating whether or not the command was successfully submitted
Availability: (for interfaces obtained with ID)
kIOFireWireReadCommandInterfaceID |
YES | |
kIOFireWireReadCommandInterfaceID_v2 |
YES | |
kIOFireWireWriteCommandInterfaceID |
YES | |
kIOFireWireWriteCommandInterfaceID_v2 |
YES | |
kIOFireWireReadQuadletCommandInterfaceID |
YES | |
kIOFireWireWriteQuadletCommandInterfaceID |
YES | |
kIOFireWireCompareSwapCommandInterfaceID |
YES | |
kIOFireWireAsyncStreamCommandInterfaceID |
YES |
revision |
UInt32 revision;
Interface revision.
version |
UInt32 version;
Interface version.
Last Updated: 2009-10-15