rt_log.h

Go to the documentation of this file.

/*
 * FILE: rt_log.h - RT Log definitions
 *
 * Copyright 2012-2014 Real-Time Innovations, Inc.
 *
 * No duplications, whole or partial, manual or electronic, may be made
 * without express written permission.  Any such copies, or
 * revisions thereof, must display this notice unaltered.
 * This code contains trade secrets of Real-Time Innovations, Inc.
 *
 * Modification History
 * --------------------
 * 14oct2014,tk MICRO-943/PR#11893 Use correct ID for RT_Log_registry_inconsistent_cid
 * 04sep2012,tk Written
 */
 /*ce
 * \file
 * \defgroup RTLogCodesClass RT
 * \brief RT. ModuleID = 3
 * \ingroup LoggingModule
 */
#ifndef rt_log_h
#define rt_log_h

#ifndef osapi_log_h
#include "osapi/osapi_log.h"
#endif

/*ce
 * \brief Failed to set registry property due to registry being already enabled
 * \ingroup RTLogCodesClass
 */
#define RT_LOG_SET_IMMUTABLE_PROPERTY                       (RT_LOG_BASE + 1)
#define RT_Log_set_immutable_property(level_) \
OSAPI_Log_msg_pN_X2((level_),RT_LOG_SET_IMMUTABLE_PROPERTY,\
        OSAPI_LOG_MSG_PN_X2_STD_PARAM ,0)

/*ce
 * \brief Failed to initialize registry due to failed table creation
 * \ingroup RTLogCodesClass
 */
#define RT_LOG_REGISTRY_INIT_FAILURE                        (RT_LOG_BASE + 2)
#define RT_Log_registry_init_failure(level_,dbrc_) \
OSAPI_Log_msg_pN_X2((level_),RT_LOG_REGISTRY_INIT_FAILURE,\
        OSAPI_LOG_MSG_PN_X2_STD_PARAM ,1,\
        "dbrc=%d",(dbrc_))

/*ce
 * \brief Failed to finalize registry due to failed table deletion
 * \ingroup RTLogCodesClass
 */
#define RT_LOG_REGISTRY_FINALIZE                            (RT_LOG_BASE + 3)
#define RT_Log_registry_finalize(level_,dbrc_) \
OSAPI_Log_msg_pN_X2((level_),RT_LOG_REGISTRY_FINALIZE,\
        OSAPI_LOG_MSG_PN_X2_STD_PARAM ,1,\
        "dbrc=%d",(dbrc_))

/*ce
 * \brief Failed to register a factory that was previously registered
 * \ingroup RTLogCodesClass
 */
#define RT_LOG_REGISTRY_EXISTS                              (RT_LOG_BASE + 4)
#define RT_Log_registry_exists(level_,name_) \
OSAPI_Log_msg_pN_X2((level_),RT_LOG_REGISTRY_EXISTS,\
        OSAPI_LOG_MSG_PN_X2_STD_PARAM ,1,\
        "name=%s",(name_))

/*ce
 * \brief Error registering a component factory.  May have exceeded 
 *        RT_RegistryProperty.max_factories
 * \ingroup RTLogCodesClass
 */
#define RT_LOG_REGISTRY_REGISTER                            (RT_LOG_BASE + 5)
#define RT_Log_registry_register(level_,dbrc_) \
OSAPI_Log_msg_pN_X2((level_),RT_LOG_REGISTRY_REGISTER,\
        OSAPI_LOG_MSG_PN_X2_STD_PARAM ,1,\
        "dbrc=%d",(dbrc_))

/*ce
 * \brief A registered factory failed to initialize
 * \ingroup RTLogCodesClass
 */
#define RT_LOG_REGISTRY_INIT_FACTORY                        (RT_LOG_BASE + 7)
#define RT_Log_registry_init_factory(level_) \
OSAPI_Log_msg_pN_X2((level_),RT_LOG_REGISTRY_INIT_FACTORY,\
        OSAPI_LOG_MSG_PN_X2_STD_PARAM ,0)


/*ce
 * \brief Factory name longer than maximum length of 8
 * \ingroup RTLogCodesClass
 */
#define RT_LOG_REGISTRY_NAME_TOO_LONG                       (RT_LOG_BASE + 8)
#define RT_Log_registry_name_too_long(level_,name_,len_) \
OSAPI_Log_msg_pN_X2((level_),RT_LOG_REGISTRY_NAME_TOO_LONG,\
        OSAPI_LOG_MSG_PN_X2_STD_PARAM ,3,\
        "name=%s,len=%d (>%d)",(name_),(len_),RT_MAX_FACTORY_NAME)

/*ce
 * \brief Factory name exists, but the class ID is not of the requested type
 * \ingroup RTLogCodesClass
 */
#define RT_LOG_REGISTRY_INCONSISTENT_CID                    (RT_LOG_BASE + 9)
#define RT_Log_registry_inconsistent_cid(level_,name_,req_cid_,real_cid_) \
OSAPI_Log_msg_pN_X2((level_),RT_LOG_REGISTRY_INCONSISTENT_CID,\
        OSAPI_LOG_MSG_PN_X2_STD_PARAM ,3,\
        "name=%s,req cid=%d,real cid=%d",(name_),(req_cid_),(real_cid_))


#endif