TABLE OF CONTENTS

1. OpenSM/Port Info Receive Controller
2. OpenSM: Port Info Receive Controller/osm_pi_rcv_ctrl_t
3. OpenSM: Port Info Receive Controller/osm_pi_rcv_ctrl_construct
4. OpenSM: Port Info Receive Controller/osm_pi_rcv_ctrl_destroy
5. OpenSM: Port Info Receive Controller/osm_pi_rcv_ctrl_init
6. OpenSM: Port Info Receive Controller/osm_pi_rcv_ctrl_is_inited

OpenSM/Port Info Receive Controller

    Port Info Receive Controller

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

    The Port Info 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: Port Info Receive Controller/osm_pi_rcv_ctrl_t

    osm_pi_rcv_ctrl_t

    Port Info Receive Controller structure.

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

typedef struct _osm_pi_rcv_ctrl
{
    osm_pi_rcv_t                *p_rcv;
    osm_log_t                   *p_log;
    cl_dispatcher_t             *p_disp;
    cl_disp_reg_handle_t        h_disp;

} osm_pi_rcv_ctrl_t;

    base
        OpenSM base object.

    p_rcv
        Pointer to the Port Info Receiver object.

    p_log
        Pointer to the log object.

    p_disp
        Pointer to the Dispatcher.

    h_disp
        Handle returned from dispatcher registration.

    Port Info Receive Controller object
    Port Info Receiver object

OpenSM: Port Info Receive Controller/osm_pi_rcv_ctrl_construct

    osm_pi_rcv_ctrl_construct

    This function constructs a Port Info Receive Controller object.

void osm_pi_rcv_ctrl_construct(
    IN osm_pi_rcv_ctrl_t* const p_ctrl );

    p_ctrl
        [in] Pointer to a Port Info Receive Controller
        object to construct.

    This function does not return a value.

    Allows calling osm_pi_rcv_ctrl_init, osm_pi_rcv_ctrl_destroy,
    and osm_pi_rcv_ctrl_is_inited.

    Calling osm_pi_rcv_ctrl_construct is a prerequisite to calling any other
    method except osm_pi_rcv_ctrl_init.

    Port Info Receive Controller object, osm_pi_rcv_ctrl_init,
    osm_pi_rcv_ctrl_destroy, osm_pi_rcv_ctrl_is_inited

OpenSM: Port Info Receive Controller/osm_pi_rcv_ctrl_destroy

    osm_pi_rcv_ctrl_destroy

    The osm_pi_rcv_ctrl_destroy function destroys the object, releasing
    all resources.

void osm_pi_rcv_ctrl_destroy(
    IN osm_pi_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
    Port Info Receive Controller object.
    Further operations should not be attempted on the destroyed object.
    This function should only be called after a call to
    osm_pi_rcv_ctrl_construct or osm_pi_rcv_ctrl_init.

    Port Info Receive Controller object, osm_pi_rcv_ctrl_construct,
    osm_pi_rcv_ctrl_init

OpenSM: Port Info Receive Controller/osm_pi_rcv_ctrl_init

    osm_pi_rcv_ctrl_init

    The osm_pi_rcv_ctrl_init function initializes a
    Port Info Receive Controller object for use.

ib_api_status_t osm_pi_rcv_ctrl_init(
    IN osm_pi_rcv_ctrl_t* const p_ctrl,
    IN osm_pi_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_pi_rcv_ctrl_t object to initialize.

    p_rcv
        [in] Pointer to an osm_pi_rcv_t object.

    p_log
        [in] Pointer to the log object.

    p_disp
        [in] Pointer to the OpenSM central Dispatcher.

    CL_SUCCESS if the Port Info Receive Controller object was initialized
    successfully.

    Allows calling other Port Info Receive Controller methods.

    Port Info Receive Controller object, osm_pi_rcv_ctrl_construct,
    osm_pi_rcv_ctrl_destroy, osm_pi_rcv_ctrl_is_inited

OpenSM: Port Info Receive Controller/osm_pi_rcv_ctrl_is_inited

    osm_pi_rcv_ctrl_is_inited

    Indicates if the object has been initialized with osm_pi_rcv_ctrl_init.

boolean_t osm_pi_rcv_ctrl_is_inited(
    IN const osm_pi_rcv_ctrl_t* const p_ctrl );

    p_ctrl
        [in] Pointer to an osm_pi_rcv_ctrl_t object.

    TRUE if the object was initialized successfully,
    FALSE otherwise.

    The osm_pi_rcv_ctrl_construct or osm_pi_rcv_ctrl_init must be
    called before using this function.

    Port Info Receive Controller object, osm_pi_rcv_ctrl_construct,
    osm_pi_rcv_ctrl_init