it_bus/bus_logger.h

#ifndef _IT_BUS_BUS_LOGGER_H_
#define _IT_BUS_BUS_LOGGER_H_

// prevent logging_support.h being included !!!!
#if defined(_IT_BUS_LOGGING_SUPPORT_H_) || defined(_IT_BUS_OLD_LOGGING_HELPER_H_)
#error bus_logger.h should not be included with logging_support.h or old_logging_helper.h
#endif

// @Copyright 2005 IONA Technologies, Plc. All Rights Reserved.
//
#include <it_bus_pdk/pdk_bus.h>
#include <it_bus/logging_defs.h>

namespace IT_Logging
{
    class EventLog;
}

namespace IT_Bus
{
    namespace Logging
    {
        class ServiceNameRetriever;
        class LoggingConfig;

        class IT_BUS_API BusLogger
        {
          protected:
            BusLogger();

          public:
            virtual ~BusLogger();

            virtual void
            write_log_record(
                IT_Bus::Logging::ServiceNameRetriever* snr,
                IT_TraceLevel trace_level,
                const char* description,
                ...) = 0;

            virtual void
            write_log_record_with_CDATA(
                IT_Bus::Logging::ServiceNameRetriever* snr,
                IT_TraceLevel trace_level,
                const char* description,
                const char* data_buffer,
                long buffer_size
            ) = 0;

            virtual void
            write_log_record_with_binary(
                IT_Bus::Logging::ServiceNameRetriever* snr,
                IT_TraceLevel trace_level,
                const char* description,
                const char* data_buffer,
                long buffer_size
            ) = 0;

            virtual const char*
            get_subsystem() = 0;

            inline IT_Bool
            is_loggable(
                IT_TraceLevel level
            )
            {
                return ((m_bus_master_log_filter & level) != 0);
            }

            inline IT_Bool
            is_loggable_subsystem(
                IT_TraceLevel level
            )
            {
                return ((m_subsystem_log_filter & level) != 0);
            }

            inline IT_TraceLevel
            get_subsystem_log_filter()
            {
                return m_subsystem_log_filter;
            }

            inline IT_TraceLevel
            get_bus_master_log_filter()
            {
                return m_bus_master_log_filter;
            }

          protected:
            IT_TraceLevel m_bus_master_log_filter;
            IT_TraceLevel m_subsystem_log_filter;

          private:
            BusLogger& operator=(const BusLogger& rhs);
            BusLogger(const BusLogger& rhs);
        };
    }
}

#define IT_LOG_BUFFER(bus_logger, Entry, Length) \
    if (bus_logger->is_loggable(IT_TRACE_BUFFER)) \
    { \
        bus_logger->write_log_record_with_binary(_IT_SUBSYSTEM_SERVICE, IT_TRACE_BUFFER, "Buffer Output", Entry, Length); \
    } 

