TABLE OF CONTENTS

1. OpenSM/Node Info Receiver
2. OpenSM: Node Info Receiver/osm_nr_t
3. OpenSM: Node Info Receiver/osm_nr_construct
4. OpenSM: Node Info Receiver/osm_nr_destroy
5. OpenSM: Node Info Receiver/osm_nr_init
6. OpenSM: Node Info Receiver/osm_nr_is_inited
7. OpenSM: Node Info Receiver/osm_nr_process

OpenSM/Node Info Receiver

    Node Info Receiver

    The Node Info Receiver object encapsulates the information
    needed to receive the NodeRecord attribute from a node.

    The Node Info Receiver object is thread safe.

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

    Ranjit Pandit, Intel

OpenSM: Node Info Receiver/osm_nr_t

    osm_nr_t

    Node Info Receiver structure.

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

typedef struct _osm_nr
{
    osm_subn_t              *p_subn;
    osm_sa_resp_t               *p_resp;
    osm_mad_pool_t              *p_mad_pool;
    osm_bind_handle_t           h_bind;
    osm_log_t               *p_log;
    cl_plock_t              *p_lock;
} osm_nr_t;

    base
        OpenSM base object.

    p_subn
        Pointer to the Subnet object for this subnet.

    p_gen_req_ctrl
        Pointer to the generic request controller.

    p_log
        Pointer to the log object.

    p_lock
        Pointer to the serializing lock.

    Node Info Receiver object

OpenSM: Node Info Receiver/osm_nr_construct

    osm_nr_construct

    This function constructs a Node Info Receiver object.

void osm_nr_construct(
    IN osm_nr_t* const p_ctrl );

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

    This function does not return a value.

    Allows calling osm_nr_init, osm_nr_destroy,
    and osm_nr_is_inited.

    Calling osm_nr_construct is a prerequisite to calling any other
    method except osm_nr_init.

    Node Info Receiver object, osm_nr_init,
    osm_nr_destroy, osm_nr_is_inited

OpenSM: Node Info Receiver/osm_nr_destroy

    osm_nr_destroy

    The osm_nr_destroy function destroys the object, releasing
    all resources.

void osm_nr_destroy(
    IN osm_nr_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 Info Receiver object.
    Further operations should not be attempted on the destroyed object.
    This function should only be called after a call to
    osm_nr_construct or osm_nr_init.

    Node Info Receiver object, osm_nr_construct,
    osm_nr_init

OpenSM: Node Info Receiver/osm_nr_init

    osm_nr_init

    The osm_nr_init function initializes a
    Node Info Receiver object for use.

ib_api_status_t osm_nr_init(
    IN osm_nr_t* const p_ctrl,
    IN osm_sa_resp_t* const p_resp,
    IN osm_mad_pool_t* const p_mad_pool,
    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_nr_t object to initialize.

    p_req
        [in] Pointer to an osm_req_t object.

    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 Info Receiver object was initialized
    successfully.

    Allows calling other Node Info Receiver methods.

    Node Info Receiver object, osm_nr_construct,
    osm_nr_destroy, osm_nr_is_inited

OpenSM: Node Info Receiver/osm_nr_is_inited

    osm_nr_is_inited

    Indicates if the object has been initialized with osm_nr_init.

boolean_t osm_nr_is_inited(
    IN const osm_nr_t* const p_ctrl );

    p_ctrl
        [in] Pointer to an osm_nr_t object.

    TRUE if the object was initialized successfully,
    FALSE otherwise.

    The osm_nr_construct or osm_nr_init must be
    called before using this function.

    Node Info Receiver object, osm_nr_construct,
    osm_nr_init

OpenSM: Node Info Receiver/osm_nr_process

    osm_nr_process

    Process the NodeRecord attribute.

void osm_nr_process(
    IN const osm_nr_t* const p_ctrl,
    IN osm_madw_t* const p_madw );

    p_ctrl
        [in] Pointer to an osm_nr_t object.

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

    CL_SUCCESS if the NodeRecord processing was successful.

    This function processes a NodeRecord attribute.

    Node Info Receiver, Node Info Response Controller