Ntp.Common.Log.TextLog Class Reference

Inheritance diagram for Ntp.Common.Log.TextLog:

Collaboration diagram for Ntp.Common.Log.TextLog:

Public Member Functions
override void	Initialize ()
override void	Resume ()
override void	Suspend ()
override void	WriteLine (string text, Severity severity)
override void	WriteLine (Exception exception)
override void	WriteLine (Exception exception, Severity severity)
Public Member Functions inherited from Ntp.Common.Log.LogBase
abstract void	Close ()

Protected Member Functions
	TextLog (Severity threshold, string timeFormat)
abstract TextWriter	CreateWriter ()
Protected Member Functions inherited from Ntp.Common.Log.LogBase
	LogBase (Severity threshold, bool isSysLog=false)

Protected Attributes
bool	Closed
bool	Initialized
readonly object	Locker = new object()

Properties
bool	ShowSeverity [get, set]
bool	ShowTimeStamp [get, set]
Properties inherited from Ntp.Common.Log.LogBase
bool	IsSysLog [get]
Severity	Threshold [get]

Private Attributes
readonly List< string >	cache = new List<string>()
bool	suspended
readonly string	timeFormat
TextWriter	writer

Detailed Description

Definition at line 28 of file TextLog.cs.

Constructor & Destructor Documentation

Ntp.Common.Log.TextLog.TextLog ( Severity  threshold, string  timeFormat  )

inlineprotected

Definition at line 30 of file TextLog.cs.

            : base(threshold)
        {
            this.timeFormat = timeFormat;
            Initialized = false;
            suspended = false;
        }

Member Function Documentation

abstract TextWriter Ntp.Common.Log.TextLog.CreateWriter ( )

protectedpure virtual

Implemented in Ntp.Common.Log.FileLog, and Ntp.Common.Log.ConsoleLog.

override void Ntp.Common.Log.TextLog.Initialize ( )

inlinevirtual

Implements Ntp.Common.Log.LogBase.

Definition at line 51 of file TextLog.cs.

        {
            lock (Locker)
            {
                if (!Initialized && !suspended && !Closed)
                {
                    writer = CreateWriter();
                    Initialized = true;
                }
            }
        }

override void Ntp.Common.Log.TextLog.Resume ( )

inlinevirtual

Implements Ntp.Common.Log.LogBase.

Definition at line 63 of file TextLog.cs.

        {
            lock (Locker)
            {
                suspended = false;
            }
        }

override void Ntp.Common.Log.TextLog.Suspend ( )

inlinevirtual

Implements Ntp.Common.Log.LogBase.

Definition at line 71 of file TextLog.cs.

        {
            lock (Locker)
            {
                if (writer != null)
                {
                    writer.Close();
                    writer.Dispose();
                    writer = null;
                }
                Initialized = false;
                suspended = true;
            }
        }

override void Ntp.Common.Log.TextLog.WriteLine ( string  text, Severity  severity  )

inlinevirtual

Implements Ntp.Common.Log.LogBase.

Definition at line 86 of file TextLog.cs.

Referenced by Ntp.Common.Log.LogGroup.WriteLine().

        {
            if (!Initialized)
                Initialize();

            if (!Initialized)
                return;

            lock (Locker)
            {
                if (Initialized && !suspended && cache.Count != 0)
                {
                    foreach (string line in cache)
                    {
                        writer.WriteLine(line);
                    }
                    writer.Flush();
                    cache.Clear();
                }
            }

            if (severity < Threshold)
                return;

            string severityText = string.Empty;

            if (ShowSeverity)
            {
                string pad = string.Empty;

                switch (severity)
                {
                    case Severity.Error:
                        severityText = "ERROR";
                        break;
                    case Severity.Warn:
                        severityText = "WARN";
                        pad = " ";
                        break;
                    case Severity.Notice:
                        severityText = "NOTICE";
                        break;
                    case Severity.Info:
                        severityText = "INFO";
                        pad = " ";
                        break;
                    case Severity.Debug:
                        severityText = "DEBUG";
                        break;
                    case Severity.Trace:
                        severityText = "TRACE";
                        break;
                    default:
                        throw new ApplicationException("Unknown severity level.");
                }

                severityText = string.Concat(" [", severityText, "] ", pad);
            }

            DateTime now = DateTime.Now;

            string stamp =
                ShowTimeStamp && timeFormat != null
                    ? now.ToString(timeFormat)
                    : string.Empty;

            string entry = string.Concat(stamp, severityText, text);

            lock (Locker)
            {
                if (Initialized)
                {
                    writer.WriteLine(entry);
                    writer.Flush();
                }
                else
                {
                    cache.Add(entry);
                }
            }
        }

Here is the caller graph for this function:

override void Ntp.Common.Log.TextLog.WriteLine ( Exception  exception )

inlinevirtual

Implements Ntp.Common.Log.LogBase.

Definition at line 168 of file TextLog.cs.

        {
            WriteLine(exception.Message, Severity.Error);
            WriteLine(exception.StackTrace, Severity.Debug);
        }

override void Ntp.Common.Log.TextLog.WriteLine ( Exception  exception, Severity  severity  )

inlinevirtual

Implements Ntp.Common.Log.LogBase.

Definition at line 174 of file TextLog.cs.

        {
            if (severity < Threshold)
                return;

            WriteLine(exception.Message, severity);
            WriteLine(exception.StackTrace, severity);
        }

Member Data Documentation

readonly List<string> Ntp.Common.Log.TextLog.cache = new List<string>()

private

Definition at line 38 of file TextLog.cs.

bool Ntp.Common.Log.TextLog.Closed

protected

Definition at line 42 of file TextLog.cs.

bool Ntp.Common.Log.TextLog.Initialized

protected

Definition at line 43 of file TextLog.cs.

readonly object Ntp.Common.Log.TextLog.Locker = new object()

protected

Definition at line 40 of file TextLog.cs.

bool Ntp.Common.Log.TextLog.suspended

private

Definition at line 44 of file TextLog.cs.

readonly string Ntp.Common.Log.TextLog.timeFormat

private

Definition at line 41 of file TextLog.cs.

TextWriter Ntp.Common.Log.TextLog.writer

private

Definition at line 45 of file TextLog.cs.

Property Documentation

bool Ntp.Common.Log.TextLog.ShowSeverity

getset

Definition at line 49 of file TextLog.cs.

bool Ntp.Common.Log.TextLog.ShowTimeStamp

getset

Definition at line 47 of file TextLog.cs.

---

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

• Ntp.Common/Log/TextLog.cs