OpenSim.Framework.LogWriter Class Reference

Class for writing a high performance, high volume log file. Sometimes, to debug, one has a high volume logging to do and the regular log file output is not appropriate. Create a new instance with the parameters needed and call Write() to output a line. Call Close() when finished. If created with no parameters, it will not log anything. More...

Inheritance diagram for OpenSim.Framework.LogWriter:

Collaboration diagram for OpenSim.Framework.LogWriter:

Public Member Functions
	LogWriter ()
	Create a log writer that will not write anything. Good for when not enabled but the write statements are still in the code. More...
	LogWriter (string dir, string headr, int maxFileTime, bool flushWrite)
	Create a log writer instance. More...
	LogWriter (string dir, string headr, int maxFileTime)
void	Dispose ()
void	Close ()
void	Write (string line, params object[] args)
void	Flush ()
void	Write (string line)

Public Attributes
ILog	ErrorLogger = null

Properties
bool	Enabled [get, set]
String	LogFileHeader [get, set]

Detailed Description

Class for writing a high performance, high volume log file. Sometimes, to debug, one has a high volume logging to do and the regular log file output is not appropriate. Create a new instance with the parameters needed and call Write() to output a line. Call Close() when finished. If created with no parameters, it will not log anything.

Definition at line 43 of file LogWriter.cs.

Constructor & Destructor Documentation

OpenSim.Framework.LogWriter.LogWriter ( )

inline

Create a log writer that will not write anything. Good for when not enabled but the write statements are still in the code.

Definition at line 65 of file LogWriter.cs.

OpenSim.Framework.LogWriter.LogWriter ( string  dir, string  headr, int  maxFileTime, bool  flushWrite  )

inline

Create a log writer instance.

Parameters

dir	The directory to create the log file in. May be 'null' for default.
headr	The characters that begin the log file name. May be 'null' for default.
maxFileTime	Maximum age of a log file in minutes. If zero, will set default.
flushWrite	Whether to do a flush after every log write. Best left off but if one is looking for a crash, this is a good thing to turn on.

Definition at line 79 of file LogWriter.cs.

OpenSim.Framework.LogWriter.LogWriter ( string  dir, string  headr, int  maxFileTime  )

inline

Definition at line 97 of file LogWriter.cs.

Member Function Documentation

void OpenSim.Framework.LogWriter.Close ( )

inline

Definition at line 106 of file LogWriter.cs.

void OpenSim.Framework.LogWriter.Dispose ( )

inline

Definition at line 101 of file LogWriter.cs.

void OpenSim.Framework.LogWriter.Flush ( )

inline

Definition at line 123 of file LogWriter.cs.

void OpenSim.Framework.LogWriter.Write ( string  line, params object[]  args  )

inline

Definition at line 117 of file LogWriter.cs.

void OpenSim.Framework.LogWriter.Write ( string  line )

inline

Definition at line 132 of file LogWriter.cs.

Member Data Documentation

ILog OpenSim.Framework.LogWriter.ErrorLogger = null

Definition at line 58 of file LogWriter.cs.

Property Documentation

bool OpenSim.Framework.LogWriter.Enabled

getset

Definition at line 45 of file LogWriter.cs.

String OpenSim.Framework.LogWriter.LogFileHeader

getset

Definition at line 49 of file LogWriter.cs.

---

The documentation for this class was generated from the following file:

• Framework/LogWriter.cs