Logging.LoggerTask Class Reference

Task for logging events More...

Public Member Functions
	LoggerTask (string folder, string fileName)
	Initializes a new instance of the LoggerTask class. More...
void	DoWork ()
	Does the work. Events to log are filled in a concurrent queue and then read here in serial order. More...

Package Functions
void	EnqueueObject (LoggerInfo loggerInfo)
	Enqueues the object. More...
void	Stop ()
	Stops this instance. More...

Properties
bool	IsStopped [get]
	Gets a value indicating whether this instance is stopped. More...

Detailed Description

Task for logging events

Definition at line 10 of file LoggerTask.cs.

Constructor & Destructor Documentation

Logging.LoggerTask.LoggerTask	(	string	folder,
		string	fileName
	)

Initializes a new instance of the LoggerTask class.

Parameters

folder	The folder.
fileName	Name of the file.

Definition at line 31 of file LoggerTask.cs.

        {
            fileName = String.IsNullOrWhiteSpace(fileName) 
                ? $"{DateTime.Now.ToFileTime()}_DefaultLog.log"
                : $"{DateTime.Now.ToFileTime()}_{Path.GetFileName(fileName)}.log";
            this.streamWriter = new StreamWriter(Path.Combine(folder, fileName));
        }

Member Function Documentation

void Logging.LoggerTask.DoWork

(

)

Does the work. Events to log are filled in a concurrent queue and then read here in serial order.

Definition at line 43 of file LoggerTask.cs.

        {
            while (!this.stop)
            {
                LoggerInfo logInfo = this.logEntries.Take();
                if (null != logInfo)
                    this.Log(logInfo);
            }

            if (this.streamWriter == null) 
                return;

            lock (this.lockObject)
            {
                this.streamWriter.Close();
            }

            this.IsStopped = true;
        }

Here is the caller graph for this function:

void Logging.LoggerTask.EnqueueObject ( LoggerInfo  loggerInfo )

package

Enqueues the object.

Parameters

loggerInfo

The logger information.

Definition at line 80 of file LoggerTask.cs.

        {
            this.logEntries.Add(loggerInfo);
        }

Here is the caller graph for this function:

void Logging.LoggerTask.Stop ( )

package

Stops this instance.

Definition at line 88 of file LoggerTask.cs.

        {
            this.stop = true;
            this.logEntries.Add(null);
        }

Property Documentation

bool Logging.LoggerTask.IsStopped

get

Gets a value indicating whether this instance is stopped.

true if this instance is stopped; otherwise, false.

Definition at line 22 of file LoggerTask.cs.

---

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

• C:/Entwicklung/Simple3DScan/Simple3DScan/Logging/LoggerTask.cs