TABLE OF CONTENTS

1. OpenSM/Node Description Receive Controller
2. OpenSM: Node Description Receive Controller/osm_si_rcv_ctrl_t
3. OpenSM: Node Description Receive Controller/osm_si_rcv_ctrl_construct
4. OpenSM: Node Description Receive Controller/osm_si_rcv_ctrl_destroy
5. OpenSM: Node Description Receive Controller/osm_si_rcv_ctrl_init
6. OpenSM: Node Description Receive Controller/osm_si_rcv_ctrl_is_inited

OpenSM/Node Description Receive Controller

    Node Description Receive Controller

    The Node Description Receive Controller object encapsulates
    the information needed to receive the NodeInfo attribute from a node.

    The Node Description Receive Controller object is thread safe.

    This object should be treated as opaque and should be
    manipulated only through the provided functions.

    Steve King, Intel

OpenSM: Node Description Receive Controller/osm_si_rcv_ctrl_t

    osm_si_rcv_ctrl_t

    Node Description Receive Controller structure.

    This object should be treated as opaque and should
    be manipulated only through the provided functions.

typedef struct _osm_si_rcv_ctrl
{
    osm_si_rcv_t                *p_rcv;
    osm_log_t                   *p_log;
    cl_dispatcher_t             *p_disp;
    cl_disp_reg_handle_t        h_disp;

} osm_si_rcv_ctrl_t;

    base
        OpenSM base object.

    p_rcv
        Pointer to the Node Description Receiver object.

    p_log
        Pointer to the log object.

    p_disp
        Pointer to the Dispatcher.

    h_disp
        Handle returned from dispatcher registration.

    Node Description Receive Controller object
    Node Description Receiver object

OpenSM: Node Description Receive Controller/osm_si_rcv_ctrl_construct

    osm_si_rcv_ctrl_construct

    This function constructs a Node Description Receive Controller object.

void osm_si_rcv_ctrl_construct(
    IN osm_si_rcv_ctrl_t* const p_ctrl );

    p_ctrl
        [in] Pointer to a Node Description Receive Controller
        object to construct.

    This function does not return a value.

    Allows calling osm_si_rcv_ctrl_init, osm_si_rcv_ctrl_destroy,
    and osm_si_rcv_ctrl_is_inited.

    Calling osm_si_rcv_ctrl_construct is a prerequisite to calling any other
    method except osm_si_rcv_ctrl_init.

    Node Description Receive Controller object, osm_si_rcv_ctrl_init,
    osm_si_rcv_ctrl_destroy, osm_si_rcv_ctrl_is_inited

OpenSM: Node Description Receive Controller/osm_si_rcv_ctrl_destroy

    osm_si_rcv_ctrl_destroy

    The osm_si_rcv_ctrl_destroy function destroys the object, releasing
    all resources.

void osm_si_rcv_ctrl_destroy(
    IN osm_si_rcv_ctrl_t* const p_ctrl );

    p_ctrl
        [in] Pointer to the object to destroy.

    This function does not return a value.

    Performs any necessary cleanup of the specified
    Node Description Receive Controller object.
    Further operations should not be attempted on the destroyed object.
    This function should only be called after a call to
    osm_si_rcv_ctrl_construct or osm_si_rcv_ctrl_init.

    Node Description Receive Controller object, osm_si_rcv_ctrl_construct,
    osm_si_rcv_ctrl_init

OpenSM: Node Description Receive Controller/osm_si_rcv_ctrl_init

    osm_si_rcv_ctrl_init

    The osm_si_rcv_ctrl_init function initializes a
    Node Description Receive Controller object for use.

ib_api_status_t osm_si_rcv_ctrl_init(
    IN osm_si_rcv_ctrl_t* const p_ctrl,
    IN osm_si_rcv_t* const p_rcv,
    IN osm_log_t* const p_log,
    IN cl_dispatcher_t* const p_disp );

    p_ctrl
        [in] Pointer to an osm_si_rcv_ctrl_t object to initialize.

    p_rcv
        [in] Pointer to an osm_si_rcv_t object.

    p_log
        [in] Pointer to the log object.

    p_disp
        [in] Pointer to the OpenSM central Dispatcher.

    CL_SUCCESS if the Node Description Receive Controller object was initialized
    successfully.

    Allows calling other Node Description Receive Controller methods.

    Node Description Receive Controller object, osm_si_rcv_ctrl_construct,
    osm_si_rcv_ctrl_destroy, osm_si_rcv_ctrl_is_inited

OpenSM: Node Description Receive Controller/osm_si_rcv_ctrl_is_inited

    osm_si_rcv_ctrl_is_inited

    Indicates if the object has been initialized with osm_si_rcv_ctrl_init.

boolean_t osm_si_rcv_ctrl_is_inited(
    IN const osm_si_rcv_ctrl_t* const p_ctrl );

    p_ctrl
        [in] Pointer to an osm_si_rcv_ctrl_t object.

    TRUE if the object was initialized successfully,
    FALSE otherwise.

    The osm_si_rcv_ctrl_construct or osm_si_rcv_ctrl_init must be
    called before using this function.

    Node Description Receive Controller object, osm_si_rcv_ctrl_construct,
    osm_si_rcv_ctrl_init