Mac Developer Library

Developer

IOFireWireSBP2ManagementORB Class Reference

Options
Deployment Target:

On This Page
Language:

IOFireWireSBP2ManagementORB

Inheritance


Not Applicable

Conforms To


Not Applicable

Import Statement


Not Applicable

Objective-C

@import Kernel;

Availability


Available in OS X v10.0 and later.

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.

  • Returns the current function of the management ORB.

    Declaration

    C++

    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.

  • Returns the current managee command of the management ORB.

    Declaration

    C++

    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.

  • Returns the current managee command of the management ORB.

    Declaration

    C++

    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.

  • Returns the response buffer for the management ORB.

    Declaration

    C++

    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

  • Primary implementation of the release mechanism.

    Declaration

    C++

    virtual void release() const;

    Parameters

    when

    When retainCount == when then call free().

    Discussion

    See OSObject.h for more information.

  • Sets the function of the management ORB.

    Declaration

    C++

    virtual IOReturn setCommandFunction( UInt32function );

    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.

  • Sets the command to be managed by the management ORB.

    Declaration

    C++

    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.

  • Sets the response buffer for the management ORB.

    Declaration

    C++

    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.

  • Sets the response buffer for the management ORB.

    Declaration

    C++

    virtual IOReturn setResponseBuffer( void *buf, UInt32len );

    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.