Added logging
sta
13 years ago
parent
e3ff26a2d5
commit
49dc8800d3
@ -0,0 +1,150 @@
|
||||
#region License
|
||||
/*
|
||||
* LogData.cs
|
||||
*
|
||||
* The MIT License
|
||||
*
|
||||
* Copyright (c) 2013 sta.blockhead
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
#endregion
|
||||
|
||||
using System;
|
||||
using System.Diagnostics;
|
||||
using System.Text;
|
||||
|
||||
namespace WebSocketSharp {
|
||||
|
||||
/// <summary>
|
||||
/// Represents the log data used by the <see cref="Logger"/> class.
|
||||
/// </summary>
|
||||
public class LogData {
|
||||
|
||||
#region Private Fields
|
||||
|
||||
private StackFrame _caller;
|
||||
private DateTime _date;
|
||||
private LogLevel _level;
|
||||
private string _message;
|
||||
|
||||
#endregion
|
||||
|
||||
#region Internal Constructors
|
||||
|
||||
internal LogData (DateTime date, LogLevel level, StackFrame caller, string message)
|
||||
{
|
||||
_date = date;
|
||||
_level = level;
|
||||
_caller = caller;
|
||||
_message = message;
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region Public Properties
|
||||
|
||||
/// <summary>
|
||||
/// Gets the information of the logging method caller.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// A <see cref="StackFrame"/> that contains the information of a logging method caller.
|
||||
/// </value>
|
||||
public StackFrame Caller {
|
||||
get {
|
||||
return _caller;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the date and time when the log data was created.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// A <see cref="DateTime"/> that contains the date and time when the log data was created.
|
||||
/// </value>
|
||||
public DateTime Date {
|
||||
get {
|
||||
return _date;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the logging level associated with the log data.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// One of the <see cref="LogLevel"/> values that indicates the logging level
|
||||
/// associated with the log data.
|
||||
/// </value>
|
||||
public LogLevel Level {
|
||||
get {
|
||||
return _level;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the message of the log data.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// A <see cref="string"/> that contains the message of a log data.
|
||||
/// </value>
|
||||
public string Message {
|
||||
get {
|
||||
return _message;
|
||||
}
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region Public Methods
|
||||
|
||||
/// <summary>
|
||||
/// Returns a <see cref="string"/> that represents the current <see cref="LogData"/>.
|
||||
/// </summary>
|
||||
/// <returns>
|
||||
/// A <see cref="string"/> that represents the current <see cref="LogData"/>.
|
||||
/// </returns>
|
||||
public override string ToString ()
|
||||
{
|
||||
var header = String.Format ("{0}|{1,-5}|", _date, _level);
|
||||
var method = _caller.GetMethod ();
|
||||
var type = method.DeclaringType;
|
||||
#if DEBUG
|
||||
var lineNum = _caller.GetFileLineNumber ();
|
||||
var headerAndCaller = String.Format ("{0}{1}.{2}:{3}|", header, type.Name, method.Name, lineNum);
|
||||
#else
|
||||
var headerAndCaller = String.Format ("{0}{1}.{2}|", header, type.Name, method.Name);
|
||||
#endif
|
||||
|
||||
var messages = _message.Replace ("\r\n", "\n").TrimEnd ('\n').Split ('\n');
|
||||
if (messages.Length <= 1)
|
||||
return String.Format ("{0}{1}", headerAndCaller, _message);
|
||||
|
||||
var output = new StringBuilder (String.Format ("{0}{1}\n", headerAndCaller, messages [0]), 64);
|
||||
var space = header.Length;
|
||||
var format = String.Format ("{{0,{0}}}{{1}}\n", space);
|
||||
for (var i = 1; i < messages.Length; i++)
|
||||
output.AppendFormat (format, "", messages [i]);
|
||||
|
||||
output.Length--;
|
||||
return output.ToString ();
|
||||
}
|
||||
|
||||
#endregion
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,63 @@
|
||||
#region License
|
||||
/*
|
||||
* LogLevel.cs
|
||||
*
|
||||
* The MIT License
|
||||
*
|
||||
* Copyright (c) 2013 sta.blockhead
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
#endregion
|
||||
|
||||
using System;
|
||||
|
||||
namespace WebSocketSharp {
|
||||
|
||||
/// <summary>
|
||||
/// Contains the values of the logging level.
|
||||
/// </summary>
|
||||
public enum LogLevel {
|
||||
|
||||
/// <summary>
|
||||
/// Indicates the bottom logging level.
|
||||
/// </summary>
|
||||
TRACE,
|
||||
/// <summary>
|
||||
/// Indicates the 2nd logging level from the bottom.
|
||||
/// </summary>
|
||||
DEBUG,
|
||||
/// <summary>
|
||||
/// Indicates the 3rd logging level from the bottom.
|
||||
/// </summary>
|
||||
INFO,
|
||||
/// <summary>
|
||||
/// Indicates the 3rd logging level from the top.
|
||||
/// </summary>
|
||||
WARN,
|
||||
/// <summary>
|
||||
/// Indicates the 2nd logging level from the top.
|
||||
/// </summary>
|
||||
ERROR,
|
||||
/// <summary>
|
||||
/// Indicates the top logging level.
|
||||
/// </summary>
|
||||
FATAL
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,323 @@
|
||||
#region License
|
||||
/*
|
||||
* Logger.cs
|
||||
*
|
||||
* The MIT License
|
||||
*
|
||||
* Copyright (c) 2013 sta.blockhead
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
#endregion
|
||||
|
||||
using System;
|
||||
using System.Diagnostics;
|
||||
using System.IO;
|
||||
|
||||
namespace WebSocketSharp {
|
||||
|
||||
/// <summary>
|
||||
/// Provides the simple logging functions.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// The Logger class provides some methods that output the logs associated with the each
|
||||
/// <see cref="LogLevel"/> values.
|
||||
/// If the <see cref="LogLevel"/> value associated with a log was less than the <see cref="Level"/>,
|
||||
/// the log could not be outputted.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// The default output action used by the output methods outputs the log data to the standard output stream
|
||||
/// and writes the same log data to the <see cref="Logger.File"/> if it has a valid path.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// If you wanted to run your custom output action, you would replace the current output action with
|
||||
/// your output action by using the <see cref="SetOutput"/> method.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public class Logger {
|
||||
|
||||
#region Private Fields
|
||||
|
||||
private volatile string _file;
|
||||
private volatile LogLevel _level;
|
||||
private Action<LogData, string> _output;
|
||||
private object _sync;
|
||||
|
||||
#endregion
|
||||
|
||||
#region Public Constructors
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="Logger"/> class.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This constructor initializes the current logging level with the <see cref="LogLevel.ERROR"/> and
|
||||
/// initializes the path to the log file with <see langword="null"/>.
|
||||
/// </remarks>
|
||||
public Logger ()
|
||||
: this (LogLevel.ERROR, null, defaultOutput)
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="Logger"/> class
|
||||
/// with the specified logging <paramref name="level"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This constructor initializes the path to the log file with <see langword="null"/>.
|
||||
/// </remarks>
|
||||
/// <param name="level">
|
||||
/// One of the <see cref="LogLevel"/> values to initialize.
|
||||
/// </param>
|
||||
public Logger (LogLevel level)
|
||||
: this (level, null, defaultOutput)
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="Logger"/> class
|
||||
/// with the specified logging <paramref name="level"/>, path to the log <paramref name="file"/>
|
||||
/// and <paramref name="output"/> action.
|
||||
/// </summary>
|
||||
/// <param name="level">
|
||||
/// One of the <see cref="LogLevel"/> values to initialize.
|
||||
/// </param>
|
||||
/// <param name="file">
|
||||
/// A <see cref="string"/> that contains a path to the log file to initialize.
|
||||
/// </param>
|
||||
/// <param name="output">
|
||||
/// An <c>Action<LogData, string></c> delegate that references the method(s) to initialize.
|
||||
/// A <see cref="string"/> parameter to pass to the method(s) is the value of <see cref="Logger.File"/>
|
||||
/// if any.
|
||||
/// </param>
|
||||
public Logger (LogLevel level, string file, Action<LogData, string> output)
|
||||
{
|
||||
_level = level;
|
||||
_file = file;
|
||||
if (output != null)
|
||||
_output = output;
|
||||
else
|
||||
_output = defaultOutput;
|
||||
|
||||
_sync = new object ();
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region Public Properties
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the path to the log file.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// A <see cref="string"/> that contains a path to the log file.
|
||||
/// </value>
|
||||
public string File {
|
||||
get {
|
||||
return _file;
|
||||
}
|
||||
|
||||
set {
|
||||
lock (_sync)
|
||||
{
|
||||
_file = value;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the current logging level.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// A log associated with a less than the current logging level can not be outputted.
|
||||
/// </remarks>
|
||||
/// <value>
|
||||
/// One of the <see cref="LogLevel"/> values that indicates the current logging level.
|
||||
/// </value>
|
||||
public LogLevel Level {
|
||||
get {
|
||||
return _level;
|
||||
}
|
||||
|
||||
set {
|
||||
_level = value;
|
||||
}
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region Private Methods
|
||||
|
||||
private static void defaultOutput (LogData data, string path)
|
||||
{
|
||||
var log = data.ToString ();
|
||||
Console.WriteLine (log);
|
||||
if (path != null && path.Length > 0)
|
||||
writeLine (log, path);
|
||||
}
|
||||
|
||||
private void output (LogLevel level, string message)
|
||||
{
|
||||
if (level < _level || message == null || message.Length == 0)
|
||||
return;
|
||||
|
||||
lock (_sync)
|
||||
{
|
||||
LogData data = null;
|
||||
try {
|
||||
data = new LogData (DateTime.Now, level, new StackFrame (2, true), message);
|
||||
_output (data, _file);
|
||||
}
|
||||
catch (Exception ex) {
|
||||
data = new LogData (DateTime.Now, LogLevel.FATAL, new StackFrame (0, true), ex.Message);
|
||||
Console.WriteLine (data.ToString ());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private static void writeLine (string value, string path)
|
||||
{
|
||||
using (var writer = new StreamWriter (path, true))
|
||||
using (var syncWriter = TextWriter.Synchronized (writer))
|
||||
{
|
||||
syncWriter.WriteLine (value);
|
||||
}
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region Public Methods
|
||||
|
||||
/// <summary>
|
||||
/// Outputs the specified <paramref name="message"/> as a log with the <see cref="LogLevel.DEBUG"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This method does not output <paramref name="message"/> as a log
|
||||
/// if the current logging level is greater than the <see cref="LogLevel.DEBUG"/>.
|
||||
/// </remarks>
|
||||
/// <param name="message">
|
||||
/// A <see cref="string"/> that contains a message to output as a log.
|
||||
/// </param>
|
||||
public void Debug (string message)
|
||||
{
|
||||
output (LogLevel.DEBUG, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Outputs the specified <paramref name="message"/> as a log with the <see cref="LogLevel.ERROR"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This method does not output <paramref name="message"/> as a log
|
||||
/// if the current logging level is greater than the <see cref="LogLevel.ERROR"/>.
|
||||
/// </remarks>
|
||||
/// <param name="message">
|
||||
/// A <see cref="string"/> that contains a message to output as a log.
|
||||
/// </param>
|
||||
public void Error (string message)
|
||||
{
|
||||
output (LogLevel.ERROR, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Outputs the specified <paramref name="message"/> as a log with the <see cref="LogLevel.FATAL"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This method does not output <paramref name="message"/> as a log
|
||||
/// if the current logging level is greater than the <see cref="LogLevel.FATAL"/>.
|
||||
/// </remarks>
|
||||
/// <param name="message">
|
||||
/// A <see cref="string"/> that contains a message to output as a log.
|
||||
/// </param>
|
||||
public void Fatal (string message)
|
||||
{
|
||||
output (LogLevel.FATAL, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Outputs the specified <paramref name="message"/> as a log with the <see cref="LogLevel.INFO"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This method does not output <paramref name="message"/> as a log
|
||||
/// if the current logging level is greater than the <see cref="LogLevel.INFO"/>.
|
||||
/// </remarks>
|
||||
/// <param name="message">
|
||||
/// A <see cref="string"/> that contains a message to output as a log.
|
||||
/// </param>
|
||||
public void Info (string message)
|
||||
{
|
||||
output (LogLevel.INFO, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Replaces the current output action with the specified <paramref name="output"/> action.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This method replaces the current output action with the default output action
|
||||
/// if <paramref name="output"/> is <see langword="null"/>.
|
||||
/// </remarks>
|
||||
/// <param name="output">
|
||||
/// An <c>Action<LogData, string></c> delegate that references the method(s) to set.
|
||||
/// A <see cref="string"/> parameter to pass to the method(s) is the value of <see cref="Logger.File"/>
|
||||
/// if any.
|
||||
/// </param>
|
||||
public void SetOutput (Action<LogData, string> output)
|
||||
{
|
||||
lock (_sync)
|
||||
{
|
||||
if (output != null)
|
||||
_output = output;
|
||||
else
|
||||
_output = defaultOutput;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Outputs the specified <paramref name="message"/> as a log with the <see cref="LogLevel.TRACE"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This method does not output <paramref name="message"/> as a log
|
||||
/// if the current logging level is greater than the <see cref="LogLevel.TRACE"/>.
|
||||
/// </remarks>
|
||||
/// <param name="message">
|
||||
/// A <see cref="string"/> that contains a message to output as a log.
|
||||
/// </param>
|
||||
public void Trace (string message)
|
||||
{
|
||||
output (LogLevel.TRACE, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Outputs the specified <paramref name="message"/> as a log with the <see cref="LogLevel.WARN"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This method does not output <paramref name="message"/> as a log
|
||||
/// if the current logging level is greater than the <see cref="LogLevel.WARN"/>.
|
||||
/// </remarks>
|
||||
/// <param name="message">
|
||||
/// A <see cref="string"/> that contains a message to output as a log.
|
||||
/// </param>
|
||||
public void Warn (string message)
|
||||
{
|
||||
output (LogLevel.WARN, message);
|
||||
}
|
||||
|
||||
#endregion
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue