TABLE OF CONTENTS

1. OpenSM/State Manager Controller
2. OpenSM: State Manager Controller/osm_state_mgr_ctrl_t
3. OpenSM: State Manager Controller/osm_state_mgr_ctrl_construct
4. OpenSM: State Manager Controller/osm_state_mgr_ctrl_destroy
5. OpenSM: State Manager Controller/osm_state_mgr_ctrl_init

OpenSM/State Manager Controller

    State Manager Controller

    The State Manager Controller object encapsulates the information
    needed to pass the dispatcher message from the dispatcher
    to the State Manager.

    The State Manager 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: State Manager Controller/osm_state_mgr_ctrl_t

    osm_state_mgr_ctrl_t

    State Manager Controller structure.

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

typedef struct _osm_state_mgr_ctrl
{
    osm_state_mgr_t             *p_mgr;
    osm_log_t                   *p_log;
    cl_dispatcher_t             *p_disp;
    cl_disp_reg_handle_t        h_disp;

} osm_state_mgr_ctrl_t;

    base
        OpenSM base object.

    p_mgr
        Pointer to the State Manager object.

    p_log
        Pointer to the log object.

    p_disp
        Pointer to the Dispatcher.

    h_disp
        Handle returned from dispatcher registration.

    State Manager Controller object

OpenSM: State Manager Controller/osm_state_mgr_ctrl_construct

    osm_state_mgr_ctrl_construct

    This function constructs a State Manager Controller object.

void
osm_state_mgr_ctrl_construct(
    IN osm_state_mgr_ctrl_t* const p_ctrl );

    p_ctrl
        [in] Pointer to a State Manager Controller
        object to construct.

    This function does not return a value.

    Allows calling osm_state_mgr_ctrl_init, osm_state_mgr_ctrl_destroy,
    and osm_state_mgr_ctrl_is_inited.

    Calling osm_state_mgr_ctrl_construct is a prerequisite to calling any other
    method except osm_state_mgr_ctrl_init.

    State Manager Controller object, osm_state_mgr_ctrl_init,
    osm_state_mgr_ctrl_destroy

OpenSM: State Manager Controller/osm_state_mgr_ctrl_destroy

    osm_state_mgr_ctrl_destroy

    The osm_state_mgr_ctrl_destroy function destroys the object, releasing
    all resources.

void
osm_state_mgr_ctrl_destroy(
    IN osm_state_mgr_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
    State Manager Controller object.
    Further operations should not be attempted on the destroyed object.
    This function should only be called after a call to
    osm_state_mgr_ctrl_construct or osm_state_mgr_ctrl_init.

    State Manager Controller object, osm_state_mgr_ctrl_construct,
    osm_state_mgr_ctrl_init

OpenSM: State Manager Controller/osm_state_mgr_ctrl_init

    osm_state_mgr_ctrl_init

    The osm_state_mgr_ctrl_init function initializes a
    State Manager Controller object for use.

ib_api_status_t
osm_state_mgr_ctrl_init(
    IN osm_state_mgr_ctrl_t* const p_ctrl,
    IN osm_state_mgr_t* const p_mgr,
    IN osm_log_t* const p_log,
    IN cl_dispatcher_t* const p_disp );

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

    p_mgr
        [in] Pointer to an osm_state_mgr_t object.

    p_log
        [in] Pointer to the log object.

    p_disp
        [in] Pointer to the OpenSM central Dispatcher.

    IB_SUCCESS if the State Manager Controller object
    was initialized successfully.

    Allows calling other State Manager Controller methods.

    State Manager Controller object, osm_state_mgr_ctrl_construct,
    osm_state_mgr_ctrl_destroy