LogSettings.h

Go to the documentation of this file.

/*
 * Copyright Onix Solutions Limited [OnixS]. All rights reserved.
 *
 * This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
 * and international copyright treaties.
 *
 * Access to and use of the software is governed by the terms of the applicable ONIXS Software
 * Services Agreement (the Agreement) and Customer end user license agreements granting
 * a non-assignable, non-transferable and non-exclusive license to use the software
 * for it's own data processing purposes under the terms defined in the Agreement.
 *
 * Except as otherwise granted within the terms of the Agreement, copying or reproduction of any
 * part of this source code or associated reference material to any other location for further
 * reproduction or redistribution, and any amendments to this copyright notice, are expressly
 * prohibited.
 *
 * Any reproduction or redistribution for sale or hiring of the Software not in accordance with
 * the terms of the Agreement is a violation of copyright law.
 */

#pragma once

#include "OnixS/Eurex/Trading/Export.h"

#include <string>

namespace OnixS { namespace Eurex { namespace Trading {

/// Log level.
struct ONIXS_EUREX_ETI_EXPORT LogLevel
{
    enum Enum
    {
        Fatal,   ///< Fatal error, cannot continue.
        Error,   ///< System error, but we can go on.
        Warning, ///< User or logic error, just say about it.
        Info,    ///< Information message.
        Trace,   ///< Used for tracing, usually including functions' names and args.
        Debug,   ///< Used for debugging.
    };
};

/// Returns string representation.
ONIXS_EUREX_ETI_EXPORT std::string enumToString(LogLevel::Enum);

/// Make it printable using C++ I/O streams.
ONIXS_EUREX_ETI_EXPORT std::ostream& operator<<(std::ostream&, LogLevel::Enum);

/// Logging options.
struct ONIXS_EUREX_ETI_EXPORT LogSettings
{
    enum Enum
    {
        /// Disable all tracing.
        NoTrace = 0x00,

        /// Trace to the log file.
        TraceToFile = 0x01,

        /// Trace to the console.
        ///
        /// \note Messages with LogLevel::Trace and LogLevel::Debug are not duplicated to console.
        TraceToConsole = 0x02,

        /// Enable asynchronous logging.
        ///
        /// \note Instead of direct output to file or console, handler put log message into
        /// interthread queue, that will be processed by auxiliary thread.
        Async = 0x04,

        /// Default log settings.
        Default = TraceToFile | TraceToConsole
    };
};

/// Typed logical operator helper.
inline LogSettings::Enum operator|(LogSettings::Enum a, LogSettings::Enum b)
{
    return LogSettings::Enum((int) a | (int) b);
}

/// Returns string representation.
ONIXS_EUREX_ETI_EXPORT std::string enumToString(LogSettings::Enum);

/// Returns string representation.
ONIXS_EUREX_ETI_EXPORT std::string bitsToString(LogSettings::Enum);

/// Make it printable using C++ I/O streams.
ONIXS_EUREX_ETI_EXPORT std::ostream& operator<<(std::ostream&, LogSettings::Enum);

}}}