blpapi_logging.h

Go to the documentation of this file.

/* Copyright 2012. Bloomberg Finance L.P.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:  The above
 * copyright notice and this permission notice shall be included in all copies
 * or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#ifndef INCLUDED_BLPAPI_LOGGING
#define INCLUDED_BLPAPI_LOGGING

#ifndef INCLUDED_BLPAPI_CALL
#include <blpapi_call.h>
#endif

#ifndef INCLUDED_BLPAPI_DATETIME
#include <blpapi_datetime.h>
#endif

#ifndef INCLUDED_BLPAPI_DEFS
#include <blpapi_defs.h>
#endif

#ifdef __cplusplus
extern "C" {
#endif

typedef void (*blpapi_Logging_Func_t)(blpapi_UInt64_t threadId,
        int severity,
        blpapi_Datetime_t timestamp,
        const char *category,
        const char *message);
BLPAPI_EXPORT
int blpapi_Logging_registerCallback(blpapi_Logging_Func_t callback,
        blpapi_Logging_Severity_t thresholdSeverity);
BLPAPI_EXPORT
int blpapi_Logging_configureLogging(int level,
        const char *fileName,
        int rolloverFileCount,
        int rolloverFileLimit);
BLPAPI_EXPORT
void blpapi_Logging_logTestMessage(blpapi_Logging_Severity_t severity);
#ifdef __cplusplus
}

namespace BloombergLP {
namespace blpapi {

struct Logging {

    struct Severity {
        enum Type {

            e_off = blpapi_Logging_SEVERITY_OFF, 
            e_fatal = blpapi_Logging_SEVERITY_FATAL, 
            e_error = blpapi_Logging_SEVERITY_ERROR, 
            e_warn = blpapi_Logging_SEVERITY_WARN, 
            e_info = blpapi_Logging_SEVERITY_INFO, 
            e_debug = blpapi_Logging_SEVERITY_DEBUG, 
            e_trace = blpapi_Logging_SEVERITY_TRACE 
        };
    };

    // CLASS METHODS
    static void logTestMessage(Severity::Type severity);
};

// ============================================================================
//                      INLINE FUNCTION DEFINITIONS
// ============================================================================

// --------------
// struct Logging
// --------------

// CLASS METHODS
inline void Logging::logTestMessage(Severity::Type severity)
{
    BLPAPI_CALL(blpapi_Logging_logTestMessage)
    (static_cast<blpapi_Logging_Severity_t>(severity));
}

} // close namespace blpapi
} // close namespace BloombergLP

#endif

#endif