Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

Appender.d

Go to the documentation of this file.
00001 /*******************************************************************************
00002 
00003         @file Appender.d
00004 
00005         Copyright (c) 2004 Kris Bell
00006         
00007         This software is provided 'as-is', without any express or implied
00008         warranty. In no event will the authors be held liable for damages
00009         of any kind arising from the use of this software.
00010         
00011         Permission is hereby granted to anyone to use this software for any 
00012         purpose, including commercial applications, and to alter it and/or 
00013         redistribute it freely, subject to the following restrictions:
00014         
00015         1. The origin of this software must not be misrepresented; you must 
00016            not claim that you wrote the original software. If you use this 
00017            software in a product, an acknowledgment within documentation of 
00018            said product would be appreciated but is not required.
00019 
00020         2. Altered source versions must be plainly marked as such, and must 
00021            not be misrepresented as being the original software.
00022 
00023         3. This notice may not be removed or altered from any distribution
00024            of the source.
00025 
00026         4. Derivative works are permitted, but they must carry this notice
00027            in full and credit the original source.
00028 
00029 
00030                         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
00031 
00032       
00033         @version        Initial version, May 2004
00034         @author         Kris
00035 
00036 
00037 *******************************************************************************/
00038 
00039 module mango.log.Appender;
00040 
00041 public import   mango.log.Event,
00042                 mango.log.Layout;
00043 
00044 /*******************************************************************************
00045 
00046         Base class for all Appenders. These objects are responsible for
00047         emitting messages sent to a particular logger. There may be more
00048         than one appender attached to any logger. The actual message is
00049         constructed by another class known as a Layout.
00050         
00051 *******************************************************************************/
00052 
00053 public class Appender
00054 {
00055         private Appender        next;
00056         private Layout          layout;
00057 
00058         /***********************************************************************
00059                 
00060                 Return the mask used to identify this Appender. The mask
00061                 is used to figure out whether an appender has already been 
00062                 invoked for a particular logger.
00063 
00064         ***********************************************************************/
00065 
00066         abstract uint getMask ();
00067 
00068         /***********************************************************************
00069                 
00070                 Return the name of this Appender.
00071 
00072         ***********************************************************************/
00073 
00074         abstract char[] getName ();
00075                 
00076         /***********************************************************************
00077                 
00078                 Append a message to the output.
00079 
00080         ***********************************************************************/
00081 
00082         abstract void append (Event event);
00083 
00084         /***********************************************************************
00085               
00086               Create an Appender and default its layout to SimpleLayout.  
00087 
00088         ***********************************************************************/
00089 
00090         this ()
00091         {
00092                 layout = new SimpleLayout;
00093         }
00094 
00095         /***********************************************************************
00096                 
00097                 Static method to return a mask for identifying the Appender.
00098                 Each Appender class should have a unique fingerprint so that
00099                 we can figure out which ones have been invoked for a given
00100                 event. A bitmask is a simple an efficient way to do that.
00101 
00102         ***********************************************************************/
00103 
00104         protected static uint nextMask()
00105         {
00106                 static uint mask = 1;
00107 
00108                 uint ret = mask;
00109                 mask <<= 1;
00110                 return ret;
00111         }
00112 
00113         /***********************************************************************
00114                 
00115                 Set the current layout to be that of the argument.
00116 
00117         ***********************************************************************/
00118 
00119         void setLayout (Layout layout)
00120         {
00121                 this.layout = layout;
00122         }
00123 
00124         /***********************************************************************
00125                 
00126                 Return the current Layout
00127 
00128         ***********************************************************************/
00129 
00130         Layout getLayout ()
00131         {
00132                 return layout;
00133         }
00134 
00135         /***********************************************************************
00136                 
00137                 Attach another appender to this one
00138 
00139         ***********************************************************************/
00140 
00141         void setNext (Appender next)
00142         {
00143                 this.next = next;
00144         }
00145 
00146         /***********************************************************************
00147                 
00148                 Return the next appender in the list
00149 
00150         ***********************************************************************/
00151 
00152         Appender getNext ()
00153         {
00154                 return next;
00155         }
00156 
00157         /***********************************************************************
00158                 
00159                 Close this appender. This would be used for file, sockets, 
00160                 and such like.
00161 
00162         ***********************************************************************/
00163 
00164         void close ()
00165         {
00166         }
00167 }
00168 

Generated on Sat Dec 24 17:28:31 2005 for Mango by  doxygen 1.4.0