#define IT_LOG_CDATA(bus_logger, description, Entry) \
    if (bus_logger->is_loggable(IT_TRACE_BUFFER) \
    { \
        bus_logger->write_log_record_with_CDATA(_IT_SUBSYSTEM_SERVICE, IT_TRACE_BUFFER, description, Entry, 0); \
    }

#define IT_LOG_CDATA_SIZE(bus_logger, description, Entry, Size) \
    if (bus_logger->is_loggable(IT_TRACE_BUFFER) \
    { \
        bus_logger->write_log_record_with_CDATA(_IT_SUBSYSTEM_SERVICE, IT_TRACE_BUFFER, description, Entry, Size); \
    }

#define IT_LOG_CDATA_BINARY_BUFFER(bus_logger, description, bbData) \
    if (bus_logger->is_loggable(IT_TRACE_BUFFER) \
    { \
        bus_logger->write_log_record_with_binary(_IT_SUBSYSTEM_SERVICE, IT_TRACE_BUFFER, description, bbData.get_const_pointer(), bbData.get_size()); \
    }

// these are used for controlled tracing operations.  description is a printf format string
// they allow specifying the trace level so callers can control visibility
#define IT_LOG_GUARDED0(bus_logger, snr, trace_level, description) \
    if (bus_logger->is_loggable(trace_level)) \
    { \
        bus_logger->write_log_record(snr, trace_level, description); \
    }

#define IT_LOG_GUARDED(bus_logger, snr, trace_level, description) \
    IT_LOG_GUARDED0(bus_logger, snr, trace_level, description)

#define IT_LOG_GUARDED1(bus_logger, snr, trace_level, description, Arg1) \
    if (bus_logger->is_loggable(trace_level)) \
    { \
            bus_logger->write_log_record(snr, trace_level, description, Arg1); \
    } 

#define IT_LOG_GUARDED2(bus_logger, snr, trace_level, description, Arg1, Arg2) \
    if (bus_logger->is_loggable(trace_level)) \
    { \
            bus_logger->write_log_record(snr, trace_level, description, Arg1, Arg2); \
    } 

#define IT_LOG_GUARDED3(bus_logger, snr, trace_level, description, Arg1, Arg2, Arg3) \
    if (bus_logger->is_loggable(trace_level)) \
    { \
            bus_logger->write_log_record(snr, trace_level, description, Arg1, Arg2, Arg3); \
    } 

#define IT_LOG_GUARDED4(bus_logger, snr, trace_level, description, Arg1, Arg2, Arg3, Arg4) \
    if (bus_logger->is_loggable(trace_level)) \
    { \
            bus_logger->write_log_record(snr, trace_level, description, Arg1, Arg2, Arg3, Arg4); \
    } 

#define IT_LOG_GUARDED5(bus_logger, snr, trace_level, description, Arg1, Arg2, Arg3, Arg4, Arg5) \
    if (bus_logger->is_loggable(trace_level)) \
    { \
            bus_logger->write_log_record(snr, trace_level, description, Arg1, Arg2, Arg3, Arg4, Arg5); \
    } 


//these are used to guard a code block from executing when the purpose of the code
//block is solely for formatting a trace statement.  It prevents the code from 
//executing when the trace_level is filtered out and wouldn't be used anyway.
#define BEGIN_TRACE(trace_level)                                        \
    if (_IT_BUS_LOGGER->is_loggable(trace_level)) \
    {                                                                                                    

#define BEGIN_SUBSYSTEM_TRACE(trace_level)                                        \
    if (_IT_BUS_LOGGER->is_loggable_subsystem(trace_level)) \
    {                                                                                                    

#define END_TRACE                                                                        \
    }

//all the macros that follow are just short hand for the previous ones, but they
//default the bus_logger to "this"

#define TRACELOGBUFFER(Entry, Length) \
    if (_IT_BUS_LOGGER->is_loggable(IT_TRACE_BUFFER)) \
    { \
        _IT_BUS_LOGGER->write_log_record_with_binary(_IT_SUBSYSTEM_SERVICE, IT_TRACE_BUFFER, "Buffer Output", Entry, Length); \
    } 

#define TRACELOG_CDATA(description, Entry) \
    if (_IT_BUS_LOGGER->is_loggable(IT_TRACE_BUFFER)) \
    { \
        _IT_BUS_LOGGER->write_log_record_with_CDATA(_IT_SUBSYSTEM_SERVICE, IT_TRACE_BUFFER, description, Entry, 0); \
    }

#define TRACELOG_CDATA_SIZE(description, Entry, Size) \
    if (_IT_BUS_LOGGER->is_loggable(IT_TRACE_BUFFER)) \
    { \
        _IT_BUS_LOGGER->write_log_record_with_CDATA(_IT_SUBSYSTEM_SERVICE, IT_TRACE_BUFFER, description, Entry, Size); \
    }

#define SUBSYSTEM_TRACELOG_CDATA_SIZE(priority, description, Entry, Size) \
    if (_IT_BUS_LOGGER->is_loggable_subsystem(priority)) \
    { \
        _IT_BUS_LOGGER->write_log_record_with_CDATA(_IT_SUBSYSTEM_SERVICE, priority, description, Entry, Size); \
    }


#define SUBSYSTEM_TRACELOG(priority, description) \
    if (_IT_BUS_LOGGER->is_loggable_subsystem(priority)) \
    { \
        _IT_BUS_LOGGER->write_log_record(_IT_SUBSYSTEM_SERVICE, priority, description); \
    }

#define TRACELOG_CDATA_BINARY_BUFFER(description, bbData) \
    if (_IT_BUS_LOGGER->is_loggable(IT_TRACE_BUFFER)) \
    { \
        _IT_BUS_LOGGER->write_log_record_with_binary(_IT_SUBSYSTEM_SERVICE, IT_TRACE_BUFFER, description, bbData.get_const_pointer(), bbData.get_size()); \
    }

//These are used for method level tracing
//to see output from these, include INFO_LOW in your event_log:filters
#define BEGIN_INTERNAL_METHOD(Name) \
    const char *FuncName = Name; \
    if (_IT_BUS_LOGGER->is_loggable(IT_TRACE_METHODS_INTERNAL)) \
        _IT_BUS_LOGGER->write_log_record(_IT_SUBSYSTEM_SERVICE, IT_TRACE_METHODS_INTERNAL, FuncName); 

#define END_INTERNAL_METHOD    

#define BEGIN_METHOD(Name) \
    const char *FuncName = Name; \
    if (_IT_BUS_LOGGER->is_loggable(IT_TRACE_METHODS_INTERNAL)) \
        _IT_BUS_LOGGER->write_log_record(_IT_SUBSYSTEM_SERVICE, IT_TRACE_METHODS, FuncName);    

#define END_METHOD        


//these are used for controlled tracing operations.  description is a printf format string
//they allow specifying the trace level so callers can control visibility
#define TRACELOG_WITH_LEVEL0(trace_level, description) \
    IT_LOG_GUARDED(_IT_BUS_LOGGER, _IT_SUBSYSTEM_SERVICE , trace_level, description)

#define TRACELOG_WITH_LEVEL(trace_level, description) \
    IT_LOG_GUARDED(_IT_BUS_LOGGER, _IT_SUBSYSTEM_SERVICE , trace_level, description)

#define TRACELOG_WITH_LEVEL1(trace_level, description, Arg1) \
    IT_LOG_GUARDED1(_IT_BUS_LOGGER, _IT_SUBSYSTEM_SERVICE , trace_level, description, Arg1)

#define TRACELOG_WITH_LEVEL2(trace_level, description, Arg1, Arg2) \
    IT_LOG_GUARDED2(_IT_BUS_LOGGER, _IT_SUBSYSTEM_SERVICE , trace_level, description, Arg1, Arg2)

#define TRACELOG_WITH_LEVEL3(trace_level, description, Arg1, Arg2, Arg3) \
    IT_LOG_GUARDED3(_IT_BUS_LOGGER, _IT_SUBSYSTEM_SERVICE , trace_level, description, Arg1, Arg2, Arg3)

#define TRACELOG_WITH_LEVEL4(trace_level, description, Arg1, Arg2, Arg3, Arg4) \
    IT_LOG_GUARDED4(_IT_BUS_LOGGER, _IT_SUBSYSTEM_SERVICE , trace_level, description, Arg1, Arg2, Arg3, Arg4)

#define TRACELOG_WITH_LEVEL5(trace_level, description, Arg1, Arg2, Arg3, Arg4, Arg5) \
    IT_LOG_GUARDED5(_IT_BUS_LOGGER, _IT_SUBSYSTEM_SERVICE , trace_level, description, Arg1, Arg2, Arg3, Arg4, Arg5)

// as above but these are used as above but where service name logging 
// is enabled but not available in the current scope
#define TRACELOG_NSN_WITH_LEVEL0(trace_level, description) \
    IT_LOG_GUARDED(_IT_BUS_LOGGER, 0, trace_level, description)

#define TRACELOG_NSN_WITH_LEVEL(trace_level, description) \
    IT_LOG_GUARDED(_IT_BUS_LOGGER, 0, trace_level, description)

#define TRACELOG_NSN_WITH_LEVEL1(trace_level, description, Arg1) \
    IT_LOG_GUARDED1(_IT_BUS_LOGGER, 0, trace_level, description, Arg1)

#define TRACELOG_NSN_WITH_LEVEL2(trace_level, description, Arg1, Arg2) \
    IT_LOG_GUARDED2(_IT_BUS_LOGGER, 0, trace_level, description, Arg1, Arg2)

#define TRACELOG_NSN_WITH_LEVEL3(trace_level, description, Arg1, Arg2, Arg3) \
    IT_LOG_GUARDED3(_IT_BUS_LOGGER, 0, trace_level, description, Arg1, Arg2, Arg3)

#define TRACELOG_NSN_WITH_LEVEL4(trace_level, description, Arg1, Arg2, Arg3, Arg4) \
    IT_LOG_GUARDED4(_IT_BUS_LOGGER, 0, trace_level, description, Arg1, Arg2, Arg3, Arg4)

#define TRACELOG_NSN_WITH_LEVEL5(trace_level, description, Arg1, Arg2, Arg3, Arg4, Arg5) \
    IT_LOG_GUARDED5(_IT_BUS_LOGGER, 0, trace_level, description, Arg1, Arg2, Arg3, Arg4, Arg5)

//these are used for normal tracing operations.  description is a printf format string
//they default the trace level to IT_TRACE, if you want to use another level see the previous set
#define TRACELOG(description) \
    IT_LOG_GUARDED(_IT_BUS_LOGGER, _IT_SUBSYSTEM_SERVICE, IT_TRACE , description)

#define TRACELOG0(description) \
    IT_LOG_GUARDED(_IT_BUS_LOGGER, _IT_SUBSYSTEM_SERVICE, IT_TRACE , description)

#define TRACELOG1(description, Arg1) \
    IT_LOG_GUARDED1(_IT_BUS_LOGGER, _IT_SUBSYSTEM_SERVICE, IT_TRACE , description, Arg1)

#define TRACELOG2(description, Arg1, Arg2) \
    IT_LOG_GUARDED2(_IT_BUS_LOGGER, _IT_SUBSYSTEM_SERVICE, IT_TRACE , description, Arg1, Arg2)

#define TRACELOG3(description, Arg1, Arg2, Arg3) \
    IT_LOG_GUARDED3(_IT_BUS_LOGGER, _IT_SUBSYSTEM_SERVICE, IT_TRACE , description, Arg1, Arg2, Arg3)

#define TRACELOG4(description, Arg1, Arg2, Arg3, Arg4) \
    IT_LOG_GUARDED4(_IT_BUS_LOGGER, _IT_SUBSYSTEM_SERVICE, IT_TRACE , description, Arg1, Arg2, Arg3, Arg4)

#define TRACELOG5(description, Arg1, Arg2, Arg3, Arg4, Arg5) \
    IT_LOG_GUARDED5(_IT_BUS_LOGGER, _IT_SUBSYSTEM_SERVICE, IT_TRACE , description, Arg1, Arg2, Arg3, Arg4, Arg5)

// as above but these are used as above but where service name logging 
// is enabled but not available in the current scope
#define TRACELOG_NSN(description) \
    IT_LOG_GUARDED(_IT_BUS_LOGGER, 0, IT_TRACE , description)

#define TRACELOG_NSN0(description) \
    IT_LOG_GUARDED(_IT_BUS_LOGGER, 0, IT_TRACE , description)

#define TRACELOG_NSN1(description, Arg1) \
    IT_LOG_GUARDED1(_IT_BUS_LOGGER, 0, IT_TRACE , description, Arg1)

#define TRACELOG_NSN2(description, Arg1, Arg2) \
    IT_LOG_GUARDED2(_IT_BUS_LOGGER, 0, IT_TRACE , description, Arg1, Arg2)

#define TRACELOG_NSN3(description, Arg1, Arg2, Arg3) \
    IT_LOG_GUARDED3(_IT_BUS_LOGGER, 0, IT_TRACE , description, Arg1, Arg2, Arg3)

#define TRACELOG_NSN4(description, Arg1, Arg2, Arg3, Arg4) \
    IT_LOG_GUARDED4(_IT_BUS_LOGGER, 0, IT_TRACE , description, Arg1, Arg2, Arg3, Arg4)

#define TRACELOG_NSN5(description, Arg1, Arg2, Arg3, Arg4, Arg5) \
    IT_LOG_GUARDED5(_IT_BUS_LOGGER, 0, IT_TRACE , description, Arg1, Arg2, Arg3, Arg4, Arg5)

#ifdef _IT_LOGGING_SERVICE_NAME_RETRIEVER_INSTANCE_
    #define _IT_SUBSYSTEM_SERVICE _IT_LOGGING_SERVICE_NAME_RETRIEVER_INSTANCE_
#else
    #define _IT_SUBSYSTEM_SERVICE 0
#endif

#ifndef _IT_BUS_LOGGER
#define _IT_BUS_LOGGER _it_bus_logger
#endif

#ifdef _IT_IN_WSDL_CPP_CLIENT_STUBS
  #ifndef _IT_SUBSYSTEM_SCOPE
    #define _IT_SUBSYSTEM_SCOPE "IT_BUS.STUB.CLIENT"
  #endif
#endif
#ifdef _IT_IN_WSDL_CPP_SERVER_STUBS
  #ifndef _IT_SUBSYSTEM_SCOPE
    #define _IT_SUBSYSTEM_SCOPE "IT_BUS.STUB.SERVER"
  #endif
#endif

#ifndef _IT_SUBSYSTEM_SCOPE
    #define _IT_SUBSYSTEM_SCOPE "IT_BUS"
#endif

#define IT_INIT_BUS_LOGGER_MEM(bus) \
    _it_bus_logger = bus->get_pdk_bus()->get_bus_logger(_IT_SUBSYSTEM_SCOPE);

#define IT_NULL_BUS_LOGGER_MEM \
    _it_bus_logger = 0;

#define IT_FINALISE_BUS_LOGGER_MEM(bus) \
    bus->get_pdk_bus()->bus_logger_complete( \
        _it_bus_logger,_IT_SUBSYSTEM_SCOPE \
    ); \
    _it_bus_logger = 0;


#define IT_DECLARE_BUS_LOGGER_MEM_SAFE IT_Bus::Logging::BusLogger* _it_bus_logger = 0;

#define IT_INIT_BUS_LOGGER_MEM_SAFE(bus) \
    if (_it_bus_logger == 0) _it_bus_logger = bus->get_pdk_bus()->get_bus_logger(_IT_SUBSYSTEM_SCOPE);

#define IT_FINALISE_BUS_LOGGER_MEM_SAFE(bus) \
    if (_it_bus_logger != 0) { \
      bus->get_pdk_bus()->bus_logger_complete( \
        _it_bus_logger,_IT_SUBSYSTEM_SCOPE \
      ); \
      _it_bus_logger = 0; \
    }

#define IT_GET_SUBSYSTEM(subsystem) \
    if (0 == _IT_BUS_LOGGER) \
        throw Exception("BusLogger not available"); \
    subsystem = _IT_BUS_LOGGER->get_subsystem();

#define IT_GET_SUBSYSTEM_LOG_FILTER(filter) \
    if (0 == _IT_BUS_LOGGER) \
        throw Exception("BusLogger not available"); \
    filter = _IT_BUS_LOGGER->get_subsystem_log_filter();

#define IT_GET_BUS_MASTER_LOG_FILTER(filter) \
    if (0 == _IT_BUS_LOGGER) \
        throw Exception("BusLogger not available"); \
    filter = _IT_BUS_LOGGER->get_bus_master_log_filter();

#endif  

---