TABLE OF CONTENTS

1. OpenSM/Generic Request Controller
2. OpenSM: Generic Request Controller/osm_req_ctrl_t
3. OpenSM: Generic Request Controller/osm_req_ctrl_construct
4. OpenSM: Generic Request Controller/osm_req_ctrl_destroy
5. OpenSM: Generic Request Controller/osm_req_ctrl_init

OpenSM/Generic Request Controller

    Generic Request Controller

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

    The Generic Request 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: Generic Request Controller/osm_req_ctrl_t

    osm_req_ctrl_t

    Generic Request Controller structure.

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

typedef struct _osm_req_ctrl
{
    osm_req_t               *p_req;
    osm_log_t                   *p_log;
    cl_dispatcher_t             *p_disp;
    cl_disp_reg_handle_t        h_disp;

} osm_req_ctrl_t;

    base
        OpenSM base object.

    p_log
        Pointer to the log object.

    p_disp
        Pointer to the Dispatcher.

    h_disp
        Handle returned from dispatcher registration.

    Generic Request Controller object

OpenSM: Generic Request Controller/osm_req_ctrl_construct

    osm_req_ctrl_construct

    This function constructs a Generic Request Controller object.

void
osm_req_ctrl_construct(
    IN osm_req_ctrl_t* const p_ctrl );

    p_ctrl
        [in] Pointer to a Generic Request Controller object to construct.

    This function does not return a value.

    Allows calling osm_req_ctrl_init, osm_req_ctrl_destroy,
    and osm_req_ctrl_is_inited.

    Calling osm_req_ctrl_construct is a prerequisite to calling any other
    method except osm_req_ctrl_init.

    Generic Request Controller object, osm_req_ctrl_init,
    osm_req_ctrl_destroy, osm_req_ctrl_is_inited

OpenSM: Generic Request Controller/osm_req_ctrl_destroy

    osm_req_ctrl_destroy

    The osm_req_ctrl_destroy function destroys the object, releasing
    all resources.

void
osm_req_ctrl_destroy(
    IN osm_req_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
    Generic Request Controller object.
    Further operations should not be attempted on the destroyed object.
    This function should only be called after a call to
    osm_req_ctrl_construct or osm_req_ctrl_init.

    Generic Request Controller object, osm_req_ctrl_construct,
    osm_req_ctrl_init

OpenSM: Generic Request Controller/osm_req_ctrl_init

    osm_req_ctrl_init

    The osm_req_ctrl_init function initializes a
    Generic Request Controller object for use.

ib_api_status_t
osm_req_ctrl_init(
    IN osm_req_ctrl_t*  const p_ctrl,
    IN osm_req_t*       const p_req,
    IN osm_log_t*           const p_log,
    IN cl_dispatcher_t*     const p_disp );

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

    p_req
        [in] Pointer to a Generic Requester object.

    p_log
        [in] Pointer to the log object.

    p_disp
        [in] Pointer to the OpenSM central Dispatcher.

    CL_SUCCESS if the Generic Request Controller object was initialized
    successfully.

    Allows calling other Generic Request Controller methods.

    Generic Request Controller object, osm_req_ctrl_construct,
    Generic Requester object, osm_req_ctrl_destroy,
    osm_req_ctrl_is_inited