Utils/Logger/FileTarget.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 FileTarget public header */
  25
  26 #ifndef HH_FileTarget_
  27 #define HH_FileTarget_ 1
  28
  29 // Custom includes
  30 #include <boost/utility.hpp>
  31 #include <fstream>
  32 #include "IOStreamTarget.hh"
  33
  34 //#include "FileTarget.mpp"
  35 ///////////////////////////////hh.p////////////////////////////////////////
  36
  37 namespace senf {
  38 namespace log {
  39
  40     /** \brief Log target writing to a log file.
  41
  42         The FileTarget will save all log messages in the given file. Messages will be appended at
  43         the end of the file.
  44
  45         After log files have been rotated, the reopen() member should be called to create a new log
  46         file.
  47
  48         \ingroup targets
  49       */
  50     class FileTarget
  51         : private boost::base_from_member<std::ofstream>,
  52           public IOStreamTarget
  53     {
  54         typedef boost::base_from_member<std::ofstream> ofstream_t;
  55
  56     public:
  57         ///////////////////////////////////////////////////////////////////////////
  58         ///\name Structors and default members
  59         ///@{
  60
  61         explicit FileTarget(std::string file); ///< Construct FileTarget writing to \a file
  62
  63         ///@}
  64         ///////////////////////////////////////////////////////////////////////////
  65
  66         void reopen();                  ///< Reopen log after log-file rotation
  67         void reopen(std::string file);  ///< Reopen log under a new name
  68
  69     private:
  70         std::string file_;
  71     };
  72
  73 }}
  74
  75 ///////////////////////////////hh.e////////////////////////////////////////
  76 //#include "FileTarget.cci"
  77 //#include "FileTarget.ct"
  78 //#include "FileTarget.cti"
  79 #endif
  80
  81 \f
  82 // Local Variables:
  83 // mode: c++
  84 // fill-column: 100
  85 // comment-column: 40
  86 // c-file-style: "senf"
  87 // indent-tabs-mode: nil
  88 // ispell-local-dictionary: "american"
  89 // compile-command: "scons -u test"
  90 // End: