You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
682 lines
32 KiB
XML
682 lines
32 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>SafetyRally.Logger</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:SafetyRally.Logger.SRLogImpl">
|
|
<summary>
|
|
Implementation of <see cref="T:SafetyRally.Logger.ISRLog"/> wrapper interface.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
This logger has methods to allow the caller to log at the following
|
|
levels:
|
|
</para>
|
|
<list type="definition">
|
|
<item>
|
|
<term>DEBUG</term>
|
|
<description>
|
|
The <see cref="M:SafetyRally.Logger.SRLogImpl.Debug(System.Object)"/> and <see cref="M:SafetyRally.Logger.SRLogImpl.DebugFormat(System.String,System.Object[])"/> methods log messages
|
|
at the <c>DEBUG</c> level. The default value for this level is <see cref="F:log4net.Core.Level.Debug"/>.
|
|
The <see cref="P:SafetyRally.Logger.SRLogImpl.IsDebugEnabled"/> property tests if this level is enabled for logging but it's
|
|
also tested insede this method.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>INFO</term>
|
|
<description>
|
|
The <see cref="M:SafetyRally.Logger.SRLogImpl.Info(System.Object)"/> and <see cref="M:SafetyRally.Logger.SRLogImpl.InfoFormat(System.String,System.Object[])"/> methods log messages
|
|
at the <c>INFO</c> level. The default value for this level is <see cref="F:log4net.Core.Level.Info"/>.
|
|
The <see cref="P:SafetyRally.Logger.SRLogImpl.IsInfoEnabled"/> property tests if this level is enabled for logging but it's
|
|
also tested insede this method.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>WARN</term>
|
|
<description>
|
|
The <see cref="M:SafetyRally.Logger.SRLogImpl.Warn(System.Object)"/> and <see cref="M:SafetyRally.Logger.SRLogImpl.WarnFormat(System.String,System.Object[])"/> methods log messages
|
|
at the <c>WARN</c> level. The default value for this level is <see cref="F:log4net.Core.Level.Warn"/>.
|
|
The <see cref="P:SafetyRally.Logger.SRLogImpl.IsWarnEnabled"/> property tests if this level is enabled for logging but it's
|
|
also tested insede this method.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>ERROR</term>
|
|
<description>
|
|
The <see cref="M:SafetyRally.Logger.SRLogImpl.Error(System.Object)"/> and <see cref="M:SafetyRally.Logger.SRLogImpl.ErrorFormat(System.String,System.Object[])"/> methods log messages
|
|
at the <c>ERROR</c> level. The default value for this level is <see cref="F:log4net.Core.Level.Error"/>.
|
|
The <see cref="P:SafetyRally.Logger.SRLogImpl.IsErrorEnabled"/> property tests if this level is enabled for logging but its
|
|
also tested insede this method.
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>FATAL</term>
|
|
<description>
|
|
The <see cref="M:SafetyRally.Logger.SRLogImpl.Fatal(System.Object)"/> and <see cref="M:SafetyRally.Logger.SRLogImpl.FatalFormat(System.String,System.Object[])"/> methods log messages
|
|
at the <c>FATAL</c> level. The default value for this level is <see cref="F:log4net.Core.Level.Fatal"/>.
|
|
The <see cref="P:SafetyRally.Logger.SRLogImpl.IsFatalEnabled"/> property tests if this level is enabled for logging but its
|
|
also tested insede this method.
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</remarks>
|
|
</member>
|
|
<member name="T:SafetyRally.Logger.ISRLog">
|
|
<summary>
|
|
The ISRLog interface is use by application to log messages.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
Use the <see cref="T:SafetyRally.Logger.SRLogManager"/> to obtain logger instances
|
|
that implement this interface. The <see cref="M:SafetyRally.Logger.SRLogManager.GetCommonLogger"/>
|
|
or <see cref="M:SafetyRally.Logger.SRLogManager.GetDeviceLogger(System.String)"/> static methods are used to get logger instances.
|
|
</para>
|
|
<para>
|
|
This class contains methods for logging at different levels and also
|
|
has properties for determining if those logging levels are
|
|
enabled in the current configuration.
|
|
</para>
|
|
<para>
|
|
This interface can be implemented in different ways. This documentation
|
|
specifies reasonable behavior that a caller can expect from the actual
|
|
implementation, however different implementations reserve the right to
|
|
do things differently.
|
|
</para>
|
|
</remarks>
|
|
<example>Simple example of logging messages
|
|
<code lang="C#">
|
|
ISRLog log = SRLogManager.GetCommonLogger("application-log");
|
|
|
|
log.Info("Application Start");
|
|
log.Debug("This is a debug message");
|
|
|
|
</code>
|
|
</example>
|
|
<seealso cref="T:SafetyRally.Logger.SRLogManager"/>
|
|
<seealso cref="M:SafetyRally.Logger.SRLogManager.GetCommonLogger"/>
|
|
<seealso cref="M:SafetyRally.Logger.SRLogManager.GetDeviceLogger(System.String)"/>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.ISRLog.Debug(System.Exception)">
|
|
<summary>
|
|
Log a <see cref="T:System.Exception"/> message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
|
|
the stack trace of the <see cref="T:System.Exception"/> passed
|
|
as a parameter.
|
|
</summary>
|
|
<param name="exception">The exception to log, including its stack trace.</param>
|
|
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.ISRLog.Error(System.Exception)">
|
|
<summary>
|
|
Log a <see cref="T:System.Exception"/> message object with the <see cref="F:log4net.Core.Level.Error"/> level including
|
|
the stack trace of the <see cref="T:System.Exception"/> passed
|
|
as a parameter.
|
|
</summary>
|
|
<param name="exception">The exception to log, including its stack trace.</param>
|
|
<seealso cref="P:log4net.ILog.IsErrorEnabled"/>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.ISRLog.Fatal(System.Exception)">
|
|
<summary>
|
|
Log a <see cref="T:System.Exception"/> message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
|
|
the stack trace of the <see cref="T:System.Exception"/> passed
|
|
as a parameter.
|
|
</summary>
|
|
<param name="exception">The exception to log, including its stack trace.</param>
|
|
<seealso cref="P:log4net.ILog.IsFatalEnabled"/>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.ISRLog.Info(System.Exception)">
|
|
<summary>
|
|
Log a <see cref="T:System.Exception"/> message object with the <see cref="F:log4net.Core.Level.Info"/> level including
|
|
the stack trace of the <see cref="T:System.Exception"/> passed
|
|
as a parameter.
|
|
</summary>
|
|
<param name="exception">The exception to log, including its stack trace.</param>
|
|
<seealso cref="P:log4net.ILog.IsInfoEnabled"/>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.ISRLog.Warn(System.Exception)">
|
|
<summary>
|
|
Log a <see cref="T:System.Exception"/> message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
|
|
the stack trace of the <see cref="T:System.Exception"/> passed
|
|
as a parameter.
|
|
</summary>
|
|
<param name="exception">The exception to log, including its stack trace.</param>
|
|
<seealso cref="P:log4net.ILog.IsWarnEnabled"/>
|
|
</member>
|
|
<member name="P:SafetyRally.Logger.ISRLog.DebugEnabled">
|
|
<summary>
|
|
Gets/ Sets if the logger should record the <see cref="F:log4net.Core.Level.Debug"/> level events.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SafetyRally.Logger.SRLogImpl"/> class.
|
|
</summary>
|
|
<param name="logName">Name of the logger.</param>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.Debug(System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.Debug(System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.Debug(System.Exception)">
|
|
<summary>
|
|
<see cref="M:SafetyRally.Logger.ISRLog.Debug(System.Exception)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.Debug(System.Object,System.Exception)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.Debug(System.Object,System.Exception)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.DebugFormat(System.IFormatProvider,System.String,System.Object[])"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.DebugFormat(System.String,System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.DebugFormat(System.String,System.Object,System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.DebugFormat(System.String,System.Object,System.Object,System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object,System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.DebugFormat(System.String,System.Object[])">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object[])"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.Error(System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.Error(System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.Error(System.Exception)">
|
|
<summary>
|
|
<see cref="M:SafetyRally.Logger.ISRLog.Error(System.Exception)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.Error(System.Object,System.Exception)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.Error(System.Object,System.Exception)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.ErrorFormat(System.IFormatProvider,System.String,System.Object[])"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.ErrorFormat(System.String,System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.ErrorFormat(System.String,System.Object,System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object,System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.ErrorFormat(System.String,System.Object[])">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object[])"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.Fatal(System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.Fatal(System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.Fatal(System.Exception)">
|
|
<summary>
|
|
<see cref="M:SafetyRally.Logger.ISRLog.Fatal(System.Exception)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.Fatal(System.Object,System.Exception)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.Fatal(System.Object,System.Exception)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.FatalFormat(System.IFormatProvider,System.String,System.Object[])"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.FatalFormat(System.String,System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.FatalFormat(System.String,System.Object,System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.FatalFormat(System.String,System.Object,System.Object,System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object,System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.FatalFormat(System.String,System.Object[])">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object[])"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.Info(System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.Info(System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.Info(System.Exception)">
|
|
<summary>
|
|
<see cref="M:SafetyRally.Logger.ISRLog.Info(System.Exception)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.Info(System.Object,System.Exception)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.Info(System.Object,System.Exception)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.InfoFormat(System.IFormatProvider,System.String,System.Object[])"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.InfoFormat(System.String,System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.InfoFormat(System.String,System.Object,System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.InfoFormat(System.String,System.Object,System.Object,System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object,System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.InfoFormat(System.String,System.Object[])">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object[])"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.Warn(System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.Warn(System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.Warn(System.Exception)">
|
|
<summary>
|
|
<see cref="M:SafetyRally.Logger.ISRLog.Warn(System.Exception)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.Warn(System.Object,System.Exception)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.Warn(System.Object,System.Exception)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.WarnFormat(System.IFormatProvider,System.String,System.Object[])"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.WarnFormat(System.String,System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.WarnFormat(System.String,System.Object,System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.WarnFormat(System.String,System.Object,System.Object,System.Object)">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object,System.Object)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogImpl.WarnFormat(System.String,System.Object[])">
|
|
<summary>
|
|
<see cref="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object[])"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:SafetyRally.Logger.SRLogImpl.DebugEnabled">
|
|
<summary>
|
|
<see cref="P:SafetyRally.Logger.ISRLog.DebugEnabled"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:SafetyRally.Logger.SRLogImpl.IsDebugEnabled">
|
|
<summary>
|
|
<see cref="P:log4net.ILog.IsDebugEnabled"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:SafetyRally.Logger.SRLogImpl.IsErrorEnabled">
|
|
<summary>
|
|
<see cref="P:log4net.ILog.IsErrorEnabled"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:SafetyRally.Logger.SRLogImpl.IsFatalEnabled">
|
|
<summary>
|
|
<see cref="P:log4net.ILog.IsFatalEnabled"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:SafetyRally.Logger.SRLogImpl.IsInfoEnabled">
|
|
<summary>
|
|
<see cref="P:log4net.ILog.IsInfoEnabled"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:SafetyRally.Logger.SRLogImpl.IsWarnEnabled">
|
|
<summary>
|
|
<see cref="P:log4net.ILog.IsWarnEnabled"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:SafetyRally.Logger.SRLogImpl.Logger">
|
|
<summary>
|
|
<see cref="T:log4net.Core.ILoggerWrapper"/>
|
|
</summary>
|
|
</member>
|
|
<member name="T:SafetyRally.Logger.SRLogManager">
|
|
<summary>
|
|
This class is used by client applications to request logger instances.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
This class has static methods that are used by a client to request
|
|
a logger instance. The <see cref="M:SafetyRally.Logger.SRLogManager.GetCommonLogger"/> and <see cref="M:SafetyRally.Logger.SRLogManager.GetDeviceLogger(System.String)"/> methods are
|
|
used to retrieve a logger.
|
|
</para>
|
|
<para>
|
|
See the <see cref="T:SafetyRally.Logger.ISRLog"/> interface for more details.
|
|
</para>
|
|
</remarks>
|
|
<example>Simple example of logging messages
|
|
<code lang="C#">
|
|
ISRLog log = SRLogManager.GetCommonLogger("application-log");
|
|
|
|
log.Info("Application Start");
|
|
log.Debug("This is a debug message");
|
|
|
|
</code>
|
|
</example>
|
|
<threadsafety static="true" instance="true"/>
|
|
<seealso cref="T:SafetyRally.Logger.ISRLog"/>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogManager.#cctor">
|
|
<summary>
|
|
Initializes all the SRLogManager data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogManager.BuildConfig(System.String,SafetyRally.Logger.SRLogManager.LoggerConfigType)">
|
|
<summary>
|
|
Builds a xml configuration based in the logger name and config type.
|
|
</summary>
|
|
<param name="loggerName">Name of the requested logger.</param>
|
|
<param name="configType">Configuration type.</param>
|
|
<returns>XmlElement with the configuration.</returns>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogManager.GetLogger(System.String,SafetyRally.Logger.SRLogManager.LoggerConfigType)">
|
|
<summary>
|
|
Gets a logger with a specified name.
|
|
</summary>
|
|
<param name="loggerName">Name of the logger to get.</param>
|
|
<param name="configType">Type of configuration to use to create the logger.</param>
|
|
<returns>The requested logger.</returns>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogManager.GetCommonLogger">
|
|
<summary>
|
|
Gets a common logger.
|
|
</summary>
|
|
<returns>The requested common logger.</returns>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.SRLogManager.GetDeviceLogger(System.String)">
|
|
<summary>
|
|
Gets a device logger with a specified name.
|
|
</summary>
|
|
<param name="loggerName">Name of the logger to get.</param>
|
|
<returns>The requested device logger.</returns>
|
|
</member>
|
|
<member name="T:SafetyRally.Logger.SRLogManager.LoggerConfigType">
|
|
<summary>
|
|
Logger Configuration Type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:SafetyRally.Logger.SRLogManager.LoggerConfigType.CommonConfig">
|
|
<summary>
|
|
Common configuration.
|
|
</summary>
|
|
</member>
|
|
<member name="F:SafetyRally.Logger.SRLogManager.LoggerConfigType.DeviceConfig">
|
|
<summary>
|
|
Configuration especific for a device.
|
|
</summary>
|
|
</member>
|
|
<member name="T:SafetyRally.Logger.Layout.SRXmlLayout">
|
|
<summary>
|
|
Layout that formats the log events as XML elements.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
The output of the <see cref="T:SafetyRally.Logger.Layout.SRXmlLayout"/> consists of a series of
|
|
log4net:event elements. It does not output a complete well-formed XML
|
|
file. The output is designed to be included as an <em>external entity</em>
|
|
in a separate file to form a correct XML file.
|
|
This approach enforces the independence of the <see cref="T:SafetyRally.Logger.Layout.SRXmlLayout"/>
|
|
and the appender where it is embedded.
|
|
</para>
|
|
<para>
|
|
The <c>version</c> attribute helps components to correctly
|
|
interpret output generated by <see cref="T:SafetyRally.Logger.Layout.SRXmlLayout"/>. The value of
|
|
this attribute should be "1.2" for release 1.2 and later.
|
|
</para>
|
|
<para>
|
|
Alternatively the <c>Header</c> and <c>Footer</c> properties can be
|
|
configured to output the correct XML header, open tag and close tag.
|
|
When setting the <c>Header</c> and <c>Footer</c> properties it is essential
|
|
that the underlying data store not be appendable otherwise the data
|
|
will become invalid XML.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:SafetyRally.Logger.Layout.SRXmlLayout.m_protectCloseTextWriter">
|
|
<summary>
|
|
Writer adapter that ignores Close
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.Layout.SRXmlLayout.#ctor">
|
|
<summary>
|
|
Constructs an SRXmlLayout
|
|
</summary>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.Layout.SRXmlLayout.#ctor(System.Boolean)">
|
|
<summary>
|
|
Constructs an SRXmlLayout.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
The <b>LocationInfo</b> option takes a boolean value. By
|
|
default, it is set to false which means there will be no location
|
|
information output by this layout. If the the option is set to
|
|
true, then the file name and line number of the statement
|
|
at the origin of the log statement will be output.
|
|
</para>
|
|
<para>
|
|
If you are embedding this layout within an SmtpAppender
|
|
then make sure to set the <b>LocationInfo</b> option of that
|
|
appender as well.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.Layout.SRXmlLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
|
|
<summary>
|
|
Produces a formatted string.
|
|
</summary>
|
|
<param name="loggingEvent">The event being logged.</param>
|
|
<param name="writer">The TextWriter to write the formatted event to</param>
|
|
<remarks>
|
|
<para>
|
|
Format the <see cref="T:log4net.Core.LoggingEvent"/> and write it to the <see cref="T:System.IO.TextWriter"/>.
|
|
</para>
|
|
<para>
|
|
This method creates an <see cref="T:System.Xml.XmlTextWriter"/> that writes to the
|
|
<paramref name="writer"/>. The <see cref="T:System.Xml.XmlTextWriter"/> is passed
|
|
to the <see cref="M:SafetyRally.Logger.Layout.SRXmlLayout.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method. Subclasses should override the
|
|
<see cref="M:SafetyRally.Logger.Layout.SRXmlLayout.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method rather than this method.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SafetyRally.Logger.Layout.SRXmlLayout.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
|
|
<summary>
|
|
Does the actual writing of the XML.
|
|
</summary>
|
|
<param name="writer">The writer to use to output the event to.</param>
|
|
<param name="loggingEvent">The event to write.</param>
|
|
<remarks>
|
|
<para>
|
|
Override the base class <see cref="M:log4net.Layout.XmlLayout.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method
|
|
to write the <see cref="T:log4net.Core.LoggingEvent"/> to the <see cref="T:System.Xml.XmlWriter"/>.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SafetyRally.Logger.Layout.SRXmlLayout.ShowTimeStamp">
|
|
<summary>
|
|
Gets/Sets a value indicating whether to include the <b>TimeStamp</b> in
|
|
the XML events.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the <b>TimeStamp</b> should be included in the XML
|
|
events; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>
|
|
<para>
|
|
If <b>ShowTimeStamp</b> is set to <c>true</c>, then the timestamp of the
|
|
event will be output.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SafetyRally.Logger.Layout.SRXmlLayout.ShowLevel">
|
|
<summary>
|
|
Gets/Sets a value indicating whether to include the <b>Level</b> in
|
|
the XML events.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the <b>Level</b> should be included in the XML
|
|
events; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>
|
|
<para>
|
|
If <b>ShowLevel</b> is set to <c>true</c>, then the level of the
|
|
event will be output.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SafetyRally.Logger.Layout.SRXmlLayout.ShowThread">
|
|
<summary>
|
|
Gets/Sets a value indicating whether to include the <b>Thread Name</b> in
|
|
the XML events.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the <b>Thread Name</b> should be included in the XML
|
|
events; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>
|
|
<para>
|
|
If <b>ShowThread</b> is set to <c>true</c>, then the thread name of the
|
|
event will be output.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SafetyRally.Logger.Layout.SRXmlLayout.ShowIdentity">
|
|
<summary>
|
|
Gets/Sets a value indicating whether to include the <b>Identity</b> in
|
|
the XML events.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the <b>Identity</b> should be included in the XML
|
|
events; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>
|
|
<para>
|
|
If <b>ShowIdentity</b> is set to <c>true</c>, then the identity of the
|
|
event will be output.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SafetyRally.Logger.Layout.SRXmlLayout.ShowDomain">
|
|
<summary>
|
|
Gets/Sets a value indicating whether to include the <b>Domain</b> in
|
|
the XML events.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the <b>Domain</b> should be included in the XML
|
|
events; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>
|
|
<para>
|
|
If <b>ShowDomain</b> is set to <c>true</c>, then the domain of the
|
|
event will be output.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SafetyRally.Logger.Layout.SRXmlLayout.ShowUserName">
|
|
<summary>
|
|
Gets/Sets a value indicating whether to include the <b>UserName</b> in
|
|
the XML events.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the <b>UserName</b> should be included in the XML
|
|
events; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>
|
|
<para>
|
|
If <b>ShowUserName</b> is set to <c>true</c>, then the username of the
|
|
event will be output.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SafetyRally.Logger.Layout.SRXmlLayout.ShowProperties">
|
|
<summary>
|
|
Gets/Sets a value indicating whether to include the <b>Properties</b> in
|
|
the XML events.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the <b>Properties</b> should be included in the XML
|
|
events; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>
|
|
<para>
|
|
If <b>ShowProperties</b> is set to <c>true</c>, then the properties of the
|
|
event will be output.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SafetyRally.Logger.Layout.SRXmlLayout.IndentXml">
|
|
<summary>
|
|
Gets/Sets a value indicating whether to <b>Indent</b> the XML output in
|
|
the XML events.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if identation should be used in the XML
|
|
events; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>
|
|
<para>
|
|
If <b>IndentXml</b> is set to <c>true</c>, then the output will be indented.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
</members>
|
|
</doc>
|