Utils/Logger/IOStreamTarget.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief IOStreamTarget public header */
  25
  26 #ifndef HH_IOStreamTarget_
  27 #define HH_IOStreamTarget_ 1
  28
  29 // Custom includes
  30 #include <boost/utility.hpp>
  31 #include <boost/scoped_ptr.hpp>
  32 #include "Target.hh"
  33
  34 //#include "IOStreamTarget.mpp"
  35 ///////////////////////////////hh.p////////////////////////////////////////
  36
  37 namespace senf {
  38 namespace log {
  39
  40     /** \brief Write %log messages to arbitrary std::ostream
  41
  42         This target will write %log messages to an arbitrary std::ostream in the format
  43         <pre>
  44         <date> [<area>] <message>
  45         </pre>
  46
  47         The \e area will be omitted it it is \c senf::log::DefaultArea.
  48
  49         The date formatting is set using the Boost.DateTime date_facet, e.g.:
  50         \code
  51         stream.imbue( std::locale(stream.getloc(),
  52                                   new boost::posix_time::time_facet("%Y%m%d %H:%M:%S")) );
  53         \endcode
  54
  55         By default, the date-time will be written in extended ISO format.
  56
  57         \warning The class keeps a reference to the passed stream.
  58
  59         \note This class will permanently and globally change the date formating of the given
  60             stream if no \c boost::posix_time::time_facet has been set.
  61
  62         \ingroup targets
  63       */
  64     class IOStreamTarget
  65         : public Target
  66     {
  67     public:
  68         ///////////////////////////////////////////////////////////////////////////
  69         ///\name Structors and default members
  70         ///@{
  71
  72         explicit IOStreamTarget(std::ostream & os);
  73
  74         ///@}
  75         ///////////////////////////////////////////////////////////////////////////
  76
  77     protected:
  78
  79     private:
  80         void v_write(boost::posix_time::ptime timestamp, std::string const & stream,
  81                      std::string const & area, unsigned level,
  82                      std::string const & message);
  83
  84         std::ostream & stream_;
  85     };
  86
  87
  88 }}
  89
  90 ///////////////////////////////hh.e////////////////////////////////////////
  91 //#include "IOStreamTarget.cci"
  92 //#include "IOStreamTarget.ct"
  93 //#include "IOStreamTarget.cti"
  94 #endif
  95
  96 \f
  97 // Local Variables:
  98 // mode: c++
  99 // fill-column: 100
 100 // comment-column: 40
 101 // c-file-style: "senf"
 102 // indent-tabs-mode: nil
 103 // ispell-local-dictionary: "american"
 104 // compile-command: "scons -u test"
 105 // End: