WLogger.h 2.69 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
//---------------------------------------------------------------------------
//
// Project: OpenWalnut ( http://www.openwalnut.org )
//
// Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
// For more information see http://www.openwalnut.org/copying
//
// This file is part of OpenWalnut.
//
// OpenWalnut is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// OpenWalnut is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
//
//---------------------------------------------------------------------------

#ifndef WLOGGER_H
#define WLOGGER_H

#include <queue>
#include <string>
#include <vector>

#include <boost/shared_ptr.hpp>
#include <boost/thread/thread.hpp>
#include <boost/thread/mutex.hpp>
schurade's avatar
schurade committed
35
#include <boost/thread/locks.hpp>
36 37 38 39 40 41 42 43 44 45 46 47 48
#include "../common/WThreadedRunner.h"

#include "WLogEntry.h"

/**
 * TODO(schurade): Document this!
 */
class WLogger: public WThreadedRunner
{
public:
    /**
     * Constructor
     */
schurade's avatar
schurade committed
49
    WLogger( std::string fileName = "walnut.log", LogLevel level = LL_DEBUG );
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91

    /**
     * Destructor.
     */
    virtual ~WLogger();

    /**
     *
     */
    void setLogLevel( LogLevel level );

    /**
     *
     */
    void setSTDOUTLevel( LogLevel level );

    /**
     *
     */
    void setSTDERRLevel( LogLevel level );

    /**
     *
     */
    void setLogFileLevel( LogLevel level );


    /**
     *
     */
    void setLogFileName( std::string fileName );

    /**
     *
     */
    void addLogMessage( std::string message, std::string source = "", LogLevel level = LL_DEBUG );

    /**
     *
     */
    void processQueue();

schurade's avatar
schurade committed
92 93 94 95 96 97
    /**
     * \par Description
     * Entry point after loading the module. Runs in separate thread.
     */
    virtual void threadMain();

98
protected:
schurade's avatar
schurade committed
99 100

private:
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
    /**
     *
     */
    LogLevel m_LogLevel;

    /**
     *
     */
    LogLevel m_STDOUTLevel;

    /**
     *
     */
    LogLevel m_STDERRLevel;

    /**
     *
     */
    LogLevel m_LogFileLevel;


    /**
     *
     */
    std::string m_LogFileName;

    /**
     *
     */
    std::vector< WLogEntry > m_SessionLog;

    /**
     *
     */
    std::queue< WLogEntry > m_LogQueue;

    /**
     *
     */
schurade's avatar
schurade committed
140
    boost::mutex m_QueueMutex;
141 142 143
};

#endif  // WLOGGER_H