TABLE OF CONTENTS

1. OpenSM/Node Description Receiver
2. OpenSM: Node Description Receiver/osm_nd_rcv_t
3. OpenSM: Node Description Receiver/osm_nd_rcv_construct
4. OpenSM: Node Description Receiver/osm_nd_rcv_destroy
5. OpenSM: Node Description Receiver/osm_nd_rcv_init
6. OpenSM: Node Description Receiver/osm_nd_rcv_is_inited
7. OpenSM: Node Description Receiver/osm_nd_rcv_process

OpenSM/Node Description Receiver

    Node Description Receiver

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

    The Node Description Receiver 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 Receiver/osm_nd_rcv_t

    osm_nd_rcv_t

    Node Description Receiver structure.

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

typedef struct _osm_nd_rcv
{
    osm_subn_t                  *p_subn;
    osm_log_t                   *p_log;
    cl_plock_t                  *p_lock;

} osm_nd_rcv_t;

    base
        OpenSM base object.

    p_subn
        Pointer to the Subnet object for this subnet.

    p_log
        Pointer to the log object.

    p_lock
        Pointer to the serializing lock.

    Node Description Receiver object

OpenSM: Node Description Receiver/osm_nd_rcv_construct

    osm_nd_rcv_construct

    This function constructs a Node Description Receiver object.

void osm_nd_rcv_construct(
    IN osm_nd_rcv_t* const p_ctrl );

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

    This function does not return a value.

    Allows calling osm_nd_rcv_init, osm_nd_rcv_destroy,
    and osm_nd_rcv_is_inited.

    Calling osm_nd_rcv_construct is a prerequisite to calling any other
    method except osm_nd_rcv_init.

    Node Description Receiver object, osm_nd_rcv_init,
    osm_nd_rcv_destroy, osm_nd_rcv_is_inited

OpenSM: Node Description Receiver/osm_nd_rcv_destroy

    osm_nd_rcv_destroy

    The osm_nd_rcv_destroy function destroys the object, releasing
    all resources.

void osm_nd_rcv_destroy(
    IN osm_nd_rcv_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 Receiver object.
    Further operations should not be attempted on the destroyed object.
    This function should only be called after a call to
    osm_nd_rcv_construct or osm_nd_rcv_init.

    Node Description Receiver object, osm_nd_rcv_construct,
    osm_nd_rcv_init

OpenSM: Node Description Receiver/osm_nd_rcv_init

    osm_nd_rcv_init

    The osm_nd_rcv_init function initializes a
    Node Description Receiver object for use.

ib_api_status_t osm_nd_rcv_init(
    IN osm_nd_rcv_t* const p_ctrl,
    IN osm_subn_t* const p_subn,
    IN osm_log_t* const p_log,
    IN cl_plock_t* const p_lock );

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

    p_subn
        [in] Pointer to the Subnet object for this subnet.

    p_log
        [in] Pointer to the log object.

    p_lock
        [in] Pointer to the OpenSM serializing lock.

    CL_SUCCESS if the Node Description Receiver object was initialized
    successfully.

    Allows calling other Node Description Receiver methods.

    Node Description Receiver object, osm_nd_rcv_construct,
    osm_nd_rcv_destroy, osm_nd_rcv_is_inited

OpenSM: Node Description Receiver/osm_nd_rcv_is_inited

    osm_nd_rcv_is_inited

    Indicates if the object has been initialized with osm_nd_rcv_init.

boolean_t osm_nd_rcv_is_inited(
    IN const osm_nd_rcv_t* const p_ctrl );

    p_ctrl
        [in] Pointer to an osm_nd_rcv_t object.

    TRUE if the object was initialized successfully,
    FALSE otherwise.

    The osm_nd_rcv_construct or osm_nd_rcv_init must be
    called before using this function.

    Node Description Receiver object, osm_nd_rcv_construct,
    osm_nd_rcv_init

OpenSM: Node Description Receiver/osm_nd_rcv_process

    osm_nd_rcv_process

    Process the NodeInfo attribute.

void osm_nd_rcv_process(
    IN const osm_nd_rcv_t* const p_ctrl,
    IN osm_madw_t* const p_madw );

    p_ctrl
        [in] Pointer to an osm_nd_rcv_t object.

    p_madw
        [in] Pointer to the MAD Wrapper containing the MAD
        that contains the node's NodeInfo attribute.

    CL_SUCCESS if the NodeInfo processing was successful.

    This function processes a NodeInfo attribute.

    Node Description Receiver, Node Description Response Controller