LogAppender.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2005, Quest Software, 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 
*       Quest Software, 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_LOG_APPENDER_IFC_HPP_INCLUDE_GUARD_
#define BLOCXX_LOG_APPENDER_IFC_HPP_INCLUDE_GUARD_
#include "blocxx/BLOCXX_config.h"
#include "blocxx/CommonFwd.hpp"
#include "blocxx/IntrusiveCountableBase.hpp"
#include "blocxx/SortedVectorSet.hpp"
#include "blocxx/LogConfig.hpp"
#include "blocxx/LogMessagePatternFormatter.hpp"
#include "blocxx/LazyGlobal.hpp"
#include "blocxx/GlobalString.hpp"
#include "blocxx/GlobalStringArray.hpp"
#include "blocxx/String.hpp"


namespace BLOCXX_NAMESPACE
{

class BLOCXX_COMMON_API LogAppender : public IntrusiveCountableBase
{
public:

   virtual ~LogAppender();

   static LogAppenderRef getCurrentLogAppender();

   static LogAppenderRef getDefaultLogAppender();

   static bool setDefaultLogAppender(const LogAppenderRef &ref);

   static LogAppenderRef getThreadLogAppender();

   static bool setThreadLogAppender(const LogAppenderRef &ref);

   void logMessage(const LogMessage& message) const;

   bool categoryIsEnabled(const String& category) const;
   bool componentAndCategoryAreEnabled(const String& component, const String& category) const;

   ELogLevel getLogLevel() const
   {
      return m_logLevel;
   }

   static LogAppenderRef createLogAppender(
      const String& name,
      const StringArray& components,
      const StringArray& categories,
      const String& messageFormat,
      const String& type,
      const LoggerConfigMap& configItems);

   static const GlobalStringArray ALL_COMPONENTS;
   static const GlobalStringArray ALL_CATEGORIES;
   static const GlobalString STR_TTCC_MESSAGE_FORMAT;
   static const GlobalString TYPE_SYSLOG;
   static const GlobalString TYPE_STDERR;
   static const GlobalString TYPE_FILE;
   static const GlobalString TYPE_MPFILE;
   static const GlobalString TYPE_NULL;

protected:

   LogAppender(const StringArray& components = ALL_COMPONENTS, 
      const StringArray& categories = ALL_CATEGORIES, 
      const String& pattern = STR_TTCC_MESSAGE_FORMAT);

private:
   virtual void doProcessLogMessage(const String& formattedMessage, const LogMessage& message) const = 0;

private: // data
   SortedVectorSet<String> m_components;
   bool m_allComponents;
   SortedVectorSet<String> m_categories;
   bool m_allCategories;

   LogMessagePatternFormatter m_formatter;

   ELogLevel m_logLevel;

};
BLOCXX_EXPORT_TEMPLATE(BLOCXX_COMMON_API, IntrusiveReference, LogAppender);

#ifdef BLOCXX_WIN32
extern DWORD dwTlsIndex;
#else
namespace 
{
pthread_key_t g_loggerKey;
}
#endif

} // end namespace BLOCXX_NAMESPACE

#endif