Generated from osm_log.h with ROBODoc vunknown on Wed Aug 07 15:31:42 2002

TABLE OF CONTENTS

  1. OpenSM/Log
  2. OpenSM: MAD Wrapper/osm_log_t
  3. OpenSM: Log/osm_log_construct
  4. OpenSM: Log/osm_log_destroy
  5. OpenSM: Log/osm_log_init
  6. OpenSM: Log/osm_log_get_level
  7. OpenSM: Log/osm_log_set_level
  8. OpenSM: Log/osm_log_level_active

OpenSM/Log

NAME 
    Log
DESCRIPTION 
AUTHOR








OpenSM: MAD Wrapper/osm_log_t


NAME

    osm_log_t


DESCRIPTION

SYNOPSIS

typedef struct _osm_log
{
    osm_log_level_t         level;

} osm_log_t;






OpenSM: Log/osm_log_construct


NAME

    osm_log_construct


DESCRIPTION

    This function constructs a Log object.


SYNOPSIS

 void
osm_log_construct(
    IN osm_log_t* const p_log );

PARAMETERS

    p_log
        [in] Pointer to a Log object to construct.


RETURN VALUE

    This function does not return a value.


NOTES

    Allows calling osm_log_init, osm_log_destroy,
    and osm_log_is_inited.

    Calling osm_log_construct is a prerequisite to calling any other
    method except osm_log_init.


SEE ALSO

    Log object, osm_log_init,
    osm_log_destroy, osm_log_is_inited






OpenSM: Log/osm_log_destroy


NAME

    osm_log_destroy


DESCRIPTION

    The osm_log_destroy function destroys the object, releasing
    all resources.


SYNOPSIS

 void
osm_log_destroy(
    IN osm_log_t* const p_log );

PARAMETERS

    p_log
        [in] Pointer to the object to destroy.


RETURN VALUE

    This function does not return a value.


NOTES

    Performs any necessary cleanup of the specified
    Log object.
    Further operations should not be attempted on the destroyed object.
    This function should only be called after a call to
    osm_log_construct or osm_log_init.


SEE ALSO

    Log object, osm_log_construct,
    osm_log_init






OpenSM: Log/osm_log_init


NAME

    osm_log_init


DESCRIPTION

    The osm_log_init function initializes a
    Log object for use.


SYNOPSIS

ib_api_status_t
osm_log_init(
    IN osm_log_t*           const p_log );


PARAMETERS

    p_log
        [in] Pointer to the log object.


RETURN VALUES

    CL_SUCCESS if the Log object was initialized
    successfully.


NOTES

    Allows calling other Log methods.


SEE ALSO

    Log object, osm_log_construct,
    osm_log_destroy, osm_log_is_inited






OpenSM: Log/osm_log_get_level


NAME

    osm_log_get_level


DESCRIPTION

    Returns the current log level.


SYNOPSIS

 osm_log_level_t
osm_log_get_level(
    IN const osm_log_t* const p_log );

PARAMETERS

    p_log
        [in] Pointer to the log object.


RETURN VALUES

    Returns the current log level.


NOTES



SEE ALSO

    Log object, osm_log_construct,
    osm_log_destroy






OpenSM: Log/osm_log_set_level


NAME

    osm_log_set_level


DESCRIPTION

    Sets the current log level.


SYNOPSIS

 void
osm_log_set_level(
    IN osm_log_t* const p_log,
    IN const osm_log_level_t level );

PARAMETERS

    p_log
        [in] Pointer to the log object.

    level
        [in] New level to set.


RETURN VALUES

    Returns the current log level.


NOTES



SEE ALSO

    Log object, osm_log_construct,
    osm_log_destroy






OpenSM: Log/osm_log_level_active


NAME

    osm_log_level_active


DESCRIPTION

    Returns TRUE if the specified log level would be logged.
    FALSE otherwise.


SYNOPSIS

 boolean_t
osm_log_is_active(
    IN const osm_log_t* const p_log,
    IN const osm_log_level_t level );

PARAMETERS

    p_log
        [in] Pointer to the log object.

    level
        [in] Level to check.


RETURN VALUES

    Returns TRUE if the specified log level would be logged.
    FALSE otherwise.


NOTES



SEE ALSO

    Log object, osm_log_construct,
    osm_log_destroy