PriorityLog.hxx
上传用户:sy_wanhua
上传日期:2013-07-25
资源大小:3048k
文件大小:6k
源码类别:

流媒体/Mpeg4/MP4

开发平台:

C/C++

  1. #if !defined(VOCAL_PRIORITYLOG_HXX)
  2. #define VOCAL_PRIORITYLOG_HXX
  3. /* ====================================================================
  4.  * The Vovida Software License, Version 1.0 
  5.  * 
  6.  * Copyright (c) 2000 Vovida Networks, Inc.  All rights reserved.
  7.  * 
  8.  * Redistribution and use in source and binary forms, with or without
  9.  * modification, are permitted provided that the following conditions
  10.  * are met:
  11.  * 
  12.  * 1. Redistributions of source code must retain the above copyright
  13.  *    notice, this list of conditions and the following disclaimer.
  14.  * 
  15.  * 2. Redistributions in binary form must reproduce the above copyright
  16.  *    notice, this list of conditions and the following disclaimer in
  17.  *    the documentation and/or other materials provided with the
  18.  *    distribution.
  19.  * 
  20.  * 3. The names "VOCAL", "Vovida Open Communication Application Library",
  21.  *    and "Vovida Open Communication Application Library (VOCAL)" must
  22.  *    not be used to endorse or promote products derived from this
  23.  *    software without prior written permission. For written
  24.  *    permission, please contact vocal@vovida.org.
  25.  *
  26.  * 4. Products derived from this software may not be called "VOCAL", nor
  27.  *    may "VOCAL" appear in their name, without prior written
  28.  *    permission of Vovida Networks, Inc.
  29.  * 
  30.  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
  31.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  32.  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
  33.  * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA
  34.  * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
  35.  * IN EXCESS OF $1,000, NOR FOR ANY INDIRECT, INCIDENTAL, SPECIAL,
  36.  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  37.  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  38.  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  39.  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  40.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  41.  * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  42.  * DAMAGE.
  43.  * 
  44.  * ====================================================================
  45.  * 
  46.  * This software consists of voluntary contributions made by Vovida
  47.  * Networks, Inc. and many individuals on behalf of Vovida Networks,
  48.  * Inc.  For more information on Vovida Networks, Inc., please see
  49.  * <http://www.vovida.org/>.
  50.  *
  51.  */
  52. static const char* const PriorityLog_hxx_Version = 
  53.     "$Id: PriorityLog.hxx,v 1.1 2001/03/26 10:35:32 icahoon Exp $";
  54. #include "Writer.hxx"
  55. #include <string>
  56. #include <strstream>
  57. /** Infrastructure common to VOCAL.
  58.  */
  59. namespace Vocal 
  60. {
  61. /** Infrastructure in VOCAL related to logging.<br><br>
  62.  */
  63. namespace Logging
  64. {
  65. /** The ostream based log associated with a given priority.<br><br>
  66.  *
  67.  *  @see    Vocal::Logging::Log
  68.  *  @see    Vocal::Logging::VLog
  69.  *  @see    Vocal::Logging::CpPriorityLog   
  70.  */
  71. class PriorityLog : public Vocal::IO::Writer
  72. {
  73.     protected:
  74.      /** Create a prototype PriorityLog. See the Prototype pattern
  75.  *  in GOF's Design Pattern.
  76.  *
  77.  *  @param  priorityName    The name of the priority.
  78.  *  @param  priority     The value of the priority.
  79.  *  @param  alwaysOn     If set, the log cannot be disabled.
  80.  *  @param  defaultOn     If set, the log will be created enabled.
  81.  */
  82. PriorityLog(
  83.     const char   *   priorityName,
  84.     int           priority,
  85.     bool          alwaysOn = false,
  86.     bool          defaultOn  = true);
  87.      /** Copy constructor.
  88.  */
  89. PriorityLog(const PriorityLog &);
  90.         /** Assignment
  91.          */
  92.         PriorityLog &     operator=(const PriorityLog &);
  93.     public:
  94.     
  95.      /** Virtual destructor.
  96.  */
  97. virtual ~PriorityLog();
  98.      /** Create a clone of this object. See the Prototype pattern from
  99.  *  Design Patterns.
  100.  */
  101.      virtual PriorityLog *     clone() const = 0;
  102.      /** Get the native ostream.
  103.  */
  104. ostream &     get(bool header = false);
  105.      /** Test to see if this object is enabled.
  106.  */
  107.      bool          isOn() const;
  108.      /** Enable this log.
  109.  */
  110. void          on();
  111.      /** Disable this log.
  112.  */
  113. void          off();
  114.      /** Callback that is called from end(), before writeLog() is called.
  115.  */
  116.      virtual void          preWrite();
  117.      /** Callback that is called from end(), after writeLog() is called.
  118.  */
  119. virtual void          postWrite();
  120.         /** Set the file name for this log.
  121.          */
  122.                 void                file(const char *);
  123.             
  124.         /** Set the file line for this log.
  125.          */
  126.                 void                line(int);
  127.                 
  128.                 
  129.      /** Commit the contents of the native ostream to the log.
  130.  */
  131.           void          end();
  132.      /** Abstract callback that is called from end() after preWrite and
  133.  *  before postWrite. The intent is that the user will override this
  134.  *  method and write the given log message to the log.
  135.  *
  136.  *  @param  priorityName    The name of the priority.
  137.  *  @param  priority     The value of the priority.
  138.  *  @param  logMessage     The actual message to log.
  139.  *  @param  file         The name of the file where the log is taking
  140.  *                 place.
  141.  *  @param  line         The line number of the file where the log
  142.  *                 is taking place.
  143.  */
  144. virtual void          writeLog(
  145.                     const string &   priorityName,
  146. int           priority,
  147. const char   *   logMessage,
  148. const char   *   file = 0, 
  149. int           line = 0) = 0;
  150.         /** Another way to call end.
  151.          */
  152.         ostream & writeTo(ostream &) const;
  153.     private:
  154.           ostrstream   *   buffer_;
  155.           string          priorityName_;
  156. int           priority_;
  157. bool          alwaysOn_;
  158. bool          on_;
  159.                 string              file_;
  160.                 int                 line_;
  161. };
  162. class setFile : public Vocal::IO::Writer
  163. {
  164.     public:
  165.         setFile(PriorityLog &, const char *);
  166.         ostream & writeTo(ostream &) const;
  167. };
  168. class setLine : public Vocal::IO::Writer
  169. {
  170.     public:
  171.         setLine(PriorityLog &, int);
  172.         ostream & writeTo(ostream &) const;
  173. };
  174. } // namespace Logging
  175. } // namespace Vocal
  176. #endif // !defined(VOCAL_PRIORITYLOG_HXX)