FileAppender.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2005, Vintela, Inc. All rights reserved.
* Copyright (C) 2006, Novell, Inc. All rights reserved.
* 
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 
*     * Redistributions of source code must retain the above copyright notice,
*       this list of conditions and the following disclaimer.
*     * Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in the
*       documentation and/or other materials provided with the distribution.
*     * Neither the name of 
*       Vintela, Inc., 
*       nor Novell, Inc., 
*       nor the names of its contributors or employees may be used to 
*       endorse or promote products derived from this software without 
*       specific prior written permission.
* 
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/


#ifndef BLOCXX_FILE_APPENDER_HPP_INCLUDE_GUARD_
#define BLOCXX_FILE_APPENDER_HPP_INCLUDE_GUARD_
#include "blocxx/BLOCXX_config.h"
#include "blocxx/CommonFwd.hpp"
#include "blocxx/LogAppender.hpp"
#include "blocxx/String.hpp"
#include "blocxx/GlobalString.hpp"

#include <fstream>

namespace BLOCXX_NAMESPACE
{

class BLOCXX_COMMON_API FileAppender : public LogAppender
{
public:
   static UInt64 const NO_MAX_LOG_SIZE = 0;
   static unsigned int const NO_MAX_BACKUP_INDEX = 0;

   FileAppender(const StringArray& components,
      const StringArray& categories,
      const char* filename,
      const String& pattern,
      UInt64 maxFileSize,
      unsigned int maxBackupIndex,
      bool flushLog=true);
   virtual ~FileAppender();

   static const GlobalString STR_DEFAULT_MESSAGE_PATTERN;

protected:
   virtual void doProcessLogMessage(const String& formattedMessage, const LogMessage& message) const;
private:
   String m_filename;
   UInt64 m_maxFileSize;
   unsigned int m_maxBackupIndex;
   mutable std::ofstream m_log;
   bool m_flushLog;
};

} // end namespace BLOCXX_NAMESPACE

#endif