Clog: Client Logging, Silverlight Edition

/*
<File>
	<Copyright>Copyright © 2007, Daniel Vaughan. All rights reserved.</Copyright>
	<License see="prj:///Documentation/License.txt"/>
	<Owner Name="Daniel Vaughan" Email="dbvaughan@gmail.com"/>
	<CreationDate>2007/11/19 20:00</CreationDate>
	<LastSubmissionDate>$Date: $</LastSubmissionDate>
	<Version>$Revision: $</Version>
</File>
*/

using System;
using Orpius.Logging.ClientLogging;

namespace Orpius.Logging
{
	/// <summary>
	/// A log is responsible for sending log messages
	/// the server.
	/// </summary>
	public interface ILog
	{
		/// <summary>
		/// Gets the name of the log.
		/// This is used to filter log entries on the server.
		/// </summary>
		/// <value>The name of this log.</value>
		string Name
		{
			get;
		}

		/// <summary>
		/// Occurs when a log entry is sent to the server.
		/// </summary>
		event EventHandler<LogEventArgs> LogEntrySent;

		/// <summary>
		/// Occurs when any request to log is made.
		/// This will be raised at equal or greater frequency
		/// than the <see cref="LogEntrySent"/> <code>event</code>.
		/// </summary>
		event EventHandler<LogEventArgs> WriteRequested;

		/// <summary>
		/// Writes a log entry at the <see cref="LogLevel.Debug"/>.
		/// </summary>
		/// <param name="message">The message to write.</param>
		void Debug(string message);

		/// <summary>
		/// Writes a log entry at the <see cref="LogLevel.Debug"/>.
		/// </summary>
		/// <param name="message">The message to write.</param>
		/// <param name="exception">The exception that this message 
		/// is regarding.</param>
		void Debug(string message, Exception exception);

		/// <summary>
		/// Writes a log entry at the <see cref="LogLevel.Info"/>.
		/// </summary>
		/// <param name="message">The message to write.</param>
		void Info(string message);

		/// <summary>
		/// Writes a log entry at the <see cref="LogLevel.Info"/>.
		/// </summary>
		/// <param name="message">The message to write.</param>
		/// <param name="exception">The exception that this message 
		/// is regarding.</param>
		void Info(string message, Exception exception);

		/// <summary>
		/// Writes a log entry at the <see cref="LogLevel.Warn"/>.
		/// </summary>
		/// <param name="message">The message to write.</param>
		void Warn(string message);

		/// <summary>
		/// Writes a log entry at the <see cref="LogLevel.Warn"/>.
		/// </summary>
		/// <param name="message">The message to write.</param>
		/// <param name="exception">The exception that this message 
		/// is regarding.</param>
		void Warn(string message, Exception exception);

		/// <summary>
		/// Writes a log entry at the <see cref="LogLevel.Error"/>.
		/// </summary>
		/// <param name="message">The message to write.</param>
		void Error(string message);

		/// <summary>
		/// Writes a log entry at the <see cref="LogLevel.Error"/>.
		/// </summary>
		/// <param name="message">The message to write.</param>
		/// <param name="exception">The exception that this message 
		/// is regarding.</param>
		void Error(string message, Exception exception);

		/// <summary>
		/// Writes a log entry at the <see cref="LogLevel.Fatal"/>.
		/// </summary>
		/// <param name="message">The message to write.</param>
		void Fatal(string message);

		/// <summary>
		/// Writes a log entry at the <see cref="LogLevel.Fatal"/>.
		/// </summary>
		/// <param name="message">The message to write.</param>
		/// <param name="exception">The exception that this message 
		/// is regarding.</param>
		void Fatal(string message, Exception exception);
	}
}