TABLE OF CONTENTS

1. OpenSM/Generic Requester
2. OpenSM: Generic Requester/osm_req_t
3. OpenSM: Generic Requester/osm_req_construct
4. OpenSM: Generic Requester/osm_req_destroy
5. OpenSM: Generic Requester/osm_req_init
6. OpenSM: Generic Requester/osm_req_get
7. OpenSM: Generic Requester/osm_req_set

OpenSM/Generic Requester

    Generic Requester

    The Generic Requester object encapsulates the information
    needed to request an attribute from a node.

    The Generic Requester object is thread safe.

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

    Steve King, Intel

OpenSM: Generic Requester/osm_req_t

    osm_req_t

    Generic Requester structure.

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

typedef struct _osm_req
{
    osm_mad_pool_t              *p_pool;
    osm_vl15_t                  *p_vl15;
    osm_log_t                   *p_log;
    osm_subn_t                  *p_subn;
    atomic32_t                  *p_sm_trans_id;

} osm_req_t;

    base
        OpenSM base object.

    p_pool
        Pointer to the MAD pool.

    p_vl15
        Pointer to the VL15 interface.

    p_log
        Pointer to the log object.

    p_subn
        Pointer to the subnet object.

    Generic Requester object

OpenSM: Generic Requester/osm_req_construct

    osm_req_construct

    This function constructs a Generic Requester object.

void
osm_req_construct(
    IN osm_req_t* const p_req );

    p_req
        [in] Pointer to a Generic Requester object to construct.

    This function does not return a value.

    Allows calling osm_req_init, osm_req_destroy,
    and osm_req_is_inited.

    Calling osm_req_construct is a prerequisite to calling any other
    method except osm_req_init.

    Generic Requester object, osm_req_init,
    osm_req_destroy, osm_req_is_inited

OpenSM: Generic Requester/osm_req_destroy

    osm_req_destroy

    The osm_req_destroy function destroys the object, releasing
    all resources.

void
osm_req_destroy(
    IN osm_req_t* const p_req );

    p_req
        [in] Pointer to the object to destroy.

    This function does not return a value.

    Performs any necessary cleanup of the specified
    Generic Requester object.
    Further operations should not be attempted on the destroyed object.
    This function should only be called after a call to
    osm_req_construct or osm_req_init.

    Generic Requester object, osm_req_construct,
    osm_req_init

OpenSM: Generic Requester/osm_req_init

    osm_req_init

    The osm_req_init function initializes a
    Generic Requester object for use.

ib_api_status_t
osm_req_init(
    IN osm_req_t*               const p_req,
    IN osm_mad_pool_t*          const p_pool,
    IN osm_vl15_t*              const p_vl15,
    IN osm_subn_t*              const p_subn,
    IN osm_log_t*               const p_log,
    IN atomic32_t*              const p_sm_trans_id );

    p_req
        [in] Pointer to an osm_req_t object to initialize.

    p_mad_pool
        [in] Pointer to the MAD pool.

    p_vl15
        [in] Pointer to the VL15 interface.

    p_subn
        [in] Pointer to the subnet object.

    p_log
        [in] Pointer to the log object.

    p_sm_trans_id
        [in] Pointer to the atomic SM transaction ID.

    IB_SUCCESS if the Generic Requester object was initialized
    successfully.

    Allows calling other Generic Requester methods.

    Generic Requester object, osm_req_construct,
    osm_req_destroy, osm_req_is_inited

OpenSM: Generic Requester/osm_req_get

    osm_req_get

    Starts the process to transmit a directed route request for
    the NodeInfo attribute.

ib_api_status_t
osm_req_get(
    IN const osm_req_t* const p_req,
    IN const osm_dr_path_t* const p_path,
    IN const uint16_t attr_id,
    IN const uint32_t attr_mod,
    IN const osm_madw_context_t* const p_context );

    p_req
        [in] Pointer to an osm_req_t object.

    p_path
        [in] Pointer to the directed route path to the node
        from which to retrieve the NodeInfo attribute.

    attr_id
        [in] Attribute ID to request.

    attr_mod
        [in] Attribute modifier for this request.

    p_context
        [in] Mad wrapper context structure to be copied into the wrapper
        context, and thus visible to the recipient of the response.

    CL_SUCCESS if the request was successful.

    This function asynchronously requests the specified attribute.
    The response from the node will be routed through the Dispatcher
    to the appropriate receive controller object.

    Generic Requester

OpenSM: Generic Requester/osm_req_set

    osm_req_set

    Starts the process to transmit a directed route Set() request.

ib_api_status_t
osm_req_set(
    IN const osm_req_t* const p_req,
    IN const osm_dr_path_t* const p_path,
    IN const uint8_t* const p_payload,
    IN const uint16_t attr_id,
    IN const uint32_t attr_mod,
    IN const osm_madw_context_t* const p_context );

    p_req
        [in] Pointer to an osm_req_t object.

    p_path
        [in] Pointer to the directed route path of the recipient.

    p_payload
        [in] Pointer to the SMP payload to send.

    attr_id
        [in] Attribute ID to request.

    attr_mod
        [in] Attribute modifier for this request.

    p_context
        [in] Mad wrapper context structure to be copied into the wrapper
        context, and thus visible to the recipient of the response.

    IB_SUCCESS if the request was successful.

    This function asynchronously requests the specified attribute.
    The response from the node will be routed through the Dispatcher
    to the appropriate receive controller object.

    Generic Requester