IOFireWireSBP2ManagementORB

Inherits from
IOFWCommand
Availability
Available in OS X v10.0 and later.
Declared in
IOFireWireSBP2ManagementORB.h

Overview

Supplies non login related management ORBs. Management ORBs can be executed independent of a login, if necessary. Management ORBs are created using the IOFireWireSBP2LUN interface.

Tasks

Miscellaneous

Instance Methods

getCommandFunction()

Returns the current function of the management ORB.

virtual UInt32 getCommandFunction( void );
Return Value

Returns the function of the management ORB.

Discussion

Returns the function of the management ORB. This is the same value that was set with setCommandFunction.

getCommandFunction()

Returns the current managee command of the management ORB.

virtual OSObject* getManageeCommand( void );
Return Value

Returns the current managee command of the management ORB.

Discussion

Returns the current managee command of the management ORB. This is the same value that was set with setManageeCommand.

getManageeCommand

Returns the current managee command of the management ORB.

virtual OSObject* getManageeCommand( void );
Return Value

Returns the current managee command of the management ORB.

Discussion

Returns the current managee command of the management ORB. This is the same value that was set with setManageeCommand.

getResponseBuffer

Returns the response buffer for the management ORB.

virtual void getResponseBuffer( void **buf, UInt32 *len );
Parameters
desc

memory descriptor for buffer.

buf

output parameter for backing store for buffer

len

output parameter for length of buffer.

Discussion

Returns the response buffer set in setResponseBuffer above

release

Primary implementation of the release mechanism.

virtual void release() const;
Parameters
when

When retainCount == when then call free().

Discussion

See OSObject.h for more information.

setCommandFunction

Sets the function of the management ORB.

virtual IOReturn setCommandFunction( UInt32 function );
Parameters
function

a value indicating the desired management function.

Return Value

Returns kIOReturnSuccess if function was a legal function.

Discussion

Sets the the function of the management ORB. Legal values are kFWSBP2QueryLogins, kFWSBP2AbortTask, kFWSBP2AbortTaskSet, kFWSBP2LogicalUnitReset, and kFWSBP2TargetReset.

setManageeCommand

Sets the command to be managed by the management ORB.

virtual void setManageeCommand( OSObject *command );
Parameters
command

a reference to an IOFireWireSBP2Login or an IOFireWireSBP2ORB.

Discussion

All management functions except kFWSBP2QueryLogins require a reference to an ORB of some sort. kFWSBP2AbortTaskSet, kFWSBP2LogicalUnitReset, and kFWSBP2TargetReset require a reference to the login ORB. kFWSBP2AbortTask requires a reference to the ORB to be aborted. This method allows you to set the ORB to be managed.

setResponseBuffer(IOMemoryDescriptor *)

Sets the response buffer for the management ORB.

virtual IOReturn setResponseBuffer( IOMemoryDescriptor *desc );
Parameters
desc

memory descriptor for buffer.

Return Value

Returns kIOReturnSuccess on a success.

Discussion

Sets the response buffer for the management ORB. kFWSBP2QueryLogins returns a response to its query and needs to write it somewhere. This routine allows you to specify the location.

setResponseBuffer(void *, UInt32)

Sets the response buffer for the management ORB.

virtual IOReturn setResponseBuffer( void *buf, UInt32 len );
Parameters
buf

backing store for buffer

len

length of buffer.

Return Value

Returns kIOReturnSuccess on a success.

Discussion

Sets the response buffer for the management ORB. kFWSBP2QueryLogins returns a response to its query and needs to write it somewhere. This routine allows you to specify the location.