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

FileAppender.d

Go to the documentation of this file.
00001 /*******************************************************************************
00002 
00003         @file FileAppender.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 
00027                         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
00028 
00029       
00030         @version        Initial version, May 2004
00031         @author         Kris
00032 
00033 
00034 *******************************************************************************/
00035 
00036 module mango.log.FileAppender;
00037 
00038 version (Mango)
00039 {
00040 private import  mango.log.Appender;
00041 
00042 private import  mango.io.FileConduit,
00043                 mango.io.DisplayWriter;
00044 
00045 /*******************************************************************************
00046 
00047         Append log messages to a file. This basic version has no rollover 
00048         support, so it just keeps on adding to the file. There's also a
00049         RollingFileAppender that may suit your needs.
00050 
00051 *******************************************************************************/
00052 
00053 public class FileAppender : Appender
00054 {
00055         private static uint     mask;
00056         private DisplayWriter   writer;
00057         private IConduit        conduit;
00058 
00059         /***********************************************************************
00060                 
00061                 Get a unique fingerprint for this class
00062 
00063         ***********************************************************************/
00064 
00065         static this()
00066         {
00067                 mask = nextMask();
00068         }
00069 
00070         /***********************************************************************
00071 
00072         ***********************************************************************/
00073 
00074         protected this (){}
00075 
00076         /***********************************************************************
00077                 
00078                 Create a basic FileAppender to a file with the specified 
00079                 path.
00080 
00081         ***********************************************************************/
00082 
00083         this (FilePath fp)
00084         {
00085                 setConduit (new FileConduit (fp, FileStyle.WriteAppending));
00086         }
00087 
00088         /***********************************************************************
00089                 
00090                 Create a basic FileAppender to a file with the specified 
00091                 path, and with the given Layout
00092 
00093         ***********************************************************************/
00094 
00095         this (FilePath fp, Layout layout)
00096         {
00097                 this (fp);
00098                 setLayout (layout);
00099         }
00100 
00101         /***********************************************************************
00102                 
00103                 Make sure the file is closed when we're GC'd
00104 
00105         ***********************************************************************/
00106 
00107         ~this ()
00108         {
00109                 close();
00110         }
00111 
00112         /***********************************************************************
00113                 
00114                 Return the conduit
00115 
00116         ***********************************************************************/
00117 
00118         IConduit getConduit ()
00119         {
00120                 return conduit;
00121         }
00122 
00123         /***********************************************************************
00124                 
00125                 Set the conduit
00126 
00127         ***********************************************************************/
00128 
00129         IWriter setConduit (IConduit conduit)
00130         {
00131                 // close any existing conduit
00132                 close ();
00133 
00134                 // create a new writer upon this conduit
00135                 this.conduit = conduit;
00136                 return (writer = new DisplayWriter (conduit));
00137         }
00138 
00139         /***********************************************************************
00140                 
00141                 Return the fingerprint for this class
00142 
00143         ***********************************************************************/
00144 
00145         uint getMask ()
00146         {
00147                 return mask;
00148         }
00149 
00150         /***********************************************************************
00151                 
00152                 Return the name of this class
00153 
00154         ***********************************************************************/
00155 
00156         char[] getName ()
00157         {
00158                 return this.classinfo.name;
00159         }
00160                 
00161         /***********************************************************************
00162                 
00163                 Append an event to the output.
00164                  
00165         ***********************************************************************/
00166 
00167         synchronized void append (Event event)
00168         {
00169                 writer.put (getLayout.format(event)).cr().flush();
00170         }
00171 
00172         /***********************************************************************
00173                 
00174                 Close the file associated with this Appender
00175 
00176         ***********************************************************************/
00177 
00178         synchronized void close ()
00179         {
00180                 if (conduit)
00181                    {
00182                    conduit.close();
00183                    conduit = null;
00184                    }
00185         }
00186 }
00187 }

Generated on Sun Nov 7 19:06:50 2004 for Mango by doxygen 1.3.6