platform/reactors/LogOutputReactor.hpp

// ------------------------------------------------------------------------
// Pion is a development platform for building Reactors that process Events
// ------------------------------------------------------------------------
// Copyright (C) 2007-2008 Atomic Labs, Inc.  (http://www.atomiclabs.com)
//
// Pion is free software: you can redistribute it and/or modify it under the
// terms of the GNU Affero General Public License as published by the Free
// Software Foundation, either version 3 of the License, or (at your option)
// any later version.
//
// Pion 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 Affero General Public License for
// more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with Pion.  If not, see <http://www.gnu.org/licenses/>.
//

#ifndef __PION_LOGOUTPUTREACTOR_HEADER__
#define __PION_LOGOUTPUTREACTOR_HEADER__

#include <string>
#include <fstream>
#include <pion/PionConfig.hpp>
#include <pion/PionLogger.hpp>
#include <pion/PionException.hpp>
#include <pion/platform/Codec.hpp>
#include <pion/platform/Reactor.hpp>


namespace pion {        // begin namespace pion
namespace plugins {     // begin namespace plugins


class LogOutputReactor :
    public pion::platform::Reactor
{
public:

    class EmptyCodecException : public PionException {
    public:
        EmptyCodecException(const std::string& reactor_id)
            : PionException("LogOutputReactor configuration is missing a required Codec parameter: ", reactor_id) {}
    };
    
    class EmptyFilenameException : public PionException {
    public:
        EmptyFilenameException(const std::string& reactor_id)
            : PionException("LogOutputReactor configuration is missing a required Filename parameter: ", reactor_id) {}
    };
    
    class OpenLogException : public PionException {
    public:
        OpenLogException(const std::string& log_filename)
            : PionException("Unable to open log file for writing: ", log_filename) {}
    };
    
    class WriteToLogException : public PionException {
    public:
        WriteToLogException(const std::string& log_filename)
            : PionException("Unable to write Event to log file: ", log_filename) {}
    };

    class LogRotationException : public PionException {
    public:
        LogRotationException(const std::string& log_filename)
            : PionException("Unable to rotate log file: ", log_filename) {}
    };


    LogOutputReactor(void)
        : Reactor(TYPE_STORAGE),
        m_logger(PION_GET_LOGGER("pion.LogOutputReactor"))
    {}
    
    virtual ~LogOutputReactor() { stop(); }
    
    virtual void setConfig(const pion::platform::Vocabulary& v, const xmlNodePtr config_ptr);
    
    virtual void updateVocabulary(const pion::platform::Vocabulary& v);
    
    virtual void updateCodecs(void);
    
    virtual void process(const pion::platform::EventPtr& e);
    
    virtual void query(std::ostream& out, const QueryBranches& branches,
        const QueryParams& qp);
    
    virtual void start(void);
    
    virtual void stop(void);

    inline void setLogger(PionLogger log_ptr) { m_logger = log_ptr; }
    
    inline PionLogger getLogger(void) { return m_logger; }
    
    
private:

    void openLogFileNoLock(void);

    void closeLogFileNoLock(void);

    static const std::string            CODEC_ELEMENT_NAME;
    
    static const std::string            FILENAME_ELEMENT_NAME;
    
    
    PionLogger                          m_logger;
    
    std::string                         m_codec_id;
    
    pion::platform::CodecPtr            m_codec_ptr;
    
    std::string                         m_log_filename;
    
    std::ofstream                       m_log_stream;

    boost::mutex                        m_log_writer_mutex;
};


}   // end namespace plugins
}   // end namespace pion

#endif

---