diff --git a/ClickForensics.Quartz.Manager/ClickForensics.Quartz.Manager.csproj b/ClickForensics.Quartz.Manager/ClickForensics.Quartz.Manager.csproj index 13792dd..60fc80b 100644 --- a/ClickForensics.Quartz.Manager/ClickForensics.Quartz.Manager.csproj +++ b/ClickForensics.Quartz.Manager/ClickForensics.Quartz.Manager.csproj @@ -51,16 +51,20 @@ 4 - + False - ..\packages\Common.Logging.2.1.2\lib\net40\Common.Logging.dll + ..\packages\Common.Logging.3.1.0\lib\net40\Common.Logging.dll - - ..\packages\log4net.1.2.10\lib\2.0\log4net.dll + + ..\packages\Common.Logging.Core.3.1.0\lib\net40\Common.Logging.Core.dll - + False - ..\packages\Quartz.2.2\lib\net40\Quartz.dll + ..\packages\log4net.2.0.3\lib\net40-full\log4net.dll + + + False + ..\packages\Quartz.2.3.2\lib\net40\Quartz.dll diff --git a/ClickForensics.Quartz.Manager/app.config b/ClickForensics.Quartz.Manager/app.config index e365603..6071081 100644 --- a/ClickForensics.Quartz.Manager/app.config +++ b/ClickForensics.Quartz.Manager/app.config @@ -1,3 +1,16 @@ - - - + + + + + + + + + + + + + + + + diff --git a/ClickForensics.Quartz.Manager/packages.config b/ClickForensics.Quartz.Manager/packages.config index 94e8c3d..df6191f 100644 --- a/ClickForensics.Quartz.Manager/packages.config +++ b/ClickForensics.Quartz.Manager/packages.config @@ -1,6 +1,7 @@  - - - + + + + \ No newline at end of file diff --git a/packages/Common.Logging.2.1.2/Common.Logging.2.1.2.nupkg b/packages/Common.Logging.2.1.2/Common.Logging.2.1.2.nupkg deleted file mode 100644 index 80ffdfd..0000000 Binary files a/packages/Common.Logging.2.1.2/Common.Logging.2.1.2.nupkg and /dev/null differ diff --git a/packages/Common.Logging.2.1.2/Common.Logging.2.1.2.nuspec b/packages/Common.Logging.2.1.2/Common.Logging.2.1.2.nuspec deleted file mode 100644 index 39f5300..0000000 --- a/packages/Common.Logging.2.1.2/Common.Logging.2.1.2.nuspec +++ /dev/null @@ -1,13 +0,0 @@ - - - - Common.Logging - 2.1.2 - Aleksandar Seovic, Mark Pollack, Erich Eichinger, Stephen Bohlen - Aleksandar Seovic, Mark Pollack, Erich Eichinger, Stephen Bohlen - http://netcommon.sourceforge.net/ - false - Common.Logging library introduces a simple abstraction to allow you to select a specific logging implementation at runtime. - en-US - - \ No newline at end of file diff --git a/packages/Common.Logging.2.1.2/lib/net35/Common.Logging.dll b/packages/Common.Logging.2.1.2/lib/net35/Common.Logging.dll deleted file mode 100644 index 0c35fd3..0000000 Binary files a/packages/Common.Logging.2.1.2/lib/net35/Common.Logging.dll and /dev/null differ diff --git a/packages/Common.Logging.2.1.2/lib/net35/Common.Logging.pdb b/packages/Common.Logging.2.1.2/lib/net35/Common.Logging.pdb deleted file mode 100644 index d26b618..0000000 Binary files a/packages/Common.Logging.2.1.2/lib/net35/Common.Logging.pdb and /dev/null differ diff --git a/packages/Common.Logging.2.1.2/lib/net40/Common.Logging.dll b/packages/Common.Logging.2.1.2/lib/net40/Common.Logging.dll deleted file mode 100644 index d5a9c97..0000000 Binary files a/packages/Common.Logging.2.1.2/lib/net40/Common.Logging.dll and /dev/null differ diff --git a/packages/Common.Logging.2.1.2/lib/net40/Common.Logging.pdb b/packages/Common.Logging.2.1.2/lib/net40/Common.Logging.pdb deleted file mode 100644 index c0a1bda..0000000 Binary files a/packages/Common.Logging.2.1.2/lib/net40/Common.Logging.pdb and /dev/null differ diff --git a/packages/Common.Logging.2.1.2/lib/net40/Common.Logging.xml b/packages/Common.Logging.3.1.0/lib/net35/Common.Logging.xml similarity index 72% rename from packages/Common.Logging.2.1.2/lib/net40/Common.Logging.xml rename to packages/Common.Logging.3.1.0/lib/net35/Common.Logging.xml index 66da79a..112ff13 100644 --- a/packages/Common.Logging.2.1.2/lib/net40/Common.Logging.xml +++ b/packages/Common.Logging.3.1.0/lib/net35/Common.Logging.xml @@ -4,370 +4,431 @@ Common.Logging - - - This assembly contains the core functionality of the Common.Logging framework. - In particular, checkout and for usage information. - - - - - Provides base implementation suitable for almost all logger adapters - - Erich Eichinger - - + - A simple logging interface abstracting logging APIs. + Indicates classes or members to be ignored by NCover - - Implementations should defer calling a message's until the message really needs - to be logged to avoid performance penalties. - - - Each log method offers to pass in a instead of the actual message. - Using this style has the advantage to defer possibly expensive message argument evaluation and formatting (and formatting arguments!) until the message gets - actually logged. If the message is not logged at all (e.g. due to settings), - you won't have to pay the peformance penalty of creating the message. - + Note, the key is chosen, because TestDriven.NET uses it as //ea argument to "Test With... Coverage" - - The example below demonstrates using callback style for creating the message, where the call to the - and the underlying only happens, if level is enabled: - - Log.Debug( m=>m("result is {0}", random.NextDouble()) ); - Log.Debug(delegate(m) { m("result is {0}", random.NextDouble()); }); - - - - Mark Pollack - Bruno Baia Erich Eichinger - + - Log a message object with the level. + The exception that is thrown when a configuration system error has occurred with Common.Logging - The message object to log. + Mark Pollack + + + Creates a new instance of the ObjectsException class. - + - Log a message object with the level including - the stack trace of the passed - as a parameter. + Creates a new instance of the ConfigurationException class. with the specified message. - The message object to log. - The exception to log, including its stack trace. + + A message about the exception. + - + - Log a message with the level. + Creates a new instance of the ConfigurationException class with the specified message + and root cause. - The format of the message object to log. - the list of format arguments + + A message about the exception. + + + The root exception that is being wrapped. + - + - Log a message with the level. + Creates a new instance of the ConfigurationException class. - The format of the message object to log. - The exception to log. - the list of format arguments + + The + that holds the serialized object data about the exception being thrown. + + + The + that contains contextual information about the source or destination. + - + - Log a message with the level. + Various utility methods for using during factory and logger instance configuration - An that supplies culture-specific formatting information. - The format of the message object to log. - + Erich Eichinger - + - Log a message with the level. + Initialize all members before any of this class' methods can be accessed (avoids beforeFieldInit) - An that supplies culture-specific formatting information. - The format of the message object to log. - The exception to log. - - + - Log a message with the level using a callback to obtain the message + Adds the parser to the list of known type parsers. - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. + .NET intrinsic types are pre-registerd: short, int, long, float, double, decimal, bool - A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Retrieves the named value from the specified . - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack trace. + may be null + the value's key + if is not null, the value returned by values[key]. null otherwise. - + - Log a message with the level using a callback to obtain the message + Retrieves the named value from the specified . + + may be null + the value's key + the default value, if not found + if is not null, the value returned by values[key]. null otherwise. + + + + Returns the first nonnull, nonempty value among its arguments. - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. + Returns null, if the initial list was null or empty. - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched + - + - Log a message with the level using a callback to obtain the message + Returns the first nonnull, nonempty value among its arguments. - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. + Also - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack trace. - + - Log a message object with the level. + Tries parsing into an enum of the type of . - The message object to log. + the default value to return if parsing fails + the string value to parse + the successfully parsed value, otherwise. - + - Log a message object with the level including - the stack trace of the passed - as a parameter. + Tries parsing into the specified return type. - The message object to log. - The exception to log, including its stack trace. + the default value to return if parsing fails + the string value to parse + the successfully parsed value, otherwise. - + - Log a message with the level. + Throws a if is null. - The format of the message object to log. - the list of format arguments - + - Log a message with the level. + Throws a if is null. - The format of the message object to log. - The exception to log. - the list of format arguments - + - Log a message with the level. + Throws a if an object of type is not + assignable to type . - An that supplies culture-specific formatting information. - The format of the message object to log. - - + - Log a message with the level. + Throws a if an object of type is not + assignable to type . - An that supplies culture-specific formatting information. - The format of the message object to log. - The exception to log. - - + - Log a message with the level using a callback to obtain the message + Ensures any exception thrown by the given is wrapped with an + . - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. + If already throws a ConfigurationException, it will not be wrapped. - A callback used by the logger to obtain the message if log level is matched + the action to execute + the message to be set on the thrown + args to be passed to to format the message - + - Log a message with the level using a callback to obtain the message + Ensures any exception thrown by the given is wrapped with an + . - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. + If already throws a ConfigurationException, it will not be wrapped. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack trace. + the action to execute + the message to be set on the thrown + args to be passed to to format the message - + - Log a message with the level using a callback to obtain the message + A delegate converting a string representation into the target type - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + An anonymous action delegate with no arguments and no return value. - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Debug. + - + - Log a message object with the level. + An anonymous action delegate with no arguments and no return value. - The message object to log. + - + - Log a message object with the level including - the stack trace of the passed - as a parameter. + Implementation of that uses the standard .NET + configuration APIs, ConfigurationSettings in 1.x and ConfigurationManager in 2.0 - The message object to log. - The exception to log, including its stack trace. + Mark Pollack - + - Log a message with the level. + Parses the configuration section and returns the resulting object. + Using the System.Configuration.ConfigurationManager - The format of the message object to log. - the list of format arguments + Name of the configuration section. + + Object created by a corresponding IConfigurationSectionHandler" + + +

+ Primary purpose of this method is to allow us to parse and + load configuration sections using the same API regardless + of the .NET framework version. +

+ - + - Log a message with the level. + Container used to hold configuration information from config file. - The format of the message object to log. - The exception to log. - the list of format arguments + Gilles Bayon - + - Log a message with the level. + - An that supplies culture-specific formatting information. - The format of the message object to log. - + + The type + that will be used for creating + + + Additional user supplied properties that are passed to the + 's constructor. + - + - Log a message with the level. + The type that will be used for creating + instances. - An that supplies culture-specific formatting information. - The format of the message object to log. - The exception to log. - - + - Log a message with the level using a callback to obtain the message + Additional user supplied properties that are passed to the 's constructor. - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Substitute NameValueCollection in System.Collections.Specialized. - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack trace. - + - Log a message with the level using a callback to obtain the message + Creates a new instance of NameValueCollection. + + + + + Gets the values (only a single one) for the specified key (configuration name) + + The key. + an array with one value, or null if no value exist + + + + Gets or sets the value with the specified key. + + + The value corrsponding to the key, or null if no value exist + + The key. + value store for the key + + + + Helper class for working with NameValueCollection + + + + + Convert a into the corresponding + common logging equivalent + + The properties. + + + + + An implementation of that caches loggers handed out by this factory. - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. + Implementors just need to override . - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched + Erich Eichinger - + - Log a message with the level using a callback to obtain the message + Creates a new instance, the logger cache being case-sensitive. + + + + + Creates a new instance, the logger cache being . + + + + + + Purges all loggers from cache + + + + + Create the specified named logger instance - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. + Derived factories need to implement this method to create the + actual logger instance. - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Info. - + - Log a message object with the level. + Get a ILog instance by . + + Usually the of the current class. + + An ILog instance either obtained from the internal cache or created by a call to . + + + + + Get a ILog instance by key. + + Usually a 's Name or FullName property. + + An ILog instance either obtained from the internal cache or created by a call to . + + + + + Get or create a ILog instance by key. + + Usually a 's Name or FullName property. + + An ILog instance either obtained from the internal cache or created by a call to . + + + + + Provides base implementation suitable for almost all logger adapters + + Erich Eichinger + + + + Holds the method for writing a message to the log system. + + + + + Creates a new logger instance using for + writing log events to the underlying log system. + + + + + + Override this method to use a different method than + for writing log events to the underlying log system. + + + Usually you don't need to override thise method. The default implementation returns + null to indicate that the default handler should be + used. + + + + + Actually sends the message to the underlying log system. + + the level of this log event. + the message to log + the exception to log (may be null) + + + + Log a message object with the level. The message object to log. - + - Log a message object with the level including + Log a message object with the level including the stack trace of the passed as a parameter. The message object to log. The exception to log, including its stack trace. - + - Log a message with the level. + Log a message with the level. + An that supplies culture-specific formatting information. The format of the message object to log. - the list of format arguments + - + - Log a message with the level. + Log a message with the level. + An that supplies culture-specific formatting information. The format of the message object to log. The exception to log. - the list of format arguments + - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. The format of the message object to log. - + the list of format arguments - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. The format of the message object to log. The exception to log. - + the list of format arguments - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -375,9 +436,9 @@ A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -386,9 +447,9 @@ A callback used by the logger to obtain the message if log level is matched The exception to log, including its stack trace. - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -397,9 +458,9 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -407,58 +468,58 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Warn. + The exception to log, including its stack trace. - + - Log a message object with the level. + Log a message object with the level. The message object to log. - + - Log a message object with the level including - the stack trace of the passed + Log a message object with the level including + the stack Debug of the passed as a parameter. The message object to log. - The exception to log, including its stack trace. + The exception to log, including its stack Debug. - + - Log a message with the level. + Log a message with the level. + An that supplies culture-specific formatting information. The format of the message object to log. - the list of format arguments + - + - Log a message with the level. + Log a message with the level. + An that supplies culture-specific formatting information. The format of the message object to log. The exception to log. - the list of format arguments + - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. The format of the message object to log. - + the list of format arguments - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. The format of the message object to log. The exception to log. - + the list of format arguments - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -466,20 +527,20 @@ A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments that probably won't be logged due to loglevel settings. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack trace. + The exception to log, including its stack Debug. - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -488,9 +549,9 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -498,58 +559,58 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Error. + The exception to log, including its stack Debug. - + - Log a message object with the level. + Log a message object with the level. The message object to log. - + - Log a message object with the level including - the stack trace of the passed + Log a message object with the level including + the stack Info of the passed as a parameter. The message object to log. - The exception to log, including its stack trace. + The exception to log, including its stack Info. - + - Log a message with the level. + Log a message with the level. + An that supplies culture-specific formatting information. The format of the message object to log. - the list of format arguments + - + - Log a message with the level. + Log a message with the level. + An that supplies culture-specific formatting information. The format of the message object to log. The exception to log. - the list of format arguments + - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. The format of the message object to log. - + the list of format arguments - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. The format of the message object to log. The exception to log. - + the list of format arguments - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -557,20 +618,20 @@ A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments that probably won't be logged due to loglevel settings. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack trace. + The exception to log, including its stack Info. - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -579,9 +640,9 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -589,119 +650,58 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Fatal. + The exception to log, including its stack Info. - + - Checks if this logger is enabled for the level. - - - - - Checks if this logger is enabled for the level. - - - - - Checks if this logger is enabled for the level. - - - - - Checks if this logger is enabled for the level. - - - - - Checks if this logger is enabled for the level. - - - - - Checks if this logger is enabled for the level. - - - - - Holds the method for writing a message to the log system. - - - - - Creates a new logger instance using for - writing log events to the underlying log system. - - - - - - Override this method to use a different method than - for writing log events to the underlying log system. - - - Usually you don't need to override thise method. The default implementation returns - null to indicate that the default handler should be - used. - - - - - Actually sends the message to the underlying log system. - - the level of this log event. - the message to log - the exception to log (may be null) - - - - Log a message object with the level. + Log a message object with the level. The message object to log. - + - Log a message object with the level including - the stack trace of the passed + Log a message object with the level including + the stack Warn of the passed as a parameter. The message object to log. - The exception to log, including its stack trace. + The exception to log, including its stack Warn. - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Warnrmation. The format of the message object to log. - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Warnrmation. The format of the message object to log. The exception to log. - + - Log a message with the level. + Log a message with the level. The format of the message object to log. the list of format arguments - + - Log a message with the level. + Log a message with the level. The format of the message object to log. The exception to log. the list of format arguments - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -709,20 +709,20 @@ A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments that probably won't be logged due to loglevel settings. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack trace. + The exception to log, including its stack Warn. - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -731,9 +731,9 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -741,58 +741,58 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack trace. + The exception to log, including its stack Warn. - + - Log a message object with the level. + Log a message object with the level. The message object to log. - + - Log a message object with the level including - the stack Debug of the passed + Log a message object with the level including + the stack Error of the passed as a parameter. The message object to log. - The exception to log, including its stack Debug. + The exception to log, including its stack Error. - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Errorrmation. The format of the message object to log. - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Errorrmation. The format of the message object to log. The exception to log. - + - Log a message with the level. + Log a message with the level. The format of the message object to log. the list of format arguments - + - Log a message with the level. + Log a message with the level. The format of the message object to log. The exception to log. the list of format arguments - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -800,20 +800,20 @@ A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments that probably won't be logged due to loglevel settings. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Debug. + The exception to log, including its stack Error. - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -822,9 +822,9 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -832,58 +832,58 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Debug. + The exception to log, including its stack Error. - + - Log a message object with the level. + Log a message object with the level. The message object to log. - + - Log a message object with the level including - the stack Info of the passed + Log a message object with the level including + the stack Fatal of the passed as a parameter. The message object to log. - The exception to log, including its stack Info. + The exception to log, including its stack Fatal. - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Fatalrmation. The format of the message object to log. - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Fatalrmation. The format of the message object to log. The exception to log. - + - Log a message with the level. + Log a message with the level. The format of the message object to log. the list of format arguments - + - Log a message with the level. + Log a message with the level. The format of the message object to log. The exception to log. the list of format arguments - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -891,20 +891,20 @@ A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments that probably won't be logged due to loglevel settings. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Info. + The exception to log, including its stack Fatal. - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -913,9 +913,9 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -923,466 +923,321 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Info. + The exception to log, including its stack Fatal. - + - Log a message object with the level. + Checks if this logger is enabled for the level. - The message object to log. + + Override this in your derived class to comply with the underlying logging system + - + - Log a message object with the level including - the stack Warn of the passed - as a parameter. + Checks if this logger is enabled for the level. - The message object to log. - The exception to log, including its stack Warn. + + Override this in your derived class to comply with the underlying logging system + - + - Log a message with the level. + Checks if this logger is enabled for the level. - An that supplies culture-specific formatting Warnrmation. - The format of the message object to log. - + + Override this in your derived class to comply with the underlying logging system + - + - Log a message with the level. + Checks if this logger is enabled for the level. - An that supplies culture-specific formatting Warnrmation. - The format of the message object to log. - The exception to log. - + + Override this in your derived class to comply with the underlying logging system + - + - Log a message with the level. + Checks if this logger is enabled for the level. - The format of the message object to log. - the list of format arguments - - - - Log a message with the level. - - The format of the message object to log. - The exception to log. - the list of format arguments + + Override this in your derived class to comply with the underlying logging system + - + - Log a message with the level using a callback to obtain the message + Checks if this logger is enabled for the level. - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. + Override this in your derived class to comply with the underlying logging system - A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Returns the global context for variables - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Warn. - + - Log a message with the level using a callback to obtain the message + Returns the thread-specific context for variables - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Format message on demand. - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Warn. - + - Log a message object with the level. + Initializes a new instance of the class. - The message object to log. + The format message callback. - + - Log a message object with the level including - the stack Error of the passed - as a parameter. + Initializes a new instance of the class. - The message object to log. - The exception to log, including its stack Error. + The format provider. + The format message callback. - + - Log a message with the level. + Calls and returns result. - An that supplies culture-specific formatting Errorrmation. - The format of the message object to log. - + - + - Log a message with the level. + Format string on demand. - An that supplies culture-specific formatting Errorrmation. - The format of the message object to log. - The exception to log. - - + - Log a message with the level. + Initializes a new instance of the class. - The format of the message object to log. - the list of format arguments + The format provider. + The message. + The args. - + - Log a message with the level. + Runs on supplied arguemnts. - The format of the message object to log. - The exception to log. - the list of format arguments + string - + - Log a message with the level using a callback to obtain the message + Represents a method responsible for writing a message to the log system. + + + + + Use the LogManager's or + methods to obtain instances for logging. - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. + For configuring the underlying log system using application configuration, see the example + at System.Configuration.ConfigurationManager + For configuring programmatically, see the example section below. - A callback used by the logger to obtain the message if log level is matched + + The example below shows the typical use of LogManager to obtain a reference to a logger + and log an exception: + + + ILog log = LogManager.GetLogger(this.GetType()); + ... + try + { + /* .... */ + } + catch(Exception ex) + { + log.ErrorFormat("Hi {0}", ex, "dude"); + } + + + The example below shows programmatic configuration of the underlying log system: + + + // create properties + NameValueCollection properties = new NameValueCollection(); + properties["showDateTime"] = "true"; + + // set Adapter + Common.Logging.LogManager.Adapter = new + Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter(properties); + + + + + + + Gilles Bayon - + - Log a message with the level using a callback to obtain the message + Performs static 1-time init of LogManager by calling + + + + + Reset the infrastructure to its default settings. This means, that configuration settings + will be re-read from section <common/logging> of your app.config. - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. + This is mainly used for unit testing, you wouldn't normally use this in your applications.
+ Note: instances already handed out from this LogManager are not(!) affected. + Resetting LogManager only affects new instances being handed out. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Error. - + - Log a message with the level using a callback to obtain the message + Reset the infrastructure to its default settings. This means, that configuration settings + will be re-read from section <common/logging> of your app.config. - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. + This is mainly used for unit testing, you wouldn't normally use this in your applications.
+ Note: instances already handed out from this LogManager are not(!) affected. + Resetting LogManager only affects new instances being handed out. - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched + + the instance to obtain settings for + re-initializing the LogManager. + - + - Log a message with the level using a callback to obtain the message + Gets the logger by calling + on the currently configured using the type of the calling class. - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. + This method needs to inspect the in order to determine the calling + class. This of course comes with a performance penalty, thus you shouldn't call it too + often in your application. - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Error. + + the logger instance obtained from the current - + - Log a message object with the level. + Gets the logger by calling + on the currently configured using the type of the calling class. - The message object to log. + + This method needs to inspect the in order to determine the calling + class. This of course comes with a performance penalty, thus you shouldn't call it too + often in your application. + + + the logger instance obtained from the current - + - Log a message object with the level including - the stack Fatal of the passed - as a parameter. + Gets the logger by calling + on the currently configured using the specified type. - The message object to log. - The exception to log, including its stack Fatal. + the logger instance obtained from the current - + - Log a message with the level. + Gets the logger by calling + on the currently configured using the specified type. - An that supplies culture-specific formatting Fatalrmation. - The format of the message object to log. - + the logger instance obtained from the current - + - Log a message with the level. + Gets the logger by calling + on the currently configured using the specified type. - An that supplies culture-specific formatting Fatalrmation. - The format of the message object to log. - The exception to log. - + The type. + the logger instance obtained from the current - + - Log a message with the level. + Gets the logger by calling + on the currently configured using the specified type. - The format of the message object to log. - the list of format arguments + The type. + the logger instance obtained from the current - + - Log a message with the level. + Gets the logger by calling + on the currently configured using the specified key. - The format of the message object to log. - The exception to log. - the list of format arguments + The key. + the logger instance obtained from the current - + - Log a message with the level using a callback to obtain the message + Gets the logger by calling + on the currently configured using the specified key. - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - A callback used by the logger to obtain the message if log level is matched + The key. + the logger instance obtained from the current - - - Log a message with the level using a callback to obtain the message - - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Fatal. - - - - Log a message with the level using a callback to obtain the message - - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - - - - Log a message with the level using a callback to obtain the message - - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Fatal. - - - - Checks if this logger is enabled for the level. - - - Override this in your derived class to comply with the underlying logging system - - - - - Checks if this logger is enabled for the level. - - - Override this in your derived class to comply with the underlying logging system - - - - - Checks if this logger is enabled for the level. - - - Override this in your derived class to comply with the underlying logging system - - - - - Checks if this logger is enabled for the level. - - - Override this in your derived class to comply with the underlying logging system - - - - - Checks if this logger is enabled for the level. - - - Override this in your derived class to comply with the underlying logging system - - - - - Checks if this logger is enabled for the level. - - - Override this in your derived class to comply with the underlying logging system - - - - - Format message on demand. - - - - - Initializes a new instance of the class. - - The format message callback. - - - - Initializes a new instance of the class. - - The format provider. - The format message callback. - - - - Calls and returns result. - - - - - - Format string on demand. - - - - - Initializes a new instance of the class. - - The format provider. - The message. - The args. - - + - Runs on supplied arguemnts. + Builds the logger factory adapter. - string + a factory adapter instance. Is never null. - + - Represents a method responsible for writing a message to the log system. + Builds a instance from the given + using . + + the instance. Is never null - + - An implementation of that caches loggers handed out by this factory. + The key of the default configuration section to read settings from. - Implementors just need to override . + You can always change the source of your configuration settings by setting another instance + on . - Erich Eichinger - - - - LoggerFactoryAdapter interface is used internally by LogManager - Only developers wishing to write new Common.Logging adapters need to - worry about this interface. - - Gilles Bayon - - - - Get a ILog instance by type. - - The type to use for the logger - - - - - Get a ILog instance by name. - - The name of the logger - - - - - Creates a new instance, the logger cache being case-sensitive. - - - - - Creates a new instance, the logger cache being . - - - - - Purges all loggers from cache - - - + - Create the specified named logger instance + The key of the default configuration section to read settings from. - Derived factories need to implement this method to create the - actual logger instance. + You can always change the source of your configuration settings by setting another instance + on . - + - Get a ILog instance by . + Gets the configuration reader used to initialize the LogManager. - Usually the of the current class. - - An ILog instance either obtained from the internal cache or created by a call to . - + Primarily used for testing purposes but maybe useful to obtain configuration + information from some place other than the .NET application configuration file. + The configuration reader. - + - Get a ILog instance by name. + Gets the configuration reader used to initialize the LogManager. - Usually a 's Name or FullName property. - - An ILog instance either obtained from the internal cache or created by a call to . - + Primarily used for testing purposes but maybe useful to obtain configuration + information from some place other than the .NET application configuration file. + The configuration reader. - + - Get or create a ILog instance by name. + Gets or sets the adapter. - Usually a 's Name or FullName property. - - An ILog instance either obtained from the internal cache or created by a call to . - + The adapter. - + - A logger created by that - sends all log events to the owning adapter's + Gets or sets the adapter. - Erich Eichinger + The adapter. @@ -1394,11 +1249,11 @@ Creates and initializes a the simple logger. - The name, usually type name of the calling class, of the logger. + The key, usually type key of the calling class, of the logger. The current logging threshold. Messages recieved that are beneath this threshold will not be logged. Include level in the log message. Include the current time in the log message. - Include the instance name in the log message. + Include the instance key in the log message. The date and time format to use in the log message. @@ -1419,7 +1274,7 @@ - The name of the logger. + The key of the logger. @@ -1434,7 +1289,7 @@ - Include the instance name in the log message. + Include the instance key in the log message. @@ -1494,57 +1349,176 @@ will be sent to . - - - The adapter that created this logger instance. - - - - - Clears all captured events - - - - - Resets the to null. - - - - - Holds the list of logged events. - - - To access this collection in a multithreaded application, put a lock on the list instance. - - - - - instances send their captured log events to this method. - - - - - Create a new logger instance. - - - - - Create a new and send it to - - - - - - - - Holds the last log event received from any of this adapter's loggers. - - - + - A logging event captured by + Base factory implementation for creating simple instances. - Erich Eichinger + Default settings are LogLevel.All, showDateTime = true, showLogName = true, and no DateTimeFormat. + The keys in the NameValueCollection to configure this adapter are the following + + level + showDateTime + showLogName + dateTimeFormat + + + Here is an example how to implement your own logging adapter: + + public class ConsoleOutLogger : AbstractSimpleLogger + { + public ConsoleOutLogger(string logName, LogLevel logLevel, bool showLevel, bool showDateTime, + bool showLogName, string dateTimeFormat) + : base(logName, logLevel, showLevel, showDateTime, showLogName, dateTimeFormat) + { + } + + protected override void WriteInternal(LogLevel level, object message, Exception e) + { + // Use a StringBuilder for better performance + StringBuilder sb = new StringBuilder(); + FormatOutput(sb, level, message, e); + + // Print to the appropriate destination + Console.Out.WriteLine(sb.ToString()); + } + } + + public class ConsoleOutLoggerFactoryAdapter : AbstractSimpleLoggerFactoryAdapter + { + public ConsoleOutLoggerFactoryAdapter(NameValueCollection properties) + : base(properties) + { } + + protected override ILog CreateLogger(string key, LogLevel level, bool showLevel, bool + showDateTime, bool showLogName, string dateTimeFormat) + { + ILog log = new ConsoleOutLogger(key, level, showLevel, showDateTime, showLogName, + dateTimeFormat); + return log; + } + } + + + + Gilles Bayon + Mark Pollack + Erich Eichinger + + + + Initializes a new instance of the class. + + + Looks for level, showDateTime, showLogName, dateTimeFormat items from + for use when the GetLogger methods are called. + System.Configuration.ConfigurationManager for more information on how to use the + standard .NET application configuraiton file (App.config/Web.config) + to configure this adapter. + + The key value collection, typically specified by the user in + a configuration section named common/logging. + + + + Initializes a new instance of the class with + default settings for the loggers created by this factory. + + + + + Create the specified logger instance + + + + + Derived factories need to implement this method to create the + actual logger instance. + + a new logger instance. Must never be null! + + + + The default to use when creating new instances. + + + + + The default setting to use when creating new instances. + + + + + The default setting to use when creating new instances. + + + + + The default setting to use when creating new instances. + + + + + The default setting to use when creating new instances. + + + + + A logger created by that + sends all log events to the owning adapter's + + Erich Eichinger + + + + The adapter that created this logger instance. + + + + + Clears all captured events + + + + + Resets the to null. + + + + + Holds the list of logged events. + + + To access this collection in a multithreaded application, put a lock on the list instance. + + + + + instances send their captured log events to this method. + + + + + Create a new logger instance. + + + + + Create a new and send it to + + + + + + + + Holds the last log event received from any of this adapter's loggers. + + + + + A logging event captured by + + Erich Eichinger @@ -1634,7 +1608,7 @@ - Get a instance for the given name. + Get a instance for the given key. @@ -1642,1018 +1616,422 @@ Holds the last log event received from any of this adapter's loggers. - + - A implementation sending all System.Diagnostics.Trace output to - the Common.Logging infrastructure. + Sends log messages to . + + Gilles Bayon + + + + Creates and initializes a logger that writes messages to . + + The key, usually type key of the calling class, of the logger. + The current logging threshold. Messages recieved that are beneath this threshold will not be logged. + Include the current log level in the log message. + Include the current time in the log message. + Include the instance key in the log message. + The date and time format to use in the log message. + + + + Do the actual logging by constructing the log message using a then + sending the output to . + + The of the message. + The log message. + An optional associated with the message. + + + + Factory for creating instances that write data using . - This listener captures all output sent by calls to System.Diagnostics.Trace and - and and sends it to an instance.
- The instance to be used is obtained by calling - . The name of the logger is created by passing - this listener's and any source or category passed - into this listener (see or for example). - - The snippet below shows how to add and configure this listener to your app.config: - - <system.diagnostics> - <sharedListeners> - <add name="Diagnostics" - type="Common.Logging.Simple.CommonLoggingTraceListener, Common.Logging" - initializeData="DefaultTraceEventType=Information; LoggerNameFormat={listenerName}.{sourceName}"> - <filter type="System.Diagnostics.EventTypeFilter" initializeData="Information"/> - </add> - </sharedListeners> - <trace> - <listeners> - <add name="Diagnostics" /> - </listeners> - </trace> - </system.diagnostics> + Below is an example how to configure this adapter: + + <configuration> + + <configSections> + <sectionGroup key="common"> + <section key="logging" + type="Common.Logging.ConfigurationSectionHandler, Common.Logging" + requirePermission="false" /> + </sectionGroup> + </configSections> + + <common> + <logging> + <factoryAdapter type="Common.Logging.Simple.DebugLoggerFactoryAdapter, Common.Logging"> + <arg key="level" value="ALL" /> + </factoryAdapter> + </logging> + </common> + + </configuration> + + + Gilles Bayon + Mark Pollack Erich Eichinger - + - Creates a new instance with the default name "Diagnostics" and "Trace". + Initializes a new instance of the class using default + settings. - + - Creates a new instance initialized with properties from the . string. + Initializes a new instance of the class. - is a semicolon separated string of name/value pairs, where each pair has - the form key=value. E.g. - "Name=MyLoggerName;LogLevel=Debug" + Looks for level, showDateTime, showLogName, dateTimeFormat items from + for use when the GetLogger methods are called. + for more information on how to use the + standard .NET application configuraiton file (App.config/Web.config) + to configure this adapter. - a semicolon separated list of name/value pairs. + The key value collection, typically specified by the user in + a configuration section named common/logging. - + - Creates a new instance initialized with the specified properties. + Initializes a new instance of the class with + default settings for the loggers created by this factory. - name/value configuration properties. - + - Logs the given message to the Common.Logging infrastructure. + Creates a new instance. - the eventType - the name or category name passed into e.g. . - the id of this event - the message format - the message arguments - + - Writes message to logger provided by . - + - Writes message to logger provided by . - - - - - Writes message to logger provided by . - - - - - Writes message to logger provided by . - - - - - Writes message to logger provided by . - - - - - Writes message to logger provided by . - - - - - Writes message to logger provided by . - - - - - Writes message to logger provided by - - - - - Writes message to logger provided by - - - - - Writes message to logger provided by - - - - - Writes message to logger provided by - - - - - Writes message to logger provided by - - - - - Writes message to logger provided by - - - - - Sets the default to use for logging - all events emitted by .Write(...) and - .WriteLine(...) methods. - - - This listener captures all output sent by calls to and - sends it to an instance using the specified - on . - - - - - Format to use for creating the logger name. Defaults to "{listenerName}.{sourceName}". - - - Available placeholders are: - - {listenerName}: the configured name of this listener instance. - {sourceName}: the trace source name an event originates from (see e.g. . - - - - - - The exception that is thrown when a configuration system error has occurred with Common.Logging - - Mark Pollack - - - Creates a new instance of the ObjectsException class. - - - - Creates a new instance of the ConfigurationException class. with the specified message. - - - A message about the exception. - - - - - Creates a new instance of the ConfigurationException class with the specified message - and root cause. - - - A message about the exception. - - - The root exception that is being wrapped. - - - - - Creates a new instance of the ConfigurationException class. - - - The - that holds the serialized object data about the exception being thrown. - - - The - that contains contextual information about the source or destination. - - - - - Implementation of that uses the standard .NET - configuration APIs, ConfigurationSettings in 1.x and ConfigurationManager in 2.0 - - Mark Pollack - - - - Interface for basic operations to read .NET application configuration information. - - Provides a simple abstraction to handle BCL API differences between .NET 1.x and 2.0. Also - useful for testing scenarios. - Mark Pollack - - - - Parses the configuration section and returns the resulting object. - - -

- Primary purpose of this method is to allow us to parse and - load configuration sections using the same API regardless - of the .NET framework version. -

- - Name of the configuration section. - Object created by a corresponding . - - - - - Parses the configuration section and returns the resulting object. - - Name of the configuration section. - - Object created by a corresponding . - - -

- Primary purpose of this method is to allow us to parse and - load configuration sections using the same API regardless - of the .NET framework version. -

- - - - - - This namespace contains convenience base classes for implementing your own s. - - - - - Various utility methods for using during factory and logger instance configuration - - Erich Eichinger - - - - Initialize all members before any of this class' methods can be accessed (avoids beforeFieldInit) - - - - - Adds the parser to the list of known type parsers. - - - .NET intrinsic types are pre-registerd: short, int, long, float, double, decimal, bool - - - - - Retrieves the named value from the specified . - - may be null - the value's key - if is not null, the value returned by values[name]. null otherwise. - - - - Retrieves the named value from the specified . - - may be null - the value's key - the default value, if not found - if is not null, the value returned by values[name]. null otherwise. - - - - Returns the first nonnull, nonempty value among its arguments. - - - Returns null, if the initial list was null or empty. - - - - - - Returns the first nonnull, nonempty value among its arguments. - - - Also - - - - - Tries parsing into an enum of the type of . - - the default value to return if parsing fails - the string value to parse - the successfully parsed value, otherwise. - - - - Tries parsing into the specified return type. - - the default value to return if parsing fails - the string value to parse - the successfully parsed value, otherwise. - - - - Throws a if is null. - - - - - Throws a if is null. - - - - - Throws a if an object of type is not - assignable to type . - - - - - Throws a if an object of type is not - assignable to type . - - - - - Ensures any exception thrown by the given is wrapped with an - . - - - If already throws a ConfigurationException, it will not be wrapped. - - the action to execute - the message to be set on the thrown - args to be passed to to format the message - - - - Ensures any exception thrown by the given is wrapped with an - . - - - If already throws a ConfigurationException, it will not be wrapped. - - the action to execute - the message to be set on the thrown - args to be passed to to format the message - - - - A delegate converting a string representation into the target type - - - - - An anonymous action delegate with no arguments and no return value. - - - - - - An anonymous action delegate with no arguments and no return value. - - - - - - The type of method that is passed into e.g. - and allows the callback method to "submit" it's message to the underlying output system. - - the format argument as in - the argument list as in - - Erich Eichinger - - - - Used in an application's configuration file (App.Config or Web.Config) to configure the logging subsystem. - - - An example configuration section that writes log messages to the Console using the - built-in Console Logger. - - <configuration> - <configSections> - <sectionGroup name="common"> - <section name="logging" type="Common.Logging.ConfigurationSectionHandler, Common.Logging" /> - </sectionGroup> - </configSections> - <common> - <logging> - <factoryAdapter type="Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter, Common.Logging"> - <arg key="showLogName" value="true" /> - <arg key="showDataTime" value="true" /> - <arg key="level" value="ALL" /> - <arg key="dateTimeFormat" value="yyyy/MM/dd HH:mm:ss:fff" /> - </factoryAdapter> - </logging> - </common> - </configuration> - - - - - - Ensure static fields get initialized before any class member - can be accessed (avoids beforeFieldInit) - - - - - Constructor - - - - - Retrieves the of the logger the use by looking at the logFactoryAdapter element - of the logging configuration element. - - - - A object containing the specified type that implements - along with zero or more properties that will be - passed to the logger factory adapter's constructor as an . - - - - - Verifies that the logFactoryAdapter element appears once in the configuration section. - - settings of a parent section - atm this must always be null - Additional information about the configuration process. - The configuration section to apply an XPath query too. - - A object containing the specified logFactoryAdapter type - along with user supplied configuration properties. - - - - - Verifies that the logFactoryAdapter element appears once in the configuration section. - - The parent of the current item. - Additional information about the configuration process. - The configuration section to apply an XPath query too. - - A object containing the specified logFactoryAdapter type - along with user supplied configuration properties. - - - - - The 7 possible logging levels - - Gilles Bayon - - - - All logging levels - - - - - A trace logging level - - - - - A debug logging level - - - - - A info logging level - - - - - A warn logging level - - - - - An error logging level - - - - - A fatal logging level - - - - - Do not log anything. - - - - - Use the LogManager's or - methods to obtain instances for logging. - - - For configuring the underlying log system using application configuration, see the example - at . - For configuring programmatically, see the example section below. - - - The example below shows the typical use of LogManager to obtain a reference to a logger - and log an exception: - - - ILog log = LogManager.GetLogger(this.GetType()); - ... - try - { - /* .... */ - } - catch(Exception ex) - { - log.ErrorFormat("Hi {0}", ex, "dude"); - } - - - The example below shows programmatic configuration of the underlying log system: - - - // create properties - NameValueCollection properties = new NameValueCollection(); - properties["showDateTime"] = "true"; - - // set Adapter - Common.Logging.LogManager.Adapter = new - Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter(properties); - - - - - - - - Gilles Bayon - - - - The name of the default configuration section to read settings from. - - - You can always change the source of your configuration settings by setting another instance - on . - - - - - Performs static 1-time init of LogManager by calling - - - - - Reset the infrastructure to its default settings. This means, that configuration settings - will be re-read from section <common/logging> of your app.config. - - - This is mainly used for unit testing, you wouldn't normally use this in your applications.
- Note: instances already handed out from this LogManager are not(!) affected. - Resetting LogManager only affects new instances being handed out. - - - - - Reset the infrastructure to its default settings. This means, that configuration settings - will be re-read from section <common/logging> of your app.config. - - - This is mainly used for unit testing, you wouldn't normally use this in your applications.
- Note: instances already handed out from this LogManager are not(!) affected. - Resetting LogManager only affects new instances being handed out. - - - the instance to obtain settings for - re-initializing the LogManager. - - - - - Gets the logger by calling - on the currently configured using the type of the calling class. - - - This method needs to inspect the in order to determine the calling - class. This of course comes with a performance penalty, thus you shouldn't call it too - often in your application. - - - the logger instance obtained from the current - - - - Gets the logger by calling - on the currently configured using the specified type. + Silently ignores all log messages. - the logger instance obtained from the current + Gilles Bayon + Erich Eichinger - + - Gets the logger by calling - on the currently configured using the specified type. + Ignores message. - The type. - the logger instance obtained from the current + - + - Gets the logger by calling - on the currently configured using the specified name. + Ignores message. - The name. - the logger instance obtained from the current + + - + - Builds the logger factory adapter. + Ignores message. - a factory adapter instance. Is never null. + The format of the message object to log. + - + - Builds a instance from the given - using . + Ignores message. - - the instance. Is never null + The format of the message object to log. + The exception to log. + the list of message format arguments - + - Gets the configuration reader used to initialize the LogManager. + Ignores message. - Primarily used for testing purposes but maybe useful to obtain configuration - information from some place other than the .NET application configuration file. - The configuration reader. + An that supplies culture-specific formatting information. + The format of the message object to log. + the list of message format arguments - + - Gets or sets the adapter. + Ignores message. - The adapter. + An that supplies culture-specific formatting information. + The format of the message object to log. + The exception to log. + the list of message format arguments - + - Container used to hold configuration information from config file. + Ignores message. - Gilles Bayon + A callback used by the logger to obtain the message if log level is matched - + - + Ignores message. - - The type - that will be used for creating - - - Additional user supplied properties that are passed to the - 's constructor. - + A callback used by the logger to obtain the message if log level is matched + The exception to log, including its stack trace. - + - The type that will be used for creating - instances. + Ignores message. + An that supplies culture-specific formatting information. + A callback used by the logger to obtain the message if log level is matched - + - Additional user supplied properties that are passed to the 's constructor. + Ignores message. + An that supplies culture-specific formatting information. + A callback used by the logger to obtain the message if log level is matched + The exception to log, including its stack trace. - + - This namespace contains all core classes making up the Common.Logging framework. + Ignores message. + - + - This namespace contains out-of-the-box adapters to intrinsic systems, namely - , and the - all output suppressing . - For unit testing, you may also want to have a look at - that allows to easily inspect logged messages. - To route messages logged through the infrastructure back into - Common.Logging, you can use + Ignores message. + + - + - This namespace contains various utility classes. + Ignores message. + The format of the message object to log. + - + -

Overview

- - There are a variety of logging implementations for .NET currently in use, log4net, Enterprise - Library Logging, NLog, to name the most popular. The downside of having differerent implementation - is that they do not share a common interface and therefore impose a particular logging - implementation on the users of your library. To solve this dependency problem the Common.Logging - library introduces a simple abstraction to allow you to select a specific logging implementation at - runtime. - - - The library is based on work done by the developers of IBatis.NET and it's usage is inspired by - log4net. Many thanks to the developers of those projects! - -

Usage

- - The core logging library Common.Logging provides the base logging interface as - well as the global that you use to instrument your code: - - - ILog log = LogManager.GetLogger(this.GetType()); - - log.DebugFormat("Hi {0}", "dude"); - - - To output the information logged, you need to tell Common.Logging, what underlying logging system - to use. Common.Logging already includes simple console and trace based logger implementations - usable out of the box. Adding the following configuration snippet to your app.config causes - Common.Logging to output all information to the console: - - - <configuration> - <configSections> - <sectionGroup name="common"> - <section name="logging" type="Common.Logging.ConfigurationSectionHandler, Common.Logging" /> - </sectionGroup> - </configSections> - - <common> - <logging> - <factoryAdapter type="Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter, Common.Logging"> - <arg key="level" value="DEBUG" /> - </factoryAdapter> - </logging> - </common> - </configuration> - -

Customizing

- - In the case you want to integrate your own logging system that is not supported by Common.Logging yet, it is easily - possible to implement your own plugin by implementing . - For convenience there is a base implementation available that usually - makes implementing your own adapter a breeze. - -

<system.diagnostics> Integration

- - If your code already uses the .NET framework's built-in System.Diagnostics.Trace - system, you can use to redirect all trace output to the - Common.Logging infrastructure. - + Ignores message. + The format of the message object to log. + The exception to log. + the list of message format arguments - + - Base factory implementation for creating simple instances. + Ignores message. - Default settings are LogLevel.All, showDateTime = true, showLogName = true, and no DateTimeFormat. - The keys in the NameValueCollection to configure this adapter are the following - - level - showDateTime - showLogName - dateTimeFormat - - - Here is an example how to implement your own logging adapter: - - public class ConsoleOutLogger : AbstractSimpleLogger - { - public ConsoleOutLogger(string logName, LogLevel logLevel, bool showLevel, bool showDateTime, - bool showLogName, string dateTimeFormat) - : base(logName, logLevel, showLevel, showDateTime, showLogName, dateTimeFormat) - { - } - - protected override void WriteInternal(LogLevel level, object message, Exception e) - { - // Use a StringBuilder for better performance - StringBuilder sb = new StringBuilder(); - FormatOutput(sb, level, message, e); - - // Print to the appropriate destination - Console.Out.WriteLine(sb.ToString()); - } - } - - public class ConsoleOutLoggerFactoryAdapter : AbstractSimpleLoggerFactoryAdapter - { - public ConsoleOutLoggerFactoryAdapter(NameValueCollection properties) - : base(properties) - { } - - protected override ILog CreateLogger(string name, LogLevel level, bool showLevel, bool - showDateTime, bool showLogName, string dateTimeFormat) - { - ILog log = new ConsoleOutLogger(name, level, showLevel, showDateTime, showLogName, - dateTimeFormat); - return log; - } - } - - - - - - Gilles Bayon - Mark Pollack - Erich Eichinger + An that supplies culture-specific formatting information. + The format of the message object to log. + the list of message format arguments - + - Initializes a new instance of the class. + Ignores message. - - Looks for level, showDateTime, showLogName, dateTimeFormat items from - for use when the GetLogger methods are called. - for more information on how to use the - standard .NET application configuraiton file (App.config/Web.config) - to configure this adapter. - - The name value collection, typically specified by the user in - a configuration section named common/logging. + An that supplies culture-specific formatting information. + The format of the message object to log. + The exception to log. + the list of message format arguments - + - Initializes a new instance of the class with - default settings for the loggers created by this factory. + Ignores message. + A callback used by the logger to obtain the message if log level is matched - + - Create the specified logger instance + Ignores message. + A callback used by the logger to obtain the message if log level is matched + The exception to log, including its stack Debug. - + - Derived factories need to implement this method to create the - actual logger instance. + Ignores message. - a new logger instance. Must never be null! + An that supplies culture-specific formatting information. + A callback used by the logger to obtain the message if log level is matched - + - The default to use when creating new instances. + Ignores message. + An that supplies culture-specific formatting information. + A callback used by the logger to obtain the message if log level is matched + The exception to log, including its stack Debug. - + - The default setting to use when creating new instances. + Ignores message. + - + - The default setting to use when creating new instances. + Ignores message. + + - + - The default setting to use when creating new instances. + Ignores message. + The format of the message object to log. + - + - The default setting to use when creating new instances. + Ignores message. + The format of the message object to log. + The exception to log. + the list of message format arguments - + - Sends log messages to . + Ignores message. - Gilles Bayon + An that supplies culture-specific formatting information. + The format of the message object to log. + the list of message format arguments - + - Creates and initializes a logger that writes messages to . + Ignores message. - The name, usually type name of the calling class, of the logger. - The current logging threshold. Messages recieved that are beneath this threshold will not be logged. - Include the current log level in the log message. - Include the current time in the log message. - Include the instance name in the log message. - The date and time format to use in the log message. + An that supplies culture-specific formatting information. + The format of the message object to log. + The exception to log. + the list of message format arguments - + - Do the actual logging by constructing the log message using a then - sending the output to . + Ignores message. - The of the message. - The log message. - An optional associated with the message. + A callback used by the logger to obtain the message if log level is matched - + - Factory for creating instances that write data to . + Ignores message. - - - Below is an example how to configure this adapter: - - <configuration> - - <configSections> - <sectionGroup name="common"> - <section name="logging" - type="Common.Logging.ConfigurationSectionHandler, Common.Logging" - requirePermission="false" /> - </sectionGroup> - </configSections> - - <common> - <logging> - <factoryAdapter type="Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter, Common.Logging"> - <arg key="level" value="ALL" /> - </factoryAdapter> - </logging> - </common> - - </configuration> - - - - - - - Gilles Bayon - Mark Pollack - Erich Eichinger + A callback used by the logger to obtain the message if log level is matched + The exception to log, including its stack Info. - + - Initializes a new instance of the class using default - settings. + Ignores message. + An that supplies culture-specific formatting information. + A callback used by the logger to obtain the message if log level is matched - + - Initializes a new instance of the class. + Ignores message. - - Looks for level, showDateTime, showLogName, dateTimeFormat items from - for use when the GetLogger methods are called. - for more information on how to use the - standard .NET application configuraiton file (App.config/Web.config) - to configure this adapter. - - The name value collection, typically specified by the user in - a configuration section named common/logging. + An that supplies culture-specific formatting information. + A callback used by the logger to obtain the message if log level is matched + The exception to log, including its stack Info. - + - Initializes a new instance of the class with - default settings for the loggers created by this factory. + Ignores message. + - + - Creates a new instance. + Ignores message. + + - + - Silently ignores all log messages. + Ignores message. - Gilles Bayon - Erich Eichinger + The format of the message object to log. + - + + + Ignores message. + + The format of the message object to log. + The exception to log. + the list of message format arguments + + + + Ignores message. + + An that supplies culture-specific formatting Warnrmation. + The format of the message object to log. + the list of message format arguments + + + + Ignores message. + + An that supplies culture-specific formatting Warnrmation. + The format of the message object to log. + The exception to log. + the list of message format arguments + + + + Ignores message. + + A callback used by the logger to obtain the message if log level is matched + + + + Ignores message. + + A callback used by the logger to obtain the message if log level is matched + The exception to log, including its stack Warn. + + + + Ignores message. + + An that supplies culture-specific formatting information. + A callback used by the logger to obtain the message if log level is matched + + + + Ignores message. + + An that supplies culture-specific formatting information. + A callback used by the logger to obtain the message if log level is matched + The exception to log, including its stack Warn. + + Ignores message. - + Ignores message. - + Ignores message. The format of the message object to log. - + Ignores message. @@ -2661,72 +2039,72 @@ The exception to log. the list of message format arguments - + Ignores message. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Errorrmation. The format of the message object to log. the list of message format arguments - + Ignores message. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Errorrmation. The format of the message object to log. The exception to log. the list of message format arguments - + Ignores message. A callback used by the logger to obtain the message if log level is matched - + Ignores message. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack trace. + The exception to log, including its stack Error. - + Ignores message. An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - + Ignores message. An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack trace. + The exception to log, including its stack Error. - + Ignores message. - + Ignores message. - + Ignores message. The format of the message object to log. - + Ignores message. @@ -2734,381 +2112,466 @@ The exception to log. the list of message format arguments - + Ignores message. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Fatalrmation. The format of the message object to log. the list of message format arguments - + Ignores message. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Fatalrmation. The format of the message object to log. The exception to log. the list of message format arguments - + Ignores message. A callback used by the logger to obtain the message if log level is matched - + Ignores message. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Debug. + The exception to log, including its stack Fatal. - + Ignores message. An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - + Ignores message. An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Debug. + The exception to log, including its stack Fatal. - + - Ignores message. + Always returns . - - + - Ignores message. + Always returns . - - - + - Ignores message. + Always returns . - The format of the message object to log. - - + - Ignores message. + Always returns . - The format of the message object to log. - The exception to log. - the list of message format arguments - + - Ignores message. + Always returns . - An that supplies culture-specific formatting information. - The format of the message object to log. - the list of message format arguments - + - Ignores message. + Always returns . - An that supplies culture-specific formatting information. - The format of the message object to log. - The exception to log. - the list of message format arguments - + - Ignores message. + Returns the global context for variables - A callback used by the logger to obtain the message if log level is matched - + - Ignores message. + Returns the thread-specific context for variables - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Info. - + - Ignores message. + Factory for creating instances that silently ignores + logging requests. - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched + + This logger adapter is the default used by Common.Logging if unconfigured. Using this logger adapter is the most efficient + way to suppress any logging output. + + Below is an example how to configure this adapter: + + <configuration> + + <configSections> + <sectionGroup key="common"> + <section key="logging" + type="Common.Logging.ConfigurationSectionHandler, Common.Logging" + requirePermission="false" /> + </sectionGroup> + </configSections> + + <common> + <logging> + <factoryAdapter type="Common.Logging.Simple.NoOpLoggerFactoryAdapter, Common.Logging"> + <arg key="level" value="ALL" /> + </factoryAdapter> + </logging> + </common> + + </configuration> + + + + Gilles Bayon - + - Ignores message. + Constructor - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Info. - + - Ignores message. + Constructor - - + - Ignores message. + Constructor for binary backwards compatibility - - + The properties. - + - Ignores message. + Get a ILog instance by type - The format of the message object to log. - + + - + - Ignores message. + Get a ILog instance by type key - The format of the message object to log. - The exception to log. - the list of message format arguments + + - + - Ignores message. + A null-functionality implementation of - An that supplies culture-specific formatting Warnrmation. - The format of the message object to log. - the list of message format arguments - + - Ignores message. + Sets the value of a new or existing variable within the global context - An that supplies culture-specific formatting Warnrmation. - The format of the message object to log. - The exception to log. - the list of message format arguments + The key of the variable that is to be added + The value to add - + - Ignores message. + Gets the value of a variable within the global context - A callback used by the logger to obtain the message if log level is matched + The key of the variable to get + The value or null if not found - + - Ignores message. + Checks if a variable is set within the global context - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Warn. + The key of the variable to check for + True if the variable is set - + - Ignores message. + Removes a variable from the global context by key - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched + The key of the variable to remove - + - Ignores message. + Clears the global context variables - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Warn. - + - Ignores message. + A implementation sending all System.Diagnostics.Trace output to + the Common.Logging infrastructure. - + + This listener captures all output sent by calls to System.Diagnostics.Trace and + and and sends it to an instance.
+ The instance to be used is obtained by calling + . The name of the logger is created by passing + this listener's and any source or category passed + into this listener (see or for example). + + + The snippet below shows how to add and configure this listener to your app.config: + + <system.diagnostics> + <sharedListeners> + <add name="Diagnostics" + type="Common.Logging.Simple.CommonLoggingTraceListener, Common.Logging" + initializeData="DefaultTraceEventType=Information; LoggerNameFormat={listenerName}.{sourceName}"> + <filter type="System.Diagnostics.EventTypeFilter" initializeData="Information"/> + </add> + </sharedListeners> + <trace> + <listeners> + <add name="Diagnostics" /> + </listeners> + </trace> + </system.diagnostics> + + + Erich Eichinger - + - Ignores message. + Creates a new instance with the default name "Diagnostics" and "Trace". - - - + - Ignores message. + Creates a new instance initialized with properties from the . string. - The format of the message object to log. - + + is a semicolon separated string of name/value pairs, where each pair has + the form key=value. E.g. + "Name=MyLoggerName;LogLevel=Debug" + + a semicolon separated list of name/value pairs. - + - Ignores message. + Creates a new instance initialized with the specified properties. - The format of the message object to log. - The exception to log. - the list of message format arguments + name/value configuration properties. - + + + Logs the given message to the Common.Logging infrastructure. + + the eventType + the name or category name passed into e.g. . + the id of this event + the message format + the message arguments + + + + Writes message to logger provided by . + + + + + Writes message to logger provided by . + + + + + Writes message to logger provided by . + + + - Ignores message. + Writes message to logger provided by . - An that supplies culture-specific formatting Errorrmation. - The format of the message object to log. - the list of message format arguments - + - Ignores message. + Writes message to logger provided by . - An that supplies culture-specific formatting Errorrmation. - The format of the message object to log. - The exception to log. - the list of message format arguments - + - Ignores message. + Writes message to logger provided by . - A callback used by the logger to obtain the message if log level is matched - + - Ignores message. + Writes message to logger provided by . - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Error. - + - Ignores message. + Writes message to logger provided by - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - + - Ignores message. + Writes message to logger provided by - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Error. - + - Ignores message. + Writes message to logger provided by - - + - Ignores message. + Writes message to logger provided by - - - + - Ignores message. + Writes message to logger provided by - The format of the message object to log. - - + - Ignores message. + Writes message to logger provided by - The format of the message object to log. - The exception to log. - the list of message format arguments - + - Ignores message. + Sets the default to use for logging + all events emitted by .Write(...) and + .WriteLine(...) methods. - An that supplies culture-specific formatting Fatalrmation. - The format of the message object to log. - the list of message format arguments + + This listener captures all output sent by calls to and + sends it to an instance using the specified + on . + - + - Ignores message. + Format to use for creating the logger name. Defaults to "{listenerName}.{sourceName}". - An that supplies culture-specific formatting Fatalrmation. - The format of the message object to log. - The exception to log. - the list of message format arguments + + Available placeholders are: + + {listenerName}: the configured name of this listener instance. + {sourceName}: the trace source name an event originates from (see e.g. . + + - + - Ignores message. + Used in an application's configuration file (App.Config or Web.Config) to configure the logging subsystem. - A callback used by the logger to obtain the message if log level is matched + + An example configuration section that writes log messages to the Console using the + built-in Console Logger. + + <configuration> + <configSections> + <sectionGroup name="common"> + <section name="logging" type="Common.Logging.ConfigurationSectionHandler, Common.Logging" /> + </sectionGroup> + </configSections> + <common> + <logging> + <factoryAdapter type="Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter, Common.Logging"> + <arg key="showLogName" value="true" /> + <arg key="showDateTime" value="true" /> + <arg key="level" value="ALL" /> + <arg key="dateTimeFormat" value="yyyy/MM/dd HH:mm:ss:fff" /> + </factoryAdapter> + </logging> + </common> + </configuration> + + - + - Ignores message. + Ensure static fields get initialized before any class member + can be accessed (avoids beforeFieldInit) - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Fatal. - + - Ignores message. + Constructor - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - + - Ignores message. + Retrieves the of the logger the use by looking at the logFactoryAdapter element + of the logging configuration element. - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Fatal. + + + A object containing the specified type that implements + along with zero or more properties that will be + passed to the logger factory adapter's constructor as an . + - + - Always returns . + Verifies that the logFactoryAdapter element appears once in the configuration section. + settings of a parent section - atm this must always be null + Additional information about the configuration process. + The configuration section to apply an XPath query too. + + A object containing the specified logFactoryAdapter type + along with user supplied configuration properties. + - + - Always returns . + Verifies that the logFactoryAdapter element appears once in the configuration section. + The parent of the current item. + Additional information about the configuration process. + The configuration section to apply an XPath query too. + + A object containing the specified logFactoryAdapter type + along with user supplied configuration properties. + - + - Always returns . + Sends log messages to . + Gilles Bayon - + - Always returns . + Creates and initializes a logger that writes messages to . + The name, usually type name of the calling class, of the logger. + The current logging threshold. Messages recieved that are beneath this threshold will not be logged. + Include the current log level in the log message. + Include the current time in the log message. + Include the instance name in the log message. + The date and time format to use in the log message. - + - Always returns . + Creates and initializes a logger that writes messages to . + The name, usually type name of the calling class, of the logger. + The current logging threshold. Messages recieved that are beneath this threshold will not be logged. + Include the current log level in the log message. + Include the current time in the log message. + Include the instance name in the log message. + The date and time format to use in the log message. + Use color when writing the log message. - + - Always returns . + Do the actual logging by constructing the log message using a then + sending the output to . + The of the message. + The log message. + An optional associated with the message. - + - Factory for creating instances that silently ignores - logging requests. + Factory for creating instances that write data to . - This logger adapter is the default used by Common.Logging if unconfigured. Using this logger adapter is the most efficient - way to suppress any logging output. Below is an example how to configure this adapter: @@ -3124,7 +2587,7 @@ <common> <logging> - <factoryAdapter type="Common.Logging.Simple.NoOpLoggerFactoryAdapter, Common.Logging"> + <factoryAdapter type="Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter, Common.Logging"> <arg key="level" value="ALL" /> </factoryAdapter> </logging> @@ -3134,33 +2597,55 @@ + Gilles Bayon + Mark Pollack + Erich Eichinger - + - Constructor + Initializes a new instance of the class using default + settings. - + - Constructor + Initializes a new instance of the class. + + + Looks for level, showDateTime, showLogName, dateTimeFormat items from + for use when the GetLogger methods are called. + for more information on how to use the + standard .NET application configuraiton file (App.config/Web.config) + to configure this adapter. + + The name value collection, typically specified by the user in + a configuration section named common/logging. + + + + Constructor for binary backwards compatibility with non-portableversions + The properties. - + - Get a ILog instance by type + Initializes a new instance of the class with + default settings for the loggers created by this factory. - - - + - Get a ILog instance by type name + Initializes a new instance of the class with + default settings for the loggers created by this factory. + + + + + Creates a new instance. - - @@ -3260,7 +2745,7 @@ Initializes a new instance of the class using default settings. - + Initializes a new instance of the class. @@ -3291,14 +2776,5 @@ or . - - - Indicates classes or members to be ignored by NCover - - - Note, the name is chosen, because TestDriven.NET uses it as //ea argument to "Test With... Coverage" - - Erich Eichinger - diff --git a/packages/Common.Logging.2.1.2/lib/net35/Common.Logging.xml b/packages/Common.Logging.3.1.0/lib/net40/Common.Logging.xml similarity index 72% rename from packages/Common.Logging.2.1.2/lib/net35/Common.Logging.xml rename to packages/Common.Logging.3.1.0/lib/net40/Common.Logging.xml index 66da79a..f8abb5a 100644 --- a/packages/Common.Logging.2.1.2/lib/net35/Common.Logging.xml +++ b/packages/Common.Logging.3.1.0/lib/net40/Common.Logging.xml @@ -4,370 +4,431 @@ Common.Logging - - - This assembly contains the core functionality of the Common.Logging framework. - In particular, checkout and for usage information. - - - - - Provides base implementation suitable for almost all logger adapters - - Erich Eichinger - - + - A simple logging interface abstracting logging APIs. + Indicates classes or members to be ignored by NCover - - Implementations should defer calling a message's until the message really needs - to be logged to avoid performance penalties. - - - Each log method offers to pass in a instead of the actual message. - Using this style has the advantage to defer possibly expensive message argument evaluation and formatting (and formatting arguments!) until the message gets - actually logged. If the message is not logged at all (e.g. due to settings), - you won't have to pay the peformance penalty of creating the message. - + Note, the key is chosen, because TestDriven.NET uses it as //ea argument to "Test With... Coverage" - - The example below demonstrates using callback style for creating the message, where the call to the - and the underlying only happens, if level is enabled: - - Log.Debug( m=>m("result is {0}", random.NextDouble()) ); - Log.Debug(delegate(m) { m("result is {0}", random.NextDouble()); }); - - - - Mark Pollack - Bruno Baia Erich Eichinger - + - Log a message object with the level. + The exception that is thrown when a configuration system error has occurred with Common.Logging - The message object to log. + Mark Pollack + + + Creates a new instance of the ObjectsException class. - + - Log a message object with the level including - the stack trace of the passed - as a parameter. + Creates a new instance of the ConfigurationException class. with the specified message. - The message object to log. - The exception to log, including its stack trace. + + A message about the exception. + - + - Log a message with the level. + Creates a new instance of the ConfigurationException class with the specified message + and root cause. - The format of the message object to log. - the list of format arguments + + A message about the exception. + + + The root exception that is being wrapped. + - + - Log a message with the level. + Creates a new instance of the ConfigurationException class. - The format of the message object to log. - The exception to log. - the list of format arguments + + The + that holds the serialized object data about the exception being thrown. + + + The + that contains contextual information about the source or destination. + - + - Log a message with the level. + Various utility methods for using during factory and logger instance configuration - An that supplies culture-specific formatting information. - The format of the message object to log. - + Erich Eichinger - + - Log a message with the level. + Initialize all members before any of this class' methods can be accessed (avoids beforeFieldInit) - An that supplies culture-specific formatting information. - The format of the message object to log. - The exception to log. - - + - Log a message with the level using a callback to obtain the message + Adds the parser to the list of known type parsers. - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. + .NET intrinsic types are pre-registerd: short, int, long, float, double, decimal, bool - A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Retrieves the named value from the specified . - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack trace. + may be null + the value's key + if is not null, the value returned by values[key]. null otherwise. - + - Log a message with the level using a callback to obtain the message + Retrieves the named value from the specified . + + may be null + the value's key + the default value, if not found + if is not null, the value returned by values[key]. null otherwise. + + + + Returns the first nonnull, nonempty value among its arguments. - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. + Returns null, if the initial list was null or empty. - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched + - + - Log a message with the level using a callback to obtain the message + Returns the first nonnull, nonempty value among its arguments. - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. + Also - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack trace. - + - Log a message object with the level. + Tries parsing into an enum of the type of . - The message object to log. + the default value to return if parsing fails + the string value to parse + the successfully parsed value, otherwise. - + - Log a message object with the level including - the stack trace of the passed - as a parameter. + Tries parsing into the specified return type. - The message object to log. - The exception to log, including its stack trace. + the default value to return if parsing fails + the string value to parse + the successfully parsed value, otherwise. - + - Log a message with the level. + Throws a if is null. - The format of the message object to log. - the list of format arguments - + - Log a message with the level. + Throws a if is null. - The format of the message object to log. - The exception to log. - the list of format arguments - + - Log a message with the level. + Throws a if an object of type is not + assignable to type . - An that supplies culture-specific formatting information. - The format of the message object to log. - - + - Log a message with the level. + Throws a if an object of type is not + assignable to type . - An that supplies culture-specific formatting information. - The format of the message object to log. - The exception to log. - - + - Log a message with the level using a callback to obtain the message + Ensures any exception thrown by the given is wrapped with an + . - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. + If already throws a ConfigurationException, it will not be wrapped. - A callback used by the logger to obtain the message if log level is matched + the action to execute + the message to be set on the thrown + args to be passed to to format the message - + - Log a message with the level using a callback to obtain the message + Ensures any exception thrown by the given is wrapped with an + . - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. + If already throws a ConfigurationException, it will not be wrapped. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack trace. + the action to execute + the message to be set on the thrown + args to be passed to to format the message - + - Log a message with the level using a callback to obtain the message + A delegate converting a string representation into the target type - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + An anonymous action delegate with no arguments and no return value. - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Debug. + - + - Log a message object with the level. + An anonymous action delegate with no arguments and no return value. - The message object to log. + - + - Log a message object with the level including - the stack trace of the passed - as a parameter. + Implementation of that uses the standard .NET + configuration APIs, ConfigurationSettings in 1.x and ConfigurationManager in 2.0 - The message object to log. - The exception to log, including its stack trace. + Mark Pollack - + - Log a message with the level. + Parses the configuration section and returns the resulting object. + Using the System.Configuration.ConfigurationManager - The format of the message object to log. - the list of format arguments + Name of the configuration section. + + Object created by a corresponding IConfigurationSectionHandler" + + +

+ Primary purpose of this method is to allow us to parse and + load configuration sections using the same API regardless + of the .NET framework version. +

+ - + - Log a message with the level. + Container used to hold configuration information from config file. - The format of the message object to log. - The exception to log. - the list of format arguments + Gilles Bayon - + - Log a message with the level. + - An that supplies culture-specific formatting information. - The format of the message object to log. - + + The type + that will be used for creating + + + Additional user supplied properties that are passed to the + 's constructor. + - + - Log a message with the level. + The type that will be used for creating + instances. - An that supplies culture-specific formatting information. - The format of the message object to log. - The exception to log. - - + - Log a message with the level using a callback to obtain the message + Additional user supplied properties that are passed to the 's constructor. - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Substitute NameValueCollection in System.Collections.Specialized. - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack trace. - + - Log a message with the level using a callback to obtain the message + Creates a new instance of NameValueCollection. + + + + + Gets the values (only a single one) for the specified key (configuration name) + + The key. + an array with one value, or null if no value exist + + + + Gets or sets the value with the specified key. + + + The value corrsponding to the key, or null if no value exist + + The key. + value store for the key + + + + Helper class for working with NameValueCollection + + + + + Convert a into the corresponding + common logging equivalent + + The properties. + + + + + An implementation of that caches loggers handed out by this factory. - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. + Implementors just need to override . - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched + Erich Eichinger - + - Log a message with the level using a callback to obtain the message + Creates a new instance, the logger cache being case-sensitive. + + + + + Creates a new instance, the logger cache being . + + + + + + Purges all loggers from cache + + + + + Create the specified named logger instance - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. + Derived factories need to implement this method to create the + actual logger instance. - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Info. - + - Log a message object with the level. + Get a ILog instance by . + + Usually the of the current class. + + An ILog instance either obtained from the internal cache or created by a call to . + + + + + Get a ILog instance by key. + + Usually a 's Name or FullName property. + + An ILog instance either obtained from the internal cache or created by a call to . + + + + + Get or create a ILog instance by key. + + Usually a 's Name or FullName property. + + An ILog instance either obtained from the internal cache or created by a call to . + + + + + Provides base implementation suitable for almost all logger adapters + + Erich Eichinger + + + + Holds the method for writing a message to the log system. + + + + + Creates a new logger instance using for + writing log events to the underlying log system. + + + + + + Override this method to use a different method than + for writing log events to the underlying log system. + + + Usually you don't need to override thise method. The default implementation returns + null to indicate that the default handler should be + used. + + + + + Actually sends the message to the underlying log system. + + the level of this log event. + the message to log + the exception to log (may be null) + + + + Log a message object with the level. The message object to log. - + - Log a message object with the level including + Log a message object with the level including the stack trace of the passed as a parameter. The message object to log. The exception to log, including its stack trace. - + - Log a message with the level. + Log a message with the level. + An that supplies culture-specific formatting information. The format of the message object to log. - the list of format arguments + - + - Log a message with the level. + Log a message with the level. + An that supplies culture-specific formatting information. The format of the message object to log. The exception to log. - the list of format arguments + - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. The format of the message object to log. - + the list of format arguments - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. The format of the message object to log. The exception to log. - + the list of format arguments - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -375,9 +436,9 @@ A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -386,9 +447,9 @@ A callback used by the logger to obtain the message if log level is matched The exception to log, including its stack trace. - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -397,9 +458,9 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -407,58 +468,58 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Warn. + The exception to log, including its stack trace. - + - Log a message object with the level. + Log a message object with the level. The message object to log. - + - Log a message object with the level including - the stack trace of the passed + Log a message object with the level including + the stack Debug of the passed as a parameter. The message object to log. - The exception to log, including its stack trace. + The exception to log, including its stack Debug. - + - Log a message with the level. + Log a message with the level. + An that supplies culture-specific formatting information. The format of the message object to log. - the list of format arguments + - + - Log a message with the level. + Log a message with the level. + An that supplies culture-specific formatting information. The format of the message object to log. The exception to log. - the list of format arguments + - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. The format of the message object to log. - + the list of format arguments - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. The format of the message object to log. The exception to log. - + the list of format arguments - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -466,20 +527,20 @@ A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments that probably won't be logged due to loglevel settings. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack trace. + The exception to log, including its stack Debug. - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -488,9 +549,9 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -498,58 +559,58 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Error. + The exception to log, including its stack Debug. - + - Log a message object with the level. + Log a message object with the level. The message object to log. - + - Log a message object with the level including - the stack trace of the passed + Log a message object with the level including + the stack Info of the passed as a parameter. The message object to log. - The exception to log, including its stack trace. + The exception to log, including its stack Info. - + - Log a message with the level. + Log a message with the level. + An that supplies culture-specific formatting information. The format of the message object to log. - the list of format arguments + - + - Log a message with the level. + Log a message with the level. + An that supplies culture-specific formatting information. The format of the message object to log. The exception to log. - the list of format arguments + - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. The format of the message object to log. - + the list of format arguments - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. The format of the message object to log. The exception to log. - + the list of format arguments - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -557,20 +618,20 @@ A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments that probably won't be logged due to loglevel settings. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack trace. + The exception to log, including its stack Info. - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -579,9 +640,9 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -589,119 +650,58 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Fatal. + The exception to log, including its stack Info. - + - Checks if this logger is enabled for the level. - - - - - Checks if this logger is enabled for the level. - - - - - Checks if this logger is enabled for the level. - - - - - Checks if this logger is enabled for the level. - - - - - Checks if this logger is enabled for the level. - - - - - Checks if this logger is enabled for the level. - - - - - Holds the method for writing a message to the log system. - - - - - Creates a new logger instance using for - writing log events to the underlying log system. - - - - - - Override this method to use a different method than - for writing log events to the underlying log system. - - - Usually you don't need to override thise method. The default implementation returns - null to indicate that the default handler should be - used. - - - - - Actually sends the message to the underlying log system. - - the level of this log event. - the message to log - the exception to log (may be null) - - - - Log a message object with the level. + Log a message object with the level. The message object to log. - + - Log a message object with the level including - the stack trace of the passed + Log a message object with the level including + the stack Warn of the passed as a parameter. The message object to log. - The exception to log, including its stack trace. + The exception to log, including its stack Warn. - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Warnrmation. The format of the message object to log. - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Warnrmation. The format of the message object to log. The exception to log. - + - Log a message with the level. + Log a message with the level. The format of the message object to log. the list of format arguments - + - Log a message with the level. + Log a message with the level. The format of the message object to log. The exception to log. the list of format arguments - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -709,20 +709,20 @@ A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments that probably won't be logged due to loglevel settings. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack trace. + The exception to log, including its stack Warn. - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -731,9 +731,9 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -741,58 +741,58 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack trace. + The exception to log, including its stack Warn. - + - Log a message object with the level. + Log a message object with the level. The message object to log. - + - Log a message object with the level including - the stack Debug of the passed + Log a message object with the level including + the stack Error of the passed as a parameter. The message object to log. - The exception to log, including its stack Debug. + The exception to log, including its stack Error. - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Errorrmation. The format of the message object to log. - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Errorrmation. The format of the message object to log. The exception to log. - + - Log a message with the level. + Log a message with the level. The format of the message object to log. the list of format arguments - + - Log a message with the level. + Log a message with the level. The format of the message object to log. The exception to log. the list of format arguments - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -800,20 +800,20 @@ A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments that probably won't be logged due to loglevel settings. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Debug. + The exception to log, including its stack Error. - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -822,9 +822,9 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments @@ -832,1326 +832,203 @@ An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Debug. + The exception to log, including its stack Error. - + - Log a message object with the level. + Log a message object with the level. The message object to log. - + - Log a message object with the level including - the stack Info of the passed + Log a message object with the level including + the stack Fatal of the passed as a parameter. The message object to log. - The exception to log, including its stack Info. + The exception to log, including its stack Fatal. - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Fatalrmation. The format of the message object to log. - + - Log a message with the level. + Log a message with the level. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Fatalrmation. The format of the message object to log. The exception to log. - + - Log a message with the level. + Log a message with the level. The format of the message object to log. the list of format arguments - + - Log a message with the level. + Log a message with the level. The format of the message object to log. The exception to log. the list of format arguments - - - Log a message with the level using a callback to obtain the message - - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - A callback used by the logger to obtain the message if log level is matched - - - - Log a message with the level using a callback to obtain the message - - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Info. - - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments that probably won't be logged due to loglevel settings. - An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - + - Log a message with the level using a callback to obtain the message + Log a message with the level using a callback to obtain the message Using this method avoids the cost of creating a message and evaluating message arguments that probably won't be logged due to loglevel settings. - An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Info. - - - - Log a message object with the level. - - The message object to log. - - - - Log a message object with the level including - the stack Warn of the passed - as a parameter. - - The message object to log. - The exception to log, including its stack Warn. - - - - Log a message with the level. - - An that supplies culture-specific formatting Warnrmation. - The format of the message object to log. - - - - - Log a message with the level. - - An that supplies culture-specific formatting Warnrmation. - The format of the message object to log. - The exception to log. - + The exception to log, including its stack Fatal. - - - Log a message with the level. - - The format of the message object to log. - the list of format arguments - - - - Log a message with the level. - - The format of the message object to log. - The exception to log. - the list of format arguments - - - - Log a message with the level using a callback to obtain the message - - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - A callback used by the logger to obtain the message if log level is matched - - - - Log a message with the level using a callback to obtain the message - - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Warn. - - - - Log a message with the level using a callback to obtain the message - - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - - - - Log a message with the level using a callback to obtain the message - - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Warn. - - - - Log a message object with the level. - - The message object to log. - - - - Log a message object with the level including - the stack Error of the passed - as a parameter. - - The message object to log. - The exception to log, including its stack Error. - - - - Log a message with the level. - - An that supplies culture-specific formatting Errorrmation. - The format of the message object to log. - - - - - Log a message with the level. - - An that supplies culture-specific formatting Errorrmation. - The format of the message object to log. - The exception to log. - - - - - Log a message with the level. - - The format of the message object to log. - the list of format arguments - - - - Log a message with the level. - - The format of the message object to log. - The exception to log. - the list of format arguments - - - - Log a message with the level using a callback to obtain the message - - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - A callback used by the logger to obtain the message if log level is matched - - - - Log a message with the level using a callback to obtain the message - - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Error. - - - - Log a message with the level using a callback to obtain the message - - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - - - - Log a message with the level using a callback to obtain the message - - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Error. - - - - Log a message object with the level. - - The message object to log. - - - - Log a message object with the level including - the stack Fatal of the passed - as a parameter. - - The message object to log. - The exception to log, including its stack Fatal. - - - - Log a message with the level. - - An that supplies culture-specific formatting Fatalrmation. - The format of the message object to log. - - - - - Log a message with the level. - - An that supplies culture-specific formatting Fatalrmation. - The format of the message object to log. - The exception to log. - - - - - Log a message with the level. - - The format of the message object to log. - the list of format arguments - - - - Log a message with the level. - - The format of the message object to log. - The exception to log. - the list of format arguments - - - - Log a message with the level using a callback to obtain the message - - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - A callback used by the logger to obtain the message if log level is matched - - - - Log a message with the level using a callback to obtain the message - - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Fatal. - - - - Log a message with the level using a callback to obtain the message - - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - - + Log a message with the level using a callback to obtain the message - - Using this method avoids the cost of creating a message and evaluating message arguments - that probably won't be logged due to loglevel settings. - - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Fatal. - - - - Checks if this logger is enabled for the level. - - - Override this in your derived class to comply with the underlying logging system - - - - - Checks if this logger is enabled for the level. - - - Override this in your derived class to comply with the underlying logging system - - - - - Checks if this logger is enabled for the level. - - - Override this in your derived class to comply with the underlying logging system - - - - - Checks if this logger is enabled for the level. - - - Override this in your derived class to comply with the underlying logging system - - - - - Checks if this logger is enabled for the level. - - - Override this in your derived class to comply with the underlying logging system - - - - - Checks if this logger is enabled for the level. - - - Override this in your derived class to comply with the underlying logging system - - - - - Format message on demand. - - - - - Initializes a new instance of the class. - - The format message callback. - - - - Initializes a new instance of the class. - - The format provider. - The format message callback. - - - - Calls and returns result. - - - - - - Format string on demand. - - - - - Initializes a new instance of the class. - - The format provider. - The message. - The args. - - - - Runs on supplied arguemnts. - - string - - - - Represents a method responsible for writing a message to the log system. - - - - - An implementation of that caches loggers handed out by this factory. - - - Implementors just need to override . - - Erich Eichinger - - - - LoggerFactoryAdapter interface is used internally by LogManager - Only developers wishing to write new Common.Logging adapters need to - worry about this interface. - - Gilles Bayon - - - - Get a ILog instance by type. - - The type to use for the logger - - - - - Get a ILog instance by name. - - The name of the logger - - - - - Creates a new instance, the logger cache being case-sensitive. - - - - - Creates a new instance, the logger cache being . - - - - - - Purges all loggers from cache - - - - - Create the specified named logger instance - - - Derived factories need to implement this method to create the - actual logger instance. - - - - - Get a ILog instance by . - - Usually the of the current class. - - An ILog instance either obtained from the internal cache or created by a call to . - - - - - Get a ILog instance by name. - - Usually a 's Name or FullName property. - - An ILog instance either obtained from the internal cache or created by a call to . - - - - - Get or create a ILog instance by name. - - Usually a 's Name or FullName property. - - An ILog instance either obtained from the internal cache or created by a call to . - - - - - A logger created by that - sends all log events to the owning adapter's - - Erich Eichinger - - - - Abstract class providing a standard implementation of simple loggers. - - Erich Eichinger - - - - Creates and initializes a the simple logger. - - The name, usually type name of the calling class, of the logger. - The current logging threshold. Messages recieved that are beneath this threshold will not be logged. - Include level in the log message. - Include the current time in the log message. - Include the instance name in the log message. - The date and time format to use in the log message. - - - - Appends the formatted message to the specified . - - the that receíves the formatted message. - - - - - - - Determines if the given log level is currently enabled. - - - - - - - The name of the logger. - - - - - Include the current log level in the log message. - - - - - Include the current time in the log message. - - - - - Include the instance name in the log message. - - - - - The current logging threshold. Messages recieved that are beneath this threshold will not be logged. - - - - - The date and time format to use in the log message. - - - - - Determines Whether is set. - - - - - Returns if the current is greater than or - equal to . If it is, all messages will be sent to . - - - - - Returns if the current is greater than or - equal to . If it is, all messages will be sent to . - - - - - Returns if the current is greater than or - equal to . If it is, only messages with a of - , , , and - will be sent to . - - - - - Returns if the current is greater than or - equal to . If it is, only messages with a of - , , and - will be sent to . - - - - - Returns if the current is greater than or - equal to . If it is, only messages with a of - and will be sent to . - - - - - Returns if the current is greater than or - equal to . If it is, only messages with a of - will be sent to . - - - - - The adapter that created this logger instance. - - - - - Clears all captured events - - - - - Resets the to null. - - - - - Holds the list of logged events. - - - To access this collection in a multithreaded application, put a lock on the list instance. - - - - - instances send their captured log events to this method. - - - - - Create a new logger instance. - - - - - Create a new and send it to - - - - - - - - Holds the last log event received from any of this adapter's loggers. - - - - - A logging event captured by - - Erich Eichinger - - - - The logger that logged this event - - - - - The level used to log this event - - - - - The raw message object - - - - - A logged exception - - - - - Create a new event instance - - - - - Retrieves the formatted message text - - - - - An adapter, who's loggers capture all log events and send them to . - Retrieve the list of log events from . - - - This logger factory is mainly for debugging and test purposes. - - This is an example how you might use this adapter for testing: - - // configure for capturing - CapturingLoggerFactoryAdapter adapter = new CapturingLoggerFactoryAdapter(); - LogManager.Adapter = adapter; - - // reset capture state - adapter.Clear(); - // log something - ILog log = LogManager.GetCurrentClassLogger(); - log.DebugFormat("Current Time:{0}", DateTime.Now); - - // check logged data - Assert.AreEqual(1, adapter.LoggerEvents.Count); - Assert.AreEqual(LogLevel.Debug, adapter.LastEvent.Level); - - - - Erich Eichinger - - - - Clears all captured events - - - - - Resets the to null. - - - - - Holds the list of logged events. - - - To access this collection in a multithreaded application, put a lock on the list instance. - - - - - instances send their captured log events to this method. - - - - - Get a instance for the given type. - - - - - Get a instance for the given name. - - - - - Holds the last log event received from any of this adapter's loggers. - - - - - A implementation sending all System.Diagnostics.Trace output to - the Common.Logging infrastructure. - - - This listener captures all output sent by calls to System.Diagnostics.Trace and - and and sends it to an instance.
- The instance to be used is obtained by calling - . The name of the logger is created by passing - this listener's and any source or category passed - into this listener (see or for example). - - - The snippet below shows how to add and configure this listener to your app.config: - - <system.diagnostics> - <sharedListeners> - <add name="Diagnostics" - type="Common.Logging.Simple.CommonLoggingTraceListener, Common.Logging" - initializeData="DefaultTraceEventType=Information; LoggerNameFormat={listenerName}.{sourceName}"> - <filter type="System.Diagnostics.EventTypeFilter" initializeData="Information"/> - </add> - </sharedListeners> - <trace> - <listeners> - <add name="Diagnostics" /> - </listeners> - </trace> - </system.diagnostics> - - - Erich Eichinger - - - - Creates a new instance with the default name "Diagnostics" and "Trace". - - - - - Creates a new instance initialized with properties from the . string. - - - is a semicolon separated string of name/value pairs, where each pair has - the form key=value. E.g. - "Name=MyLoggerName;LogLevel=Debug" - - a semicolon separated list of name/value pairs. - - - - Creates a new instance initialized with the specified properties. - - name/value configuration properties. - - - - Logs the given message to the Common.Logging infrastructure. - - the eventType - the name or category name passed into e.g. . - the id of this event - the message format - the message arguments - - - - Writes message to logger provided by . - - - - - Writes message to logger provided by . - - - - - Writes message to logger provided by . - - - - - Writes message to logger provided by . - - - - - Writes message to logger provided by . - - - - - Writes message to logger provided by . - - - - - Writes message to logger provided by . - - - - - Writes message to logger provided by - - - - - Writes message to logger provided by - - - - - Writes message to logger provided by - - - - - Writes message to logger provided by - - - - - Writes message to logger provided by - - - - - Writes message to logger provided by - - - - - Sets the default to use for logging - all events emitted by .Write(...) and - .WriteLine(...) methods. - - - This listener captures all output sent by calls to and - sends it to an instance using the specified - on . - - - - - Format to use for creating the logger name. Defaults to "{listenerName}.{sourceName}". - - - Available placeholders are: - - {listenerName}: the configured name of this listener instance. - {sourceName}: the trace source name an event originates from (see e.g. . - - - - - - The exception that is thrown when a configuration system error has occurred with Common.Logging - - Mark Pollack - - - Creates a new instance of the ObjectsException class. - - - - Creates a new instance of the ConfigurationException class. with the specified message. - - - A message about the exception. - - - - - Creates a new instance of the ConfigurationException class with the specified message - and root cause. - - - A message about the exception. - - - The root exception that is being wrapped. - - - - - Creates a new instance of the ConfigurationException class. - - - The - that holds the serialized object data about the exception being thrown. - - - The - that contains contextual information about the source or destination. - - - - - Implementation of that uses the standard .NET - configuration APIs, ConfigurationSettings in 1.x and ConfigurationManager in 2.0 - - Mark Pollack - - - - Interface for basic operations to read .NET application configuration information. - - Provides a simple abstraction to handle BCL API differences between .NET 1.x and 2.0. Also - useful for testing scenarios. - Mark Pollack - - - - Parses the configuration section and returns the resulting object. - - -

- Primary purpose of this method is to allow us to parse and - load configuration sections using the same API regardless - of the .NET framework version. -

- - Name of the configuration section. - Object created by a corresponding . - - - - - Parses the configuration section and returns the resulting object. - - Name of the configuration section. - - Object created by a corresponding . - - -

- Primary purpose of this method is to allow us to parse and - load configuration sections using the same API regardless - of the .NET framework version. -

- - - - - - This namespace contains convenience base classes for implementing your own s. - - - - - Various utility methods for using during factory and logger instance configuration - - Erich Eichinger - - - - Initialize all members before any of this class' methods can be accessed (avoids beforeFieldInit) - - - - - Adds the parser to the list of known type parsers. - - - .NET intrinsic types are pre-registerd: short, int, long, float, double, decimal, bool - - - - - Retrieves the named value from the specified . - - may be null - the value's key - if is not null, the value returned by values[name]. null otherwise. - - - - Retrieves the named value from the specified . - - may be null - the value's key - the default value, if not found - if is not null, the value returned by values[name]. null otherwise. - - - - Returns the first nonnull, nonempty value among its arguments. - - - Returns null, if the initial list was null or empty. - - - - - - Returns the first nonnull, nonempty value among its arguments. - - - Also - - - - - Tries parsing into an enum of the type of . - - the default value to return if parsing fails - the string value to parse - the successfully parsed value, otherwise. - - - - Tries parsing into the specified return type. - - the default value to return if parsing fails - the string value to parse - the successfully parsed value, otherwise. - - - - Throws a if is null. - - - - - Throws a if is null. - - - - - Throws a if an object of type is not - assignable to type . - - - - - Throws a if an object of type is not - assignable to type . - - - - - Ensures any exception thrown by the given is wrapped with an - . - - - If already throws a ConfigurationException, it will not be wrapped. - - the action to execute - the message to be set on the thrown - args to be passed to to format the message - - - - Ensures any exception thrown by the given is wrapped with an - . - - - If already throws a ConfigurationException, it will not be wrapped. - - the action to execute - the message to be set on the thrown - args to be passed to to format the message - - - - A delegate converting a string representation into the target type - - - - - An anonymous action delegate with no arguments and no return value. - - + + Using this method avoids the cost of creating a message and evaluating message arguments + that probably won't be logged due to loglevel settings. + + An that supplies culture-specific formatting information. + A callback used by the logger to obtain the message if log level is matched - + - An anonymous action delegate with no arguments and no return value. + Log a message with the level using a callback to obtain the message - + + Using this method avoids the cost of creating a message and evaluating message arguments + that probably won't be logged due to loglevel settings. + + An that supplies culture-specific formatting information. + A callback used by the logger to obtain the message if log level is matched + The exception to log, including its stack Fatal. - + - The type of method that is passed into e.g. - and allows the callback method to "submit" it's message to the underlying output system. + Checks if this logger is enabled for the level. - the format argument as in - the argument list as in - - Erich Eichinger + + Override this in your derived class to comply with the underlying logging system + - + - Used in an application's configuration file (App.Config or Web.Config) to configure the logging subsystem. + Checks if this logger is enabled for the level. - - An example configuration section that writes log messages to the Console using the - built-in Console Logger. - - <configuration> - <configSections> - <sectionGroup name="common"> - <section name="logging" type="Common.Logging.ConfigurationSectionHandler, Common.Logging" /> - </sectionGroup> - </configSections> - <common> - <logging> - <factoryAdapter type="Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter, Common.Logging"> - <arg key="showLogName" value="true" /> - <arg key="showDataTime" value="true" /> - <arg key="level" value="ALL" /> - <arg key="dateTimeFormat" value="yyyy/MM/dd HH:mm:ss:fff" /> - </factoryAdapter> - </logging> - </common> - </configuration> - - + + Override this in your derived class to comply with the underlying logging system + - + - Ensure static fields get initialized before any class member - can be accessed (avoids beforeFieldInit) + Checks if this logger is enabled for the level. + + Override this in your derived class to comply with the underlying logging system + - + - Constructor + Checks if this logger is enabled for the level. + + Override this in your derived class to comply with the underlying logging system + - + - Retrieves the of the logger the use by looking at the logFactoryAdapter element - of the logging configuration element. + Checks if this logger is enabled for the level. - - - A object containing the specified type that implements - along with zero or more properties that will be - passed to the logger factory adapter's constructor as an . - + + Override this in your derived class to comply with the underlying logging system + - + - Verifies that the logFactoryAdapter element appears once in the configuration section. + Checks if this logger is enabled for the level. - settings of a parent section - atm this must always be null - Additional information about the configuration process. - The configuration section to apply an XPath query too. - - A object containing the specified logFactoryAdapter type - along with user supplied configuration properties. - + + Override this in your derived class to comply with the underlying logging system + - + - Verifies that the logFactoryAdapter element appears once in the configuration section. + Returns the global context for variables - The parent of the current item. - Additional information about the configuration process. - The configuration section to apply an XPath query too. - - A object containing the specified logFactoryAdapter type - along with user supplied configuration properties. - - + - The 7 possible logging levels + Returns the thread-specific context for variables - Gilles Bayon - + - All logging levels + Format message on demand. - + - A trace logging level + Initializes a new instance of the class. + The format message callback. - + - A debug logging level + Initializes a new instance of the class. + The format provider. + The format message callback. - + - A info logging level + Calls and returns result. + - + - A warn logging level + Format string on demand. - + - An error logging level + Initializes a new instance of the class. + The format provider. + The message. + The args. - + - A fatal logging level + Runs on supplied arguemnts. + string - + - Do not log anything. + Represents a method responsible for writing a message to the log system. @@ -2161,7 +1038,7 @@ For configuring the underlying log system using application configuration, see the example - at . + at System.Configuration.ConfigurationManager For configuring programmatically, see the example section below. @@ -2197,18 +1074,8 @@ - Gilles Bayon - - - The name of the default configuration section to read settings from. - - - You can always change the source of your configuration settings by setting another instance - on . - - Performs static 1-time init of LogManager by calling @@ -2253,169 +1120,233 @@ the logger instance obtained from the current - + + + Gets the logger by calling + on the currently configured using the type of the calling class. + + + This method needs to inspect the in order to determine the calling + class. This of course comes with a performance penalty, thus you shouldn't call it too + often in your application. + + + the logger instance obtained from the current + + + + Gets the logger by calling + on the currently configured using the specified type. + + the logger instance obtained from the current + + + + Gets the logger by calling + on the currently configured using the specified type. + + the logger instance obtained from the current + + + + Gets the logger by calling + on the currently configured using the specified type. + + The type. + the logger instance obtained from the current + + + + Gets the logger by calling + on the currently configured using the specified type. + + The type. + the logger instance obtained from the current + + + + Gets the logger by calling + on the currently configured using the specified key. + + The key. + the logger instance obtained from the current + + + + Gets the logger by calling + on the currently configured using the specified key. + + The key. + the logger instance obtained from the current + + + + Builds the logger factory adapter. + + a factory adapter instance. Is never null. + + + + Builds a instance from the given + using . + + + the instance. Is never null + + + + The key of the default configuration section to read settings from. + + + You can always change the source of your configuration settings by setting another instance + on . + + + + + The key of the default configuration section to read settings from. + + + You can always change the source of your configuration settings by setting another instance + on . + + + + + Gets the configuration reader used to initialize the LogManager. + + Primarily used for testing purposes but maybe useful to obtain configuration + information from some place other than the .NET application configuration file. + The configuration reader. + + + + Gets the configuration reader used to initialize the LogManager. + + Primarily used for testing purposes but maybe useful to obtain configuration + information from some place other than the .NET application configuration file. + The configuration reader. + + + + Gets or sets the adapter. + + The adapter. + + + + Gets or sets the adapter. + + The adapter. + + + + Abstract class providing a standard implementation of simple loggers. + + Erich Eichinger + + + + Creates and initializes a the simple logger. + + The key, usually type key of the calling class, of the logger. + The current logging threshold. Messages recieved that are beneath this threshold will not be logged. + Include level in the log message. + Include the current time in the log message. + Include the instance key in the log message. + The date and time format to use in the log message. + + - Gets the logger by calling - on the currently configured using the specified type. + Appends the formatted message to the specified . - the logger instance obtained from the current + the that receíves the formatted message. + + + - + - Gets the logger by calling - on the currently configured using the specified type. + Determines if the given log level is currently enabled. - The type. - the logger instance obtained from the current + + - + - Gets the logger by calling - on the currently configured using the specified name. + The key of the logger. - The name. - the logger instance obtained from the current - + - Builds the logger factory adapter. + Include the current log level in the log message. - a factory adapter instance. Is never null. - + - Builds a instance from the given - using . + Include the current time in the log message. - - the instance. Is never null - + - Gets the configuration reader used to initialize the LogManager. + Include the instance key in the log message. - Primarily used for testing purposes but maybe useful to obtain configuration - information from some place other than the .NET application configuration file. - The configuration reader. - + - Gets or sets the adapter. + The current logging threshold. Messages recieved that are beneath this threshold will not be logged. - The adapter. - + - Container used to hold configuration information from config file. + The date and time format to use in the log message. - Gilles Bayon - + - + Determines Whether is set. - - The type - that will be used for creating - - - Additional user supplied properties that are passed to the - 's constructor. - - + - The type that will be used for creating - instances. + Returns if the current is greater than or + equal to . If it is, all messages will be sent to . - + - Additional user supplied properties that are passed to the 's constructor. + Returns if the current is greater than or + equal to . If it is, all messages will be sent to . - + - This namespace contains all core classes making up the Common.Logging framework. + Returns if the current is greater than or + equal to . If it is, only messages with a of + , , , and + will be sent to . - + - This namespace contains out-of-the-box adapters to intrinsic systems, namely - , and the - all output suppressing . - For unit testing, you may also want to have a look at - that allows to easily inspect logged messages. - To route messages logged through the infrastructure back into - Common.Logging, you can use + Returns if the current is greater than or + equal to . If it is, only messages with a of + , , and + will be sent to . - + - This namespace contains various utility classes. + Returns if the current is greater than or + equal to . If it is, only messages with a of + and will be sent to . - + -

Overview

- - There are a variety of logging implementations for .NET currently in use, log4net, Enterprise - Library Logging, NLog, to name the most popular. The downside of having differerent implementation - is that they do not share a common interface and therefore impose a particular logging - implementation on the users of your library. To solve this dependency problem the Common.Logging - library introduces a simple abstraction to allow you to select a specific logging implementation at - runtime. - - - The library is based on work done by the developers of IBatis.NET and it's usage is inspired by - log4net. Many thanks to the developers of those projects! - -

Usage

- - The core logging library Common.Logging provides the base logging interface as - well as the global that you use to instrument your code: - - - ILog log = LogManager.GetLogger(this.GetType()); - - log.DebugFormat("Hi {0}", "dude"); - - - To output the information logged, you need to tell Common.Logging, what underlying logging system - to use. Common.Logging already includes simple console and trace based logger implementations - usable out of the box. Adding the following configuration snippet to your app.config causes - Common.Logging to output all information to the console: - - - <configuration> - <configSections> - <sectionGroup name="common"> - <section name="logging" type="Common.Logging.ConfigurationSectionHandler, Common.Logging" /> - </sectionGroup> - </configSections> - - <common> - <logging> - <factoryAdapter type="Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter, Common.Logging"> - <arg key="level" value="DEBUG" /> - </factoryAdapter> - </logging> - </common> - </configuration> - -

Customizing

- - In the case you want to integrate your own logging system that is not supported by Common.Logging yet, it is easily - possible to implement your own plugin by implementing . - For convenience there is a base implementation available that usually - makes implementing your own adapter a breeze. - -

<system.diagnostics> Integration

- - If your code already uses the .NET framework's built-in System.Diagnostics.Trace - system, you can use to redirect all trace output to the - Common.Logging infrastructure. - + Returns if the current is greater than or + equal to . If it is, only messages with a of + will be sent to . @@ -2458,10 +1389,10 @@ : base(properties) { } - protected override ILog CreateLogger(string name, LogLevel level, bool showLevel, bool + protected override ILog CreateLogger(string key, LogLevel level, bool showLevel, bool showDateTime, bool showLogName, string dateTimeFormat) { - ILog log = new ConsoleOutLogger(name, level, showLevel, showDateTime, showLogName, + ILog log = new ConsoleOutLogger(key, level, showLevel, showDateTime, showLogName, dateTimeFormat); return log; } @@ -2469,24 +1400,22 @@ - - Gilles Bayon Mark Pollack Erich Eichinger - + Initializes a new instance of the class. Looks for level, showDateTime, showLogName, dateTimeFormat items from - for use when the GetLogger methods are called. - for more information on how to use the + for use when the GetLogger methods are called. + System.Configuration.ConfigurationManager for more information on how to use the standard .NET application configuraiton file (App.config/Web.config) to configure this adapter. - The name value collection, typically specified by the user in + The key value collection, typically specified by the user in a configuration section named common/logging. @@ -2519,37 +1448,192 @@ - The default setting to use when creating new instances. + The default setting to use when creating new instances. + + + + + The default setting to use when creating new instances. + + + + + The default setting to use when creating new instances. + + + + + A logger created by that + sends all log events to the owning adapter's + + Erich Eichinger + + + + The adapter that created this logger instance. + + + + + Clears all captured events + + + + + Resets the to null. + + + + + Holds the list of logged events. + + + To access this collection in a multithreaded application, put a lock on the list instance. + + + + + instances send their captured log events to this method. + + + + + Create a new logger instance. + + + + + Create a new and send it to + + + + + + + + Holds the last log event received from any of this adapter's loggers. + + + + + A logging event captured by + + Erich Eichinger + + + + The logger that logged this event + + + + + The level used to log this event + + + + + The raw message object + + + + + A logged exception + + + + + Create a new event instance + + + + + Retrieves the formatted message text + + + + + An adapter, who's loggers capture all log events and send them to . + Retrieve the list of log events from . + + + This logger factory is mainly for debugging and test purposes. + + This is an example how you might use this adapter for testing: + + // configure for capturing + CapturingLoggerFactoryAdapter adapter = new CapturingLoggerFactoryAdapter(); + LogManager.Adapter = adapter; + + // reset capture state + adapter.Clear(); + // log something + ILog log = LogManager.GetCurrentClassLogger(); + log.DebugFormat("Current Time:{0}", DateTime.Now); + + // check logged data + Assert.AreEqual(1, adapter.LoggerEvents.Count); + Assert.AreEqual(LogLevel.Debug, adapter.LastEvent.Level); + + + + Erich Eichinger + + + + Clears all captured events + + + + + Resets the to null. + + + + + Holds the list of logged events. + + + To access this collection in a multithreaded application, put a lock on the list instance. + + + + + instances send their captured log events to this method. + + + + + Get a instance for the given type. - + - The default setting to use when creating new instances. + Get a instance for the given key. - + - The default setting to use when creating new instances. + Holds the last log event received from any of this adapter's loggers. - + - Sends log messages to . + Sends log messages to . Gilles Bayon - + - Creates and initializes a logger that writes messages to . + Creates and initializes a logger that writes messages to . - The name, usually type name of the calling class, of the logger. + The key, usually type key of the calling class, of the logger. The current logging threshold. Messages recieved that are beneath this threshold will not be logged. Include the current log level in the log message. Include the current time in the log message. - Include the instance name in the log message. + Include the instance key in the log message. The date and time format to use in the log message. - + Do the actual logging by constructing the log message using a then sending the output to . @@ -2558,9 +1642,9 @@ The log message. An optional associated with the message. - + - Factory for creating instances that write data to . + Factory for creating instances that write data using . @@ -2569,8 +1653,8 @@ <configuration> <configSections> - <sectionGroup name="common"> - <section name="logging" + <sectionGroup key="common"> + <section key="logging" type="Common.Logging.ConfigurationSectionHandler, Common.Logging" requirePermission="false" /> </sectionGroup> @@ -2578,7 +1662,7 @@ <common> <logging> - <factoryAdapter type="Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter, Common.Logging"> + <factoryAdapter type="Common.Logging.Simple.DebugLoggerFactoryAdapter, Common.Logging"> <arg key="level" value="ALL" /> </factoryAdapter> </logging> @@ -2589,41 +1673,43 @@ - - Gilles Bayon Mark Pollack Erich Eichinger - + - Initializes a new instance of the class using default + Initializes a new instance of the class using default settings. - + - Initializes a new instance of the class. + Initializes a new instance of the class. Looks for level, showDateTime, showLogName, dateTimeFormat items from - for use when the GetLogger methods are called. - for more information on how to use the + for use when the GetLogger methods are called. + for more information on how to use the standard .NET application configuraiton file (App.config/Web.config) to configure this adapter. - The name value collection, typically specified by the user in + The key value collection, typically specified by the user in a configuration section named common/logging. - + Initializes a new instance of the class with default settings for the loggers created by this factory. - + + + Creates a new instance. + + + - Creates a new instance. @@ -2726,7 +1812,226 @@ The format of the message object to log. - + + + Ignores message. + + The format of the message object to log. + The exception to log. + the list of message format arguments + + + + Ignores message. + + An that supplies culture-specific formatting information. + The format of the message object to log. + the list of message format arguments + + + + Ignores message. + + An that supplies culture-specific formatting information. + The format of the message object to log. + The exception to log. + the list of message format arguments + + + + Ignores message. + + A callback used by the logger to obtain the message if log level is matched + + + + Ignores message. + + A callback used by the logger to obtain the message if log level is matched + The exception to log, including its stack Debug. + + + + Ignores message. + + An that supplies culture-specific formatting information. + A callback used by the logger to obtain the message if log level is matched + + + + Ignores message. + + An that supplies culture-specific formatting information. + A callback used by the logger to obtain the message if log level is matched + The exception to log, including its stack Debug. + + + + Ignores message. + + + + + + Ignores message. + + + + + + + Ignores message. + + The format of the message object to log. + + + + + Ignores message. + + The format of the message object to log. + The exception to log. + the list of message format arguments + + + + Ignores message. + + An that supplies culture-specific formatting information. + The format of the message object to log. + the list of message format arguments + + + + Ignores message. + + An that supplies culture-specific formatting information. + The format of the message object to log. + The exception to log. + the list of message format arguments + + + + Ignores message. + + A callback used by the logger to obtain the message if log level is matched + + + + Ignores message. + + A callback used by the logger to obtain the message if log level is matched + The exception to log, including its stack Info. + + + + Ignores message. + + An that supplies culture-specific formatting information. + A callback used by the logger to obtain the message if log level is matched + + + + Ignores message. + + An that supplies culture-specific formatting information. + A callback used by the logger to obtain the message if log level is matched + The exception to log, including its stack Info. + + + + Ignores message. + + + + + + Ignores message. + + + + + + + Ignores message. + + The format of the message object to log. + + + + + Ignores message. + + The format of the message object to log. + The exception to log. + the list of message format arguments + + + + Ignores message. + + An that supplies culture-specific formatting Warnrmation. + The format of the message object to log. + the list of message format arguments + + + + Ignores message. + + An that supplies culture-specific formatting Warnrmation. + The format of the message object to log. + The exception to log. + the list of message format arguments + + + + Ignores message. + + A callback used by the logger to obtain the message if log level is matched + + + + Ignores message. + + A callback used by the logger to obtain the message if log level is matched + The exception to log, including its stack Warn. + + + + Ignores message. + + An that supplies culture-specific formatting information. + A callback used by the logger to obtain the message if log level is matched + + + + Ignores message. + + An that supplies culture-specific formatting information. + A callback used by the logger to obtain the message if log level is matched + The exception to log, including its stack Warn. + + + + Ignores message. + + + + + + Ignores message. + + + + + + + Ignores message. + + The format of the message object to log. + + + Ignores message. @@ -2734,72 +2039,72 @@ The exception to log. the list of message format arguments - + Ignores message. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Errorrmation. The format of the message object to log. the list of message format arguments - + Ignores message. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Errorrmation. The format of the message object to log. The exception to log. the list of message format arguments - + Ignores message. A callback used by the logger to obtain the message if log level is matched - + Ignores message. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Debug. + The exception to log, including its stack Error. - + Ignores message. An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - + Ignores message. An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Debug. + The exception to log, including its stack Error. - + Ignores message. - + Ignores message. - + Ignores message. The format of the message object to log. - + Ignores message. @@ -2807,308 +2112,460 @@ The exception to log. the list of message format arguments - + Ignores message. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Fatalrmation. The format of the message object to log. the list of message format arguments - + Ignores message. - An that supplies culture-specific formatting information. + An that supplies culture-specific formatting Fatalrmation. The format of the message object to log. The exception to log. the list of message format arguments - + Ignores message. A callback used by the logger to obtain the message if log level is matched - + Ignores message. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Info. + The exception to log, including its stack Fatal. - + Ignores message. An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - + Ignores message. An that supplies culture-specific formatting information. A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Info. + The exception to log, including its stack Fatal. - + - Ignores message. + Always returns . - - + - Ignores message. + Always returns . - - - + - Ignores message. + Always returns . - The format of the message object to log. - - + - Ignores message. + Always returns . - The format of the message object to log. - The exception to log. - the list of message format arguments - + - Ignores message. + Always returns . - An that supplies culture-specific formatting Warnrmation. - The format of the message object to log. - the list of message format arguments - + - Ignores message. + Always returns . - An that supplies culture-specific formatting Warnrmation. - The format of the message object to log. - The exception to log. - the list of message format arguments - + - Ignores message. + Returns the global context for variables - A callback used by the logger to obtain the message if log level is matched - + - Ignores message. + Returns the thread-specific context for variables - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Warn. - + - Ignores message. + Factory for creating instances that silently ignores + logging requests. - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched + + This logger adapter is the default used by Common.Logging if unconfigured. Using this logger adapter is the most efficient + way to suppress any logging output. + + Below is an example how to configure this adapter: + + <configuration> + + <configSections> + <sectionGroup key="common"> + <section key="logging" + type="Common.Logging.ConfigurationSectionHandler, Common.Logging" + requirePermission="false" /> + </sectionGroup> + </configSections> + + <common> + <logging> + <factoryAdapter type="Common.Logging.Simple.NoOpLoggerFactoryAdapter, Common.Logging"> + <arg key="level" value="ALL" /> + </factoryAdapter> + </logging> + </common> + + </configuration> + + + + Gilles Bayon - + - Ignores message. + Constructor - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Warn. - + - Ignores message. + Constructor - - + - Ignores message. + Get a ILog instance by type - - + + - + - Ignores message. + Get a ILog instance by type key - The format of the message object to log. - + + - + - Ignores message. + A null-functionality implementation of + + + + + Sets the value of a new or existing variable within the global context + + The key of the variable that is to be added + The value to add + + + + Gets the value of a variable within the global context + + The key of the variable to get + The value or null if not found + + + + Checks if a variable is set within the global context + + The key of the variable to check for + True if the variable is set + + + + Removes a variable from the global context by key + + The key of the variable to remove + + + + Clears the global context variables + + + + + A implementation sending all System.Diagnostics.Trace output to + the Common.Logging infrastructure. + + + This listener captures all output sent by calls to System.Diagnostics.Trace and + and and sends it to an instance.
+ The instance to be used is obtained by calling + . The name of the logger is created by passing + this listener's and any source or category passed + into this listener (see or for example). + + + The snippet below shows how to add and configure this listener to your app.config: + + <system.diagnostics> + <sharedListeners> + <add name="Diagnostics" + type="Common.Logging.Simple.CommonLoggingTraceListener, Common.Logging" + initializeData="DefaultTraceEventType=Information; LoggerNameFormat={listenerName}.{sourceName}"> + <filter type="System.Diagnostics.EventTypeFilter" initializeData="Information"/> + </add> + </sharedListeners> + <trace> + <listeners> + <add name="Diagnostics" /> + </listeners> + </trace> + </system.diagnostics> + + + Erich Eichinger + + + + Creates a new instance with the default name "Diagnostics" and "Trace". + + + + + Creates a new instance initialized with properties from the . string. + + + is a semicolon separated string of name/value pairs, where each pair has + the form key=value. E.g. + "Name=MyLoggerName;LogLevel=Debug" + + a semicolon separated list of name/value pairs. + + + + Creates a new instance initialized with the specified properties. + + name/value configuration properties. + + + + Logs the given message to the Common.Logging infrastructure. + + the eventType + the name or category name passed into e.g. . + the id of this event + the message format + the message arguments + + + + Writes message to logger provided by . + + + + + Writes message to logger provided by . + + + + + Writes message to logger provided by . - The format of the message object to log. - The exception to log. - the list of message format arguments - + - Ignores message. + Writes message to logger provided by . - An that supplies culture-specific formatting Errorrmation. - The format of the message object to log. - the list of message format arguments - + - Ignores message. + Writes message to logger provided by . - An that supplies culture-specific formatting Errorrmation. - The format of the message object to log. - The exception to log. - the list of message format arguments - + - Ignores message. + Writes message to logger provided by . - A callback used by the logger to obtain the message if log level is matched - + - Ignores message. + Writes message to logger provided by . - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Error. - + - Ignores message. + Writes message to logger provided by - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - + - Ignores message. + Writes message to logger provided by - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Error. - + - Ignores message. + Writes message to logger provided by - - + - Ignores message. + Writes message to logger provided by - - - + - Ignores message. + Writes message to logger provided by - The format of the message object to log. - - + - Ignores message. + Writes message to logger provided by - The format of the message object to log. - The exception to log. - the list of message format arguments - + - Ignores message. + Sets the default to use for logging + all events emitted by .Write(...) and + .WriteLine(...) methods. - An that supplies culture-specific formatting Fatalrmation. - The format of the message object to log. - the list of message format arguments + + This listener captures all output sent by calls to and + sends it to an instance using the specified + on . + - + - Ignores message. + Format to use for creating the logger name. Defaults to "{listenerName}.{sourceName}". - An that supplies culture-specific formatting Fatalrmation. - The format of the message object to log. - The exception to log. - the list of message format arguments + + Available placeholders are: + + {listenerName}: the configured name of this listener instance. + {sourceName}: the trace source name an event originates from (see e.g. . + + - + - Ignores message. + Used in an application's configuration file (App.Config or Web.Config) to configure the logging subsystem. - A callback used by the logger to obtain the message if log level is matched + + An example configuration section that writes log messages to the Console using the + built-in Console Logger. + + <configuration> + <configSections> + <sectionGroup name="common"> + <section name="logging" type="Common.Logging.ConfigurationSectionHandler, Common.Logging" /> + </sectionGroup> + </configSections> + <common> + <logging> + <factoryAdapter type="Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter, Common.Logging"> + <arg key="showLogName" value="true" /> + <arg key="showDateTime" value="true" /> + <arg key="level" value="ALL" /> + <arg key="dateTimeFormat" value="yyyy/MM/dd HH:mm:ss:fff" /> + </factoryAdapter> + </logging> + </common> + </configuration> + + - + - Ignores message. + Ensure static fields get initialized before any class member + can be accessed (avoids beforeFieldInit) - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Fatal. - + - Ignores message. + Constructor - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - + - Ignores message. + Retrieves the of the logger the use by looking at the logFactoryAdapter element + of the logging configuration element. - An that supplies culture-specific formatting information. - A callback used by the logger to obtain the message if log level is matched - The exception to log, including its stack Fatal. + + + A object containing the specified type that implements + along with zero or more properties that will be + passed to the logger factory adapter's constructor as an . + - + - Always returns . + Verifies that the logFactoryAdapter element appears once in the configuration section. + settings of a parent section - atm this must always be null + Additional information about the configuration process. + The configuration section to apply an XPath query too. + + A object containing the specified logFactoryAdapter type + along with user supplied configuration properties. + - + - Always returns . + Verifies that the logFactoryAdapter element appears once in the configuration section. + The parent of the current item. + Additional information about the configuration process. + The configuration section to apply an XPath query too. + + A object containing the specified logFactoryAdapter type + along with user supplied configuration properties. + - + - Always returns . + Sends log messages to . + Gilles Bayon - + - Always returns . + Creates and initializes a logger that writes messages to . + The name, usually type name of the calling class, of the logger. + The current logging threshold. Messages recieved that are beneath this threshold will not be logged. + Include the current log level in the log message. + Include the current time in the log message. + Include the instance name in the log message. + The date and time format to use in the log message. - + - Always returns . + Creates and initializes a logger that writes messages to . + The name, usually type name of the calling class, of the logger. + The current logging threshold. Messages recieved that are beneath this threshold will not be logged. + Include the current log level in the log message. + Include the current time in the log message. + Include the instance name in the log message. + The date and time format to use in the log message. + Use color when writing the log message. - + - Always returns . + Do the actual logging by constructing the log message using a then + sending the output to . + The of the message. + The log message. + An optional associated with the message. - + - Factory for creating instances that silently ignores - logging requests. + Factory for creating instances that write data to . - This logger adapter is the default used by Common.Logging if unconfigured. Using this logger adapter is the most efficient - way to suppress any logging output. Below is an example how to configure this adapter: @@ -3124,7 +2581,7 @@ <common> <logging> - <factoryAdapter type="Common.Logging.Simple.NoOpLoggerFactoryAdapter, Common.Logging"> + <factoryAdapter type="Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter, Common.Logging"> <arg key="level" value="ALL" /> </factoryAdapter> </logging> @@ -3134,33 +2591,55 @@ + Gilles Bayon + Mark Pollack + Erich Eichinger - + - Constructor + Initializes a new instance of the class using default + settings. - + - Constructor + Initializes a new instance of the class. + + + Looks for level, showDateTime, showLogName, dateTimeFormat items from + for use when the GetLogger methods are called. + for more information on how to use the + standard .NET application configuraiton file (App.config/Web.config) + to configure this adapter. + + The name value collection, typically specified by the user in + a configuration section named common/logging. + + + + Constructor for binary backwards compatibility with non-portableversions + The properties. - + - Get a ILog instance by type + Initializes a new instance of the class with + default settings for the loggers created by this factory. - - - + - Get a ILog instance by type name + Initializes a new instance of the class with + default settings for the loggers created by this factory. + + + + + Creates a new instance. - - @@ -3260,7 +2739,7 @@ Initializes a new instance of the class using default settings. - + Initializes a new instance of the class. @@ -3291,14 +2770,5 @@ or . - - - Indicates classes or members to be ignored by NCover - - - Note, the name is chosen, because TestDriven.NET uses it as //ea argument to "Test With... Coverage" - - Erich Eichinger - diff --git a/packages/Quartz.2.2/Quartz.2.2.nupkg b/packages/Quartz.2.2/Quartz.2.2.nupkg deleted file mode 100644 index 9556eb0..0000000 Binary files a/packages/Quartz.2.2/Quartz.2.2.nupkg and /dev/null differ diff --git a/packages/Quartz.2.2/Quartz.2.2.nuspec b/packages/Quartz.2.2/Quartz.2.2.nuspec deleted file mode 100644 index a67b078..0000000 --- a/packages/Quartz.2.2/Quartz.2.2.nuspec +++ /dev/null @@ -1,58 +0,0 @@ - - - - Quartz - 2.2 - Quartz.NET - Marko Lahma - Marko Lahma - http://www.quartz-scheduler.net/ - false - Quartz.NET Scheduling Framework for .NET Platform - This release contains important bug fixes, new functionality and minor breaking changes. - -UPGRADING - -Database schema upgrade is needed from 2.x series to 2.2: - - * SQL Server: alter table QRTZ_FIRED_TRIGGERS add SCHED_TIME [BIGINT] NOT NULL; - * MySQL: alter table QRTZ_FIRED_TRIGGERS add SCHED_TIME BIGINT(19) NOT NULL - * Oracle: alter table QRTZ_FIRED_TRIGGERS add SCHED_TIME NUMBER(19) NOT NULL - * this adds a new column SCHED_TIME to table QRTZ_FIRED_TRIGGERS - -BREAKING CHANGES - - * database schema needs upgrade - * add SchedulerStarting() method to ISchedulerListener interface - * make the scheduler's TypeLoadHelper available to plugins when they are initialized - * dbFailureRetryInterval parameter was removed from DirectSchedulerFactory APIs - -NEW FEATURES - - * ability to override worker thread names (when using SimpleThreadPool) - * add new IScheduler method: ScheduleJob(IJobDetail job, ISet trigger) to schedule multiple triggers for a job all at once - * allow 'triggerless' initial storing of non-durable jobs. - * improvements for job recovery information - * package job_scheduling_data_2_0.xsd to nuget package's content folder - * allow scheduler exported with remoting to be used from local machine only - * support for Oracle managed ODP driver - -FIXES - - * job ending with exception and trigger not going to fire again, trigger is incorrectly not removed from job store - * XML schema supports multiple schedule elements but processor does not - * DailyTimeIntervalTriggerPersistenceDelegate does not handle empty time interval properly - * DailyTimeIntervalScheduleBuilder.EndingDailyAfterCount(...) doesn't pass validation - * trace throwing exception - * bug in QuartzSchedulerThread.GetRandomizedIdleWaitTime() - * can't delete or replace job without the referenced class - -MISC - -* Performance improvements, including improvements to some select statements in AdoJobStore - en-US - - - - - \ No newline at end of file diff --git a/packages/Quartz.2.2/lib/net35-client/Quartz.dll b/packages/Quartz.2.2/lib/net35-client/Quartz.dll deleted file mode 100644 index 39465a3..0000000 Binary files a/packages/Quartz.2.2/lib/net35-client/Quartz.dll and /dev/null differ diff --git a/packages/Quartz.2.2/lib/net35-client/Quartz.pdb b/packages/Quartz.2.2/lib/net35-client/Quartz.pdb deleted file mode 100644 index 2cbc9e8..0000000 Binary files a/packages/Quartz.2.2/lib/net35-client/Quartz.pdb and /dev/null differ diff --git a/packages/Quartz.2.2/lib/net35/Quartz.dll b/packages/Quartz.2.2/lib/net35/Quartz.dll deleted file mode 100644 index 29a3cd0..0000000 Binary files a/packages/Quartz.2.2/lib/net35/Quartz.dll and /dev/null differ diff --git a/packages/Quartz.2.2/lib/net35/Quartz.pdb b/packages/Quartz.2.2/lib/net35/Quartz.pdb deleted file mode 100644 index c8f0604..0000000 Binary files a/packages/Quartz.2.2/lib/net35/Quartz.pdb and /dev/null differ diff --git a/packages/Quartz.2.2/lib/net40-client/Quartz.dll b/packages/Quartz.2.2/lib/net40-client/Quartz.dll deleted file mode 100644 index 7f332ee..0000000 Binary files a/packages/Quartz.2.2/lib/net40-client/Quartz.dll and /dev/null differ diff --git a/packages/Quartz.2.2/lib/net40-client/Quartz.pdb b/packages/Quartz.2.2/lib/net40-client/Quartz.pdb deleted file mode 100644 index 58b0541..0000000 Binary files a/packages/Quartz.2.2/lib/net40-client/Quartz.pdb and /dev/null differ diff --git a/packages/Quartz.2.2/lib/net40/Quartz.dll b/packages/Quartz.2.2/lib/net40/Quartz.dll deleted file mode 100644 index 284f56e..0000000 Binary files a/packages/Quartz.2.2/lib/net40/Quartz.dll and /dev/null differ diff --git a/packages/Quartz.2.2/lib/net40/Quartz.pdb b/packages/Quartz.2.2/lib/net40/Quartz.pdb deleted file mode 100644 index 8f8c3e0..0000000 Binary files a/packages/Quartz.2.2/lib/net40/Quartz.pdb and /dev/null differ diff --git a/packages/Quartz.2.2/content/job_scheduling_data_2_0.xsd b/packages/Quartz.2.3.2/content/job_scheduling_data_2_0.xsd similarity index 100% rename from packages/Quartz.2.2/content/job_scheduling_data_2_0.xsd rename to packages/Quartz.2.3.2/content/job_scheduling_data_2_0.xsd diff --git a/packages/Quartz.2.3.2/lib/net35-client/Quartz.pdb b/packages/Quartz.2.3.2/lib/net35-client/Quartz.pdb new file mode 100644 index 0000000..454cc08 Binary files /dev/null and b/packages/Quartz.2.3.2/lib/net35-client/Quartz.pdb differ diff --git a/packages/Quartz.2.2/lib/net40-client/Quartz.xml b/packages/Quartz.2.3.2/lib/net35-client/Quartz.xml similarity index 96% rename from packages/Quartz.2.2/lib/net40-client/Quartz.xml rename to packages/Quartz.2.3.2/lib/net35-client/Quartz.xml index 9ee197f..8ebb68e 100644 --- a/packages/Quartz.2.2/lib/net40-client/Quartz.xml +++ b/packages/Quartz.2.3.2/lib/net35-client/Quartz.xml @@ -68,7 +68,7 @@ - Constructor that prepolutates. + Constructor that prepopulates. @@ -673,7 +673,7 @@ - Removes the object from garbae collection protected list. + Removes the object from garbage collection protected list. The obj. @@ -1060,7 +1060,7 @@ Notifies the trigger listeners of completion. - The job executution context. + The job execution context. The instruction code to report to triggers. @@ -1071,7 +1071,7 @@ - Notifies the job listeners that job exucution was vetoed. + Notifies the job listeners that job execution was vetoed. The job execution context. @@ -1228,7 +1228,7 @@ Gets or sets a value indicating whether to signal on scheduling change. - true if schduler should signal on scheduling change; otherwise, false. + true if scheduler should signal on scheduling change; otherwise, false. @@ -1596,7 +1596,7 @@ Signals the main processing loop that a change in scheduling has been - made - in order to interrupt any sleeping that may be occuring while + made - in order to interrupt any sleeping that may be occurring while waiting for the fire time to arrive. @@ -1683,6 +1683,56 @@ Signals the scheduling change. + + + The DbMetadata factory based on application configuration + + + + + Base class for the DbMetadata Factory implementations + + + + + Gets the supported provider names. + + The enumeration of the supported provider names + + + + Gets the database metadata associated to the specified provider name. + + Name of the provider. + The metadata instance for the requested provider + + + + Initializes a new instance of the class. + + Name of the configuration section. + The provider name prefix. + The providerNamePrefix cannot be null or empty. + + + + Gets the properties parser. + + The properties parser + + + + Gets the supported provider names. + + The enumeration of the supported provider names + + + + Gets the database metadata associated to the specified provider name. + + Name of the provider. + The metadata instance for the specified name + Metadata information about specific ADO.NET driver library. Metadata is used to @@ -1822,7 +1872,7 @@ - Returns a new command object for executing SQL statments/Stored Procedures + Returns a new command object for executing SQL statements/Stored Procedures against the database. An new @@ -1878,9 +1928,15 @@ + + + Generates the valid provider names information. + + + - Returns a new command object for executing SQL statments/Stored Procedures + Returns a new command object for executing SQL statements/Stored Procedures against the database. An new @@ -1924,6 +1980,31 @@ The metadata. + + + The DbMetadata factory based on embedded assembly resource + + + + + Initializes a new instance of the class. + + Name of the resource. + Name of the property group (The prefix of the provider name). + + + + Gets the supported provider names. + + The enumeration of the supported provider names + + + + Gets the database metadata associated to the specified provider name. + + Name of the provider. + The metadata instance for the specified name + This interface can be implemented by any @@ -1970,7 +2051,7 @@ Replace the table prefix in a query by replacing any occurrences of "{0}" with the table prefix. - The unsubstitued query + The unsubstituted query The table prefix the scheduler name The query, with proper table prefix substituted @@ -2229,7 +2310,7 @@ - Initialization argumens holder for implementations. + Initialization arguments holder for implementations. @@ -2281,143 +2362,20 @@ settingName=settingValue|otherSettingName=otherSettingValue|... - - - Conveys the state of a fired-trigger record. - - James House - Marko Lahma (.NET) - - - - Gets or sets the fire instance id. - - The fire instance id. - - - - Gets or sets the fire timestamp. - - The fire timestamp. - - - - Gets or sets the scheduled fire timestamp. - - - - - Gets or sets a value indicating whether job disallows concurrent execution. - - - - - Gets or sets the job key. - - The job key. - - - - Gets or sets the scheduler instance id. - - The scheduler instance id. - - - - Gets or sets the trigger key. - - The trigger key. - - - - Gets or sets the state of the fire instance. - - The state of the fire instance. - - - - Gets or sets a value indicating whether [job requests recovery]. - - true if [job requests recovery]; otherwise, false. - - - - Gets or sets the priority. - - The priority. - - - - Service interface or modifying parameters - and resultset values. - - - - - Prepares a to be used to access database. - - Connection and tranasction pair - SQL to run - - - - - Adds a parameter to . - - Command to add parameter to - Parameter's name - Parameter's value - - - - Adds a parameter to . - - Command to add parameter to - Parameter's name - Parameter's value - Parameter's data type - - - - Gets the db presentation for boolean value. Subclasses can overwrite this behaviour. - - Value to map to database. - - - - - Gets the boolean value from db presentation. Subclasses can overwrite this behaviour. - - Value to map from database. - - - - - Gets the db presentation for date/time value. Subclasses can overwrite this behaviour. - - Value to map to database. - - - - - Gets the date/time value from db presentation. Subclasses can overwrite this behaviour. - - Value to map from database. - - - + - Gets the db presentation for time span value. Subclasses can overwrite this behaviour. + Delegate implementation for Firebird. - Value to map to database. - - + - Gets the time span value from db presentation. Subclasses can overwrite this behaviour. + This is meant to be an abstract base class for most, if not all, + implementations. Subclasses should override only those methods that need + special handling for the DBMS driver in question. - Value to map from database. - + Jeffrey Wescott + James House + Marko Lahma (.NET) @@ -3116,2399 +3074,2559 @@ - + - Exception class for when a driver delegate cannot be found for a given - configuration, or lack thereof. + Service interface or modifying parameters + and resultset values. - Jeffrey Wescott - Marko Lahma (.NET) - - - Base class for exceptions thrown by the Quartz . + + + Prepares a to be used to access database. - - SchedulerExceptions may contain a reference to another - , which was the underlying cause of the SchedulerException. - - James House - Marko Lahma (.NET) + Connection and transaction pair + SQL to run + - + - Initializes a new instance of the class. + Adds a parameter to . + Command to add parameter to + Parameter's name + Parameter's value - + - Initializes a new instance of the class. + Adds a parameter to . - The MSG. + Command to add parameter to + Parameter's name + Parameter's value + Parameter's data type - + - Initializes a new instance of the class. + Gets the db presentation for boolean value. Subclasses can overwrite this behaviour. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The class name is null or is zero (0). - The info parameter is null. + Value to map to database. + - + - Initializes a new instance of the class. + Gets the boolean value from db presentation. Subclasses can overwrite this behaviour. - The cause. + Value to map from database. + - + - Initializes a new instance of the class. + Gets the db presentation for date/time value. Subclasses can overwrite this behaviour. - The MSG. - The cause. + Value to map to database. + - + - Creates and returns a string representation of the current exception. + Gets the date/time value from db presentation. Subclasses can overwrite this behaviour. - - A string representation of the current exception. - - + Value to map from database. + - + - Initializes a new instance of the class. + Gets the db presentation for time span value. Subclasses can overwrite this behaviour. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The class name is null or is zero (0). - The info parameter is null. - - - - is meant to be used in an application-server - or other software framework environment that provides - container-managed-transactions. No commit / rollback will be handled by this class. - - - If you need commit / rollback, use - instead. - - Jeffrey Wescott - James House - Srinivas Venkatarangaiah - Marko Lahma (.NET) - - - - Contains base functionality for ADO.NET-based JobStore implementations. - - Jeffrey Wescott - James House - Marko Lahma (.NET) - - - - The interface to be implemented by classes that want to provide a - and storage mechanism for the - 's use. - - - Storage of s and s should be keyed - on the combination of their name and group for uniqueness. - - - - - - - - James House - Marko Lahma (.NET) + Value to map to database. + - + - Called by the QuartzScheduler before the is - used, in order to give the it a chance to Initialize. + Gets the time span value from db presentation. Subclasses can overwrite this behaviour. + Value to map from database. + - + - Called by the QuartzScheduler to inform the that - the scheduler has started. + Initializes the driver delegate. - + - Called by the QuartzScheduler to inform the JobStore that - the scheduler has been paused. + Insert the job detail record. + the DB Connection + the new state for the triggers + the first old state to update + the second old state to update + number of rows updated - + - Called by the QuartzScheduler to inform the JobStore that - the scheduler has resumed after being paused. + Get the names of all of the triggers that have misfired. + the DB Connection + The ts. + an array of objects - - - Called by the QuartzScheduler to inform the that - it should free up all of it's resources because the scheduler is - shutting down. + + + Select all of the triggers in a given state. + The DB Connection + The state the triggers must be in + an array of trigger s - + - Store the given and . + Get the names of all of the triggers in the given state that have + misfired - according to the given timestamp. - The to be stored. - The to be stored. - ObjectAlreadyExistsException + The DB Connection + The state. + The time stamp. + An array of objects - + - returns true if the given JobGroup is paused + Get the names of all of the triggers in the given state that have + misfired - according to the given timestamp. No more than count will + be returned. - - + The conn. + The state1. + The ts. + The most misfired triggers to return, negative for all + + Output parameter. A List of objects. Must not be null + + Whether there are more misfired triggers left to find beyond the given count. - + - returns true if the given TriggerGroup - is paused + Get the number of triggers in the given state that have + misfired - according to the given timestamp. - + + + - + - Store the given . + Get the names of all of the triggers in the given group and state that + have misfired. - The to be stored. - - If , any existing in the - with the same name and group should be - over-written. - + The DB Connection + Name of the group. + The state. + The timestamp. + an array of objects - + - Remove (delete) the with the given - key, and any s that reference - it. + Select all of the triggers for jobs that are requesting recovery. The + returned trigger objects will have unique "recoverXXX" trigger names and + will be in the + trigger group. - If removal of the results in an empty group, the - group should be removed from the 's list of - known group names. + In order to preserve the ordering of the triggers, the fire time will be + set from the ColumnFiredTime column in the TableFiredTriggers + table. The caller is responsible for calling + on each returned trigger. It is also up to the caller to insert the + returned triggers to ensure that they are fired. - - if a with the given name and - group was found and removed from the store. - + The DB Connection + an array of objects - + - Retrieve the for the given - . + Delete all fired triggers. - - The desired , or null if there is no match. - + The DB Connection. + The number of rows deleted. - + - Store the given . + Delete all fired triggers of the given instance. - The to be stored. - If , any existing in - the with the same name and group should - be over-written. - ObjectAlreadyExistsException + The DB Connection + The instance id. + The number of rows deleted - + - Remove (delete) the with the given key. + Clear (delete!) all scheduling data - all s, s + s. - - If removal of the results in an empty group, the - group should be removed from the 's list of - known group names. - - - If removal of the results in an 'orphaned' - that is not 'durable', then the should be deleted - also. - - - if a with the given - name and group was found and removed from the store. - - + - Remove (delete) the with the - given name, and store the new given one - which must be associated - with the same job. + Insert the job detail record. - The to be replaced. - The new to be stored. - - if a with the given - name and group was found and removed from the store. - + The DB Connection. + The job to insert. + Number of rows inserted. - + - Retrieve the given . + Gets the db presentation for boolean value. Subclasses can overwrite this behaviour. - - The desired , or null if there is no - match. - + Value to map to database. + - + - Determine whether a with the given identifier already - exists within the scheduler. + Gets the boolean value from db presentation. Subclasses can overwrite this behaviour. - - - the identifier to check for - true if a job exists with the given identifier + Value to map from database. + - + - Determine whether a with the given identifier already - exists within the scheduler. + Gets the db presentation for date/time value. Subclasses can overwrite this behaviour. - - - the identifier to check for - true if a trigger exists with the given identifier + Value to map to database. + - + - Clear (delete!) all scheduling data - all s, s - s. + Gets the date/time value from db presentation. Subclasses can overwrite this behaviour. - - + Value to map from database. + - + - Store the given . + Gets the db presentation for time span value. Subclasses can overwrite this behaviour. - The name. - The to be stored. - If , any existing - in the with the same name and group - should be over-written. - If , any s existing - in the that reference an existing - Calendar with the same name with have their next fire time - re-computed with the new . - ObjectAlreadyExistsException + Value to map to database. + - + - Remove (delete) the with the - given name. + Gets the time span value from db presentation. Subclasses can overwrite this behaviour. - - If removal of the would result in - s pointing to non-existent calendars, then a - will be thrown. - - The name of the to be removed. - - if a with the given name - was found and removed from the store. - + Value to map from database. + - + - Retrieve the given . + Update the job detail record. - The name of the to be retrieved. - - The desired , or null if there is no - match. - + The DB Connection. + The job to update. + Number of rows updated. - + - Get the number of s that are - stored in the . + Get the names of all of the triggers associated with the given job. - + The DB Connection. + The key identifying the job. + An array of objects - + - Get the number of s that are - stored in the . + Delete the job detail record for the given job. - + the DB Connection + The key identifying the job. + the number of rows deleted - + - Get the number of s that are - stored in the . + Check whether or not the given job is stateful. - + the DB Connection + The key identifying the job. + + true if the job exists and is stateful, false otherwise + - + - Get the names of all of the s that - have the given group name. - - If there are no jobs in the given group name, the result should be a - zero-length array (not ). - + Check whether or not the given job exists. - - + the DB Connection + The key identifying the job. + true if the job exists, false otherwise - + - Get the names of all of the s - that have the given group name. - - If there are no triggers in the given group name, the result should be a - zero-length array (not ). - + Update the job data map for the given job. + The conn. + the job to update + the number of rows updated - + - Get the names of all of the - groups. - - If there are no known group names, the result should be a zero-length - array (not ). - + Select the JobDetail object for a given job name / group name. + The DB Connection. + The key identifying the job. + The load helper. + The populated JobDetail object. - + + build Map from java.util.Properties encoding. + + - Get the names of all of the - groups. - - If there are no known group names, the result should be a zero-length - array (not ). - + Select the total number of jobs stored. + The DB Connection. + The total number of jobs stored. - + - Get the names of all of the s - in the . - - - If there are no Calendars in the given group name, the result should be - a zero-length array (not ). - + Select all of the job group names that are stored. + The DB Connection. + An array of group names. - + - Get all of the Triggers that are associated to the given Job. + Select all of the jobs contained in a given group. - - If there are no matches, a zero-length array should be returned. - + The DB Connection. + + An array of job names. - + - Get the current state of the identified . + Insert the base trigger data. - + the DB Connection + the trigger to insert + the state that the trigger should be stored in + The job detail. + the number of rows inserted - + - Pause the with the given key. + Insert the blob trigger data. + The DB Connection. + The trigger to insert. + The number of rows inserted. - + - Pause all of the s in the - given group. + Update the base trigger data. - - The JobStore should "remember" that the group is paused, and impose the - pause on any new triggers that are added to the group while the group is - paused. - + The DB Connection. + The trigger to insert. + The state that the trigger should be stored in. + The job detail. + The number of rows updated. - + - Pause the with the given key - by - pausing all of its current s. + Update the blob trigger data. + The DB Connection. + The trigger to insert. + The number of rows updated. - + - Pause all of the s in the given - group - by pausing all of their s. - - The JobStore should "remember" that the group is paused, and impose the - pause on any new jobs that are added to the group while the group is - paused. - + Check whether or not a trigger exists. - - + The DB Connection. + the key of the trigger + true if the trigger exists, false otherwise - + - Resume (un-pause) the with the - given key. - - - If the missed one or more fire-times, then the - 's misfire instruction will be applied. - + Update the state for a given trigger. - - + The DB Connection. + the key of the trigger + The new state for the trigger. + The number of rows updated. - + - Resume (un-pause) all of the s - in the given group. - - If any missed one or more fire-times, then the - 's misfire instruction will be applied. - + Update the given trigger to the given new state, if it is one of the + given old states. + The DB connection. + the key of the trigger + The new state for the trigger. + One of the old state the trigger must be in. + One of the old state the trigger must be in. + One of the old state the trigger must be in. + The number of rows updated. - + - Gets the paused trigger groups. - - - - - - Resume (un-pause) the with the - given key. - - If any of the 's s missed one - or more fire-times, then the 's misfire - instruction will be applied. - + Update all triggers in the given group to the given new state, if they + are in one of the given old states. + The DB connection. + + The new state for the trigger. + One of the old state the trigger must be in. + One of the old state the trigger must be in. + One of the old state the trigger must be in. + The number of rows updated. - + - Resume (un-pause) all of the s in - the given group. - - If any of the s had s that - missed one or more fire-times, then the 's - misfire instruction will be applied. - + Update the given trigger to the given new state, if it is in the given + old state. + the DB connection + the key of the trigger + the new state for the trigger + the old state the trigger must be in + int the number of rows updated - + - Pause all triggers - equivalent of calling - on every group. - - When is called (to un-pause), trigger misfire - instructions WILL be applied. - + Update all of the triggers of the given group to the given new state, if + they are in the given old state. - + the DB connection + + the new state for the trigger group + the old state the triggers must be in + int the number of rows updated - + - Resume (un-pause) all triggers - equivalent of calling - on every group. - - If any missed one or more fire-times, then the - 's misfire instruction will be applied. - - + Update the states of all triggers associated with the given job. - + the DB Connection + the key of the job + the new state for the triggers + the number of rows updated - + - Get a handle to the next trigger to be fired, and mark it as 'reserved' - by the calling scheduler. + Updates the state of the trigger states for job from other. - If > 0, the JobStore should only return a Trigger - that will fire no later than the time represented in this value as - milliseconds. - - + The conn. + Key of the job. + The state. + The old state. - - - - - Inform the that the scheduler no longer plans to - fire the given , that it had previously acquired - (reserved). + + + Delete the cron trigger data for a trigger. + the DB Connection + the key of the trigger + the number of rows deleted - + - Inform the that the scheduler is now firing the - given (executing its associated ), - that it had previously acquired (reserved). + Delete the base trigger data for a trigger. - - May return null if all the triggers or their calendars no longer exist, or - if the trigger was not successfully put into the 'executing' - state. Preference is to return an empty list if none of the triggers - could be fired. - + the DB Connection + the key of the trigger + the number of rows deleted - + - Inform the that the scheduler has completed the - firing of the given (and the execution its - associated ), and that the - in the given should be updated if the - is stateful. + Select the number of triggers associated with a given job. + the DB Connection + the key of the job + the number of triggers for the given job - + - Indicates whether job store supports persistence. + Select the triggers for a job - + the DB Connection + the key of the job + + an array of objects + associated with a given job. + - + - How long (in milliseconds) the implementation - estimates that it will take to release a trigger and acquire a new one. + Select the triggers for a calendar + The DB Connection. + Name of the calendar. + + An array of objects associated with a given job. + - + - Whether or not the implementation is clustered. + Select a trigger. - + the DB Connection + the key of the trigger + The object - + - Inform the of the Scheduler instance's Id, - prior to initialize being invoked. + Select a trigger's JobDataMap. + the DB Connection + the key of the trigger + The of the Trigger, never null, but possibly empty. - + - Inform the of the Scheduler instance's name, - prior to initialize being invoked. + Select a trigger's state value. + the DB Connection + the key of the trigger + The object - + - Tells the JobStore the pool size used to execute jobs. + Select a trigger status (state and next fire time). + the DB Connection + the key of the trigger + + a object, or null + - + - Initializes a new instance of the class. + Select the total number of triggers stored. + the DB Connection + the total number of triggers stored - + - Gets the connection and starts a new transaction. + Select all of the trigger group names that are stored. - + the DB Connection + + an array of group names + - + - Called by the QuartzScheduler before the is - used, in order to give it a chance to Initialize. + Select all of the triggers contained in a given group. + the DB Connection + + + an array of trigger names + - - - - + - Called by the QuartzScheduler to inform the JobStore that - the scheduler has been paused. + Inserts the paused trigger group. + The conn. + Name of the group. + - + - Called by the QuartzScheduler to inform the JobStore that - the scheduler has resumed after being paused. + Deletes the paused trigger group. + The conn. + Name of the group. + - + - Called by the QuartzScheduler to inform the that - it should free up all of it's resources because the scheduler is - shutting down. + Deletes all paused trigger groups. + The conn. + - + - Will recover any failed or misfired jobs and clean up the data store as - appropriate. + Determines whether the specified trigger group is paused. + The conn. + Name of the group. + + true if trigger group is paused; otherwise, false. + - + - Will recover any failed or misfired jobs and clean up the data store as - appropriate. + Determines whether given trigger group already exists. + The conn. + Name of the group. + + true if trigger group exists; otherwise, false. + - + - Store the given and . + Insert a new calendar. - Job to be stored. - Trigger to be stored. + the DB Connection + The name for the new calendar. + The calendar. + the number of rows inserted + IOException - + - returns true if the given JobGroup - is paused + Update a calendar. - - + the DB Connection + The name for the new calendar. + The calendar. + the number of rows updated + IOException - + - returns true if the given TriggerGroup - is paused + Check whether or not a calendar exists. - - + the DB Connection + The name of the calendar. + + true if the trigger exists, false otherwise + - + - Stores the given . - - The to be stored. - - If , any existing in the - with the same name & group should be over-written. - - - - - Insert or update a job. - + Select a calendar. + the DB Connection + The name of the calendar. + the Calendar + ClassNotFoundException + IOException - + - Check existence of a given job. + Check whether or not a calendar is referenced by any triggers. + the DB Connection + The name of the calendar. + + true if any triggers reference the calendar, false otherwise + - + - Store the given . + Delete a calendar. - The to be stored. - - If , any existing in - the with the same name & group should - be over-written. - - - if a with the same name/group already - exists, and replaceExisting is set to false. - + the DB Connection + The name of the trigger. + the number of rows deleted - + - Insert or update a trigger. + Select the total number of calendars stored. + the DB Connection + the total number of calendars stored - + - Check existence of a given trigger. + Select all of the stored calendars. + the DB Connection + + an array of calendar names + - + - Remove (delete) the with the given - name, and any s that reference - it. + Select the trigger that will be fired at the given fire time. - - - If removal of the results in an empty group, the - group should be removed from the 's list of - known group names. - + the DB Connection + the time that the trigger will be fired - if a with the given name & - group was found and removed from the store. + a representing the + trigger that will be fired at the given fire time, or null if no + trigger will be fired at that time - + - Delete a job and its listeners. + Select the next trigger which will fire to fire between the two given timestamps + in ascending order of fire time, and then descending by priority. - - + The conn. + highest value of of the triggers (exclusive) + highest value of of the triggers (inclusive) + maximum number of trigger keys allow to acquired in the returning list. + A (never null, possibly empty) list of the identifiers (Key objects) of the next triggers to be fired. - + - Delete a trigger, its listeners, and its Simple/Cron/BLOB sub-table entry. + Insert a fired trigger. - - - + the DB Connection + the trigger + the state that the trigger should be stored in + The job. + the number of rows inserted - + - Retrieve the for the given - . + + Update a fired trigger. + - The key identifying the job. - The desired , or null if there is no match. - - - - Remove (delete) the with the - given name. - - - - - If removal of the results in an empty group, the - group should be removed from the 's list of - known group names. - - - - If removal of the results in an 'orphaned' - that is not 'durable', then the should be deleted - also. - - - The key identifying the trigger. - - if a with the given - name & group was found and removed from the store. - + + + + the DB Connection + + the trigger + + + the state that the trigger should be stored in + the number of rows inserted - - + + + Select the states of all fired-trigger records for a given trigger, or + trigger group if trigger name is . + + The DB connection. + Name of the trigger. + Name of the group. + a List of objects. - + - Retrieve the given . + Select the states of all fired-trigger records for a given job, or job + group if job name is . - The key identifying the trigger. - The desired , or null if there is no match. + The DB connection. + Name of the job. + Name of the group. + a List of objects. - + - Get the current state of the identified . + Select the states of all fired-trigger records for a given scheduler + instance. - - - - - + The DB Connection + Name of the instance. + A list of FiredTriggerRecord objects. - + - Gets the state of the trigger. + Select the distinct instance names of all fired-trigger records. The conn. - The key identifying the trigger. + + This is useful when trying to identify orphaned fired triggers (a + fired trigger without a scheduler state record.) + - + - Store the given . + Delete a fired trigger. - The name of the calendar. - The to be stored. - - If , any existing - in the with the same name & group - should be over-written. - - - - if a with the same name already - exists, and replaceExisting is set to false. - - - - - Remove (delete) the with the given name. - - - If removal of the would result in - s pointing to non-existent calendars, then a - will be thrown. - - The name of the to be removed. - - if a with the given name - was found and removed from the store. - + the DB Connection + the fired trigger entry to delete + the number of rows deleted - + - Retrieve the given . + Selects the job execution count. - The name of the to be retrieved. - The desired , or null if there is no match. + The DB connection. + The key of the job. + - + - Get the number of s that are - stored in the . + Inserts the state of the scheduler. + The conn. + The instance id. + The check in time. + The interval. + - + - Get the number of s that are - stored in the . + Deletes the state of the scheduler. + The database connection. + The instance id. + - + - Get the number of s that are - stored in the . + Updates the state of the scheduler. + The database connection. + The instance id. + The check in time. + - + - Get the names of all of the s that - have the given group name. + A List of all current s. + + If instanceId is not null, then only the record for the identified + instance will be returned. + - - If there are no jobs in the given group name, the result should be a - zero-length array (not ). - + The DB Connection + The instance id. + - + - Determine whether a with the given identifier already - exists within the scheduler. + Replace the table prefix in a query by replacing any occurrences of + "{0}" with the table prefix. - - - the identifier to check for - true if a Job exists with the given identifier + The unsubstituted query + The query, with proper table prefix substituted - + - Determine whether a with the given identifier already - exists within the scheduler. + Create a serialized version of an Object. - - - the identifier to check for - true if a Trigger exists with the given identifier + the object to serialize + Serialized object as byte array. - + - Clear (delete!) all scheduling data - all s, s - s. + Remove the transient data from and then create a serialized + version of a and returns the underlying bytes. - - + The data. + the serialized data as byte array - + - Get the names of all of the s - that have the given group name. + serialize - - If there are no triggers in the given group name, the result should be a - zero-length array (not ). - + The data. + - - - Get the names of all of the - groups. + + + Convert the JobDataMap into a list of properties. - - - If there are no known group names, the result should be a zero-length - array (not ). - - + - Get the names of all of the - groups. + Convert the JobDataMap into a list of properties. - - - If there are no known group names, the result should be a zero-length - array (not ). - - + - Get the names of all of the s - in the . + This method should be overridden by any delegate subclasses that need + special handling for BLOBs. The default implementation uses standard + ADO.NET operations. - - If there are no Calendars in the given group name, the result should be - a zero-length array (not ). - + The data reader, already queued to the correct row. + The column index for the BLOB. + The deserialized object from the DataReader BLOB. - + - Get all of the Triggers that are associated to the given Job. + This method should be overridden by any delegate subclasses that need + special handling for BLOBs for job details. - - If there are no matches, a zero-length array should be returned. - + The result set, already queued to the correct row. + The column index for the BLOB. + The deserialized Object from the ResultSet BLOB. - + - Pause the with the given name. + Selects the paused trigger groups. + The DB Connection. + - + - Pause the with the given name. + Gets the select next trigger to acquire SQL clause. + FireBird version with ROWS support. + - + - Pause the with the given name - by - pausing all of its current s. + Conveys the state of a fired-trigger record. - + James House + Marko Lahma (.NET) - + - Pause all of the s in the given - group - by pausing all of their s. + Gets or sets the fire instance id. - + The fire instance id. - + - Determines if a Trigger for the given job should be blocked. - State can only transition to StatePausedBlocked/StateBlocked from - StatePaused/StateWaiting respectively. + Gets or sets the fire timestamp. - StatePausedBlocked, StateBlocked, or the currentState. + The fire timestamp. - + - Resume (un-pause) the with the - given name. + Gets or sets the scheduled fire timestamp. - - If the missed one or more fire-times, then the - 's misfire instruction will be applied. - - + - Resume (un-pause) the with the - given name. + Gets or sets a value indicating whether job disallows concurrent execution. - - If any of the 's s missed one - or more fire-times, then the 's misfire - instruction will be applied. - - - + - Resume (un-pause) all of the s in - the given group. + Gets or sets the job key. - - If any of the s had s that - missed one or more fire-times, then the 's - misfire instruction will be applied. - - + The job key. - + - Pause all of the s in the given group. + Gets or sets the scheduler instance id. - + The scheduler instance id. - + - Pause all of the s in the given group. + Gets or sets the trigger key. + The trigger key. - - - Pause all of the s in the - given group. + + + Gets or sets the state of the fire instance. + The state of the fire instance. - + - Resume (un-pause) all of the s - in the given group. - - If any missed one or more fire-times, then the - 's misfire instruction will be applied. - + Gets or sets a value indicating whether [job requests recovery]. + true if [job requests recovery]; otherwise, false. - + - Pause all triggers - equivalent of calling - on every group. - - When is called (to un-pause), trigger misfire - instructions WILL be applied. - + Gets or sets the priority. - - + The priority. - + - Resume (un-pause) all triggers - equivalent of calling - on every group. + Exception class for when a driver delegate cannot be found for a given + configuration, or lack thereof. + + Jeffrey Wescott + Marko Lahma (.NET) + + + + Base class for exceptions thrown by the Quartz . - If any missed one or more fire-times, then the - 's misfire instruction will be applied. + SchedulerExceptions may contain a reference to another + , which was the underlying cause of the SchedulerException. - + James House + Marko Lahma (.NET) - + - Resume (un-pause) all triggers - equivalent of calling - on every group. - - If any missed one or more fire-times, then the - 's misfire instruction will be applied. - + Initializes a new instance of the class. - - + - Get a handle to the next N triggers to be fired, and mark them as 'reserved' - by the calling scheduler. + Initializes a new instance of the class. - + The MSG. - + - Inform the that the scheduler no longer plans to - fire the given , that it had previously acquired - (reserved). + Initializes a new instance of the class. + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The class name is null or is zero (0). + The info parameter is null. - + - Inform the that the scheduler has completed the - firing of the given (and the execution its - associated ), and that the - in the given should be updated if the - is stateful. + Initializes a new instance of the class. + The cause. - + - Get a list of all scheduler instances in the cluster that may have failed. - This includes this scheduler if it is checking in for the first time. + Initializes a new instance of the class. + The MSG. + The cause. - + - Create dummy objects for fired triggers - that have no scheduler state record. Checkin timestamp and interval are - left as zero on these dummy objects. + Creates and returns a string representation of the current exception. - - List of all current s + + A string representation of the current exception. + + - + - Cleanup the given database connection. This means restoring - any modified auto commit or transaction isolation connection - attributes, and then closing the underlying connection. - - - - This is separate from closeConnection() because the Spring - integration relies on being able to overload closeConnection() and - expects the same connection back that it originally returned - from the datasource. - - - - - - Closes the supplied connection. + Initializes a new instance of the class. - (Optional) + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The class name is null or is zero (0). + The info parameter is null. - + - Rollback the supplied connection. - - (Optional) - - JobPersistenceException thrown if a SQLException occurs when the - connection is rolled back - + is meant to be used in an application-server + or other software framework environment that provides + container-managed-transactions. No commit / rollback will be handled by this class. + + + If you need commit / rollback, use + instead. + + Jeffrey Wescott + James House + Srinivas Venkatarangaiah + Marko Lahma (.NET) - + - Commit the supplied connection. + Contains base functionality for ADO.NET-based JobStore implementations. - The CTH. - if set to true opens a new transaction. - JobPersistenceException thrown if a SQLException occurs when the + Jeffrey Wescott + James House + Marko Lahma (.NET) - - - Execute the given callback in a transaction. Depending on the JobStore, - the surrounding transaction may be assumed to be already present - (managed). + + + The interface to be implemented by classes that want to provide a + and storage mechanism for the + 's use. - This method just forwards to ExecuteInLock() with a null lockName. + Storage of s and s should be keyed + on the combination of their name and group for uniqueness. + + + + + + + James House + Marko Lahma (.NET) - - - Execute the given callback having acquired the given lock. - Depending on the JobStore, the surrounding transaction may be - assumed to be already present (managed). - - - The name of the lock to acquire, for example - "TRIGGER_ACCESS". If null, then no lock is acquired, but the - lockCallback is still executed in a transaction. - - - The callback to excute after having acquired the given lock. - - - + - Execute the given callback having optionally acquired the given lock. - This uses the non-managed transaction connection. + Called by the QuartzScheduler before the is + used, in order to give the it a chance to Initialize. - - The name of the lock to acquire, for example - "TRIGGER_ACCESS". If null, then no lock is acquired, but the - lockCallback is still executed in a non-managed transaction. - - - The callback to excute after having acquired the given lock. - - - - - Get or set the datasource name. + + + Called by the QuartzScheduler to inform the that + the scheduler has started. - - - Get or set the database connection manager. + + + Called by the QuartzScheduler to inform the JobStore that + the scheduler has been paused. - + - Gets the log. + Called by the QuartzScheduler to inform the JobStore that + the scheduler has resumed after being paused. - The log. - - - Get or sets the prefix that should be pre-pended to all table names. + + + Called by the QuartzScheduler to inform the that + it should free up all of it's resources because the scheduler is + shutting down. - + - Set whether string-only properties will be handled in JobDataMaps. + Store the given and . + The to be stored. + The to be stored. + ObjectAlreadyExistsException - + - Get or set the instance Id of the Scheduler (must be unique within a cluster). + returns true if the given JobGroup is paused + + - + - Get or set the instance Id of the Scheduler (must be unique within this server instance). + returns true if the given TriggerGroup + is paused + + - - - Get or set whether this instance is part of a cluster. + + + Store the given . + The to be stored. + + If , any existing in the + with the same name and group should be + over-written. + - + - Get or set the frequency at which this instance "checks-in" - with the other instances of the cluster. -- Affects the rate of - detecting failed instances. + Remove (delete) the with the given + key, and any s that reference + it. + + If removal of the results in an empty group, the + group should be removed from the 's list of + known group names. + + + if a with the given name and + group was found and removed from the store. + - + - Get or set the maximum number of misfired triggers that the misfire handling - thread will try to recover at one time (within one transaction). The - default is 20. + Retrieve the for the given + . + + The desired , or null if there is no match. + - + - Gets or sets the database retry interval. + Store the given . - The db retry interval. + The to be stored. + If , any existing in + the with the same name and group should + be over-written. + ObjectAlreadyExistsException - + - Get or set whether this instance should use database-based thread - synchronization. - - - - - Whether or not to obtain locks when inserting new jobs/triggers. + Remove (delete) the with the given key. - Defaults to , which is safest - some db's (such as - MS SQLServer) seem to require this to avoid deadlocks under high load, - while others seem to do fine without. Settings this to false means - isolation guarantees between job scheduling and trigger acquisition are - entirely enforced by the database. Depending on the database and it's - configuration this may cause unusual scheduling behaviors. + If removal of the results in an empty group, the + group should be removed from the 's list of + known group names. - Setting this property to will provide a - significant performance increase during the addition of new jobs - and triggers. + If removal of the results in an 'orphaned' + that is not 'durable', then the should be deleted + also. + + if a with the given + name and group was found and removed from the store. + - - - The time span by which a trigger must have missed its - next-fire-time, in order for it to be considered "misfired" and thus - have its misfire instruction applied. + + + Remove (delete) the with the + given name, and store the new given one - which must be associated + with the same job. + The to be replaced. + The new to be stored. + + if a with the given + name and group was found and removed from the store. + - - - Don't call set autocommit(false) on connections obtained from the - DataSource. This can be helpfull in a few situations, such as if you - have a driver that complains if it is called when it is already off. + + + Retrieve the given . + + The desired , or null if there is no + match. + - - - Set the transaction isolation level of DB connections to sequential. + + + Determine whether a with the given identifier already + exists within the scheduler. + + + the identifier to check for + true if a calendar exists with the given identifier - + - Whether or not the query and update to acquire a Trigger for firing - should be performed after obtaining an explicit DB lock (to avoid - possible race conditions on the trigger's db row). This is - is considered unnecessary for most databases (due to the nature of - the SQL update that is performed), and therefore a superfluous performance hit. + Determine whether a with the given identifier already + exists within the scheduler. - However, if batch acquisition is used, it is important for this behavior - to be used for all dbs. + the identifier to check for + true if a job exists with the given identifier - - - Get or set the ADO.NET driver delegate class name. + + + Determine whether a with the given identifier already + exists within the scheduler. + + + the identifier to check for + true if a trigger exists with the given identifier - + - The driver delegate's initialization string. + Clear (delete!) all scheduling data - all s, s + s. + + - + - set the SQL statement to use to select and lock a row in the "locks" - table. + Store the given . - + The name. + The to be stored. + If , any existing + in the with the same name and group + should be over-written. + If , any s existing + in the that reference an existing + Calendar with the same name with have their next fire time + re-computed with the new . + ObjectAlreadyExistsException - + - Get whether the threads spawned by this JobStore should be - marked as daemon. Possible threads include the - and the . + Remove (delete) the with the + given name. - + + If removal of the would result in + s pointing to non-existent calendars, then a + will be thrown. + + The name of the to be removed. + + if a with the given name + was found and removed from the store. + - + - Get whether to check to see if there are Triggers that have misfired - before actually acquiring the lock to recover them. This should be - set to false if the majority of the time, there are are misfired - Triggers. + Retrieve the given . - + The name of the to be retrieved. + + The desired , or null if there is no + match. + - + - Get the driver delegate for DB operations. + Get the number of s that are + stored in the . + - + - Get whether String-only properties will be handled in JobDataMaps. + Get the number of s that are + stored in the . + - + - Indicates whether this job store supports persistence. + Get the number of s that are + stored in the . - - - - An interface for classes wishing to provide the service of loading classes - and resources within the scheduler... + + + Get the names of all of the s that + have the given group name. + + If there are no jobs in the given group name, the result should be a + zero-length array (not ). + - James House - Marko Lahma (.NET) + + - - - Called to give the ClassLoadHelper a chance to Initialize itself, - including the oportunity to "steal" the class loader off of the calling - thread, which is the thread that is initializing Quartz. + + + Get the names of all of the s + that have the given group name. + + If there are no triggers in the given group name, the result should be a + zero-length array (not ). + - - - Return the class with the given name. + + + Get the names of all of the + groups. + + If there are no known group names, the result should be a zero-length + array (not ). + - - - Finds a resource with a given name. This method returns null if no - resource with this name is found. + + + Get the names of all of the + groups. + + If there are no known group names, the result should be a zero-length + array (not ). + - name of the desired resource - - a java.net.URL object - - - - Finds a resource with a given name. This method returns null if no - resource with this name is found. + + + Get the names of all of the s + in the . + + + If there are no Calendars in the given group name, the result should be + a zero-length array (not ). + - name of the desired resource - - a java.io.InputStream object - - + - Helper class for returning the composite result of trying - to recover misfired jobs. + Get all of the Triggers that are associated to the given Job. + + If there are no matches, a zero-length array should be returned. + - + - Initializes a new instance of the class. + Get the current state of the identified . - if set to true [has more misfired triggers]. - The processed misfired trigger count. - + - + - Gets a value indicating whether this instance has more misfired triggers. + Pause the with the given key. - - true if this instance has more misfired triggers; otherwise, false. - - + - Gets the processed misfired trigger count. + Pause all of the s in the + given group. - The processed misfired trigger count. + + The JobStore should "remember" that the group is paused, and impose the + pause on any new triggers that are added to the group while the group is + paused. + - + - Called by the QuartzScheduler before the is - used, in order to give the it a chance to Initialize. + Pause the with the given key - by + pausing all of its current s. - - - + - Called by the QuartzScheduler to inform the that - it should free up all of it's resources because the scheduler is - shutting down. + Pause all of the s in the given + group - by pausing all of their s. + + The JobStore should "remember" that the group is paused, and impose the + pause on any new jobs that are added to the group while the group is + paused. + + + - + - Gets the non managed TX connection. + Resume (un-pause) the with the + given key. + + + If the missed one or more fire-times, then the + 's misfire instruction will be applied. + - + + - + - Execute the given callback having optionally acquired the given lock. - Because CMT assumes that the connection is already part of a managed - transaction, it does not attempt to commit or rollback the - enclosing transaction. + Resume (un-pause) all of the s + in the given group. + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + - - - - - - The name of the lock to acquire, for example - "TRIGGER_ACCESS". If null, then no lock is acquired, but the - txCallback is still executed in a transaction. - - Callback to execute. - + - Instructs this job store whether connections should be automatically opened. + Gets the paused trigger groups. + - + + + Resume (un-pause) the with the + given key. + + If any of the 's s missed one + or more fire-times, then the 's misfire + instruction will be applied. + + + + - is meant to be used in a standalone environment. - Both commit and rollback will be handled by this class. + Resume (un-pause) all of the s in + the given group. + + If any of the s had s that + missed one or more fire-times, then the 's + misfire instruction will be applied. + - Jeffrey Wescott - James House - Marko Lahma (.NET) - + - Called by the QuartzScheduler before the is - used, in order to give the it a chance to Initialize. + Pause all triggers - equivalent of calling + on every group. + + When is called (to un-pause), trigger misfire + instructions WILL be applied. + - - + - + - For , the non-managed TX connection is just - the normal connection because it is not CMT. - - + Resume (un-pause) all triggers - equivalent of calling + on every group. + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + + + + - + - Execute the given callback having optionally aquired the given lock. - For , because it manages its own transactions - and only has the one datasource, this is the same behavior as - . + Get a handle to the next trigger to be fired, and mark it as 'reserved' + by the calling scheduler. - - The name of the lock to aquire, for example "TRIGGER_ACCESS". - If null, then no lock is aquired, but the lockCallback is still - executed in a transaction. - - Callback to execute. + If > 0, the JobStore should only return a Trigger + that will fire no later than the time represented in this value as + milliseconds. + + - - - - + + - - - Exception class for when there is a failure obtaining or releasing a - resource lock. + + + Inform the that the scheduler no longer plans to + fire the given , that it had previously acquired + (reserved). - - James House - Marko Lahma (.NET) - + - An exception that is thrown to indicate that there has been a failure in the - scheduler's underlying persistence mechanism. + Inform the that the scheduler is now firing the + given (executing its associated ), + that it had previously acquired (reserved). - James House - Marko Lahma (.NET) + + May return null if all the triggers or their calendars no longer exist, or + if the trigger was not successfully put into the 'executing' + state. Preference is to return an empty list if none of the triggers + could be fired. + - - - Create a with the given message. - + + + Inform the that the scheduler has completed the + firing of the given (and the execution its + associated ), and that the + in the given should be updated if the + is stateful. - + - Initializes a new instance of the class. + Indicates whether job store supports persistence. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The class name is null or is zero (0). - The info parameter is null. + - - - Create a with the given message - and cause. - + + + How long (in milliseconds) the implementation + estimates that it will take to release a trigger and acquire a new one. - + - Initializes a new instance of the class. + Whether or not the implementation is clustered. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The class name is null or is zero (0). - The info parameter is null. + - + - This is a driver delegate for the MySQL ADO.NET driver. + Inform the of the Scheduler instance's Id, + prior to initialize being invoked. - Marko Lahma - + - This is meant to be an abstract base class for most, if not all, - implementations. Subclasses should override only those methods that need - special handling for the DBMS driver in question. + Inform the of the Scheduler instance's name, + prior to initialize being invoked. - Jeffrey Wescott - James House - Marko Lahma (.NET) - + - Initializes the driver delegate. + Tells the JobStore the pool size used to execute jobs. - + - Insert the job detail record. + Initializes a new instance of the class. - the DB Connection - the new state for the triggers - the first old state to update - the second old state to update - number of rows updated - + - Get the names of all of the triggers that have misfired. + Gets the connection and starts a new transaction. - the DB Connection - The ts. - an array of objects + - - - Select all of the triggers in a given state. + + + Called by the QuartzScheduler before the is + used, in order to give it a chance to Initialize. - The DB Connection - The state the triggers must be in - an array of trigger s - - - Get the names of all of the triggers in the given state that have - misfired - according to the given timestamp. - - The DB Connection - The state. - The time stamp. - An array of objects - - - - Get the names of all of the triggers in the given state that have - misfired - according to the given timestamp. No more than count will - be returned. - - The conn. - The state1. - The ts. - The most misfired triggers to return, negative for all - - Output parameter. A List of objects. Must not be null - - Whether there are more misfired triggers left to find beyond the given count. - - - - Get the number of triggers in the given state that have - misfired - according to the given timestamp. - - - - - - - - - Get the names of all of the triggers in the given group and state that - have misfired. - - The DB Connection - Name of the group. - The state. - The timestamp. - an array of objects + + - + - Select all of the triggers for jobs that are requesting recovery. The - returned trigger objects will have unique "recoverXXX" trigger names and - will be in the - trigger group. + Called by the QuartzScheduler to inform the JobStore that + the scheduler has been paused. - - In order to preserve the ordering of the triggers, the fire time will be - set from the ColumnFiredTime column in the TableFiredTriggers - table. The caller is responsible for calling - on each returned trigger. It is also up to the caller to insert the - returned triggers to ensure that they are fired. - - The DB Connection - an array of objects - + - Delete all fired triggers. + Called by the QuartzScheduler to inform the JobStore that + the scheduler has resumed after being paused. - The DB Connection. - The number of rows deleted. - + - Delete all fired triggers of the given instance. + Called by the QuartzScheduler to inform the that + it should free up all of it's resources because the scheduler is + shutting down. - The DB Connection - The instance id. - The number of rows deleted - + - Clear (delete!) all scheduling data - all s, s - s. + Will recover any failed or misfired jobs and clean up the data store as + appropriate. - - - + - Insert the job detail record. + Will recover any failed or misfired jobs and clean up the data store as + appropriate. - The DB Connection. - The job to insert. - Number of rows inserted. - + - Gets the db presentation for boolean value. Subclasses can overwrite this behaviour. + Store the given and . - Value to map to database. - + Job to be stored. + Trigger to be stored. - + - Gets the boolean value from db presentation. Subclasses can overwrite this behaviour. + returns true if the given JobGroup + is paused - Value to map from database. + - + - Gets the db presentation for date/time value. Subclasses can overwrite this behaviour. + returns true if the given TriggerGroup + is paused - Value to map to database. + - + - Gets the date/time value from db presentation. Subclasses can overwrite this behaviour. + Stores the given . - Value to map from database. - + The to be stored. + + If , any existing in the + with the same name & group should be over-written. + - - - Gets the db presentation for time span value. Subclasses can overwrite this behaviour. + + + Insert or update a job. + - Value to map to database. - - + - Gets the time span value from db presentation. Subclasses can overwrite this behaviour. + Check existence of a given job. - Value to map from database. - - + - Update the job detail record. + Store the given . - The DB Connection. - The job to update. - Number of rows updated. + The to be stored. + + If , any existing in + the with the same name & group should + be over-written. + + + if a with the same name/group already + exists, and replaceExisting is set to false. + - + - Get the names of all of the triggers associated with the given job. + Insert or update a trigger. - The DB Connection. - The key identifying the job. - An array of objects - + - Delete the job detail record for the given job. + Check existence of a given trigger. - the DB Connection - The key identifying the job. - the number of rows deleted - + - Check whether or not the given job is stateful. + Remove (delete) the with the given + name, and any s that reference + it. - the DB Connection - The key identifying the job. + + + If removal of the results in an empty group, the + group should be removed from the 's list of + known group names. + - true if the job exists and is stateful, false otherwise + if a with the given name & + group was found and removed from the store. - + - Check whether or not the given job exists. + Delete a job and its listeners. - the DB Connection - The key identifying the job. - true if the job exists, false otherwise + + - + - Update the job data map for the given job. + Delete a trigger, its listeners, and its Simple/Cron/BLOB sub-table entry. - The conn. - the job to update - the number of rows updated + + + - + - Select the JobDetail object for a given job name / group name. + Retrieve the for the given + . - The DB Connection. The key identifying the job. - The load helper. - The populated JobDetail object. + The desired , or null if there is no match. - - build Map from java.util.Properties encoding. + + + Remove (delete) the with the + given name. + + + + + If removal of the results in an empty group, the + group should be removed from the 's list of + known group names. + + + + If removal of the results in an 'orphaned' + that is not 'durable', then the should be deleted + also. + + + The key identifying the trigger. + + if a with the given + name & group was found and removed from the store. + - + + + + - Select the total number of jobs stored. + Retrieve the given . - The DB Connection. - The total number of jobs stored. + The key identifying the trigger. + The desired , or null if there is no match. - + - Select all of the job group names that are stored. + Get the current state of the identified . - The DB Connection. - An array of group names. + + + + + - + - Select all of the jobs contained in a given group. + Gets the state of the trigger. - The DB Connection. - - An array of job names. + The conn. + The key identifying the trigger. + - + - Insert the base trigger data. + Store the given . - the DB Connection - the trigger to insert - the state that the trigger should be stored in - The job detail. - the number of rows inserted + The name of the calendar. + The to be stored. + + If , any existing + in the with the same name & group + should be over-written. + + + + if a with the same name already + exists, and replaceExisting is set to false. + - + + + Remove (delete) the with the given name. + + + If removal of the would result in + s pointing to non-existent calendars, then a + will be thrown. + + The name of the to be removed. + + if a with the given name + was found and removed from the store. + + + - Insert the blob trigger data. + Retrieve the given . - The DB Connection. - The trigger to insert. - The number of rows inserted. + The name of the to be retrieved. + The desired , or null if there is no match. - + - Update the base trigger data. + Get the number of s that are + stored in the . - The DB Connection. - The trigger to insert. - The state that the trigger should be stored in. - The job detail. - The number of rows updated. - + - Update the blob trigger data. + Get the number of s that are + stored in the . - The DB Connection. - The trigger to insert. - The number of rows updated. - + - Check whether or not a trigger exists. + Get the number of s that are + stored in the . - The DB Connection. - the key of the trigger - true if the trigger exists, false otherwise - + - Update the state for a given trigger. + Get the names of all of the s that + have the given group name. - The DB Connection. - the key of the trigger - The new state for the trigger. - The number of rows updated. + + If there are no jobs in the given group name, the result should be a + zero-length array (not ). + - + - Update the given trigger to the given new state, if it is one of the - given old states. + Determine whether a with the given identifier already + exists within the scheduler. - The DB connection. - the key of the trigger - The new state for the trigger. - One of the old state the trigger must be in. - One of the old state the trigger must be in. - One of the old state the trigger must be in. - The number of rows updated. + + + the identifier to check for + true if a calendar exists with the given identifier - + - Update all triggers in the given group to the given new state, if they - are in one of the given old states. + Determine whether a with the given identifier already + exists within the scheduler. - The DB connection. - - The new state for the trigger. - One of the old state the trigger must be in. - One of the old state the trigger must be in. - One of the old state the trigger must be in. - The number of rows updated. + + + the identifier to check for + true if a Job exists with the given identifier - + - Update the given trigger to the given new state, if it is in the given - old state. + Determine whether a with the given identifier already + exists within the scheduler. - the DB connection - the key of the trigger - the new state for the trigger - the old state the trigger must be in - int the number of rows updated + + + the identifier to check for + true if a Trigger exists with the given identifier - + - Update all of the triggers of the given group to the given new state, if - they are in the given old state. + Clear (delete!) all scheduling data - all s, s + s. - the DB connection - - the new state for the trigger group - the old state the triggers must be in - int the number of rows updated + + - + - Update the states of all triggers associated with the given job. + Get the names of all of the s + that have the given group name. - the DB Connection - the key of the job - the new state for the triggers - the number of rows updated + + If there are no triggers in the given group name, the result should be a + zero-length array (not ). + - + - Updates the state of the trigger states for job from other. + Get the names of all of the + groups. - The conn. - Key of the job. - The state. - The old state. - + + + If there are no known group names, the result should be a zero-length + array (not ). + - + - Delete the cron trigger data for a trigger. + Get the names of all of the + groups. - the DB Connection - the key of the trigger - the number of rows deleted + + + If there are no known group names, the result should be a zero-length + array (not ). + - + - Delete the base trigger data for a trigger. + Get the names of all of the s + in the . - the DB Connection - the key of the trigger - the number of rows deleted + + If there are no Calendars in the given group name, the result should be + a zero-length array (not ). + - + - Select the number of triggers associated with a given job. + Get all of the Triggers that are associated to the given Job. - the DB Connection - the key of the job - the number of triggers for the given job + + If there are no matches, a zero-length array should be returned. + - + - Select the triggers for a job + Pause the with the given name. - the DB Connection - the key of the job - - an array of objects - associated with a given job. - - + - Select the triggers for a calendar + Pause the with the given name. - The DB Connection. - Name of the calendar. - - An array of objects associated with a given job. - - + - Select a trigger. + Pause the with the given name - by + pausing all of its current s. - the DB Connection - the key of the trigger - The object + - + - Select a trigger's JobDataMap. - - the DB Connection - the key of the trigger - The of the Trigger, never null, but possibly empty. - - - - Select a trigger's state value. + Pause all of the s in the given + group - by pausing all of their s. - the DB Connection - the key of the trigger - The object + - + - Select a trigger status (state and next fire time). + Determines if a Trigger for the given job should be blocked. + State can only transition to StatePausedBlocked/StateBlocked from + StatePaused/StateWaiting respectively. - the DB Connection - the key of the trigger - - a object, or null - + StatePausedBlocked, StateBlocked, or the currentState. - + - Select the total number of triggers stored. + Resume (un-pause) the with the + given name. - the DB Connection - the total number of triggers stored + + If the missed one or more fire-times, then the + 's misfire instruction will be applied. + - + - Select all of the trigger group names that are stored. + Resume (un-pause) the with the + given name. - the DB Connection - - an array of group names - + + If any of the 's s missed one + or more fire-times, then the 's misfire + instruction will be applied. + + - + - Select all of the triggers contained in a given group. + Resume (un-pause) all of the s in + the given group. - the DB Connection - - - an array of trigger names - + + If any of the s had s that + missed one or more fire-times, then the 's + misfire instruction will be applied. + + - + - Inserts the paused trigger group. + Pause all of the s in the given group. - The conn. - Name of the group. - + - + - Deletes the paused trigger group. + Pause all of the s in the given group. - The conn. - Name of the group. - - - - Deletes all paused trigger groups. + + + Pause all of the s in the + given group. - The conn. - - + - Determines whether the specified trigger group is paused. + Resume (un-pause) all of the s + in the given group. + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + - The conn. - Name of the group. - - true if trigger group is paused; otherwise, false. - - + - Determines whether given trigger group already exists. + Pause all triggers - equivalent of calling + on every group. + + When is called (to un-pause), trigger misfire + instructions WILL be applied. + - The conn. - Name of the group. - - true if trigger group exists; otherwise, false. - + + - + - Insert a new calendar. + Resume (un-pause) all triggers - equivalent of calling + on every group. - the DB Connection - The name for the new calendar. - The calendar. - the number of rows inserted - IOException + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + + - + - Update a calendar. + Resume (un-pause) all triggers - equivalent of calling + on every group. + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + - the DB Connection - The name for the new calendar. - The calendar. - the number of rows updated - IOException + - + - Check whether or not a calendar exists. + Get a handle to the next N triggers to be fired, and mark them as 'reserved' + by the calling scheduler. - the DB Connection - The name of the calendar. - - true if the trigger exists, false otherwise - + - + - Select a calendar. + Inform the that the scheduler no longer plans to + fire the given , that it had previously acquired + (reserved). - the DB Connection - The name of the calendar. - the Calendar - ClassNotFoundException - IOException - + - Check whether or not a calendar is referenced by any triggers. + Inform the that the scheduler has completed the + firing of the given (and the execution its + associated ), and that the + in the given should be updated if the + is stateful. - the DB Connection - The name of the calendar. - - true if any triggers reference the calendar, false otherwise - - + - Delete a calendar. + Get a list of all scheduler instances in the cluster that may have failed. + This includes this scheduler if it is checking in for the first time. - the DB Connection - The name of the trigger. - the number of rows deleted - + - Select the total number of calendars stored. + Create dummy objects for fired triggers + that have no scheduler state record. Checkin timestamp and interval are + left as zero on these dummy objects. - the DB Connection - the total number of calendars stored + + List of all current s - + - Select all of the stored calendars. + Cleanup the given database connection. This means restoring + any modified auto commit or transaction isolation connection + attributes, and then closing the underlying connection. - the DB Connection - - an array of calendar names - + + + This is separate from closeConnection() because the Spring + integration relies on being able to overload closeConnection() and + expects the same connection back that it originally returned + from the datasource. + + - - - Select the trigger that will be fired at the given fire time. + + + Closes the supplied connection. - the DB Connection - the time that the trigger will be fired - - a representing the - trigger that will be fired at the given fire time, or null if no - trigger will be fired at that time - + (Optional) - + - Select the next trigger which will fire to fire between the two given timestamps - in ascending order of fire time, and then descending by priority. + Rollback the supplied connection. + + (Optional) + + JobPersistenceException thrown if a SQLException occurs when the + connection is rolled back - The conn. - highest value of of the triggers (exclusive) - highest value of of the triggers (inclusive) - maximum number of trigger keys allow to acquired in the returning list. - A (never null, possibly empty) list of the identifiers (Key objects) of the next triggers to be fired. - + - Insert a fired trigger. + Commit the supplied connection. - the DB Connection - the trigger - the state that the trigger should be stored in - The job. - the number of rows inserted + The CTH. + if set to true opens a new transaction. + JobPersistenceException thrown if a SQLException occurs when the - + + + Execute the given callback in a transaction. Depending on the JobStore, + the surrounding transaction may be assumed to be already present + (managed). + + + This method just forwards to ExecuteInLock() with a null lockName. + + + + Execute the given callback having acquired the given lock. + Depending on the JobStore, the surrounding transaction may be + assumed to be already present (managed). + + + The name of the lock to acquire, for example + "TRIGGER_ACCESS". If null, then no lock is acquired, but the + lockCallback is still executed in a transaction. + + + The callback to execute after having acquired the given lock. + + + + + Execute the given callback having optionally acquired the given lock. + This uses the non-managed transaction connection. + + + The name of the lock to acquire, for example + "TRIGGER_ACCESS". If null, then no lock is acquired, but the + lockCallback is still executed in a non-managed transaction. + + + The callback to execute after having acquired the given lock. + + + + + + Get or set the datasource name. + + + + + Get or set the database connection manager. + + + + + Gets the log. + + The log. + + + + Get or sets the prefix that should be pre-pended to all table names. + + + + + Set whether string-only properties will be handled in JobDataMaps. + + + + + Get or set the instance Id of the Scheduler (must be unique within a cluster). + + + + + Get or set the instance Id of the Scheduler (must be unique within this server instance). + + + + + Gets or sets the number of retries before an error is logged for recovery operations. + + + + + Get or set whether this instance is part of a cluster. + + + + + Get or set the frequency at which this instance "checks-in" + with the other instances of the cluster. -- Affects the rate of + detecting failed instances. + + + + + Get or set the maximum number of misfired triggers that the misfire handling + thread will try to recover at one time (within one transaction). The + default is 20. + + + + + Gets or sets the database retry interval. + + The db retry interval. + + + + Get or set whether this instance should use database-based thread + synchronization. + + + + + Whether or not to obtain locks when inserting new jobs/triggers. + + - Update a fired trigger. + Defaults to , which is safest - some db's (such as + MS SQLServer) seem to require this to avoid deadlocks under high load, + while others seem to do fine without. Settings this to false means + isolation guarantees between job scheduling and trigger acquisition are + entirely enforced by the database. Depending on the database and it's + configuration this may cause unusual scheduling behaviors. + + + Setting this property to will provide a + significant performance increase during the addition of new jobs + and triggers. + + + + + The time span by which a trigger must have missed its + next-fire-time, in order for it to be considered "misfired" and thus + have its misfire instruction applied. + + + + + Don't call set autocommit(false) on connections obtained from the + DataSource. This can be helpful in a few situations, such as if you + have a driver that complains if it is called when it is already off. + + + + + Set the transaction isolation level of DB connections to sequential. + + + + + Whether or not the query and update to acquire a Trigger for firing + should be performed after obtaining an explicit DB lock (to avoid + possible race conditions on the trigger's db row). This is + is considered unnecessary for most databases (due to the nature of + the SQL update that is performed), and therefore a superfluous performance hit. + However, if batch acquisition is used, it is important for this behavior + to be used for all dbs. - - the DB Connection - - the trigger - - - the state that the trigger should be stored in - the number of rows inserted - + + + Get or set the ADO.NET driver delegate class name. + + + - Select the states of all fired-trigger records for a given trigger, or - trigger group if trigger name is . + The driver delegate's initialization string. - The DB connection. - Name of the trigger. - Name of the group. - a List of objects. - + - Select the states of all fired-trigger records for a given job, or job - group if job name is . + set the SQL statement to use to select and lock a row in the "locks" + table. - The DB connection. - Name of the job. - Name of the group. - a List of objects. + + + + + Get whether the threads spawned by this JobStore should be + marked as daemon. Possible threads include the + and the . + + + + + + Get whether to check to see if there are Triggers that have misfired + before actually acquiring the lock to recover them. This should be + set to false if the majority of the time, there are are misfired + Triggers. + + + + + + Get the driver delegate for DB operations. + + + + + Get whether String-only properties will be handled in JobDataMaps. + + + + + Indicates whether this job store supports persistence. + + + + + + + An interface for classes wishing to provide the service of loading classes + and resources within the scheduler... + + James House + Marko Lahma (.NET) + + + + Called to give the ClassLoadHelper a chance to Initialize itself, + including the opportunity to "steal" the class loader off of the calling + thread, which is the thread that is initializing Quartz. + + + + + Return the class with the given name. + + + + + Finds a resource with a given name. This method returns null if no + resource with this name is found. + + name of the desired resource + + a java.net.URL object + + + + + Finds a resource with a given name. This method returns null if no + resource with this name is found. + + name of the desired resource + + a java.io.InputStream object + - + - Select the states of all fired-trigger records for a given scheduler - instance. + Helper class for returning the composite result of trying + to recover misfired jobs. - The DB Connection - Name of the instance. - A list of FiredTriggerRecord objects. - + - Select the distinct instance names of all fired-trigger records. + Initializes a new instance of the class. - The conn. - - - This is useful when trying to identify orphaned fired triggers (a - fired trigger without a scheduler state record.) - + if set to true [has more misfired triggers]. + The processed misfired trigger count. + - + - Delete a fired trigger. + Gets a value indicating whether this instance has more misfired triggers. - the DB Connection - the fired trigger entry to delete - the number of rows deleted + + true if this instance has more misfired triggers; otherwise, false. + - + - Selects the job execution count. + Gets the processed misfired trigger count. - The DB connection. - The key of the job. - + The processed misfired trigger count. - + - Inserts the state of the scheduler. + Called by the QuartzScheduler before the is + used, in order to give the it a chance to Initialize. - The conn. - The instance id. - The check in time. - The interval. - + + - + - Deletes the state of the scheduler. + Called by the QuartzScheduler to inform the that + it should free up all of it's resources because the scheduler is + shutting down. - The database connection. - The instance id. - - + - Updates the state of the scheduler. + Gets the non managed TX connection. - The database connection. - The instance id. - The check in time. - + - A List of all current s. - - If instanceId is not null, then only the record for the identified - instance will be returned. - + Execute the given callback having optionally acquired the given lock. + Because CMT assumes that the connection is already part of a managed + transaction, it does not attempt to commit or rollback the + enclosing transaction. - The DB Connection - The instance id. - + + + + + + The name of the lock to acquire, for example + "TRIGGER_ACCESS". If null, then no lock is acquired, but the + txCallback is still executed in a transaction. + + Callback to execute. - + - Replace the table prefix in a query by replacing any occurrences of - "{0}" with the table prefix. + Instructs this job store whether connections should be automatically opened. - The unsubstitued query - The query, with proper table prefix substituted - + - Create a serialized version of an Object. + is meant to be used in a standalone environment. + Both commit and rollback will be handled by this class. - the object to serialize - Serialized object as byte array. + Jeffrey Wescott + James House + Marko Lahma (.NET) - + - Remove the transient data from and then create a serialized - version of a and returns the underlying bytes. + Called by the QuartzScheduler before the is + used, in order to give the it a chance to Initialize. - The data. - the serialized data as byte array + + - + - serialize + For , the non-managed TX connection is just + the normal connection because it is not CMT. + + + + + + Execute the given callback having optionally acquired the given lock. + For , because it manages its own transactions + and only has the one datasource, this is the same behavior as + . - The data. + + The name of the lock to acquire, for example "TRIGGER_ACCESS". + If null, then no lock is acquired, but the lockCallback is still + executed in a transaction. + + Callback to execute. + + + + - - - Convert the JobDataMap into a list of properties. + + + Exception class for when there is a failure obtaining or releasing a + resource lock. + + James House + Marko Lahma (.NET) - + - Convert the JobDataMap into a list of properties. + An exception that is thrown to indicate that there has been a failure in the + scheduler's underlying persistence mechanism. + James House + Marko Lahma (.NET) - + + + Create a with the given message. + + + + - This method should be overridden by any delegate subclasses that need - special handling for BLOBs. The default implementation uses standard - ADO.NET operations. + Initializes a new instance of the class. - The data reader, already queued to the correct row. - The column index for the BLOB. - The deserialized object from the DataReader BLOB. + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The class name is null or is zero (0). + The info parameter is null. - + + + Create a with the given message + and cause. + + + + - This method should be overridden by any delegate subclasses that need - special handling for BLOBs for job details. + Initializes a new instance of the class. - The result set, already queued to the correct row. - The column index for the BLOB. - The deserialized Object from the ResultSet BLOB. + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The class name is null or is zero (0). + The info parameter is null. - + - Selects the paused trigger groups. + This is a driver delegate for the MySQL ADO.NET driver. - The DB Connection. - + Marko Lahma @@ -5912,7 +6030,7 @@ - Return true, if day is defined to be exluded. + Return true, if day is defined to be excluded. @@ -6078,7 +6196,7 @@ Create a with a time range defined by the specified strings and no baseCalendar. - and + and must be in the format "HH:MM[:SS[:mmm]]" where:
  • @@ -6106,12 +6224,14 @@
+ The range starting time in millis. + The range ending time in millis. Create a with a time range defined by the specified strings and the specified baseCalendar. - and + and must be in the format "HH:MM[:SS[:mmm]]" where:
  • @@ -6143,6 +6263,8 @@
The base calendar for this calendar instance see BaseCalendar for more information on base calendar functionality. + The range starting time in millis. + The range ending time in millis. @@ -6176,7 +6298,7 @@ Create a with a time range defined by the - specified values and the specified . Values are + specified values and the specified . Values are subject to the following validations:
  • @@ -6193,6 +6315,8 @@
+ The base calendar for this calendar instance see BaseCalendar for more + information on base calendar functionality. The range starting hour of day. The range starting minute. The range starting second. @@ -6231,7 +6355,7 @@ Create a with a time range defined by the specified s and the specified - . The Calendars are subject to the following + . The Calendars are subject to the following considerations:
  • @@ -6248,6 +6372,8 @@
+ The base calendar for this calendar instance see BaseCalendar for more + information on base calendar functionality. The range starting calendar. The range ending calendar. @@ -6276,7 +6402,7 @@ Create a with a time range defined by the - specified values and the specified . The values + specified values and the specified . The values are subject to the following considerations:
  • @@ -6292,6 +6418,8 @@
+ The base calendar for this calendar instance see BaseCalendar for more + information on base calendar functionality. The range starting time in millis. The range ending time in millis. @@ -6323,7 +6451,7 @@ Returns the start time of the time range of the day - specified in . + specified in . a DateTime representing the start time of the @@ -6333,7 +6461,7 @@ Returns the end time of the time range of the day - specified in + specified in A DateTime representing the end time of the @@ -6395,7 +6523,7 @@ - Gets the end of day, pratically sets time parts to maximum allowed values. + Gets the end of day, practically sets time parts to maximum allowed values. The time. @@ -6527,7 +6655,7 @@ - Return true, if mday is defined to be exluded. + Return true, if day is defined to be excluded. @@ -6611,7 +6739,7 @@ - Return true, if wday is defined to be exluded. E. g. + Return true, if wday is defined to be excluded. E. g. saturday and sunday. @@ -6739,6 +6867,11 @@ + + + Create a GroupMatcher that matches all. + + Matches on the complete key being equal (both name and group). @@ -8391,16 +8524,21 @@ Create a with fire time dictated by the - resolved with respect to the specified - occurring from the until - the given . + resolved with respect to the specified + occurring from the until + the given . The name of the The group of the name of the executed on firetime Group of the executed on firetime - A set to the earliest time for the to start firing. + A set to the earliest time for the to start firing. A set to the time for the to quit repeat firing. + A cron expression dictating the firing sequence of the + + Specifies for which time zone the cronExpression should be interpreted, + i.e. the expression 0 0 10 * * ?, is resolved to 10:00 am in this time zone. + @@ -8597,7 +8735,7 @@ Get or sets the time at which the CronTrigger should quit - repeating - even if repeastCount isn't yet satisfied. + repeating - even if repeatCount isn't yet satisfied. @@ -8657,10 +8795,10 @@ and daysOfWeek is default to every day. The startTime default to current time-stamp now, while endTime has not value. - If startTime is before startTimeOfDay, then startTimeOfDay will be used and startTime has no affect. Else if startTime is - after startTimeOfDay, then the first fire time for that day will be the next interval after the startTime. For example, if - you set startingTimeOfDay=9am, endingTimeOfDay=11am, interval=15 mins, and startTime=9:33am, then the next fire time will - be 9:45pm. Note also that if you do not set startTime value, the trigger builder will default to current time, and current time + If startTime is before startTimeOfDay, then startTimeOfDay will be used and startTime has no affect other than to specify + the first day of firing. Else if startTime is after startTimeOfDay, then the first fire time for that day will be the next + interval after the startTime. For example, if you set startingTimeOfDay=9am, endingTimeOfDay=11am, interval=15 mins, and startTime=9:33am, + then the next fire time will be 9:45pm. Note also that if you do not set startTime value, the trigger builder will default to current time, and current time maybe before or after the startTimeOfDay! So be aware how you set your startTime. @@ -8946,9 +9084,10 @@ - + - Given fireTime time, we need to advance/calculate and return a time of next available week day. + Given fireTime time determine if it is on a valid day of week. If so, simply return it unaltered, + if not, advance to the next valid week day, and set the time of day to the start time of day. given next fireTime. flag to whether to advance day without check existing week day. This scenario @@ -9079,7 +9218,7 @@ - Get or set thhe number of times the should + Get or set the number of times the should repeat, after which it will be automatically deleted. @@ -9304,7 +9443,7 @@ - Get or set thhe number of times the should + Get or set the number of times the should repeat, after which it will be automatically deleted. @@ -10123,7 +10262,7 @@ - Create a JobExcecutionContext with the given context data. + Create a JobExecutionContext with the given context data. @@ -10294,7 +10433,7 @@ - Returns the fire instace id. + Returns the fire instance id. @@ -10925,10 +11064,9 @@ - + the unique identifier of the job instance to be interrupted (see - true if the identified job instance was found and interrupted. @@ -11041,7 +11179,7 @@ - Get a object describiing the settings + Get a object describing the settings and capabilities of the scheduler instance. Note that the data returned is an 'instantaneous' snap-shot, and that as @@ -11294,7 +11432,7 @@ JobFactories may be of use to those wishing to have their application produce instances via some special mechanism, such as to - give the opertunity for dependency injection. + give the opportunity for dependency injection. @@ -11399,6 +11537,12 @@ James House Marko Lahma (.NET) + + + Construct a instance to proxy the given + instance. + + returns true if the given JobGroup @@ -11417,7 +11561,7 @@ - Get a object describiing the settings + Get a object describing the settings and capabilities of the scheduler instance. Note that the data returned is an 'instantaneous' snap-shot, and that as @@ -11451,12 +11595,6 @@ Calls the equivalent method on the 'proxied' . - - - Construct a instance to proxy the given - instance. - - Calls the equivalent method on the 'proxied' . @@ -11730,7 +11868,7 @@ By default a properties are loaded from App.config's quartz section. If that fails, then the file is loaded "quartz.properties". If file does not exist, - default configration located (as a embedded resource) in Quartz.dll is loaded. If you + default configuration located (as a embedded resource) in Quartz.dll is loaded. If you wish to use a file other than these defaults, you must define the system property 'quartz.properties' to point to the file you want. @@ -11739,7 +11877,7 @@ information about the various settings available within the file. - Alternativly, you can explicitly Initialize the factory by calling one of + Alternatively, you can explicitly Initialize the factory by calling one of the methods before calling . @@ -12005,7 +12143,7 @@ - Ïnforms that certain file has been updated. + Informs that certain file has been updated. Name of the file. @@ -12062,7 +12200,7 @@ - Optional parameter that specifies the workling directory to be used by + Optional parameter that specifies the working directory to be used by the executed command. @@ -12139,6 +12277,15 @@ The host name of the smtp server. REQUIRED. + + The port of the smtp server. Optional. + + + Username for authenticated session. Password must also be set if username is used. Optional. + + + Password for authenticated session. Optional. + The e-mail address to send the mail to. REQUIRED. @@ -12157,6 +12304,9 @@ The e-mail message body. REQUIRED. + + The message subject and body content type. Optional. + Executes the job. @@ -12270,7 +12420,7 @@ is about to be executed. It is called after the method of this - interface. If the implementation vetos the execution (via + interface. If the implementation vetoes the execution (via returning ), the job's execute method will not be called. @@ -12347,7 +12497,7 @@ If for some reason there is a failure creating the trigger for the follow-up job (which would generally only be caused by a rare serious failure in the system, or the non-existence of the follow-up job), an error - messsage is logged, but no other action is taken. If you need more rigorous + message is logged, but no other action is taken. If you need more rigorous handling of the error, consider scheduling the triggering of the flow-up job within your job itself. @@ -12382,7 +12532,7 @@ Called by the when a is about to be executed (an associated - has occured). + has occurred). This method will not be invoked if the execution of the Job was vetoed by a . @@ -12395,7 +12545,7 @@ Called by the when a was about to be executed (an associated - has occured), but a vetoed it's + has occurred), but a vetoed it's execution. @@ -12470,7 +12620,7 @@ - Logs a history of all job executions (and execution vetos) via common + Logs a history of all job executions (and execution vetoes) via common logging. @@ -12508,7 +12658,7 @@ 4 String - The Triggers's group. + The Trigger's group. 5 @@ -12526,8 +12676,7 @@ The re-fire count from the JobExecutionContext. - The default message text is "Job {1}.{0} fired (by trigger {4}.{3}) at: - {2, date, HH:mm:ss MM/dd/yyyy" + The default message text is "Job {1}.{0} fired (by trigger {4}.{3}) at: {2:HH:mm:ss MM/dd/yyyy}" JobSuccessMessage - available message data are: @@ -12559,7 +12708,7 @@ - + @@ -12584,8 +12733,7 @@ result was set.
4 StringThe Triggers's group.The Trigger's group.
5
- The default message text is "Job {1}.{0} execution complete at {2, date, - HH:mm:ss MM/dd/yyyy} and reports: {8" + The default message text is "Job {1}.{0} execution complete at {2:HH:mm:ss MM/dd/yyyy} and reports: {8}" JobFailedMessage - available message data are: @@ -12617,7 +12765,7 @@ - + @@ -12641,8 +12789,7 @@
4 StringThe Triggers's group.The Trigger's group.
5
- The default message text is "Job {1}.{0} execution failed at {2, date, - HH:mm:ss MM/dd/yyyy} and reports: {8" + The default message text is "Job {1}.{0} execution failed at {2:HH:mm:ss MM/dd/yyyy} and reports: {8}" JobWasVetoedMessage - available message data are: @@ -12674,7 +12821,7 @@ - + @@ -12693,7 +12840,7 @@
4 StringThe Triggers's group.The Trigger's group.
5
The default message text is "Job {1}.{0} was vetoed. It was to be fired - (by trigger {4}.{3}) at: {2, date, HH:mm:ss MM/dd/yyyy" + (by trigger {4}.{3}) at: {2:HH:mm:ss MM/dd/yyyy}" Marko Lahma (.NET) @@ -12801,7 +12948,7 @@ Called by the when a was about to be executed (an associated - has occured), but a vetoed it's + has occurred), but a vetoed it's execution. @@ -13125,7 +13272,7 @@ This plugin catches the event of the VM terminating (such as upon a CRTL-C) - and tells the scheuler to Shutdown. + and tells the scheduler to Shutdown. James House @@ -13384,7 +13531,7 @@ This interface may be of use to those wishing to have their application produce instances via some special mechanism, such as to - give the opertunity for dependency injection. + give the opportunity for dependency injection. @@ -13404,7 +13551,7 @@ Scheduler will move all triggers associated with the Job into the state, which will require human intervention (e.g. an application restart after fixing whatever - configuration problem led to the issue wih instantiating the Job. + configuration problem led to the issue with instantiating the Job. The TriggerFiredBundle from which the @@ -13432,7 +13579,7 @@ Scheduler will move all triggers associated with the Job into the state, which will require human intervention (e.g. an application restart after fixing whatever - configuration problem led to the issue wih instantiating the Job. + configuration problem led to the issue with instantiating the Job. The TriggerFiredBundle from which the and other info relating to the trigger firing can be obtained. @@ -13459,7 +13606,7 @@ Scheduler will move all triggers associated with the Job into the state, which will require human intervention (e.g. an application restart after fixing whatever - configuration problem led to the issue wih instantiating the Job. + configuration problem led to the issue with instantiating the Job. The TriggerFiredBundle from which the @@ -13479,14 +13626,14 @@ Whether the JobInstantiation should fail and throw and exception if a key (name) and value (type) found in the JobDataMap does not - correspond to a proptery setter on the Job class. + correspond to a property setter on the Job class. Get or set whether a warning should be logged if a key (name) and value (type) found in the JobDataMap does not - correspond to a proptery setter on the Job class. + correspond to a property setter on the Job class. @@ -13494,7 +13641,7 @@ This class implements a that utilizes RAM as its storage device. - As you should know, the ramification of this is that access is extrememly + As you should know, the ramification of this is that access is extremely fast, but the data is completely volatile - therefore this should not be used if true persistence between program shutdowns is required. @@ -13623,7 +13770,7 @@ name and group was found and removed from the store. The to be removed. - Whether to delete orpahaned job details from scheduler if job becomes orphaned from removing the trigger. + Whether to delete orphaned job details from scheduler if job becomes orphaned from removing the trigger. @@ -13650,6 +13797,16 @@ The desired , or null if there is no match. + + + Determine whether a with the given identifier already + exists within the scheduler. + + + + the identifier to check for + true if a calendar exists with the given identifier + Determine whether a with the given identifier already @@ -14206,7 +14363,7 @@ method is called a few moments (or many moments) later. If this assumption does not hold true, it may result in extra JobStore queries and updates, and if clustering features - are being used, it may result in greater imballance of load. + are being used, it may result in greater imbalance of load. James House @@ -14403,7 +14560,7 @@ Called to give the ClassLoadHelper a chance to Initialize itself, - including the oportunity to "steal" the class loader off of the calling + including the opportunity to "steal" the class loader off of the calling thread, which is the thread that is initializing Quartz. @@ -15090,7 +15247,7 @@ Wrapper class to access thread local data. Data is either accessed from thread or HTTP Context's - data if HTTP Context is avaiable. + data if HTTP Context is available. Marko Lahma .NET @@ -15384,7 +15541,7 @@ The prefix for which to search. If it does not end in a "." then one will be added to it for search purposes. Whether to strip off the given in the result's keys. - Optional array of fully qualified prefixes to exclude. For example if is "a.b.c", then might be "a.b.c.ignore". + Optional array of fully qualified prefixes to exclude. For example if is "a.b.c", then might be "a.b.c.ignore". Group of that start with the given prefix, optionally have that prefix removed, and do not include properties that start with one of the given excluded prefixes. @@ -15605,6 +15762,21 @@ + + + TimeZoneInfo.GetUtcOffset(DateTimeOffset) is not supported under mono + + + + + + + + Tries to find time zone with given id, has ability do some fallbacks when necessary. + + System id of the time zone. + + @@ -18176,19 +18348,19 @@ - Create a JobExcecutionException, with the 're-fire immediately' flag set + Create a JobExecutionException, with the 're-fire immediately' flag set to . - Create a JobExcecutionException, with the given cause. + Create a JobExecutionException, with the given cause. The cause. - Create a JobExcecutionException, with the given message. + Create a JobExecutionException, with the given message. @@ -18200,19 +18372,19 @@ - Create a JobExcecutionException with the 're-fire immediately' flag set + Create a JobExecutionException with the 're-fire immediately' flag set to the given value. - Create a JobExcecutionException with the given underlying exception, and + Create a JobExecutionException with the given underlying exception, and the 're-fire immediately' flag set to the given value. - Create a JobExcecutionException with the given message, and underlying + Create a JobExecutionException with the given message, and underlying exception, and the 're-fire immediately' flag set to the given value. @@ -18592,14 +18764,14 @@ A constant group name used internally by the scheduler - clients should not use the value of this constant - ("RECOVERING_JOBS") for thename of a 's group. + ("RECOVERING_JOBS") for the name of a 's group. A constant group name used internally by the scheduler - clients should not use the value of this constant - ("FAILED_OVER_JOBS") for thename of a 's group. + ("FAILED_OVER_JOBS") for the name of a 's group. @@ -18645,6 +18817,12 @@ be different from the actual firing time - as a trigger doesn't always fire exactly on time. + + + A special date time to check against when signaling scheduling change when the signaled fire date suggestion is actually irrelevant. + We only want to signal the change. + + Holds context/environment data that can be made available to Jobs as they @@ -19733,7 +19911,7 @@ Compute the that is 1 second after the Nth firing of - the given , taking the triger's associated + the given , taking the trigger's associated into consideration. diff --git a/packages/Quartz.2.3.2/lib/net35/Quartz.pdb b/packages/Quartz.2.3.2/lib/net35/Quartz.pdb new file mode 100644 index 0000000..78ea69b Binary files /dev/null and b/packages/Quartz.2.3.2/lib/net35/Quartz.pdb differ diff --git a/packages/Quartz.2.2/lib/net35/Quartz.xml b/packages/Quartz.2.3.2/lib/net35/Quartz.xml similarity index 96% rename from packages/Quartz.2.2/lib/net35/Quartz.xml rename to packages/Quartz.2.3.2/lib/net35/Quartz.xml index 9ee197f..8ebb68e 100644 --- a/packages/Quartz.2.2/lib/net35/Quartz.xml +++ b/packages/Quartz.2.3.2/lib/net35/Quartz.xml @@ -68,7 +68,7 @@ - Constructor that prepolutates. + Constructor that prepopulates. @@ -673,7 +673,7 @@ - Removes the object from garbae collection protected list. + Removes the object from garbage collection protected list. The obj. @@ -1060,7 +1060,7 @@ Notifies the trigger listeners of completion. - The job executution context. + The job execution context. The instruction code to report to triggers. @@ -1071,7 +1071,7 @@ - Notifies the job listeners that job exucution was vetoed. + Notifies the job listeners that job execution was vetoed. The job execution context. @@ -1228,7 +1228,7 @@ Gets or sets a value indicating whether to signal on scheduling change. - true if schduler should signal on scheduling change; otherwise, false. + true if scheduler should signal on scheduling change; otherwise, false. @@ -1596,7 +1596,7 @@ Signals the main processing loop that a change in scheduling has been - made - in order to interrupt any sleeping that may be occuring while + made - in order to interrupt any sleeping that may be occurring while waiting for the fire time to arrive. @@ -1683,6 +1683,56 @@ Signals the scheduling change. + + + The DbMetadata factory based on application configuration + + + + + Base class for the DbMetadata Factory implementations + + + + + Gets the supported provider names. + + The enumeration of the supported provider names + + + + Gets the database metadata associated to the specified provider name. + + Name of the provider. + The metadata instance for the requested provider + + + + Initializes a new instance of the class. + + Name of the configuration section. + The provider name prefix. + The providerNamePrefix cannot be null or empty. + + + + Gets the properties parser. + + The properties parser + + + + Gets the supported provider names. + + The enumeration of the supported provider names + + + + Gets the database metadata associated to the specified provider name. + + Name of the provider. + The metadata instance for the specified name + Metadata information about specific ADO.NET driver library. Metadata is used to @@ -1822,7 +1872,7 @@ - Returns a new command object for executing SQL statments/Stored Procedures + Returns a new command object for executing SQL statements/Stored Procedures against the database. An new @@ -1878,9 +1928,15 @@ + + + Generates the valid provider names information. + + + - Returns a new command object for executing SQL statments/Stored Procedures + Returns a new command object for executing SQL statements/Stored Procedures against the database. An new @@ -1924,6 +1980,31 @@ The metadata. + + + The DbMetadata factory based on embedded assembly resource + + + + + Initializes a new instance of the class. + + Name of the resource. + Name of the property group (The prefix of the provider name). + + + + Gets the supported provider names. + + The enumeration of the supported provider names + + + + Gets the database metadata associated to the specified provider name. + + Name of the provider. + The metadata instance for the specified name + This interface can be implemented by any @@ -1970,7 +2051,7 @@ Replace the table prefix in a query by replacing any occurrences of "{0}" with the table prefix. - The unsubstitued query + The unsubstituted query The table prefix the scheduler name The query, with proper table prefix substituted @@ -2229,7 +2310,7 @@ - Initialization argumens holder for implementations. + Initialization arguments holder for implementations. @@ -2281,143 +2362,20 @@ settingName=settingValue|otherSettingName=otherSettingValue|... - - - Conveys the state of a fired-trigger record. - - James House - Marko Lahma (.NET) - - - - Gets or sets the fire instance id. - - The fire instance id. - - - - Gets or sets the fire timestamp. - - The fire timestamp. - - - - Gets or sets the scheduled fire timestamp. - - - - - Gets or sets a value indicating whether job disallows concurrent execution. - - - - - Gets or sets the job key. - - The job key. - - - - Gets or sets the scheduler instance id. - - The scheduler instance id. - - - - Gets or sets the trigger key. - - The trigger key. - - - - Gets or sets the state of the fire instance. - - The state of the fire instance. - - - - Gets or sets a value indicating whether [job requests recovery]. - - true if [job requests recovery]; otherwise, false. - - - - Gets or sets the priority. - - The priority. - - - - Service interface or modifying parameters - and resultset values. - - - - - Prepares a to be used to access database. - - Connection and tranasction pair - SQL to run - - - - - Adds a parameter to . - - Command to add parameter to - Parameter's name - Parameter's value - - - - Adds a parameter to . - - Command to add parameter to - Parameter's name - Parameter's value - Parameter's data type - - - - Gets the db presentation for boolean value. Subclasses can overwrite this behaviour. - - Value to map to database. - - - - - Gets the boolean value from db presentation. Subclasses can overwrite this behaviour. - - Value to map from database. - - - - - Gets the db presentation for date/time value. Subclasses can overwrite this behaviour. - - Value to map to database. - - - - - Gets the date/time value from db presentation. Subclasses can overwrite this behaviour. - - Value to map from database. - - - + - Gets the db presentation for time span value. Subclasses can overwrite this behaviour. + Delegate implementation for Firebird. - Value to map to database. - - + - Gets the time span value from db presentation. Subclasses can overwrite this behaviour. + This is meant to be an abstract base class for most, if not all, + implementations. Subclasses should override only those methods that need + special handling for the DBMS driver in question. - Value to map from database. - + Jeffrey Wescott + James House + Marko Lahma (.NET) @@ -3116,2399 +3074,2559 @@ - + - Exception class for when a driver delegate cannot be found for a given - configuration, or lack thereof. + Service interface or modifying parameters + and resultset values. - Jeffrey Wescott - Marko Lahma (.NET) - - - Base class for exceptions thrown by the Quartz . + + + Prepares a to be used to access database. - - SchedulerExceptions may contain a reference to another - , which was the underlying cause of the SchedulerException. - - James House - Marko Lahma (.NET) + Connection and transaction pair + SQL to run + - + - Initializes a new instance of the class. + Adds a parameter to . + Command to add parameter to + Parameter's name + Parameter's value - + - Initializes a new instance of the class. + Adds a parameter to . - The MSG. + Command to add parameter to + Parameter's name + Parameter's value + Parameter's data type - + - Initializes a new instance of the class. + Gets the db presentation for boolean value. Subclasses can overwrite this behaviour. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The class name is null or is zero (0). - The info parameter is null. + Value to map to database. + - + - Initializes a new instance of the class. + Gets the boolean value from db presentation. Subclasses can overwrite this behaviour. - The cause. + Value to map from database. + - + - Initializes a new instance of the class. + Gets the db presentation for date/time value. Subclasses can overwrite this behaviour. - The MSG. - The cause. + Value to map to database. + - + - Creates and returns a string representation of the current exception. + Gets the date/time value from db presentation. Subclasses can overwrite this behaviour. - - A string representation of the current exception. - - + Value to map from database. + - + - Initializes a new instance of the class. + Gets the db presentation for time span value. Subclasses can overwrite this behaviour. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The class name is null or is zero (0). - The info parameter is null. - - - - is meant to be used in an application-server - or other software framework environment that provides - container-managed-transactions. No commit / rollback will be handled by this class. - - - If you need commit / rollback, use - instead. - - Jeffrey Wescott - James House - Srinivas Venkatarangaiah - Marko Lahma (.NET) - - - - Contains base functionality for ADO.NET-based JobStore implementations. - - Jeffrey Wescott - James House - Marko Lahma (.NET) - - - - The interface to be implemented by classes that want to provide a - and storage mechanism for the - 's use. - - - Storage of s and s should be keyed - on the combination of their name and group for uniqueness. - - - - - - - - James House - Marko Lahma (.NET) + Value to map to database. + - + - Called by the QuartzScheduler before the is - used, in order to give the it a chance to Initialize. + Gets the time span value from db presentation. Subclasses can overwrite this behaviour. + Value to map from database. + - + - Called by the QuartzScheduler to inform the that - the scheduler has started. + Initializes the driver delegate. - + - Called by the QuartzScheduler to inform the JobStore that - the scheduler has been paused. + Insert the job detail record. + the DB Connection + the new state for the triggers + the first old state to update + the second old state to update + number of rows updated - + - Called by the QuartzScheduler to inform the JobStore that - the scheduler has resumed after being paused. + Get the names of all of the triggers that have misfired. + the DB Connection + The ts. + an array of objects - - - Called by the QuartzScheduler to inform the that - it should free up all of it's resources because the scheduler is - shutting down. + + + Select all of the triggers in a given state. + The DB Connection + The state the triggers must be in + an array of trigger s - + - Store the given and . + Get the names of all of the triggers in the given state that have + misfired - according to the given timestamp. - The to be stored. - The to be stored. - ObjectAlreadyExistsException + The DB Connection + The state. + The time stamp. + An array of objects - + - returns true if the given JobGroup is paused + Get the names of all of the triggers in the given state that have + misfired - according to the given timestamp. No more than count will + be returned. - - + The conn. + The state1. + The ts. + The most misfired triggers to return, negative for all + + Output parameter. A List of objects. Must not be null + + Whether there are more misfired triggers left to find beyond the given count. - + - returns true if the given TriggerGroup - is paused + Get the number of triggers in the given state that have + misfired - according to the given timestamp. - + + + - + - Store the given . + Get the names of all of the triggers in the given group and state that + have misfired. - The to be stored. - - If , any existing in the - with the same name and group should be - over-written. - + The DB Connection + Name of the group. + The state. + The timestamp. + an array of objects - + - Remove (delete) the with the given - key, and any s that reference - it. + Select all of the triggers for jobs that are requesting recovery. The + returned trigger objects will have unique "recoverXXX" trigger names and + will be in the + trigger group. - If removal of the results in an empty group, the - group should be removed from the 's list of - known group names. + In order to preserve the ordering of the triggers, the fire time will be + set from the ColumnFiredTime column in the TableFiredTriggers + table. The caller is responsible for calling + on each returned trigger. It is also up to the caller to insert the + returned triggers to ensure that they are fired. - - if a with the given name and - group was found and removed from the store. - + The DB Connection + an array of objects - + - Retrieve the for the given - . + Delete all fired triggers. - - The desired , or null if there is no match. - + The DB Connection. + The number of rows deleted. - + - Store the given . + Delete all fired triggers of the given instance. - The to be stored. - If , any existing in - the with the same name and group should - be over-written. - ObjectAlreadyExistsException + The DB Connection + The instance id. + The number of rows deleted - + - Remove (delete) the with the given key. + Clear (delete!) all scheduling data - all s, s + s. - - If removal of the results in an empty group, the - group should be removed from the 's list of - known group names. - - - If removal of the results in an 'orphaned' - that is not 'durable', then the should be deleted - also. - - - if a with the given - name and group was found and removed from the store. - - + - Remove (delete) the with the - given name, and store the new given one - which must be associated - with the same job. + Insert the job detail record. - The to be replaced. - The new to be stored. - - if a with the given - name and group was found and removed from the store. - + The DB Connection. + The job to insert. + Number of rows inserted. - + - Retrieve the given . + Gets the db presentation for boolean value. Subclasses can overwrite this behaviour. - - The desired , or null if there is no - match. - + Value to map to database. + - + - Determine whether a with the given identifier already - exists within the scheduler. + Gets the boolean value from db presentation. Subclasses can overwrite this behaviour. - - - the identifier to check for - true if a job exists with the given identifier + Value to map from database. + - + - Determine whether a with the given identifier already - exists within the scheduler. + Gets the db presentation for date/time value. Subclasses can overwrite this behaviour. - - - the identifier to check for - true if a trigger exists with the given identifier + Value to map to database. + - + - Clear (delete!) all scheduling data - all s, s - s. + Gets the date/time value from db presentation. Subclasses can overwrite this behaviour. - - + Value to map from database. + - + - Store the given . + Gets the db presentation for time span value. Subclasses can overwrite this behaviour. - The name. - The to be stored. - If , any existing - in the with the same name and group - should be over-written. - If , any s existing - in the that reference an existing - Calendar with the same name with have their next fire time - re-computed with the new . - ObjectAlreadyExistsException + Value to map to database. + - + - Remove (delete) the with the - given name. + Gets the time span value from db presentation. Subclasses can overwrite this behaviour. - - If removal of the would result in - s pointing to non-existent calendars, then a - will be thrown. - - The name of the to be removed. - - if a with the given name - was found and removed from the store. - + Value to map from database. + - + - Retrieve the given . + Update the job detail record. - The name of the to be retrieved. - - The desired , or null if there is no - match. - + The DB Connection. + The job to update. + Number of rows updated. - + - Get the number of s that are - stored in the . + Get the names of all of the triggers associated with the given job. - + The DB Connection. + The key identifying the job. + An array of objects - + - Get the number of s that are - stored in the . + Delete the job detail record for the given job. - + the DB Connection + The key identifying the job. + the number of rows deleted - + - Get the number of s that are - stored in the . + Check whether or not the given job is stateful. - + the DB Connection + The key identifying the job. + + true if the job exists and is stateful, false otherwise + - + - Get the names of all of the s that - have the given group name. - - If there are no jobs in the given group name, the result should be a - zero-length array (not ). - + Check whether or not the given job exists. - - + the DB Connection + The key identifying the job. + true if the job exists, false otherwise - + - Get the names of all of the s - that have the given group name. - - If there are no triggers in the given group name, the result should be a - zero-length array (not ). - + Update the job data map for the given job. + The conn. + the job to update + the number of rows updated - + - Get the names of all of the - groups. - - If there are no known group names, the result should be a zero-length - array (not ). - + Select the JobDetail object for a given job name / group name. + The DB Connection. + The key identifying the job. + The load helper. + The populated JobDetail object. - + + build Map from java.util.Properties encoding. + + - Get the names of all of the - groups. - - If there are no known group names, the result should be a zero-length - array (not ). - + Select the total number of jobs stored. + The DB Connection. + The total number of jobs stored. - + - Get the names of all of the s - in the . - - - If there are no Calendars in the given group name, the result should be - a zero-length array (not ). - + Select all of the job group names that are stored. + The DB Connection. + An array of group names. - + - Get all of the Triggers that are associated to the given Job. + Select all of the jobs contained in a given group. - - If there are no matches, a zero-length array should be returned. - + The DB Connection. + + An array of job names. - + - Get the current state of the identified . + Insert the base trigger data. - + the DB Connection + the trigger to insert + the state that the trigger should be stored in + The job detail. + the number of rows inserted - + - Pause the with the given key. + Insert the blob trigger data. + The DB Connection. + The trigger to insert. + The number of rows inserted. - + - Pause all of the s in the - given group. + Update the base trigger data. - - The JobStore should "remember" that the group is paused, and impose the - pause on any new triggers that are added to the group while the group is - paused. - + The DB Connection. + The trigger to insert. + The state that the trigger should be stored in. + The job detail. + The number of rows updated. - + - Pause the with the given key - by - pausing all of its current s. + Update the blob trigger data. + The DB Connection. + The trigger to insert. + The number of rows updated. - + - Pause all of the s in the given - group - by pausing all of their s. - - The JobStore should "remember" that the group is paused, and impose the - pause on any new jobs that are added to the group while the group is - paused. - + Check whether or not a trigger exists. - - + The DB Connection. + the key of the trigger + true if the trigger exists, false otherwise - + - Resume (un-pause) the with the - given key. - - - If the missed one or more fire-times, then the - 's misfire instruction will be applied. - + Update the state for a given trigger. - - + The DB Connection. + the key of the trigger + The new state for the trigger. + The number of rows updated. - + - Resume (un-pause) all of the s - in the given group. - - If any missed one or more fire-times, then the - 's misfire instruction will be applied. - + Update the given trigger to the given new state, if it is one of the + given old states. + The DB connection. + the key of the trigger + The new state for the trigger. + One of the old state the trigger must be in. + One of the old state the trigger must be in. + One of the old state the trigger must be in. + The number of rows updated. - + - Gets the paused trigger groups. - - - - - - Resume (un-pause) the with the - given key. - - If any of the 's s missed one - or more fire-times, then the 's misfire - instruction will be applied. - + Update all triggers in the given group to the given new state, if they + are in one of the given old states. + The DB connection. + + The new state for the trigger. + One of the old state the trigger must be in. + One of the old state the trigger must be in. + One of the old state the trigger must be in. + The number of rows updated. - + - Resume (un-pause) all of the s in - the given group. - - If any of the s had s that - missed one or more fire-times, then the 's - misfire instruction will be applied. - + Update the given trigger to the given new state, if it is in the given + old state. + the DB connection + the key of the trigger + the new state for the trigger + the old state the trigger must be in + int the number of rows updated - + - Pause all triggers - equivalent of calling - on every group. - - When is called (to un-pause), trigger misfire - instructions WILL be applied. - + Update all of the triggers of the given group to the given new state, if + they are in the given old state. - + the DB connection + + the new state for the trigger group + the old state the triggers must be in + int the number of rows updated - + - Resume (un-pause) all triggers - equivalent of calling - on every group. - - If any missed one or more fire-times, then the - 's misfire instruction will be applied. - - + Update the states of all triggers associated with the given job. - + the DB Connection + the key of the job + the new state for the triggers + the number of rows updated - + - Get a handle to the next trigger to be fired, and mark it as 'reserved' - by the calling scheduler. + Updates the state of the trigger states for job from other. - If > 0, the JobStore should only return a Trigger - that will fire no later than the time represented in this value as - milliseconds. - - + The conn. + Key of the job. + The state. + The old state. - - - - - Inform the that the scheduler no longer plans to - fire the given , that it had previously acquired - (reserved). + + + Delete the cron trigger data for a trigger. + the DB Connection + the key of the trigger + the number of rows deleted - + - Inform the that the scheduler is now firing the - given (executing its associated ), - that it had previously acquired (reserved). + Delete the base trigger data for a trigger. - - May return null if all the triggers or their calendars no longer exist, or - if the trigger was not successfully put into the 'executing' - state. Preference is to return an empty list if none of the triggers - could be fired. - + the DB Connection + the key of the trigger + the number of rows deleted - + - Inform the that the scheduler has completed the - firing of the given (and the execution its - associated ), and that the - in the given should be updated if the - is stateful. + Select the number of triggers associated with a given job. + the DB Connection + the key of the job + the number of triggers for the given job - + - Indicates whether job store supports persistence. + Select the triggers for a job - + the DB Connection + the key of the job + + an array of objects + associated with a given job. + - + - How long (in milliseconds) the implementation - estimates that it will take to release a trigger and acquire a new one. + Select the triggers for a calendar + The DB Connection. + Name of the calendar. + + An array of objects associated with a given job. + - + - Whether or not the implementation is clustered. + Select a trigger. - + the DB Connection + the key of the trigger + The object - + - Inform the of the Scheduler instance's Id, - prior to initialize being invoked. + Select a trigger's JobDataMap. + the DB Connection + the key of the trigger + The of the Trigger, never null, but possibly empty. - + - Inform the of the Scheduler instance's name, - prior to initialize being invoked. + Select a trigger's state value. + the DB Connection + the key of the trigger + The object - + - Tells the JobStore the pool size used to execute jobs. + Select a trigger status (state and next fire time). + the DB Connection + the key of the trigger + + a object, or null + - + - Initializes a new instance of the class. + Select the total number of triggers stored. + the DB Connection + the total number of triggers stored - + - Gets the connection and starts a new transaction. + Select all of the trigger group names that are stored. - + the DB Connection + + an array of group names + - + - Called by the QuartzScheduler before the is - used, in order to give it a chance to Initialize. + Select all of the triggers contained in a given group. + the DB Connection + + + an array of trigger names + - - - - + - Called by the QuartzScheduler to inform the JobStore that - the scheduler has been paused. + Inserts the paused trigger group. + The conn. + Name of the group. + - + - Called by the QuartzScheduler to inform the JobStore that - the scheduler has resumed after being paused. + Deletes the paused trigger group. + The conn. + Name of the group. + - + - Called by the QuartzScheduler to inform the that - it should free up all of it's resources because the scheduler is - shutting down. + Deletes all paused trigger groups. + The conn. + - + - Will recover any failed or misfired jobs and clean up the data store as - appropriate. + Determines whether the specified trigger group is paused. + The conn. + Name of the group. + + true if trigger group is paused; otherwise, false. + - + - Will recover any failed or misfired jobs and clean up the data store as - appropriate. + Determines whether given trigger group already exists. + The conn. + Name of the group. + + true if trigger group exists; otherwise, false. + - + - Store the given and . + Insert a new calendar. - Job to be stored. - Trigger to be stored. + the DB Connection + The name for the new calendar. + The calendar. + the number of rows inserted + IOException - + - returns true if the given JobGroup - is paused + Update a calendar. - - + the DB Connection + The name for the new calendar. + The calendar. + the number of rows updated + IOException - + - returns true if the given TriggerGroup - is paused + Check whether or not a calendar exists. - - + the DB Connection + The name of the calendar. + + true if the trigger exists, false otherwise + - + - Stores the given . - - The to be stored. - - If , any existing in the - with the same name & group should be over-written. - - - - - Insert or update a job. - + Select a calendar. + the DB Connection + The name of the calendar. + the Calendar + ClassNotFoundException + IOException - + - Check existence of a given job. + Check whether or not a calendar is referenced by any triggers. + the DB Connection + The name of the calendar. + + true if any triggers reference the calendar, false otherwise + - + - Store the given . + Delete a calendar. - The to be stored. - - If , any existing in - the with the same name & group should - be over-written. - - - if a with the same name/group already - exists, and replaceExisting is set to false. - + the DB Connection + The name of the trigger. + the number of rows deleted - + - Insert or update a trigger. + Select the total number of calendars stored. + the DB Connection + the total number of calendars stored - + - Check existence of a given trigger. + Select all of the stored calendars. + the DB Connection + + an array of calendar names + - + - Remove (delete) the with the given - name, and any s that reference - it. + Select the trigger that will be fired at the given fire time. - - - If removal of the results in an empty group, the - group should be removed from the 's list of - known group names. - + the DB Connection + the time that the trigger will be fired - if a with the given name & - group was found and removed from the store. + a representing the + trigger that will be fired at the given fire time, or null if no + trigger will be fired at that time - + - Delete a job and its listeners. + Select the next trigger which will fire to fire between the two given timestamps + in ascending order of fire time, and then descending by priority. - - + The conn. + highest value of of the triggers (exclusive) + highest value of of the triggers (inclusive) + maximum number of trigger keys allow to acquired in the returning list. + A (never null, possibly empty) list of the identifiers (Key objects) of the next triggers to be fired. - + - Delete a trigger, its listeners, and its Simple/Cron/BLOB sub-table entry. + Insert a fired trigger. - - - + the DB Connection + the trigger + the state that the trigger should be stored in + The job. + the number of rows inserted - + - Retrieve the for the given - . + + Update a fired trigger. + - The key identifying the job. - The desired , or null if there is no match. - - - - Remove (delete) the with the - given name. - - - - - If removal of the results in an empty group, the - group should be removed from the 's list of - known group names. - - - - If removal of the results in an 'orphaned' - that is not 'durable', then the should be deleted - also. - - - The key identifying the trigger. - - if a with the given - name & group was found and removed from the store. - + + + + the DB Connection + + the trigger + + + the state that the trigger should be stored in + the number of rows inserted - - + + + Select the states of all fired-trigger records for a given trigger, or + trigger group if trigger name is . + + The DB connection. + Name of the trigger. + Name of the group. + a List of objects. - + - Retrieve the given . + Select the states of all fired-trigger records for a given job, or job + group if job name is . - The key identifying the trigger. - The desired , or null if there is no match. + The DB connection. + Name of the job. + Name of the group. + a List of objects. - + - Get the current state of the identified . + Select the states of all fired-trigger records for a given scheduler + instance. - - - - - + The DB Connection + Name of the instance. + A list of FiredTriggerRecord objects. - + - Gets the state of the trigger. + Select the distinct instance names of all fired-trigger records. The conn. - The key identifying the trigger. + + This is useful when trying to identify orphaned fired triggers (a + fired trigger without a scheduler state record.) + - + - Store the given . + Delete a fired trigger. - The name of the calendar. - The to be stored. - - If , any existing - in the with the same name & group - should be over-written. - - - - if a with the same name already - exists, and replaceExisting is set to false. - - - - - Remove (delete) the with the given name. - - - If removal of the would result in - s pointing to non-existent calendars, then a - will be thrown. - - The name of the to be removed. - - if a with the given name - was found and removed from the store. - + the DB Connection + the fired trigger entry to delete + the number of rows deleted - + - Retrieve the given . + Selects the job execution count. - The name of the to be retrieved. - The desired , or null if there is no match. + The DB connection. + The key of the job. + - + - Get the number of s that are - stored in the . + Inserts the state of the scheduler. + The conn. + The instance id. + The check in time. + The interval. + - + - Get the number of s that are - stored in the . + Deletes the state of the scheduler. + The database connection. + The instance id. + - + - Get the number of s that are - stored in the . + Updates the state of the scheduler. + The database connection. + The instance id. + The check in time. + - + - Get the names of all of the s that - have the given group name. + A List of all current s. + + If instanceId is not null, then only the record for the identified + instance will be returned. + - - If there are no jobs in the given group name, the result should be a - zero-length array (not ). - + The DB Connection + The instance id. + - + - Determine whether a with the given identifier already - exists within the scheduler. + Replace the table prefix in a query by replacing any occurrences of + "{0}" with the table prefix. - - - the identifier to check for - true if a Job exists with the given identifier + The unsubstituted query + The query, with proper table prefix substituted - + - Determine whether a with the given identifier already - exists within the scheduler. + Create a serialized version of an Object. - - - the identifier to check for - true if a Trigger exists with the given identifier + the object to serialize + Serialized object as byte array. - + - Clear (delete!) all scheduling data - all s, s - s. + Remove the transient data from and then create a serialized + version of a and returns the underlying bytes. - - + The data. + the serialized data as byte array - + - Get the names of all of the s - that have the given group name. + serialize - - If there are no triggers in the given group name, the result should be a - zero-length array (not ). - + The data. + - - - Get the names of all of the - groups. + + + Convert the JobDataMap into a list of properties. - - - If there are no known group names, the result should be a zero-length - array (not ). - - + - Get the names of all of the - groups. + Convert the JobDataMap into a list of properties. - - - If there are no known group names, the result should be a zero-length - array (not ). - - + - Get the names of all of the s - in the . + This method should be overridden by any delegate subclasses that need + special handling for BLOBs. The default implementation uses standard + ADO.NET operations. - - If there are no Calendars in the given group name, the result should be - a zero-length array (not ). - + The data reader, already queued to the correct row. + The column index for the BLOB. + The deserialized object from the DataReader BLOB. - + - Get all of the Triggers that are associated to the given Job. + This method should be overridden by any delegate subclasses that need + special handling for BLOBs for job details. - - If there are no matches, a zero-length array should be returned. - + The result set, already queued to the correct row. + The column index for the BLOB. + The deserialized Object from the ResultSet BLOB. - + - Pause the with the given name. + Selects the paused trigger groups. + The DB Connection. + - + - Pause the with the given name. + Gets the select next trigger to acquire SQL clause. + FireBird version with ROWS support. + - + - Pause the with the given name - by - pausing all of its current s. + Conveys the state of a fired-trigger record. - + James House + Marko Lahma (.NET) - + - Pause all of the s in the given - group - by pausing all of their s. + Gets or sets the fire instance id. - + The fire instance id. - + - Determines if a Trigger for the given job should be blocked. - State can only transition to StatePausedBlocked/StateBlocked from - StatePaused/StateWaiting respectively. + Gets or sets the fire timestamp. - StatePausedBlocked, StateBlocked, or the currentState. + The fire timestamp. - + - Resume (un-pause) the with the - given name. + Gets or sets the scheduled fire timestamp. - - If the missed one or more fire-times, then the - 's misfire instruction will be applied. - - + - Resume (un-pause) the with the - given name. + Gets or sets a value indicating whether job disallows concurrent execution. - - If any of the 's s missed one - or more fire-times, then the 's misfire - instruction will be applied. - - - + - Resume (un-pause) all of the s in - the given group. + Gets or sets the job key. - - If any of the s had s that - missed one or more fire-times, then the 's - misfire instruction will be applied. - - + The job key. - + - Pause all of the s in the given group. + Gets or sets the scheduler instance id. - + The scheduler instance id. - + - Pause all of the s in the given group. + Gets or sets the trigger key. + The trigger key. - - - Pause all of the s in the - given group. + + + Gets or sets the state of the fire instance. + The state of the fire instance. - + - Resume (un-pause) all of the s - in the given group. - - If any missed one or more fire-times, then the - 's misfire instruction will be applied. - + Gets or sets a value indicating whether [job requests recovery]. + true if [job requests recovery]; otherwise, false. - + - Pause all triggers - equivalent of calling - on every group. - - When is called (to un-pause), trigger misfire - instructions WILL be applied. - + Gets or sets the priority. - - + The priority. - + - Resume (un-pause) all triggers - equivalent of calling - on every group. + Exception class for when a driver delegate cannot be found for a given + configuration, or lack thereof. + + Jeffrey Wescott + Marko Lahma (.NET) + + + + Base class for exceptions thrown by the Quartz . - If any missed one or more fire-times, then the - 's misfire instruction will be applied. + SchedulerExceptions may contain a reference to another + , which was the underlying cause of the SchedulerException. - + James House + Marko Lahma (.NET) - + - Resume (un-pause) all triggers - equivalent of calling - on every group. - - If any missed one or more fire-times, then the - 's misfire instruction will be applied. - + Initializes a new instance of the class. - - + - Get a handle to the next N triggers to be fired, and mark them as 'reserved' - by the calling scheduler. + Initializes a new instance of the class. - + The MSG. - + - Inform the that the scheduler no longer plans to - fire the given , that it had previously acquired - (reserved). + Initializes a new instance of the class. + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The class name is null or is zero (0). + The info parameter is null. - + - Inform the that the scheduler has completed the - firing of the given (and the execution its - associated ), and that the - in the given should be updated if the - is stateful. + Initializes a new instance of the class. + The cause. - + - Get a list of all scheduler instances in the cluster that may have failed. - This includes this scheduler if it is checking in for the first time. + Initializes a new instance of the class. + The MSG. + The cause. - + - Create dummy objects for fired triggers - that have no scheduler state record. Checkin timestamp and interval are - left as zero on these dummy objects. + Creates and returns a string representation of the current exception. - - List of all current s + + A string representation of the current exception. + + - + - Cleanup the given database connection. This means restoring - any modified auto commit or transaction isolation connection - attributes, and then closing the underlying connection. - - - - This is separate from closeConnection() because the Spring - integration relies on being able to overload closeConnection() and - expects the same connection back that it originally returned - from the datasource. - - - - - - Closes the supplied connection. + Initializes a new instance of the class. - (Optional) + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The class name is null or is zero (0). + The info parameter is null. - + - Rollback the supplied connection. - - (Optional) - - JobPersistenceException thrown if a SQLException occurs when the - connection is rolled back - + is meant to be used in an application-server + or other software framework environment that provides + container-managed-transactions. No commit / rollback will be handled by this class. + + + If you need commit / rollback, use + instead. + + Jeffrey Wescott + James House + Srinivas Venkatarangaiah + Marko Lahma (.NET) - + - Commit the supplied connection. + Contains base functionality for ADO.NET-based JobStore implementations. - The CTH. - if set to true opens a new transaction. - JobPersistenceException thrown if a SQLException occurs when the + Jeffrey Wescott + James House + Marko Lahma (.NET) - - - Execute the given callback in a transaction. Depending on the JobStore, - the surrounding transaction may be assumed to be already present - (managed). + + + The interface to be implemented by classes that want to provide a + and storage mechanism for the + 's use. - This method just forwards to ExecuteInLock() with a null lockName. + Storage of s and s should be keyed + on the combination of their name and group for uniqueness. + + + + + + + James House + Marko Lahma (.NET) - - - Execute the given callback having acquired the given lock. - Depending on the JobStore, the surrounding transaction may be - assumed to be already present (managed). - - - The name of the lock to acquire, for example - "TRIGGER_ACCESS". If null, then no lock is acquired, but the - lockCallback is still executed in a transaction. - - - The callback to excute after having acquired the given lock. - - - + - Execute the given callback having optionally acquired the given lock. - This uses the non-managed transaction connection. + Called by the QuartzScheduler before the is + used, in order to give the it a chance to Initialize. - - The name of the lock to acquire, for example - "TRIGGER_ACCESS". If null, then no lock is acquired, but the - lockCallback is still executed in a non-managed transaction. - - - The callback to excute after having acquired the given lock. - - - - - Get or set the datasource name. + + + Called by the QuartzScheduler to inform the that + the scheduler has started. - - - Get or set the database connection manager. + + + Called by the QuartzScheduler to inform the JobStore that + the scheduler has been paused. - + - Gets the log. + Called by the QuartzScheduler to inform the JobStore that + the scheduler has resumed after being paused. - The log. - - - Get or sets the prefix that should be pre-pended to all table names. + + + Called by the QuartzScheduler to inform the that + it should free up all of it's resources because the scheduler is + shutting down. - + - Set whether string-only properties will be handled in JobDataMaps. + Store the given and . + The to be stored. + The to be stored. + ObjectAlreadyExistsException - + - Get or set the instance Id of the Scheduler (must be unique within a cluster). + returns true if the given JobGroup is paused + + - + - Get or set the instance Id of the Scheduler (must be unique within this server instance). + returns true if the given TriggerGroup + is paused + + - - - Get or set whether this instance is part of a cluster. + + + Store the given . + The to be stored. + + If , any existing in the + with the same name and group should be + over-written. + - + - Get or set the frequency at which this instance "checks-in" - with the other instances of the cluster. -- Affects the rate of - detecting failed instances. + Remove (delete) the with the given + key, and any s that reference + it. + + If removal of the results in an empty group, the + group should be removed from the 's list of + known group names. + + + if a with the given name and + group was found and removed from the store. + - + - Get or set the maximum number of misfired triggers that the misfire handling - thread will try to recover at one time (within one transaction). The - default is 20. + Retrieve the for the given + . + + The desired , or null if there is no match. + - + - Gets or sets the database retry interval. + Store the given . - The db retry interval. + The to be stored. + If , any existing in + the with the same name and group should + be over-written. + ObjectAlreadyExistsException - + - Get or set whether this instance should use database-based thread - synchronization. - - - - - Whether or not to obtain locks when inserting new jobs/triggers. + Remove (delete) the with the given key. - Defaults to , which is safest - some db's (such as - MS SQLServer) seem to require this to avoid deadlocks under high load, - while others seem to do fine without. Settings this to false means - isolation guarantees between job scheduling and trigger acquisition are - entirely enforced by the database. Depending on the database and it's - configuration this may cause unusual scheduling behaviors. + If removal of the results in an empty group, the + group should be removed from the 's list of + known group names. - Setting this property to will provide a - significant performance increase during the addition of new jobs - and triggers. + If removal of the results in an 'orphaned' + that is not 'durable', then the should be deleted + also. + + if a with the given + name and group was found and removed from the store. + - - - The time span by which a trigger must have missed its - next-fire-time, in order for it to be considered "misfired" and thus - have its misfire instruction applied. + + + Remove (delete) the with the + given name, and store the new given one - which must be associated + with the same job. + The to be replaced. + The new to be stored. + + if a with the given + name and group was found and removed from the store. + - - - Don't call set autocommit(false) on connections obtained from the - DataSource. This can be helpfull in a few situations, such as if you - have a driver that complains if it is called when it is already off. + + + Retrieve the given . + + The desired , or null if there is no + match. + - - - Set the transaction isolation level of DB connections to sequential. + + + Determine whether a with the given identifier already + exists within the scheduler. + + + the identifier to check for + true if a calendar exists with the given identifier - + - Whether or not the query and update to acquire a Trigger for firing - should be performed after obtaining an explicit DB lock (to avoid - possible race conditions on the trigger's db row). This is - is considered unnecessary for most databases (due to the nature of - the SQL update that is performed), and therefore a superfluous performance hit. + Determine whether a with the given identifier already + exists within the scheduler. - However, if batch acquisition is used, it is important for this behavior - to be used for all dbs. + the identifier to check for + true if a job exists with the given identifier - - - Get or set the ADO.NET driver delegate class name. + + + Determine whether a with the given identifier already + exists within the scheduler. + + + the identifier to check for + true if a trigger exists with the given identifier - + - The driver delegate's initialization string. + Clear (delete!) all scheduling data - all s, s + s. + + - + - set the SQL statement to use to select and lock a row in the "locks" - table. + Store the given . - + The name. + The to be stored. + If , any existing + in the with the same name and group + should be over-written. + If , any s existing + in the that reference an existing + Calendar with the same name with have their next fire time + re-computed with the new . + ObjectAlreadyExistsException - + - Get whether the threads spawned by this JobStore should be - marked as daemon. Possible threads include the - and the . + Remove (delete) the with the + given name. - + + If removal of the would result in + s pointing to non-existent calendars, then a + will be thrown. + + The name of the to be removed. + + if a with the given name + was found and removed from the store. + - + - Get whether to check to see if there are Triggers that have misfired - before actually acquiring the lock to recover them. This should be - set to false if the majority of the time, there are are misfired - Triggers. + Retrieve the given . - + The name of the to be retrieved. + + The desired , or null if there is no + match. + - + - Get the driver delegate for DB operations. + Get the number of s that are + stored in the . + - + - Get whether String-only properties will be handled in JobDataMaps. + Get the number of s that are + stored in the . + - + - Indicates whether this job store supports persistence. + Get the number of s that are + stored in the . - - - - An interface for classes wishing to provide the service of loading classes - and resources within the scheduler... + + + Get the names of all of the s that + have the given group name. + + If there are no jobs in the given group name, the result should be a + zero-length array (not ). + - James House - Marko Lahma (.NET) + + - - - Called to give the ClassLoadHelper a chance to Initialize itself, - including the oportunity to "steal" the class loader off of the calling - thread, which is the thread that is initializing Quartz. + + + Get the names of all of the s + that have the given group name. + + If there are no triggers in the given group name, the result should be a + zero-length array (not ). + - - - Return the class with the given name. + + + Get the names of all of the + groups. + + If there are no known group names, the result should be a zero-length + array (not ). + - - - Finds a resource with a given name. This method returns null if no - resource with this name is found. + + + Get the names of all of the + groups. + + If there are no known group names, the result should be a zero-length + array (not ). + - name of the desired resource - - a java.net.URL object - - - - Finds a resource with a given name. This method returns null if no - resource with this name is found. + + + Get the names of all of the s + in the . + + + If there are no Calendars in the given group name, the result should be + a zero-length array (not ). + - name of the desired resource - - a java.io.InputStream object - - + - Helper class for returning the composite result of trying - to recover misfired jobs. + Get all of the Triggers that are associated to the given Job. + + If there are no matches, a zero-length array should be returned. + - + - Initializes a new instance of the class. + Get the current state of the identified . - if set to true [has more misfired triggers]. - The processed misfired trigger count. - + - + - Gets a value indicating whether this instance has more misfired triggers. + Pause the with the given key. - - true if this instance has more misfired triggers; otherwise, false. - - + - Gets the processed misfired trigger count. + Pause all of the s in the + given group. - The processed misfired trigger count. + + The JobStore should "remember" that the group is paused, and impose the + pause on any new triggers that are added to the group while the group is + paused. + - + - Called by the QuartzScheduler before the is - used, in order to give the it a chance to Initialize. + Pause the with the given key - by + pausing all of its current s. - - - + - Called by the QuartzScheduler to inform the that - it should free up all of it's resources because the scheduler is - shutting down. + Pause all of the s in the given + group - by pausing all of their s. + + The JobStore should "remember" that the group is paused, and impose the + pause on any new jobs that are added to the group while the group is + paused. + + + - + - Gets the non managed TX connection. + Resume (un-pause) the with the + given key. + + + If the missed one or more fire-times, then the + 's misfire instruction will be applied. + - + + - + - Execute the given callback having optionally acquired the given lock. - Because CMT assumes that the connection is already part of a managed - transaction, it does not attempt to commit or rollback the - enclosing transaction. + Resume (un-pause) all of the s + in the given group. + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + - - - - - - The name of the lock to acquire, for example - "TRIGGER_ACCESS". If null, then no lock is acquired, but the - txCallback is still executed in a transaction. - - Callback to execute. - + - Instructs this job store whether connections should be automatically opened. + Gets the paused trigger groups. + - + + + Resume (un-pause) the with the + given key. + + If any of the 's s missed one + or more fire-times, then the 's misfire + instruction will be applied. + + + + - is meant to be used in a standalone environment. - Both commit and rollback will be handled by this class. + Resume (un-pause) all of the s in + the given group. + + If any of the s had s that + missed one or more fire-times, then the 's + misfire instruction will be applied. + - Jeffrey Wescott - James House - Marko Lahma (.NET) - + - Called by the QuartzScheduler before the is - used, in order to give the it a chance to Initialize. + Pause all triggers - equivalent of calling + on every group. + + When is called (to un-pause), trigger misfire + instructions WILL be applied. + - - + - + - For , the non-managed TX connection is just - the normal connection because it is not CMT. - - + Resume (un-pause) all triggers - equivalent of calling + on every group. + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + + + + - + - Execute the given callback having optionally aquired the given lock. - For , because it manages its own transactions - and only has the one datasource, this is the same behavior as - . + Get a handle to the next trigger to be fired, and mark it as 'reserved' + by the calling scheduler. - - The name of the lock to aquire, for example "TRIGGER_ACCESS". - If null, then no lock is aquired, but the lockCallback is still - executed in a transaction. - - Callback to execute. + If > 0, the JobStore should only return a Trigger + that will fire no later than the time represented in this value as + milliseconds. + + - - - - + + - - - Exception class for when there is a failure obtaining or releasing a - resource lock. + + + Inform the that the scheduler no longer plans to + fire the given , that it had previously acquired + (reserved). - - James House - Marko Lahma (.NET) - + - An exception that is thrown to indicate that there has been a failure in the - scheduler's underlying persistence mechanism. + Inform the that the scheduler is now firing the + given (executing its associated ), + that it had previously acquired (reserved). - James House - Marko Lahma (.NET) + + May return null if all the triggers or their calendars no longer exist, or + if the trigger was not successfully put into the 'executing' + state. Preference is to return an empty list if none of the triggers + could be fired. + - - - Create a with the given message. - + + + Inform the that the scheduler has completed the + firing of the given (and the execution its + associated ), and that the + in the given should be updated if the + is stateful. - + - Initializes a new instance of the class. + Indicates whether job store supports persistence. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The class name is null or is zero (0). - The info parameter is null. + - - - Create a with the given message - and cause. - + + + How long (in milliseconds) the implementation + estimates that it will take to release a trigger and acquire a new one. - + - Initializes a new instance of the class. + Whether or not the implementation is clustered. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The class name is null or is zero (0). - The info parameter is null. + - + - This is a driver delegate for the MySQL ADO.NET driver. + Inform the of the Scheduler instance's Id, + prior to initialize being invoked. - Marko Lahma - + - This is meant to be an abstract base class for most, if not all, - implementations. Subclasses should override only those methods that need - special handling for the DBMS driver in question. + Inform the of the Scheduler instance's name, + prior to initialize being invoked. - Jeffrey Wescott - James House - Marko Lahma (.NET) - + - Initializes the driver delegate. + Tells the JobStore the pool size used to execute jobs. - + - Insert the job detail record. + Initializes a new instance of the class. - the DB Connection - the new state for the triggers - the first old state to update - the second old state to update - number of rows updated - + - Get the names of all of the triggers that have misfired. + Gets the connection and starts a new transaction. - the DB Connection - The ts. - an array of objects + - - - Select all of the triggers in a given state. + + + Called by the QuartzScheduler before the is + used, in order to give it a chance to Initialize. - The DB Connection - The state the triggers must be in - an array of trigger s - - - Get the names of all of the triggers in the given state that have - misfired - according to the given timestamp. - - The DB Connection - The state. - The time stamp. - An array of objects - - - - Get the names of all of the triggers in the given state that have - misfired - according to the given timestamp. No more than count will - be returned. - - The conn. - The state1. - The ts. - The most misfired triggers to return, negative for all - - Output parameter. A List of objects. Must not be null - - Whether there are more misfired triggers left to find beyond the given count. - - - - Get the number of triggers in the given state that have - misfired - according to the given timestamp. - - - - - - - - - Get the names of all of the triggers in the given group and state that - have misfired. - - The DB Connection - Name of the group. - The state. - The timestamp. - an array of objects + + - + - Select all of the triggers for jobs that are requesting recovery. The - returned trigger objects will have unique "recoverXXX" trigger names and - will be in the - trigger group. + Called by the QuartzScheduler to inform the JobStore that + the scheduler has been paused. - - In order to preserve the ordering of the triggers, the fire time will be - set from the ColumnFiredTime column in the TableFiredTriggers - table. The caller is responsible for calling - on each returned trigger. It is also up to the caller to insert the - returned triggers to ensure that they are fired. - - The DB Connection - an array of objects - + - Delete all fired triggers. + Called by the QuartzScheduler to inform the JobStore that + the scheduler has resumed after being paused. - The DB Connection. - The number of rows deleted. - + - Delete all fired triggers of the given instance. + Called by the QuartzScheduler to inform the that + it should free up all of it's resources because the scheduler is + shutting down. - The DB Connection - The instance id. - The number of rows deleted - + - Clear (delete!) all scheduling data - all s, s - s. + Will recover any failed or misfired jobs and clean up the data store as + appropriate. - - - + - Insert the job detail record. + Will recover any failed or misfired jobs and clean up the data store as + appropriate. - The DB Connection. - The job to insert. - Number of rows inserted. - + - Gets the db presentation for boolean value. Subclasses can overwrite this behaviour. + Store the given and . - Value to map to database. - + Job to be stored. + Trigger to be stored. - + - Gets the boolean value from db presentation. Subclasses can overwrite this behaviour. + returns true if the given JobGroup + is paused - Value to map from database. + - + - Gets the db presentation for date/time value. Subclasses can overwrite this behaviour. + returns true if the given TriggerGroup + is paused - Value to map to database. + - + - Gets the date/time value from db presentation. Subclasses can overwrite this behaviour. + Stores the given . - Value to map from database. - + The to be stored. + + If , any existing in the + with the same name & group should be over-written. + - - - Gets the db presentation for time span value. Subclasses can overwrite this behaviour. + + + Insert or update a job. + - Value to map to database. - - + - Gets the time span value from db presentation. Subclasses can overwrite this behaviour. + Check existence of a given job. - Value to map from database. - - + - Update the job detail record. + Store the given . - The DB Connection. - The job to update. - Number of rows updated. + The to be stored. + + If , any existing in + the with the same name & group should + be over-written. + + + if a with the same name/group already + exists, and replaceExisting is set to false. + - + - Get the names of all of the triggers associated with the given job. + Insert or update a trigger. - The DB Connection. - The key identifying the job. - An array of objects - + - Delete the job detail record for the given job. + Check existence of a given trigger. - the DB Connection - The key identifying the job. - the number of rows deleted - + - Check whether or not the given job is stateful. + Remove (delete) the with the given + name, and any s that reference + it. - the DB Connection - The key identifying the job. + + + If removal of the results in an empty group, the + group should be removed from the 's list of + known group names. + - true if the job exists and is stateful, false otherwise + if a with the given name & + group was found and removed from the store. - + - Check whether or not the given job exists. + Delete a job and its listeners. - the DB Connection - The key identifying the job. - true if the job exists, false otherwise + + - + - Update the job data map for the given job. + Delete a trigger, its listeners, and its Simple/Cron/BLOB sub-table entry. - The conn. - the job to update - the number of rows updated + + + - + - Select the JobDetail object for a given job name / group name. + Retrieve the for the given + . - The DB Connection. The key identifying the job. - The load helper. - The populated JobDetail object. + The desired , or null if there is no match. - - build Map from java.util.Properties encoding. + + + Remove (delete) the with the + given name. + + + + + If removal of the results in an empty group, the + group should be removed from the 's list of + known group names. + + + + If removal of the results in an 'orphaned' + that is not 'durable', then the should be deleted + also. + + + The key identifying the trigger. + + if a with the given + name & group was found and removed from the store. + - + + + + - Select the total number of jobs stored. + Retrieve the given . - The DB Connection. - The total number of jobs stored. + The key identifying the trigger. + The desired , or null if there is no match. - + - Select all of the job group names that are stored. + Get the current state of the identified . - The DB Connection. - An array of group names. + + + + + - + - Select all of the jobs contained in a given group. + Gets the state of the trigger. - The DB Connection. - - An array of job names. + The conn. + The key identifying the trigger. + - + - Insert the base trigger data. + Store the given . - the DB Connection - the trigger to insert - the state that the trigger should be stored in - The job detail. - the number of rows inserted + The name of the calendar. + The to be stored. + + If , any existing + in the with the same name & group + should be over-written. + + + + if a with the same name already + exists, and replaceExisting is set to false. + - + + + Remove (delete) the with the given name. + + + If removal of the would result in + s pointing to non-existent calendars, then a + will be thrown. + + The name of the to be removed. + + if a with the given name + was found and removed from the store. + + + - Insert the blob trigger data. + Retrieve the given . - The DB Connection. - The trigger to insert. - The number of rows inserted. + The name of the to be retrieved. + The desired , or null if there is no match. - + - Update the base trigger data. + Get the number of s that are + stored in the . - The DB Connection. - The trigger to insert. - The state that the trigger should be stored in. - The job detail. - The number of rows updated. - + - Update the blob trigger data. + Get the number of s that are + stored in the . - The DB Connection. - The trigger to insert. - The number of rows updated. - + - Check whether or not a trigger exists. + Get the number of s that are + stored in the . - The DB Connection. - the key of the trigger - true if the trigger exists, false otherwise - + - Update the state for a given trigger. + Get the names of all of the s that + have the given group name. - The DB Connection. - the key of the trigger - The new state for the trigger. - The number of rows updated. + + If there are no jobs in the given group name, the result should be a + zero-length array (not ). + - + - Update the given trigger to the given new state, if it is one of the - given old states. + Determine whether a with the given identifier already + exists within the scheduler. - The DB connection. - the key of the trigger - The new state for the trigger. - One of the old state the trigger must be in. - One of the old state the trigger must be in. - One of the old state the trigger must be in. - The number of rows updated. + + + the identifier to check for + true if a calendar exists with the given identifier - + - Update all triggers in the given group to the given new state, if they - are in one of the given old states. + Determine whether a with the given identifier already + exists within the scheduler. - The DB connection. - - The new state for the trigger. - One of the old state the trigger must be in. - One of the old state the trigger must be in. - One of the old state the trigger must be in. - The number of rows updated. + + + the identifier to check for + true if a Job exists with the given identifier - + - Update the given trigger to the given new state, if it is in the given - old state. + Determine whether a with the given identifier already + exists within the scheduler. - the DB connection - the key of the trigger - the new state for the trigger - the old state the trigger must be in - int the number of rows updated + + + the identifier to check for + true if a Trigger exists with the given identifier - + - Update all of the triggers of the given group to the given new state, if - they are in the given old state. + Clear (delete!) all scheduling data - all s, s + s. - the DB connection - - the new state for the trigger group - the old state the triggers must be in - int the number of rows updated + + - + - Update the states of all triggers associated with the given job. + Get the names of all of the s + that have the given group name. - the DB Connection - the key of the job - the new state for the triggers - the number of rows updated + + If there are no triggers in the given group name, the result should be a + zero-length array (not ). + - + - Updates the state of the trigger states for job from other. + Get the names of all of the + groups. - The conn. - Key of the job. - The state. - The old state. - + + + If there are no known group names, the result should be a zero-length + array (not ). + - + - Delete the cron trigger data for a trigger. + Get the names of all of the + groups. - the DB Connection - the key of the trigger - the number of rows deleted + + + If there are no known group names, the result should be a zero-length + array (not ). + - + - Delete the base trigger data for a trigger. + Get the names of all of the s + in the . - the DB Connection - the key of the trigger - the number of rows deleted + + If there are no Calendars in the given group name, the result should be + a zero-length array (not ). + - + - Select the number of triggers associated with a given job. + Get all of the Triggers that are associated to the given Job. - the DB Connection - the key of the job - the number of triggers for the given job + + If there are no matches, a zero-length array should be returned. + - + - Select the triggers for a job + Pause the with the given name. - the DB Connection - the key of the job - - an array of objects - associated with a given job. - - + - Select the triggers for a calendar + Pause the with the given name. - The DB Connection. - Name of the calendar. - - An array of objects associated with a given job. - - + - Select a trigger. + Pause the with the given name - by + pausing all of its current s. - the DB Connection - the key of the trigger - The object + - + - Select a trigger's JobDataMap. - - the DB Connection - the key of the trigger - The of the Trigger, never null, but possibly empty. - - - - Select a trigger's state value. + Pause all of the s in the given + group - by pausing all of their s. - the DB Connection - the key of the trigger - The object + - + - Select a trigger status (state and next fire time). + Determines if a Trigger for the given job should be blocked. + State can only transition to StatePausedBlocked/StateBlocked from + StatePaused/StateWaiting respectively. - the DB Connection - the key of the trigger - - a object, or null - + StatePausedBlocked, StateBlocked, or the currentState. - + - Select the total number of triggers stored. + Resume (un-pause) the with the + given name. - the DB Connection - the total number of triggers stored + + If the missed one or more fire-times, then the + 's misfire instruction will be applied. + - + - Select all of the trigger group names that are stored. + Resume (un-pause) the with the + given name. - the DB Connection - - an array of group names - + + If any of the 's s missed one + or more fire-times, then the 's misfire + instruction will be applied. + + - + - Select all of the triggers contained in a given group. + Resume (un-pause) all of the s in + the given group. - the DB Connection - - - an array of trigger names - + + If any of the s had s that + missed one or more fire-times, then the 's + misfire instruction will be applied. + + - + - Inserts the paused trigger group. + Pause all of the s in the given group. - The conn. - Name of the group. - + - + - Deletes the paused trigger group. + Pause all of the s in the given group. - The conn. - Name of the group. - - - - Deletes all paused trigger groups. + + + Pause all of the s in the + given group. - The conn. - - + - Determines whether the specified trigger group is paused. + Resume (un-pause) all of the s + in the given group. + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + - The conn. - Name of the group. - - true if trigger group is paused; otherwise, false. - - + - Determines whether given trigger group already exists. + Pause all triggers - equivalent of calling + on every group. + + When is called (to un-pause), trigger misfire + instructions WILL be applied. + - The conn. - Name of the group. - - true if trigger group exists; otherwise, false. - + + - + - Insert a new calendar. + Resume (un-pause) all triggers - equivalent of calling + on every group. - the DB Connection - The name for the new calendar. - The calendar. - the number of rows inserted - IOException + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + + - + - Update a calendar. + Resume (un-pause) all triggers - equivalent of calling + on every group. + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + - the DB Connection - The name for the new calendar. - The calendar. - the number of rows updated - IOException + - + - Check whether or not a calendar exists. + Get a handle to the next N triggers to be fired, and mark them as 'reserved' + by the calling scheduler. - the DB Connection - The name of the calendar. - - true if the trigger exists, false otherwise - + - + - Select a calendar. + Inform the that the scheduler no longer plans to + fire the given , that it had previously acquired + (reserved). - the DB Connection - The name of the calendar. - the Calendar - ClassNotFoundException - IOException - + - Check whether or not a calendar is referenced by any triggers. + Inform the that the scheduler has completed the + firing of the given (and the execution its + associated ), and that the + in the given should be updated if the + is stateful. - the DB Connection - The name of the calendar. - - true if any triggers reference the calendar, false otherwise - - + - Delete a calendar. + Get a list of all scheduler instances in the cluster that may have failed. + This includes this scheduler if it is checking in for the first time. - the DB Connection - The name of the trigger. - the number of rows deleted - + - Select the total number of calendars stored. + Create dummy objects for fired triggers + that have no scheduler state record. Checkin timestamp and interval are + left as zero on these dummy objects. - the DB Connection - the total number of calendars stored + + List of all current s - + - Select all of the stored calendars. + Cleanup the given database connection. This means restoring + any modified auto commit or transaction isolation connection + attributes, and then closing the underlying connection. - the DB Connection - - an array of calendar names - + + + This is separate from closeConnection() because the Spring + integration relies on being able to overload closeConnection() and + expects the same connection back that it originally returned + from the datasource. + + - - - Select the trigger that will be fired at the given fire time. + + + Closes the supplied connection. - the DB Connection - the time that the trigger will be fired - - a representing the - trigger that will be fired at the given fire time, or null if no - trigger will be fired at that time - + (Optional) - + - Select the next trigger which will fire to fire between the two given timestamps - in ascending order of fire time, and then descending by priority. + Rollback the supplied connection. + + (Optional) + + JobPersistenceException thrown if a SQLException occurs when the + connection is rolled back - The conn. - highest value of of the triggers (exclusive) - highest value of of the triggers (inclusive) - maximum number of trigger keys allow to acquired in the returning list. - A (never null, possibly empty) list of the identifiers (Key objects) of the next triggers to be fired. - + - Insert a fired trigger. + Commit the supplied connection. - the DB Connection - the trigger - the state that the trigger should be stored in - The job. - the number of rows inserted + The CTH. + if set to true opens a new transaction. + JobPersistenceException thrown if a SQLException occurs when the - + + + Execute the given callback in a transaction. Depending on the JobStore, + the surrounding transaction may be assumed to be already present + (managed). + + + This method just forwards to ExecuteInLock() with a null lockName. + + + + Execute the given callback having acquired the given lock. + Depending on the JobStore, the surrounding transaction may be + assumed to be already present (managed). + + + The name of the lock to acquire, for example + "TRIGGER_ACCESS". If null, then no lock is acquired, but the + lockCallback is still executed in a transaction. + + + The callback to execute after having acquired the given lock. + + + + + Execute the given callback having optionally acquired the given lock. + This uses the non-managed transaction connection. + + + The name of the lock to acquire, for example + "TRIGGER_ACCESS". If null, then no lock is acquired, but the + lockCallback is still executed in a non-managed transaction. + + + The callback to execute after having acquired the given lock. + + + + + + Get or set the datasource name. + + + + + Get or set the database connection manager. + + + + + Gets the log. + + The log. + + + + Get or sets the prefix that should be pre-pended to all table names. + + + + + Set whether string-only properties will be handled in JobDataMaps. + + + + + Get or set the instance Id of the Scheduler (must be unique within a cluster). + + + + + Get or set the instance Id of the Scheduler (must be unique within this server instance). + + + + + Gets or sets the number of retries before an error is logged for recovery operations. + + + + + Get or set whether this instance is part of a cluster. + + + + + Get or set the frequency at which this instance "checks-in" + with the other instances of the cluster. -- Affects the rate of + detecting failed instances. + + + + + Get or set the maximum number of misfired triggers that the misfire handling + thread will try to recover at one time (within one transaction). The + default is 20. + + + + + Gets or sets the database retry interval. + + The db retry interval. + + + + Get or set whether this instance should use database-based thread + synchronization. + + + + + Whether or not to obtain locks when inserting new jobs/triggers. + + - Update a fired trigger. + Defaults to , which is safest - some db's (such as + MS SQLServer) seem to require this to avoid deadlocks under high load, + while others seem to do fine without. Settings this to false means + isolation guarantees between job scheduling and trigger acquisition are + entirely enforced by the database. Depending on the database and it's + configuration this may cause unusual scheduling behaviors. + + + Setting this property to will provide a + significant performance increase during the addition of new jobs + and triggers. + + + + + The time span by which a trigger must have missed its + next-fire-time, in order for it to be considered "misfired" and thus + have its misfire instruction applied. + + + + + Don't call set autocommit(false) on connections obtained from the + DataSource. This can be helpful in a few situations, such as if you + have a driver that complains if it is called when it is already off. + + + + + Set the transaction isolation level of DB connections to sequential. + + + + + Whether or not the query and update to acquire a Trigger for firing + should be performed after obtaining an explicit DB lock (to avoid + possible race conditions on the trigger's db row). This is + is considered unnecessary for most databases (due to the nature of + the SQL update that is performed), and therefore a superfluous performance hit. + However, if batch acquisition is used, it is important for this behavior + to be used for all dbs. - - the DB Connection - - the trigger - - - the state that the trigger should be stored in - the number of rows inserted - + + + Get or set the ADO.NET driver delegate class name. + + + - Select the states of all fired-trigger records for a given trigger, or - trigger group if trigger name is . + The driver delegate's initialization string. - The DB connection. - Name of the trigger. - Name of the group. - a List of objects. - + - Select the states of all fired-trigger records for a given job, or job - group if job name is . + set the SQL statement to use to select and lock a row in the "locks" + table. - The DB connection. - Name of the job. - Name of the group. - a List of objects. + + + + + Get whether the threads spawned by this JobStore should be + marked as daemon. Possible threads include the + and the . + + + + + + Get whether to check to see if there are Triggers that have misfired + before actually acquiring the lock to recover them. This should be + set to false if the majority of the time, there are are misfired + Triggers. + + + + + + Get the driver delegate for DB operations. + + + + + Get whether String-only properties will be handled in JobDataMaps. + + + + + Indicates whether this job store supports persistence. + + + + + + + An interface for classes wishing to provide the service of loading classes + and resources within the scheduler... + + James House + Marko Lahma (.NET) + + + + Called to give the ClassLoadHelper a chance to Initialize itself, + including the opportunity to "steal" the class loader off of the calling + thread, which is the thread that is initializing Quartz. + + + + + Return the class with the given name. + + + + + Finds a resource with a given name. This method returns null if no + resource with this name is found. + + name of the desired resource + + a java.net.URL object + + + + + Finds a resource with a given name. This method returns null if no + resource with this name is found. + + name of the desired resource + + a java.io.InputStream object + - + - Select the states of all fired-trigger records for a given scheduler - instance. + Helper class for returning the composite result of trying + to recover misfired jobs. - The DB Connection - Name of the instance. - A list of FiredTriggerRecord objects. - + - Select the distinct instance names of all fired-trigger records. + Initializes a new instance of the class. - The conn. - - - This is useful when trying to identify orphaned fired triggers (a - fired trigger without a scheduler state record.) - + if set to true [has more misfired triggers]. + The processed misfired trigger count. + - + - Delete a fired trigger. + Gets a value indicating whether this instance has more misfired triggers. - the DB Connection - the fired trigger entry to delete - the number of rows deleted + + true if this instance has more misfired triggers; otherwise, false. + - + - Selects the job execution count. + Gets the processed misfired trigger count. - The DB connection. - The key of the job. - + The processed misfired trigger count. - + - Inserts the state of the scheduler. + Called by the QuartzScheduler before the is + used, in order to give the it a chance to Initialize. - The conn. - The instance id. - The check in time. - The interval. - + + - + - Deletes the state of the scheduler. + Called by the QuartzScheduler to inform the that + it should free up all of it's resources because the scheduler is + shutting down. - The database connection. - The instance id. - - + - Updates the state of the scheduler. + Gets the non managed TX connection. - The database connection. - The instance id. - The check in time. - + - A List of all current s. - - If instanceId is not null, then only the record for the identified - instance will be returned. - + Execute the given callback having optionally acquired the given lock. + Because CMT assumes that the connection is already part of a managed + transaction, it does not attempt to commit or rollback the + enclosing transaction. - The DB Connection - The instance id. - + + + + + + The name of the lock to acquire, for example + "TRIGGER_ACCESS". If null, then no lock is acquired, but the + txCallback is still executed in a transaction. + + Callback to execute. - + - Replace the table prefix in a query by replacing any occurrences of - "{0}" with the table prefix. + Instructs this job store whether connections should be automatically opened. - The unsubstitued query - The query, with proper table prefix substituted - + - Create a serialized version of an Object. + is meant to be used in a standalone environment. + Both commit and rollback will be handled by this class. - the object to serialize - Serialized object as byte array. + Jeffrey Wescott + James House + Marko Lahma (.NET) - + - Remove the transient data from and then create a serialized - version of a and returns the underlying bytes. + Called by the QuartzScheduler before the is + used, in order to give the it a chance to Initialize. - The data. - the serialized data as byte array + + - + - serialize + For , the non-managed TX connection is just + the normal connection because it is not CMT. + + + + + + Execute the given callback having optionally acquired the given lock. + For , because it manages its own transactions + and only has the one datasource, this is the same behavior as + . - The data. + + The name of the lock to acquire, for example "TRIGGER_ACCESS". + If null, then no lock is acquired, but the lockCallback is still + executed in a transaction. + + Callback to execute. + + + + - - - Convert the JobDataMap into a list of properties. + + + Exception class for when there is a failure obtaining or releasing a + resource lock. + + James House + Marko Lahma (.NET) - + - Convert the JobDataMap into a list of properties. + An exception that is thrown to indicate that there has been a failure in the + scheduler's underlying persistence mechanism. + James House + Marko Lahma (.NET) - + + + Create a with the given message. + + + + - This method should be overridden by any delegate subclasses that need - special handling for BLOBs. The default implementation uses standard - ADO.NET operations. + Initializes a new instance of the class. - The data reader, already queued to the correct row. - The column index for the BLOB. - The deserialized object from the DataReader BLOB. + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The class name is null or is zero (0). + The info parameter is null. - + + + Create a with the given message + and cause. + + + + - This method should be overridden by any delegate subclasses that need - special handling for BLOBs for job details. + Initializes a new instance of the class. - The result set, already queued to the correct row. - The column index for the BLOB. - The deserialized Object from the ResultSet BLOB. + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The class name is null or is zero (0). + The info parameter is null. - + - Selects the paused trigger groups. + This is a driver delegate for the MySQL ADO.NET driver. - The DB Connection. - + Marko Lahma @@ -5912,7 +6030,7 @@ - Return true, if day is defined to be exluded. + Return true, if day is defined to be excluded. @@ -6078,7 +6196,7 @@ Create a with a time range defined by the specified strings and no baseCalendar. - and + and must be in the format "HH:MM[:SS[:mmm]]" where:
  • @@ -6106,12 +6224,14 @@
+ The range starting time in millis. + The range ending time in millis. Create a with a time range defined by the specified strings and the specified baseCalendar. - and + and must be in the format "HH:MM[:SS[:mmm]]" where:
  • @@ -6143,6 +6263,8 @@
The base calendar for this calendar instance see BaseCalendar for more information on base calendar functionality. + The range starting time in millis. + The range ending time in millis. @@ -6176,7 +6298,7 @@ Create a with a time range defined by the - specified values and the specified . Values are + specified values and the specified . Values are subject to the following validations:
  • @@ -6193,6 +6315,8 @@
+ The base calendar for this calendar instance see BaseCalendar for more + information on base calendar functionality. The range starting hour of day. The range starting minute. The range starting second. @@ -6231,7 +6355,7 @@ Create a with a time range defined by the specified s and the specified - . The Calendars are subject to the following + . The Calendars are subject to the following considerations:
  • @@ -6248,6 +6372,8 @@
+ The base calendar for this calendar instance see BaseCalendar for more + information on base calendar functionality. The range starting calendar. The range ending calendar. @@ -6276,7 +6402,7 @@ Create a with a time range defined by the - specified values and the specified . The values + specified values and the specified . The values are subject to the following considerations:
  • @@ -6292,6 +6418,8 @@
+ The base calendar for this calendar instance see BaseCalendar for more + information on base calendar functionality. The range starting time in millis. The range ending time in millis. @@ -6323,7 +6451,7 @@ Returns the start time of the time range of the day - specified in . + specified in . a DateTime representing the start time of the @@ -6333,7 +6461,7 @@ Returns the end time of the time range of the day - specified in + specified in A DateTime representing the end time of the @@ -6395,7 +6523,7 @@ - Gets the end of day, pratically sets time parts to maximum allowed values. + Gets the end of day, practically sets time parts to maximum allowed values. The time. @@ -6527,7 +6655,7 @@ - Return true, if mday is defined to be exluded. + Return true, if day is defined to be excluded. @@ -6611,7 +6739,7 @@ - Return true, if wday is defined to be exluded. E. g. + Return true, if wday is defined to be excluded. E. g. saturday and sunday. @@ -6739,6 +6867,11 @@ + + + Create a GroupMatcher that matches all. + + Matches on the complete key being equal (both name and group). @@ -8391,16 +8524,21 @@ Create a with fire time dictated by the - resolved with respect to the specified - occurring from the until - the given . + resolved with respect to the specified + occurring from the until + the given . The name of the The group of the name of the executed on firetime Group of the executed on firetime - A set to the earliest time for the to start firing. + A set to the earliest time for the to start firing. A set to the time for the to quit repeat firing. + A cron expression dictating the firing sequence of the + + Specifies for which time zone the cronExpression should be interpreted, + i.e. the expression 0 0 10 * * ?, is resolved to 10:00 am in this time zone. + @@ -8597,7 +8735,7 @@ Get or sets the time at which the CronTrigger should quit - repeating - even if repeastCount isn't yet satisfied. + repeating - even if repeatCount isn't yet satisfied. @@ -8657,10 +8795,10 @@ and daysOfWeek is default to every day. The startTime default to current time-stamp now, while endTime has not value. - If startTime is before startTimeOfDay, then startTimeOfDay will be used and startTime has no affect. Else if startTime is - after startTimeOfDay, then the first fire time for that day will be the next interval after the startTime. For example, if - you set startingTimeOfDay=9am, endingTimeOfDay=11am, interval=15 mins, and startTime=9:33am, then the next fire time will - be 9:45pm. Note also that if you do not set startTime value, the trigger builder will default to current time, and current time + If startTime is before startTimeOfDay, then startTimeOfDay will be used and startTime has no affect other than to specify + the first day of firing. Else if startTime is after startTimeOfDay, then the first fire time for that day will be the next + interval after the startTime. For example, if you set startingTimeOfDay=9am, endingTimeOfDay=11am, interval=15 mins, and startTime=9:33am, + then the next fire time will be 9:45pm. Note also that if you do not set startTime value, the trigger builder will default to current time, and current time maybe before or after the startTimeOfDay! So be aware how you set your startTime. @@ -8946,9 +9084,10 @@ - + - Given fireTime time, we need to advance/calculate and return a time of next available week day. + Given fireTime time determine if it is on a valid day of week. If so, simply return it unaltered, + if not, advance to the next valid week day, and set the time of day to the start time of day. given next fireTime. flag to whether to advance day without check existing week day. This scenario @@ -9079,7 +9218,7 @@ - Get or set thhe number of times the should + Get or set the number of times the should repeat, after which it will be automatically deleted. @@ -9304,7 +9443,7 @@ - Get or set thhe number of times the should + Get or set the number of times the should repeat, after which it will be automatically deleted. @@ -10123,7 +10262,7 @@ - Create a JobExcecutionContext with the given context data. + Create a JobExecutionContext with the given context data. @@ -10294,7 +10433,7 @@ - Returns the fire instace id. + Returns the fire instance id. @@ -10925,10 +11064,9 @@ - + the unique identifier of the job instance to be interrupted (see - true if the identified job instance was found and interrupted. @@ -11041,7 +11179,7 @@ - Get a object describiing the settings + Get a object describing the settings and capabilities of the scheduler instance. Note that the data returned is an 'instantaneous' snap-shot, and that as @@ -11294,7 +11432,7 @@ JobFactories may be of use to those wishing to have their application produce instances via some special mechanism, such as to - give the opertunity for dependency injection. + give the opportunity for dependency injection. @@ -11399,6 +11537,12 @@ James House Marko Lahma (.NET) + + + Construct a instance to proxy the given + instance. + + returns true if the given JobGroup @@ -11417,7 +11561,7 @@ - Get a object describiing the settings + Get a object describing the settings and capabilities of the scheduler instance. Note that the data returned is an 'instantaneous' snap-shot, and that as @@ -11451,12 +11595,6 @@ Calls the equivalent method on the 'proxied' . - - - Construct a instance to proxy the given - instance. - - Calls the equivalent method on the 'proxied' . @@ -11730,7 +11868,7 @@ By default a properties are loaded from App.config's quartz section. If that fails, then the file is loaded "quartz.properties". If file does not exist, - default configration located (as a embedded resource) in Quartz.dll is loaded. If you + default configuration located (as a embedded resource) in Quartz.dll is loaded. If you wish to use a file other than these defaults, you must define the system property 'quartz.properties' to point to the file you want. @@ -11739,7 +11877,7 @@ information about the various settings available within the file. - Alternativly, you can explicitly Initialize the factory by calling one of + Alternatively, you can explicitly Initialize the factory by calling one of the methods before calling . @@ -12005,7 +12143,7 @@ - Ïnforms that certain file has been updated. + Informs that certain file has been updated. Name of the file. @@ -12062,7 +12200,7 @@ - Optional parameter that specifies the workling directory to be used by + Optional parameter that specifies the working directory to be used by the executed command. @@ -12139,6 +12277,15 @@ The host name of the smtp server. REQUIRED. + + The port of the smtp server. Optional. + + + Username for authenticated session. Password must also be set if username is used. Optional. + + + Password for authenticated session. Optional. + The e-mail address to send the mail to. REQUIRED. @@ -12157,6 +12304,9 @@ The e-mail message body. REQUIRED. + + The message subject and body content type. Optional. + Executes the job. @@ -12270,7 +12420,7 @@ is about to be executed. It is called after the method of this - interface. If the implementation vetos the execution (via + interface. If the implementation vetoes the execution (via returning ), the job's execute method will not be called. @@ -12347,7 +12497,7 @@ If for some reason there is a failure creating the trigger for the follow-up job (which would generally only be caused by a rare serious failure in the system, or the non-existence of the follow-up job), an error - messsage is logged, but no other action is taken. If you need more rigorous + message is logged, but no other action is taken. If you need more rigorous handling of the error, consider scheduling the triggering of the flow-up job within your job itself. @@ -12382,7 +12532,7 @@ Called by the when a is about to be executed (an associated - has occured). + has occurred). This method will not be invoked if the execution of the Job was vetoed by a . @@ -12395,7 +12545,7 @@ Called by the when a was about to be executed (an associated - has occured), but a vetoed it's + has occurred), but a vetoed it's execution. @@ -12470,7 +12620,7 @@ - Logs a history of all job executions (and execution vetos) via common + Logs a history of all job executions (and execution vetoes) via common logging. @@ -12508,7 +12658,7 @@ 4 String - The Triggers's group. + The Trigger's group. 5 @@ -12526,8 +12676,7 @@ The re-fire count from the JobExecutionContext. - The default message text is "Job {1}.{0} fired (by trigger {4}.{3}) at: - {2, date, HH:mm:ss MM/dd/yyyy" + The default message text is "Job {1}.{0} fired (by trigger {4}.{3}) at: {2:HH:mm:ss MM/dd/yyyy}" JobSuccessMessage - available message data are: @@ -12559,7 +12708,7 @@ - + @@ -12584,8 +12733,7 @@ result was set.
4 StringThe Triggers's group.The Trigger's group.
5
- The default message text is "Job {1}.{0} execution complete at {2, date, - HH:mm:ss MM/dd/yyyy} and reports: {8" + The default message text is "Job {1}.{0} execution complete at {2:HH:mm:ss MM/dd/yyyy} and reports: {8}" JobFailedMessage - available message data are: @@ -12617,7 +12765,7 @@ - + @@ -12641,8 +12789,7 @@
4 StringThe Triggers's group.The Trigger's group.
5
- The default message text is "Job {1}.{0} execution failed at {2, date, - HH:mm:ss MM/dd/yyyy} and reports: {8" + The default message text is "Job {1}.{0} execution failed at {2:HH:mm:ss MM/dd/yyyy} and reports: {8}" JobWasVetoedMessage - available message data are: @@ -12674,7 +12821,7 @@ - + @@ -12693,7 +12840,7 @@
4 StringThe Triggers's group.The Trigger's group.
5
The default message text is "Job {1}.{0} was vetoed. It was to be fired - (by trigger {4}.{3}) at: {2, date, HH:mm:ss MM/dd/yyyy" + (by trigger {4}.{3}) at: {2:HH:mm:ss MM/dd/yyyy}" Marko Lahma (.NET) @@ -12801,7 +12948,7 @@ Called by the when a was about to be executed (an associated - has occured), but a vetoed it's + has occurred), but a vetoed it's execution. @@ -13125,7 +13272,7 @@ This plugin catches the event of the VM terminating (such as upon a CRTL-C) - and tells the scheuler to Shutdown. + and tells the scheduler to Shutdown. James House @@ -13384,7 +13531,7 @@ This interface may be of use to those wishing to have their application produce instances via some special mechanism, such as to - give the opertunity for dependency injection. + give the opportunity for dependency injection. @@ -13404,7 +13551,7 @@ Scheduler will move all triggers associated with the Job into the state, which will require human intervention (e.g. an application restart after fixing whatever - configuration problem led to the issue wih instantiating the Job. + configuration problem led to the issue with instantiating the Job. The TriggerFiredBundle from which the @@ -13432,7 +13579,7 @@ Scheduler will move all triggers associated with the Job into the state, which will require human intervention (e.g. an application restart after fixing whatever - configuration problem led to the issue wih instantiating the Job. + configuration problem led to the issue with instantiating the Job. The TriggerFiredBundle from which the and other info relating to the trigger firing can be obtained. @@ -13459,7 +13606,7 @@ Scheduler will move all triggers associated with the Job into the state, which will require human intervention (e.g. an application restart after fixing whatever - configuration problem led to the issue wih instantiating the Job. + configuration problem led to the issue with instantiating the Job. The TriggerFiredBundle from which the @@ -13479,14 +13626,14 @@ Whether the JobInstantiation should fail and throw and exception if a key (name) and value (type) found in the JobDataMap does not - correspond to a proptery setter on the Job class. + correspond to a property setter on the Job class. Get or set whether a warning should be logged if a key (name) and value (type) found in the JobDataMap does not - correspond to a proptery setter on the Job class. + correspond to a property setter on the Job class. @@ -13494,7 +13641,7 @@ This class implements a that utilizes RAM as its storage device. - As you should know, the ramification of this is that access is extrememly + As you should know, the ramification of this is that access is extremely fast, but the data is completely volatile - therefore this should not be used if true persistence between program shutdowns is required. @@ -13623,7 +13770,7 @@ name and group was found and removed from the store. The to be removed. - Whether to delete orpahaned job details from scheduler if job becomes orphaned from removing the trigger. + Whether to delete orphaned job details from scheduler if job becomes orphaned from removing the trigger. @@ -13650,6 +13797,16 @@ The desired , or null if there is no match. + + + Determine whether a with the given identifier already + exists within the scheduler. + + + + the identifier to check for + true if a calendar exists with the given identifier + Determine whether a with the given identifier already @@ -14206,7 +14363,7 @@ method is called a few moments (or many moments) later. If this assumption does not hold true, it may result in extra JobStore queries and updates, and if clustering features - are being used, it may result in greater imballance of load. + are being used, it may result in greater imbalance of load. James House @@ -14403,7 +14560,7 @@ Called to give the ClassLoadHelper a chance to Initialize itself, - including the oportunity to "steal" the class loader off of the calling + including the opportunity to "steal" the class loader off of the calling thread, which is the thread that is initializing Quartz. @@ -15090,7 +15247,7 @@ Wrapper class to access thread local data. Data is either accessed from thread or HTTP Context's - data if HTTP Context is avaiable. + data if HTTP Context is available. Marko Lahma .NET @@ -15384,7 +15541,7 @@ The prefix for which to search. If it does not end in a "." then one will be added to it for search purposes. Whether to strip off the given in the result's keys. - Optional array of fully qualified prefixes to exclude. For example if is "a.b.c", then might be "a.b.c.ignore". + Optional array of fully qualified prefixes to exclude. For example if is "a.b.c", then might be "a.b.c.ignore". Group of that start with the given prefix, optionally have that prefix removed, and do not include properties that start with one of the given excluded prefixes. @@ -15605,6 +15762,21 @@ + + + TimeZoneInfo.GetUtcOffset(DateTimeOffset) is not supported under mono + + + + + + + + Tries to find time zone with given id, has ability do some fallbacks when necessary. + + System id of the time zone. + + @@ -18176,19 +18348,19 @@ - Create a JobExcecutionException, with the 're-fire immediately' flag set + Create a JobExecutionException, with the 're-fire immediately' flag set to . - Create a JobExcecutionException, with the given cause. + Create a JobExecutionException, with the given cause. The cause. - Create a JobExcecutionException, with the given message. + Create a JobExecutionException, with the given message. @@ -18200,19 +18372,19 @@ - Create a JobExcecutionException with the 're-fire immediately' flag set + Create a JobExecutionException with the 're-fire immediately' flag set to the given value. - Create a JobExcecutionException with the given underlying exception, and + Create a JobExecutionException with the given underlying exception, and the 're-fire immediately' flag set to the given value. - Create a JobExcecutionException with the given message, and underlying + Create a JobExecutionException with the given message, and underlying exception, and the 're-fire immediately' flag set to the given value. @@ -18592,14 +18764,14 @@ A constant group name used internally by the scheduler - clients should not use the value of this constant - ("RECOVERING_JOBS") for thename of a 's group. + ("RECOVERING_JOBS") for the name of a 's group. A constant group name used internally by the scheduler - clients should not use the value of this constant - ("FAILED_OVER_JOBS") for thename of a 's group. + ("FAILED_OVER_JOBS") for the name of a 's group. @@ -18645,6 +18817,12 @@ be different from the actual firing time - as a trigger doesn't always fire exactly on time. + + + A special date time to check against when signaling scheduling change when the signaled fire date suggestion is actually irrelevant. + We only want to signal the change. + + Holds context/environment data that can be made available to Jobs as they @@ -19733,7 +19911,7 @@ Compute the that is 1 second after the Nth firing of - the given , taking the triger's associated + the given , taking the trigger's associated into consideration. diff --git a/packages/Quartz.2.3.2/lib/net40-client/Quartz.pdb b/packages/Quartz.2.3.2/lib/net40-client/Quartz.pdb new file mode 100644 index 0000000..2bce5d7 Binary files /dev/null and b/packages/Quartz.2.3.2/lib/net40-client/Quartz.pdb differ diff --git a/packages/Quartz.2.2/lib/net35-client/Quartz.xml b/packages/Quartz.2.3.2/lib/net40-client/Quartz.xml similarity index 96% rename from packages/Quartz.2.2/lib/net35-client/Quartz.xml rename to packages/Quartz.2.3.2/lib/net40-client/Quartz.xml index 9ee197f..8ebb68e 100644 --- a/packages/Quartz.2.2/lib/net35-client/Quartz.xml +++ b/packages/Quartz.2.3.2/lib/net40-client/Quartz.xml @@ -68,7 +68,7 @@ - Constructor that prepolutates. + Constructor that prepopulates. @@ -673,7 +673,7 @@ - Removes the object from garbae collection protected list. + Removes the object from garbage collection protected list. The obj. @@ -1060,7 +1060,7 @@ Notifies the trigger listeners of completion. - The job executution context. + The job execution context. The instruction code to report to triggers. @@ -1071,7 +1071,7 @@ - Notifies the job listeners that job exucution was vetoed. + Notifies the job listeners that job execution was vetoed. The job execution context. @@ -1228,7 +1228,7 @@ Gets or sets a value indicating whether to signal on scheduling change. - true if schduler should signal on scheduling change; otherwise, false. + true if scheduler should signal on scheduling change; otherwise, false. @@ -1596,7 +1596,7 @@ Signals the main processing loop that a change in scheduling has been - made - in order to interrupt any sleeping that may be occuring while + made - in order to interrupt any sleeping that may be occurring while waiting for the fire time to arrive. @@ -1683,6 +1683,56 @@ Signals the scheduling change. + + + The DbMetadata factory based on application configuration + + + + + Base class for the DbMetadata Factory implementations + + + + + Gets the supported provider names. + + The enumeration of the supported provider names + + + + Gets the database metadata associated to the specified provider name. + + Name of the provider. + The metadata instance for the requested provider + + + + Initializes a new instance of the class. + + Name of the configuration section. + The provider name prefix. + The providerNamePrefix cannot be null or empty. + + + + Gets the properties parser. + + The properties parser + + + + Gets the supported provider names. + + The enumeration of the supported provider names + + + + Gets the database metadata associated to the specified provider name. + + Name of the provider. + The metadata instance for the specified name + Metadata information about specific ADO.NET driver library. Metadata is used to @@ -1822,7 +1872,7 @@ - Returns a new command object for executing SQL statments/Stored Procedures + Returns a new command object for executing SQL statements/Stored Procedures against the database. An new @@ -1878,9 +1928,15 @@ + + + Generates the valid provider names information. + + + - Returns a new command object for executing SQL statments/Stored Procedures + Returns a new command object for executing SQL statements/Stored Procedures against the database. An new @@ -1924,6 +1980,31 @@ The metadata. + + + The DbMetadata factory based on embedded assembly resource + + + + + Initializes a new instance of the class. + + Name of the resource. + Name of the property group (The prefix of the provider name). + + + + Gets the supported provider names. + + The enumeration of the supported provider names + + + + Gets the database metadata associated to the specified provider name. + + Name of the provider. + The metadata instance for the specified name + This interface can be implemented by any @@ -1970,7 +2051,7 @@ Replace the table prefix in a query by replacing any occurrences of "{0}" with the table prefix. - The unsubstitued query + The unsubstituted query The table prefix the scheduler name The query, with proper table prefix substituted @@ -2229,7 +2310,7 @@ - Initialization argumens holder for implementations. + Initialization arguments holder for implementations. @@ -2281,143 +2362,20 @@ settingName=settingValue|otherSettingName=otherSettingValue|... - - - Conveys the state of a fired-trigger record. - - James House - Marko Lahma (.NET) - - - - Gets or sets the fire instance id. - - The fire instance id. - - - - Gets or sets the fire timestamp. - - The fire timestamp. - - - - Gets or sets the scheduled fire timestamp. - - - - - Gets or sets a value indicating whether job disallows concurrent execution. - - - - - Gets or sets the job key. - - The job key. - - - - Gets or sets the scheduler instance id. - - The scheduler instance id. - - - - Gets or sets the trigger key. - - The trigger key. - - - - Gets or sets the state of the fire instance. - - The state of the fire instance. - - - - Gets or sets a value indicating whether [job requests recovery]. - - true if [job requests recovery]; otherwise, false. - - - - Gets or sets the priority. - - The priority. - - - - Service interface or modifying parameters - and resultset values. - - - - - Prepares a to be used to access database. - - Connection and tranasction pair - SQL to run - - - - - Adds a parameter to . - - Command to add parameter to - Parameter's name - Parameter's value - - - - Adds a parameter to . - - Command to add parameter to - Parameter's name - Parameter's value - Parameter's data type - - - - Gets the db presentation for boolean value. Subclasses can overwrite this behaviour. - - Value to map to database. - - - - - Gets the boolean value from db presentation. Subclasses can overwrite this behaviour. - - Value to map from database. - - - - - Gets the db presentation for date/time value. Subclasses can overwrite this behaviour. - - Value to map to database. - - - - - Gets the date/time value from db presentation. Subclasses can overwrite this behaviour. - - Value to map from database. - - - + - Gets the db presentation for time span value. Subclasses can overwrite this behaviour. + Delegate implementation for Firebird. - Value to map to database. - - + - Gets the time span value from db presentation. Subclasses can overwrite this behaviour. + This is meant to be an abstract base class for most, if not all, + implementations. Subclasses should override only those methods that need + special handling for the DBMS driver in question. - Value to map from database. - + Jeffrey Wescott + James House + Marko Lahma (.NET) @@ -3116,2399 +3074,2559 @@ - + - Exception class for when a driver delegate cannot be found for a given - configuration, or lack thereof. + Service interface or modifying parameters + and resultset values. - Jeffrey Wescott - Marko Lahma (.NET) - - - Base class for exceptions thrown by the Quartz . + + + Prepares a to be used to access database. - - SchedulerExceptions may contain a reference to another - , which was the underlying cause of the SchedulerException. - - James House - Marko Lahma (.NET) + Connection and transaction pair + SQL to run + - + - Initializes a new instance of the class. + Adds a parameter to . + Command to add parameter to + Parameter's name + Parameter's value - + - Initializes a new instance of the class. + Adds a parameter to . - The MSG. + Command to add parameter to + Parameter's name + Parameter's value + Parameter's data type - + - Initializes a new instance of the class. + Gets the db presentation for boolean value. Subclasses can overwrite this behaviour. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The class name is null or is zero (0). - The info parameter is null. + Value to map to database. + - + - Initializes a new instance of the class. + Gets the boolean value from db presentation. Subclasses can overwrite this behaviour. - The cause. + Value to map from database. + - + - Initializes a new instance of the class. + Gets the db presentation for date/time value. Subclasses can overwrite this behaviour. - The MSG. - The cause. + Value to map to database. + - + - Creates and returns a string representation of the current exception. + Gets the date/time value from db presentation. Subclasses can overwrite this behaviour. - - A string representation of the current exception. - - + Value to map from database. + - + - Initializes a new instance of the class. + Gets the db presentation for time span value. Subclasses can overwrite this behaviour. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The class name is null or is zero (0). - The info parameter is null. - - - - is meant to be used in an application-server - or other software framework environment that provides - container-managed-transactions. No commit / rollback will be handled by this class. - - - If you need commit / rollback, use - instead. - - Jeffrey Wescott - James House - Srinivas Venkatarangaiah - Marko Lahma (.NET) - - - - Contains base functionality for ADO.NET-based JobStore implementations. - - Jeffrey Wescott - James House - Marko Lahma (.NET) - - - - The interface to be implemented by classes that want to provide a - and storage mechanism for the - 's use. - - - Storage of s and s should be keyed - on the combination of their name and group for uniqueness. - - - - - - - - James House - Marko Lahma (.NET) + Value to map to database. + - + - Called by the QuartzScheduler before the is - used, in order to give the it a chance to Initialize. + Gets the time span value from db presentation. Subclasses can overwrite this behaviour. + Value to map from database. + - + - Called by the QuartzScheduler to inform the that - the scheduler has started. + Initializes the driver delegate. - + - Called by the QuartzScheduler to inform the JobStore that - the scheduler has been paused. + Insert the job detail record. + the DB Connection + the new state for the triggers + the first old state to update + the second old state to update + number of rows updated - + - Called by the QuartzScheduler to inform the JobStore that - the scheduler has resumed after being paused. + Get the names of all of the triggers that have misfired. + the DB Connection + The ts. + an array of objects - - - Called by the QuartzScheduler to inform the that - it should free up all of it's resources because the scheduler is - shutting down. + + + Select all of the triggers in a given state. + The DB Connection + The state the triggers must be in + an array of trigger s - + - Store the given and . + Get the names of all of the triggers in the given state that have + misfired - according to the given timestamp. - The to be stored. - The to be stored. - ObjectAlreadyExistsException + The DB Connection + The state. + The time stamp. + An array of objects - + - returns true if the given JobGroup is paused + Get the names of all of the triggers in the given state that have + misfired - according to the given timestamp. No more than count will + be returned. - - + The conn. + The state1. + The ts. + The most misfired triggers to return, negative for all + + Output parameter. A List of objects. Must not be null + + Whether there are more misfired triggers left to find beyond the given count. - + - returns true if the given TriggerGroup - is paused + Get the number of triggers in the given state that have + misfired - according to the given timestamp. - + + + - + - Store the given . + Get the names of all of the triggers in the given group and state that + have misfired. - The to be stored. - - If , any existing in the - with the same name and group should be - over-written. - + The DB Connection + Name of the group. + The state. + The timestamp. + an array of objects - + - Remove (delete) the with the given - key, and any s that reference - it. + Select all of the triggers for jobs that are requesting recovery. The + returned trigger objects will have unique "recoverXXX" trigger names and + will be in the + trigger group. - If removal of the results in an empty group, the - group should be removed from the 's list of - known group names. + In order to preserve the ordering of the triggers, the fire time will be + set from the ColumnFiredTime column in the TableFiredTriggers + table. The caller is responsible for calling + on each returned trigger. It is also up to the caller to insert the + returned triggers to ensure that they are fired. - - if a with the given name and - group was found and removed from the store. - + The DB Connection + an array of objects - + - Retrieve the for the given - . + Delete all fired triggers. - - The desired , or null if there is no match. - + The DB Connection. + The number of rows deleted. - + - Store the given . + Delete all fired triggers of the given instance. - The to be stored. - If , any existing in - the with the same name and group should - be over-written. - ObjectAlreadyExistsException + The DB Connection + The instance id. + The number of rows deleted - + - Remove (delete) the with the given key. + Clear (delete!) all scheduling data - all s, s + s. - - If removal of the results in an empty group, the - group should be removed from the 's list of - known group names. - - - If removal of the results in an 'orphaned' - that is not 'durable', then the should be deleted - also. - - - if a with the given - name and group was found and removed from the store. - - + - Remove (delete) the with the - given name, and store the new given one - which must be associated - with the same job. + Insert the job detail record. - The to be replaced. - The new to be stored. - - if a with the given - name and group was found and removed from the store. - + The DB Connection. + The job to insert. + Number of rows inserted. - + - Retrieve the given . + Gets the db presentation for boolean value. Subclasses can overwrite this behaviour. - - The desired , or null if there is no - match. - + Value to map to database. + - + - Determine whether a with the given identifier already - exists within the scheduler. + Gets the boolean value from db presentation. Subclasses can overwrite this behaviour. - - - the identifier to check for - true if a job exists with the given identifier + Value to map from database. + - + - Determine whether a with the given identifier already - exists within the scheduler. + Gets the db presentation for date/time value. Subclasses can overwrite this behaviour. - - - the identifier to check for - true if a trigger exists with the given identifier + Value to map to database. + - + - Clear (delete!) all scheduling data - all s, s - s. + Gets the date/time value from db presentation. Subclasses can overwrite this behaviour. - - + Value to map from database. + - + - Store the given . + Gets the db presentation for time span value. Subclasses can overwrite this behaviour. - The name. - The to be stored. - If , any existing - in the with the same name and group - should be over-written. - If , any s existing - in the that reference an existing - Calendar with the same name with have their next fire time - re-computed with the new . - ObjectAlreadyExistsException + Value to map to database. + - + - Remove (delete) the with the - given name. + Gets the time span value from db presentation. Subclasses can overwrite this behaviour. - - If removal of the would result in - s pointing to non-existent calendars, then a - will be thrown. - - The name of the to be removed. - - if a with the given name - was found and removed from the store. - + Value to map from database. + - + - Retrieve the given . + Update the job detail record. - The name of the to be retrieved. - - The desired , or null if there is no - match. - + The DB Connection. + The job to update. + Number of rows updated. - + - Get the number of s that are - stored in the . + Get the names of all of the triggers associated with the given job. - + The DB Connection. + The key identifying the job. + An array of objects - + - Get the number of s that are - stored in the . + Delete the job detail record for the given job. - + the DB Connection + The key identifying the job. + the number of rows deleted - + - Get the number of s that are - stored in the . + Check whether or not the given job is stateful. - + the DB Connection + The key identifying the job. + + true if the job exists and is stateful, false otherwise + - + - Get the names of all of the s that - have the given group name. - - If there are no jobs in the given group name, the result should be a - zero-length array (not ). - + Check whether or not the given job exists. - - + the DB Connection + The key identifying the job. + true if the job exists, false otherwise - + - Get the names of all of the s - that have the given group name. - - If there are no triggers in the given group name, the result should be a - zero-length array (not ). - + Update the job data map for the given job. + The conn. + the job to update + the number of rows updated - + - Get the names of all of the - groups. - - If there are no known group names, the result should be a zero-length - array (not ). - + Select the JobDetail object for a given job name / group name. + The DB Connection. + The key identifying the job. + The load helper. + The populated JobDetail object. - + + build Map from java.util.Properties encoding. + + - Get the names of all of the - groups. - - If there are no known group names, the result should be a zero-length - array (not ). - + Select the total number of jobs stored. + The DB Connection. + The total number of jobs stored. - + - Get the names of all of the s - in the . - - - If there are no Calendars in the given group name, the result should be - a zero-length array (not ). - + Select all of the job group names that are stored. + The DB Connection. + An array of group names. - + - Get all of the Triggers that are associated to the given Job. + Select all of the jobs contained in a given group. - - If there are no matches, a zero-length array should be returned. - + The DB Connection. + + An array of job names. - + - Get the current state of the identified . + Insert the base trigger data. - + the DB Connection + the trigger to insert + the state that the trigger should be stored in + The job detail. + the number of rows inserted - + - Pause the with the given key. + Insert the blob trigger data. + The DB Connection. + The trigger to insert. + The number of rows inserted. - + - Pause all of the s in the - given group. + Update the base trigger data. - - The JobStore should "remember" that the group is paused, and impose the - pause on any new triggers that are added to the group while the group is - paused. - + The DB Connection. + The trigger to insert. + The state that the trigger should be stored in. + The job detail. + The number of rows updated. - + - Pause the with the given key - by - pausing all of its current s. + Update the blob trigger data. + The DB Connection. + The trigger to insert. + The number of rows updated. - + - Pause all of the s in the given - group - by pausing all of their s. - - The JobStore should "remember" that the group is paused, and impose the - pause on any new jobs that are added to the group while the group is - paused. - + Check whether or not a trigger exists. - - + The DB Connection. + the key of the trigger + true if the trigger exists, false otherwise - + - Resume (un-pause) the with the - given key. - - - If the missed one or more fire-times, then the - 's misfire instruction will be applied. - + Update the state for a given trigger. - - + The DB Connection. + the key of the trigger + The new state for the trigger. + The number of rows updated. - + - Resume (un-pause) all of the s - in the given group. - - If any missed one or more fire-times, then the - 's misfire instruction will be applied. - + Update the given trigger to the given new state, if it is one of the + given old states. + The DB connection. + the key of the trigger + The new state for the trigger. + One of the old state the trigger must be in. + One of the old state the trigger must be in. + One of the old state the trigger must be in. + The number of rows updated. - + - Gets the paused trigger groups. - - - - - - Resume (un-pause) the with the - given key. - - If any of the 's s missed one - or more fire-times, then the 's misfire - instruction will be applied. - + Update all triggers in the given group to the given new state, if they + are in one of the given old states. + The DB connection. + + The new state for the trigger. + One of the old state the trigger must be in. + One of the old state the trigger must be in. + One of the old state the trigger must be in. + The number of rows updated. - + - Resume (un-pause) all of the s in - the given group. - - If any of the s had s that - missed one or more fire-times, then the 's - misfire instruction will be applied. - + Update the given trigger to the given new state, if it is in the given + old state. + the DB connection + the key of the trigger + the new state for the trigger + the old state the trigger must be in + int the number of rows updated - + - Pause all triggers - equivalent of calling - on every group. - - When is called (to un-pause), trigger misfire - instructions WILL be applied. - + Update all of the triggers of the given group to the given new state, if + they are in the given old state. - + the DB connection + + the new state for the trigger group + the old state the triggers must be in + int the number of rows updated - + - Resume (un-pause) all triggers - equivalent of calling - on every group. - - If any missed one or more fire-times, then the - 's misfire instruction will be applied. - - + Update the states of all triggers associated with the given job. - + the DB Connection + the key of the job + the new state for the triggers + the number of rows updated - + - Get a handle to the next trigger to be fired, and mark it as 'reserved' - by the calling scheduler. + Updates the state of the trigger states for job from other. - If > 0, the JobStore should only return a Trigger - that will fire no later than the time represented in this value as - milliseconds. - - + The conn. + Key of the job. + The state. + The old state. - - - - - Inform the that the scheduler no longer plans to - fire the given , that it had previously acquired - (reserved). + + + Delete the cron trigger data for a trigger. + the DB Connection + the key of the trigger + the number of rows deleted - + - Inform the that the scheduler is now firing the - given (executing its associated ), - that it had previously acquired (reserved). + Delete the base trigger data for a trigger. - - May return null if all the triggers or their calendars no longer exist, or - if the trigger was not successfully put into the 'executing' - state. Preference is to return an empty list if none of the triggers - could be fired. - + the DB Connection + the key of the trigger + the number of rows deleted - + - Inform the that the scheduler has completed the - firing of the given (and the execution its - associated ), and that the - in the given should be updated if the - is stateful. + Select the number of triggers associated with a given job. + the DB Connection + the key of the job + the number of triggers for the given job - + - Indicates whether job store supports persistence. + Select the triggers for a job - + the DB Connection + the key of the job + + an array of objects + associated with a given job. + - + - How long (in milliseconds) the implementation - estimates that it will take to release a trigger and acquire a new one. + Select the triggers for a calendar + The DB Connection. + Name of the calendar. + + An array of objects associated with a given job. + - + - Whether or not the implementation is clustered. + Select a trigger. - + the DB Connection + the key of the trigger + The object - + - Inform the of the Scheduler instance's Id, - prior to initialize being invoked. + Select a trigger's JobDataMap. + the DB Connection + the key of the trigger + The of the Trigger, never null, but possibly empty. - + - Inform the of the Scheduler instance's name, - prior to initialize being invoked. + Select a trigger's state value. + the DB Connection + the key of the trigger + The object - + - Tells the JobStore the pool size used to execute jobs. + Select a trigger status (state and next fire time). + the DB Connection + the key of the trigger + + a object, or null + - + - Initializes a new instance of the class. + Select the total number of triggers stored. + the DB Connection + the total number of triggers stored - + - Gets the connection and starts a new transaction. + Select all of the trigger group names that are stored. - + the DB Connection + + an array of group names + - + - Called by the QuartzScheduler before the is - used, in order to give it a chance to Initialize. + Select all of the triggers contained in a given group. + the DB Connection + + + an array of trigger names + - - - - + - Called by the QuartzScheduler to inform the JobStore that - the scheduler has been paused. + Inserts the paused trigger group. + The conn. + Name of the group. + - + - Called by the QuartzScheduler to inform the JobStore that - the scheduler has resumed after being paused. + Deletes the paused trigger group. + The conn. + Name of the group. + - + - Called by the QuartzScheduler to inform the that - it should free up all of it's resources because the scheduler is - shutting down. + Deletes all paused trigger groups. + The conn. + - + - Will recover any failed or misfired jobs and clean up the data store as - appropriate. + Determines whether the specified trigger group is paused. + The conn. + Name of the group. + + true if trigger group is paused; otherwise, false. + - + - Will recover any failed or misfired jobs and clean up the data store as - appropriate. + Determines whether given trigger group already exists. + The conn. + Name of the group. + + true if trigger group exists; otherwise, false. + - + - Store the given and . + Insert a new calendar. - Job to be stored. - Trigger to be stored. + the DB Connection + The name for the new calendar. + The calendar. + the number of rows inserted + IOException - + - returns true if the given JobGroup - is paused + Update a calendar. - - + the DB Connection + The name for the new calendar. + The calendar. + the number of rows updated + IOException - + - returns true if the given TriggerGroup - is paused + Check whether or not a calendar exists. - - + the DB Connection + The name of the calendar. + + true if the trigger exists, false otherwise + - + - Stores the given . - - The to be stored. - - If , any existing in the - with the same name & group should be over-written. - - - - - Insert or update a job. - + Select a calendar. + the DB Connection + The name of the calendar. + the Calendar + ClassNotFoundException + IOException - + - Check existence of a given job. + Check whether or not a calendar is referenced by any triggers. + the DB Connection + The name of the calendar. + + true if any triggers reference the calendar, false otherwise + - + - Store the given . + Delete a calendar. - The to be stored. - - If , any existing in - the with the same name & group should - be over-written. - - - if a with the same name/group already - exists, and replaceExisting is set to false. - + the DB Connection + The name of the trigger. + the number of rows deleted - + - Insert or update a trigger. + Select the total number of calendars stored. + the DB Connection + the total number of calendars stored - + - Check existence of a given trigger. + Select all of the stored calendars. + the DB Connection + + an array of calendar names + - + - Remove (delete) the with the given - name, and any s that reference - it. + Select the trigger that will be fired at the given fire time. - - - If removal of the results in an empty group, the - group should be removed from the 's list of - known group names. - + the DB Connection + the time that the trigger will be fired - if a with the given name & - group was found and removed from the store. + a representing the + trigger that will be fired at the given fire time, or null if no + trigger will be fired at that time - + - Delete a job and its listeners. + Select the next trigger which will fire to fire between the two given timestamps + in ascending order of fire time, and then descending by priority. - - + The conn. + highest value of of the triggers (exclusive) + highest value of of the triggers (inclusive) + maximum number of trigger keys allow to acquired in the returning list. + A (never null, possibly empty) list of the identifiers (Key objects) of the next triggers to be fired. - + - Delete a trigger, its listeners, and its Simple/Cron/BLOB sub-table entry. + Insert a fired trigger. - - - + the DB Connection + the trigger + the state that the trigger should be stored in + The job. + the number of rows inserted - + - Retrieve the for the given - . + + Update a fired trigger. + - The key identifying the job. - The desired , or null if there is no match. - - - - Remove (delete) the with the - given name. - - - - - If removal of the results in an empty group, the - group should be removed from the 's list of - known group names. - - - - If removal of the results in an 'orphaned' - that is not 'durable', then the should be deleted - also. - - - The key identifying the trigger. - - if a with the given - name & group was found and removed from the store. - + + + + the DB Connection + + the trigger + + + the state that the trigger should be stored in + the number of rows inserted - - + + + Select the states of all fired-trigger records for a given trigger, or + trigger group if trigger name is . + + The DB connection. + Name of the trigger. + Name of the group. + a List of objects. - + - Retrieve the given . + Select the states of all fired-trigger records for a given job, or job + group if job name is . - The key identifying the trigger. - The desired , or null if there is no match. + The DB connection. + Name of the job. + Name of the group. + a List of objects. - + - Get the current state of the identified . + Select the states of all fired-trigger records for a given scheduler + instance. - - - - - + The DB Connection + Name of the instance. + A list of FiredTriggerRecord objects. - + - Gets the state of the trigger. + Select the distinct instance names of all fired-trigger records. The conn. - The key identifying the trigger. + + This is useful when trying to identify orphaned fired triggers (a + fired trigger without a scheduler state record.) + - + - Store the given . + Delete a fired trigger. - The name of the calendar. - The to be stored. - - If , any existing - in the with the same name & group - should be over-written. - - - - if a with the same name already - exists, and replaceExisting is set to false. - - - - - Remove (delete) the with the given name. - - - If removal of the would result in - s pointing to non-existent calendars, then a - will be thrown. - - The name of the to be removed. - - if a with the given name - was found and removed from the store. - + the DB Connection + the fired trigger entry to delete + the number of rows deleted - + - Retrieve the given . + Selects the job execution count. - The name of the to be retrieved. - The desired , or null if there is no match. + The DB connection. + The key of the job. + - + - Get the number of s that are - stored in the . + Inserts the state of the scheduler. + The conn. + The instance id. + The check in time. + The interval. + - + - Get the number of s that are - stored in the . + Deletes the state of the scheduler. + The database connection. + The instance id. + - + - Get the number of s that are - stored in the . + Updates the state of the scheduler. + The database connection. + The instance id. + The check in time. + - + - Get the names of all of the s that - have the given group name. + A List of all current s. + + If instanceId is not null, then only the record for the identified + instance will be returned. + - - If there are no jobs in the given group name, the result should be a - zero-length array (not ). - + The DB Connection + The instance id. + - + - Determine whether a with the given identifier already - exists within the scheduler. + Replace the table prefix in a query by replacing any occurrences of + "{0}" with the table prefix. - - - the identifier to check for - true if a Job exists with the given identifier + The unsubstituted query + The query, with proper table prefix substituted - + - Determine whether a with the given identifier already - exists within the scheduler. + Create a serialized version of an Object. - - - the identifier to check for - true if a Trigger exists with the given identifier + the object to serialize + Serialized object as byte array. - + - Clear (delete!) all scheduling data - all s, s - s. + Remove the transient data from and then create a serialized + version of a and returns the underlying bytes. - - + The data. + the serialized data as byte array - + - Get the names of all of the s - that have the given group name. + serialize - - If there are no triggers in the given group name, the result should be a - zero-length array (not ). - + The data. + - - - Get the names of all of the - groups. + + + Convert the JobDataMap into a list of properties. - - - If there are no known group names, the result should be a zero-length - array (not ). - - + - Get the names of all of the - groups. + Convert the JobDataMap into a list of properties. - - - If there are no known group names, the result should be a zero-length - array (not ). - - + - Get the names of all of the s - in the . + This method should be overridden by any delegate subclasses that need + special handling for BLOBs. The default implementation uses standard + ADO.NET operations. - - If there are no Calendars in the given group name, the result should be - a zero-length array (not ). - + The data reader, already queued to the correct row. + The column index for the BLOB. + The deserialized object from the DataReader BLOB. - + - Get all of the Triggers that are associated to the given Job. + This method should be overridden by any delegate subclasses that need + special handling for BLOBs for job details. - - If there are no matches, a zero-length array should be returned. - + The result set, already queued to the correct row. + The column index for the BLOB. + The deserialized Object from the ResultSet BLOB. - + - Pause the with the given name. + Selects the paused trigger groups. + The DB Connection. + - + - Pause the with the given name. + Gets the select next trigger to acquire SQL clause. + FireBird version with ROWS support. + - + - Pause the with the given name - by - pausing all of its current s. + Conveys the state of a fired-trigger record. - + James House + Marko Lahma (.NET) - + - Pause all of the s in the given - group - by pausing all of their s. + Gets or sets the fire instance id. - + The fire instance id. - + - Determines if a Trigger for the given job should be blocked. - State can only transition to StatePausedBlocked/StateBlocked from - StatePaused/StateWaiting respectively. + Gets or sets the fire timestamp. - StatePausedBlocked, StateBlocked, or the currentState. + The fire timestamp. - + - Resume (un-pause) the with the - given name. + Gets or sets the scheduled fire timestamp. - - If the missed one or more fire-times, then the - 's misfire instruction will be applied. - - + - Resume (un-pause) the with the - given name. + Gets or sets a value indicating whether job disallows concurrent execution. - - If any of the 's s missed one - or more fire-times, then the 's misfire - instruction will be applied. - - - + - Resume (un-pause) all of the s in - the given group. + Gets or sets the job key. - - If any of the s had s that - missed one or more fire-times, then the 's - misfire instruction will be applied. - - + The job key. - + - Pause all of the s in the given group. + Gets or sets the scheduler instance id. - + The scheduler instance id. - + - Pause all of the s in the given group. + Gets or sets the trigger key. + The trigger key. - - - Pause all of the s in the - given group. + + + Gets or sets the state of the fire instance. + The state of the fire instance. - + - Resume (un-pause) all of the s - in the given group. - - If any missed one or more fire-times, then the - 's misfire instruction will be applied. - + Gets or sets a value indicating whether [job requests recovery]. + true if [job requests recovery]; otherwise, false. - + - Pause all triggers - equivalent of calling - on every group. - - When is called (to un-pause), trigger misfire - instructions WILL be applied. - + Gets or sets the priority. - - + The priority. - + - Resume (un-pause) all triggers - equivalent of calling - on every group. + Exception class for when a driver delegate cannot be found for a given + configuration, or lack thereof. + + Jeffrey Wescott + Marko Lahma (.NET) + + + + Base class for exceptions thrown by the Quartz . - If any missed one or more fire-times, then the - 's misfire instruction will be applied. + SchedulerExceptions may contain a reference to another + , which was the underlying cause of the SchedulerException. - + James House + Marko Lahma (.NET) - + - Resume (un-pause) all triggers - equivalent of calling - on every group. - - If any missed one or more fire-times, then the - 's misfire instruction will be applied. - + Initializes a new instance of the class. - - + - Get a handle to the next N triggers to be fired, and mark them as 'reserved' - by the calling scheduler. + Initializes a new instance of the class. - + The MSG. - + - Inform the that the scheduler no longer plans to - fire the given , that it had previously acquired - (reserved). + Initializes a new instance of the class. + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The class name is null or is zero (0). + The info parameter is null. - + - Inform the that the scheduler has completed the - firing of the given (and the execution its - associated ), and that the - in the given should be updated if the - is stateful. + Initializes a new instance of the class. + The cause. - + - Get a list of all scheduler instances in the cluster that may have failed. - This includes this scheduler if it is checking in for the first time. + Initializes a new instance of the class. + The MSG. + The cause. - + - Create dummy objects for fired triggers - that have no scheduler state record. Checkin timestamp and interval are - left as zero on these dummy objects. + Creates and returns a string representation of the current exception. - - List of all current s + + A string representation of the current exception. + + - + - Cleanup the given database connection. This means restoring - any modified auto commit or transaction isolation connection - attributes, and then closing the underlying connection. - - - - This is separate from closeConnection() because the Spring - integration relies on being able to overload closeConnection() and - expects the same connection back that it originally returned - from the datasource. - - - - - - Closes the supplied connection. + Initializes a new instance of the class. - (Optional) + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The class name is null or is zero (0). + The info parameter is null. - + - Rollback the supplied connection. - - (Optional) - - JobPersistenceException thrown if a SQLException occurs when the - connection is rolled back - + is meant to be used in an application-server + or other software framework environment that provides + container-managed-transactions. No commit / rollback will be handled by this class. + + + If you need commit / rollback, use + instead. + + Jeffrey Wescott + James House + Srinivas Venkatarangaiah + Marko Lahma (.NET) - + - Commit the supplied connection. + Contains base functionality for ADO.NET-based JobStore implementations. - The CTH. - if set to true opens a new transaction. - JobPersistenceException thrown if a SQLException occurs when the + Jeffrey Wescott + James House + Marko Lahma (.NET) - - - Execute the given callback in a transaction. Depending on the JobStore, - the surrounding transaction may be assumed to be already present - (managed). + + + The interface to be implemented by classes that want to provide a + and storage mechanism for the + 's use. - This method just forwards to ExecuteInLock() with a null lockName. + Storage of s and s should be keyed + on the combination of their name and group for uniqueness. + + + + + + + James House + Marko Lahma (.NET) - - - Execute the given callback having acquired the given lock. - Depending on the JobStore, the surrounding transaction may be - assumed to be already present (managed). - - - The name of the lock to acquire, for example - "TRIGGER_ACCESS". If null, then no lock is acquired, but the - lockCallback is still executed in a transaction. - - - The callback to excute after having acquired the given lock. - - - + - Execute the given callback having optionally acquired the given lock. - This uses the non-managed transaction connection. + Called by the QuartzScheduler before the is + used, in order to give the it a chance to Initialize. - - The name of the lock to acquire, for example - "TRIGGER_ACCESS". If null, then no lock is acquired, but the - lockCallback is still executed in a non-managed transaction. - - - The callback to excute after having acquired the given lock. - - - - - Get or set the datasource name. + + + Called by the QuartzScheduler to inform the that + the scheduler has started. - - - Get or set the database connection manager. + + + Called by the QuartzScheduler to inform the JobStore that + the scheduler has been paused. - + - Gets the log. + Called by the QuartzScheduler to inform the JobStore that + the scheduler has resumed after being paused. - The log. - - - Get or sets the prefix that should be pre-pended to all table names. + + + Called by the QuartzScheduler to inform the that + it should free up all of it's resources because the scheduler is + shutting down. - + - Set whether string-only properties will be handled in JobDataMaps. + Store the given and . + The to be stored. + The to be stored. + ObjectAlreadyExistsException - + - Get or set the instance Id of the Scheduler (must be unique within a cluster). + returns true if the given JobGroup is paused + + - + - Get or set the instance Id of the Scheduler (must be unique within this server instance). + returns true if the given TriggerGroup + is paused + + - - - Get or set whether this instance is part of a cluster. + + + Store the given . + The to be stored. + + If , any existing in the + with the same name and group should be + over-written. + - + - Get or set the frequency at which this instance "checks-in" - with the other instances of the cluster. -- Affects the rate of - detecting failed instances. + Remove (delete) the with the given + key, and any s that reference + it. + + If removal of the results in an empty group, the + group should be removed from the 's list of + known group names. + + + if a with the given name and + group was found and removed from the store. + - + - Get or set the maximum number of misfired triggers that the misfire handling - thread will try to recover at one time (within one transaction). The - default is 20. + Retrieve the for the given + . + + The desired , or null if there is no match. + - + - Gets or sets the database retry interval. + Store the given . - The db retry interval. + The to be stored. + If , any existing in + the with the same name and group should + be over-written. + ObjectAlreadyExistsException - + - Get or set whether this instance should use database-based thread - synchronization. - - - - - Whether or not to obtain locks when inserting new jobs/triggers. + Remove (delete) the with the given key. - Defaults to , which is safest - some db's (such as - MS SQLServer) seem to require this to avoid deadlocks under high load, - while others seem to do fine without. Settings this to false means - isolation guarantees between job scheduling and trigger acquisition are - entirely enforced by the database. Depending on the database and it's - configuration this may cause unusual scheduling behaviors. + If removal of the results in an empty group, the + group should be removed from the 's list of + known group names. - Setting this property to will provide a - significant performance increase during the addition of new jobs - and triggers. + If removal of the results in an 'orphaned' + that is not 'durable', then the should be deleted + also. + + if a with the given + name and group was found and removed from the store. + - - - The time span by which a trigger must have missed its - next-fire-time, in order for it to be considered "misfired" and thus - have its misfire instruction applied. + + + Remove (delete) the with the + given name, and store the new given one - which must be associated + with the same job. + The to be replaced. + The new to be stored. + + if a with the given + name and group was found and removed from the store. + - - - Don't call set autocommit(false) on connections obtained from the - DataSource. This can be helpfull in a few situations, such as if you - have a driver that complains if it is called when it is already off. + + + Retrieve the given . + + The desired , or null if there is no + match. + - - - Set the transaction isolation level of DB connections to sequential. + + + Determine whether a with the given identifier already + exists within the scheduler. + + + the identifier to check for + true if a calendar exists with the given identifier - + - Whether or not the query and update to acquire a Trigger for firing - should be performed after obtaining an explicit DB lock (to avoid - possible race conditions on the trigger's db row). This is - is considered unnecessary for most databases (due to the nature of - the SQL update that is performed), and therefore a superfluous performance hit. + Determine whether a with the given identifier already + exists within the scheduler. - However, if batch acquisition is used, it is important for this behavior - to be used for all dbs. + the identifier to check for + true if a job exists with the given identifier - - - Get or set the ADO.NET driver delegate class name. + + + Determine whether a with the given identifier already + exists within the scheduler. + + + the identifier to check for + true if a trigger exists with the given identifier - + - The driver delegate's initialization string. + Clear (delete!) all scheduling data - all s, s + s. + + - + - set the SQL statement to use to select and lock a row in the "locks" - table. + Store the given . - + The name. + The to be stored. + If , any existing + in the with the same name and group + should be over-written. + If , any s existing + in the that reference an existing + Calendar with the same name with have their next fire time + re-computed with the new . + ObjectAlreadyExistsException - + - Get whether the threads spawned by this JobStore should be - marked as daemon. Possible threads include the - and the . + Remove (delete) the with the + given name. - + + If removal of the would result in + s pointing to non-existent calendars, then a + will be thrown. + + The name of the to be removed. + + if a with the given name + was found and removed from the store. + - + - Get whether to check to see if there are Triggers that have misfired - before actually acquiring the lock to recover them. This should be - set to false if the majority of the time, there are are misfired - Triggers. + Retrieve the given . - + The name of the to be retrieved. + + The desired , or null if there is no + match. + - + - Get the driver delegate for DB operations. + Get the number of s that are + stored in the . + - + - Get whether String-only properties will be handled in JobDataMaps. + Get the number of s that are + stored in the . + - + - Indicates whether this job store supports persistence. + Get the number of s that are + stored in the . - - - - An interface for classes wishing to provide the service of loading classes - and resources within the scheduler... + + + Get the names of all of the s that + have the given group name. + + If there are no jobs in the given group name, the result should be a + zero-length array (not ). + - James House - Marko Lahma (.NET) + + - - - Called to give the ClassLoadHelper a chance to Initialize itself, - including the oportunity to "steal" the class loader off of the calling - thread, which is the thread that is initializing Quartz. + + + Get the names of all of the s + that have the given group name. + + If there are no triggers in the given group name, the result should be a + zero-length array (not ). + - - - Return the class with the given name. + + + Get the names of all of the + groups. + + If there are no known group names, the result should be a zero-length + array (not ). + - - - Finds a resource with a given name. This method returns null if no - resource with this name is found. + + + Get the names of all of the + groups. + + If there are no known group names, the result should be a zero-length + array (not ). + - name of the desired resource - - a java.net.URL object - - - - Finds a resource with a given name. This method returns null if no - resource with this name is found. + + + Get the names of all of the s + in the . + + + If there are no Calendars in the given group name, the result should be + a zero-length array (not ). + - name of the desired resource - - a java.io.InputStream object - - + - Helper class for returning the composite result of trying - to recover misfired jobs. + Get all of the Triggers that are associated to the given Job. + + If there are no matches, a zero-length array should be returned. + - + - Initializes a new instance of the class. + Get the current state of the identified . - if set to true [has more misfired triggers]. - The processed misfired trigger count. - + - + - Gets a value indicating whether this instance has more misfired triggers. + Pause the with the given key. - - true if this instance has more misfired triggers; otherwise, false. - - + - Gets the processed misfired trigger count. + Pause all of the s in the + given group. - The processed misfired trigger count. + + The JobStore should "remember" that the group is paused, and impose the + pause on any new triggers that are added to the group while the group is + paused. + - + - Called by the QuartzScheduler before the is - used, in order to give the it a chance to Initialize. + Pause the with the given key - by + pausing all of its current s. - - - + - Called by the QuartzScheduler to inform the that - it should free up all of it's resources because the scheduler is - shutting down. + Pause all of the s in the given + group - by pausing all of their s. + + The JobStore should "remember" that the group is paused, and impose the + pause on any new jobs that are added to the group while the group is + paused. + + + - + - Gets the non managed TX connection. + Resume (un-pause) the with the + given key. + + + If the missed one or more fire-times, then the + 's misfire instruction will be applied. + - + + - + - Execute the given callback having optionally acquired the given lock. - Because CMT assumes that the connection is already part of a managed - transaction, it does not attempt to commit or rollback the - enclosing transaction. + Resume (un-pause) all of the s + in the given group. + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + - - - - - - The name of the lock to acquire, for example - "TRIGGER_ACCESS". If null, then no lock is acquired, but the - txCallback is still executed in a transaction. - - Callback to execute. - + - Instructs this job store whether connections should be automatically opened. + Gets the paused trigger groups. + - + + + Resume (un-pause) the with the + given key. + + If any of the 's s missed one + or more fire-times, then the 's misfire + instruction will be applied. + + + + - is meant to be used in a standalone environment. - Both commit and rollback will be handled by this class. + Resume (un-pause) all of the s in + the given group. + + If any of the s had s that + missed one or more fire-times, then the 's + misfire instruction will be applied. + - Jeffrey Wescott - James House - Marko Lahma (.NET) - + - Called by the QuartzScheduler before the is - used, in order to give the it a chance to Initialize. + Pause all triggers - equivalent of calling + on every group. + + When is called (to un-pause), trigger misfire + instructions WILL be applied. + - - + - + - For , the non-managed TX connection is just - the normal connection because it is not CMT. - - + Resume (un-pause) all triggers - equivalent of calling + on every group. + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + + + + - + - Execute the given callback having optionally aquired the given lock. - For , because it manages its own transactions - and only has the one datasource, this is the same behavior as - . + Get a handle to the next trigger to be fired, and mark it as 'reserved' + by the calling scheduler. - - The name of the lock to aquire, for example "TRIGGER_ACCESS". - If null, then no lock is aquired, but the lockCallback is still - executed in a transaction. - - Callback to execute. + If > 0, the JobStore should only return a Trigger + that will fire no later than the time represented in this value as + milliseconds. + + - - - - + + - - - Exception class for when there is a failure obtaining or releasing a - resource lock. + + + Inform the that the scheduler no longer plans to + fire the given , that it had previously acquired + (reserved). - - James House - Marko Lahma (.NET) - + - An exception that is thrown to indicate that there has been a failure in the - scheduler's underlying persistence mechanism. + Inform the that the scheduler is now firing the + given (executing its associated ), + that it had previously acquired (reserved). - James House - Marko Lahma (.NET) + + May return null if all the triggers or their calendars no longer exist, or + if the trigger was not successfully put into the 'executing' + state. Preference is to return an empty list if none of the triggers + could be fired. + - - - Create a with the given message. - + + + Inform the that the scheduler has completed the + firing of the given (and the execution its + associated ), and that the + in the given should be updated if the + is stateful. - + - Initializes a new instance of the class. + Indicates whether job store supports persistence. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The class name is null or is zero (0). - The info parameter is null. + - - - Create a with the given message - and cause. - + + + How long (in milliseconds) the implementation + estimates that it will take to release a trigger and acquire a new one. - + - Initializes a new instance of the class. + Whether or not the implementation is clustered. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The class name is null or is zero (0). - The info parameter is null. + - + - This is a driver delegate for the MySQL ADO.NET driver. + Inform the of the Scheduler instance's Id, + prior to initialize being invoked. - Marko Lahma - + - This is meant to be an abstract base class for most, if not all, - implementations. Subclasses should override only those methods that need - special handling for the DBMS driver in question. + Inform the of the Scheduler instance's name, + prior to initialize being invoked. - Jeffrey Wescott - James House - Marko Lahma (.NET) - + - Initializes the driver delegate. + Tells the JobStore the pool size used to execute jobs. - + - Insert the job detail record. + Initializes a new instance of the class. - the DB Connection - the new state for the triggers - the first old state to update - the second old state to update - number of rows updated - + - Get the names of all of the triggers that have misfired. + Gets the connection and starts a new transaction. - the DB Connection - The ts. - an array of objects + - - - Select all of the triggers in a given state. + + + Called by the QuartzScheduler before the is + used, in order to give it a chance to Initialize. - The DB Connection - The state the triggers must be in - an array of trigger s - - - Get the names of all of the triggers in the given state that have - misfired - according to the given timestamp. - - The DB Connection - The state. - The time stamp. - An array of objects - - - - Get the names of all of the triggers in the given state that have - misfired - according to the given timestamp. No more than count will - be returned. - - The conn. - The state1. - The ts. - The most misfired triggers to return, negative for all - - Output parameter. A List of objects. Must not be null - - Whether there are more misfired triggers left to find beyond the given count. - - - - Get the number of triggers in the given state that have - misfired - according to the given timestamp. - - - - - - - - - Get the names of all of the triggers in the given group and state that - have misfired. - - The DB Connection - Name of the group. - The state. - The timestamp. - an array of objects + + - + - Select all of the triggers for jobs that are requesting recovery. The - returned trigger objects will have unique "recoverXXX" trigger names and - will be in the - trigger group. + Called by the QuartzScheduler to inform the JobStore that + the scheduler has been paused. - - In order to preserve the ordering of the triggers, the fire time will be - set from the ColumnFiredTime column in the TableFiredTriggers - table. The caller is responsible for calling - on each returned trigger. It is also up to the caller to insert the - returned triggers to ensure that they are fired. - - The DB Connection - an array of objects - + - Delete all fired triggers. + Called by the QuartzScheduler to inform the JobStore that + the scheduler has resumed after being paused. - The DB Connection. - The number of rows deleted. - + - Delete all fired triggers of the given instance. + Called by the QuartzScheduler to inform the that + it should free up all of it's resources because the scheduler is + shutting down. - The DB Connection - The instance id. - The number of rows deleted - + - Clear (delete!) all scheduling data - all s, s - s. + Will recover any failed or misfired jobs and clean up the data store as + appropriate. - - - + - Insert the job detail record. + Will recover any failed or misfired jobs and clean up the data store as + appropriate. - The DB Connection. - The job to insert. - Number of rows inserted. - + - Gets the db presentation for boolean value. Subclasses can overwrite this behaviour. + Store the given and . - Value to map to database. - + Job to be stored. + Trigger to be stored. - + - Gets the boolean value from db presentation. Subclasses can overwrite this behaviour. + returns true if the given JobGroup + is paused - Value to map from database. + - + - Gets the db presentation for date/time value. Subclasses can overwrite this behaviour. + returns true if the given TriggerGroup + is paused - Value to map to database. + - + - Gets the date/time value from db presentation. Subclasses can overwrite this behaviour. + Stores the given . - Value to map from database. - + The to be stored. + + If , any existing in the + with the same name & group should be over-written. + - - - Gets the db presentation for time span value. Subclasses can overwrite this behaviour. + + + Insert or update a job. + - Value to map to database. - - + - Gets the time span value from db presentation. Subclasses can overwrite this behaviour. + Check existence of a given job. - Value to map from database. - - + - Update the job detail record. + Store the given . - The DB Connection. - The job to update. - Number of rows updated. + The to be stored. + + If , any existing in + the with the same name & group should + be over-written. + + + if a with the same name/group already + exists, and replaceExisting is set to false. + - + - Get the names of all of the triggers associated with the given job. + Insert or update a trigger. - The DB Connection. - The key identifying the job. - An array of objects - + - Delete the job detail record for the given job. + Check existence of a given trigger. - the DB Connection - The key identifying the job. - the number of rows deleted - + - Check whether or not the given job is stateful. + Remove (delete) the with the given + name, and any s that reference + it. - the DB Connection - The key identifying the job. + + + If removal of the results in an empty group, the + group should be removed from the 's list of + known group names. + - true if the job exists and is stateful, false otherwise + if a with the given name & + group was found and removed from the store. - + - Check whether or not the given job exists. + Delete a job and its listeners. - the DB Connection - The key identifying the job. - true if the job exists, false otherwise + + - + - Update the job data map for the given job. + Delete a trigger, its listeners, and its Simple/Cron/BLOB sub-table entry. - The conn. - the job to update - the number of rows updated + + + - + - Select the JobDetail object for a given job name / group name. + Retrieve the for the given + . - The DB Connection. The key identifying the job. - The load helper. - The populated JobDetail object. + The desired , or null if there is no match. - - build Map from java.util.Properties encoding. + + + Remove (delete) the with the + given name. + + + + + If removal of the results in an empty group, the + group should be removed from the 's list of + known group names. + + + + If removal of the results in an 'orphaned' + that is not 'durable', then the should be deleted + also. + + + The key identifying the trigger. + + if a with the given + name & group was found and removed from the store. + - + + + + - Select the total number of jobs stored. + Retrieve the given . - The DB Connection. - The total number of jobs stored. + The key identifying the trigger. + The desired , or null if there is no match. - + - Select all of the job group names that are stored. + Get the current state of the identified . - The DB Connection. - An array of group names. + + + + + - + - Select all of the jobs contained in a given group. + Gets the state of the trigger. - The DB Connection. - - An array of job names. + The conn. + The key identifying the trigger. + - + - Insert the base trigger data. + Store the given . - the DB Connection - the trigger to insert - the state that the trigger should be stored in - The job detail. - the number of rows inserted + The name of the calendar. + The to be stored. + + If , any existing + in the with the same name & group + should be over-written. + + + + if a with the same name already + exists, and replaceExisting is set to false. + - + + + Remove (delete) the with the given name. + + + If removal of the would result in + s pointing to non-existent calendars, then a + will be thrown. + + The name of the to be removed. + + if a with the given name + was found and removed from the store. + + + - Insert the blob trigger data. + Retrieve the given . - The DB Connection. - The trigger to insert. - The number of rows inserted. + The name of the to be retrieved. + The desired , or null if there is no match. - + - Update the base trigger data. + Get the number of s that are + stored in the . - The DB Connection. - The trigger to insert. - The state that the trigger should be stored in. - The job detail. - The number of rows updated. - + - Update the blob trigger data. + Get the number of s that are + stored in the . - The DB Connection. - The trigger to insert. - The number of rows updated. - + - Check whether or not a trigger exists. + Get the number of s that are + stored in the . - The DB Connection. - the key of the trigger - true if the trigger exists, false otherwise - + - Update the state for a given trigger. + Get the names of all of the s that + have the given group name. - The DB Connection. - the key of the trigger - The new state for the trigger. - The number of rows updated. + + If there are no jobs in the given group name, the result should be a + zero-length array (not ). + - + - Update the given trigger to the given new state, if it is one of the - given old states. + Determine whether a with the given identifier already + exists within the scheduler. - The DB connection. - the key of the trigger - The new state for the trigger. - One of the old state the trigger must be in. - One of the old state the trigger must be in. - One of the old state the trigger must be in. - The number of rows updated. + + + the identifier to check for + true if a calendar exists with the given identifier - + - Update all triggers in the given group to the given new state, if they - are in one of the given old states. + Determine whether a with the given identifier already + exists within the scheduler. - The DB connection. - - The new state for the trigger. - One of the old state the trigger must be in. - One of the old state the trigger must be in. - One of the old state the trigger must be in. - The number of rows updated. + + + the identifier to check for + true if a Job exists with the given identifier - + - Update the given trigger to the given new state, if it is in the given - old state. + Determine whether a with the given identifier already + exists within the scheduler. - the DB connection - the key of the trigger - the new state for the trigger - the old state the trigger must be in - int the number of rows updated + + + the identifier to check for + true if a Trigger exists with the given identifier - + - Update all of the triggers of the given group to the given new state, if - they are in the given old state. + Clear (delete!) all scheduling data - all s, s + s. - the DB connection - - the new state for the trigger group - the old state the triggers must be in - int the number of rows updated + + - + - Update the states of all triggers associated with the given job. + Get the names of all of the s + that have the given group name. - the DB Connection - the key of the job - the new state for the triggers - the number of rows updated + + If there are no triggers in the given group name, the result should be a + zero-length array (not ). + - + - Updates the state of the trigger states for job from other. + Get the names of all of the + groups. - The conn. - Key of the job. - The state. - The old state. - + + + If there are no known group names, the result should be a zero-length + array (not ). + - + - Delete the cron trigger data for a trigger. + Get the names of all of the + groups. - the DB Connection - the key of the trigger - the number of rows deleted + + + If there are no known group names, the result should be a zero-length + array (not ). + - + - Delete the base trigger data for a trigger. + Get the names of all of the s + in the . - the DB Connection - the key of the trigger - the number of rows deleted + + If there are no Calendars in the given group name, the result should be + a zero-length array (not ). + - + - Select the number of triggers associated with a given job. + Get all of the Triggers that are associated to the given Job. - the DB Connection - the key of the job - the number of triggers for the given job + + If there are no matches, a zero-length array should be returned. + - + - Select the triggers for a job + Pause the with the given name. - the DB Connection - the key of the job - - an array of objects - associated with a given job. - - + - Select the triggers for a calendar + Pause the with the given name. - The DB Connection. - Name of the calendar. - - An array of objects associated with a given job. - - + - Select a trigger. + Pause the with the given name - by + pausing all of its current s. - the DB Connection - the key of the trigger - The object + - + - Select a trigger's JobDataMap. - - the DB Connection - the key of the trigger - The of the Trigger, never null, but possibly empty. - - - - Select a trigger's state value. + Pause all of the s in the given + group - by pausing all of their s. - the DB Connection - the key of the trigger - The object + - + - Select a trigger status (state and next fire time). + Determines if a Trigger for the given job should be blocked. + State can only transition to StatePausedBlocked/StateBlocked from + StatePaused/StateWaiting respectively. - the DB Connection - the key of the trigger - - a object, or null - + StatePausedBlocked, StateBlocked, or the currentState. - + - Select the total number of triggers stored. + Resume (un-pause) the with the + given name. - the DB Connection - the total number of triggers stored + + If the missed one or more fire-times, then the + 's misfire instruction will be applied. + - + - Select all of the trigger group names that are stored. + Resume (un-pause) the with the + given name. - the DB Connection - - an array of group names - + + If any of the 's s missed one + or more fire-times, then the 's misfire + instruction will be applied. + + - + - Select all of the triggers contained in a given group. + Resume (un-pause) all of the s in + the given group. - the DB Connection - - - an array of trigger names - + + If any of the s had s that + missed one or more fire-times, then the 's + misfire instruction will be applied. + + - + - Inserts the paused trigger group. + Pause all of the s in the given group. - The conn. - Name of the group. - + - + - Deletes the paused trigger group. + Pause all of the s in the given group. - The conn. - Name of the group. - - - - Deletes all paused trigger groups. + + + Pause all of the s in the + given group. - The conn. - - + - Determines whether the specified trigger group is paused. + Resume (un-pause) all of the s + in the given group. + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + - The conn. - Name of the group. - - true if trigger group is paused; otherwise, false. - - + - Determines whether given trigger group already exists. + Pause all triggers - equivalent of calling + on every group. + + When is called (to un-pause), trigger misfire + instructions WILL be applied. + - The conn. - Name of the group. - - true if trigger group exists; otherwise, false. - + + - + - Insert a new calendar. + Resume (un-pause) all triggers - equivalent of calling + on every group. - the DB Connection - The name for the new calendar. - The calendar. - the number of rows inserted - IOException + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + + - + - Update a calendar. + Resume (un-pause) all triggers - equivalent of calling + on every group. + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + - the DB Connection - The name for the new calendar. - The calendar. - the number of rows updated - IOException + - + - Check whether or not a calendar exists. + Get a handle to the next N triggers to be fired, and mark them as 'reserved' + by the calling scheduler. - the DB Connection - The name of the calendar. - - true if the trigger exists, false otherwise - + - + - Select a calendar. + Inform the that the scheduler no longer plans to + fire the given , that it had previously acquired + (reserved). - the DB Connection - The name of the calendar. - the Calendar - ClassNotFoundException - IOException - + - Check whether or not a calendar is referenced by any triggers. + Inform the that the scheduler has completed the + firing of the given (and the execution its + associated ), and that the + in the given should be updated if the + is stateful. - the DB Connection - The name of the calendar. - - true if any triggers reference the calendar, false otherwise - - + - Delete a calendar. + Get a list of all scheduler instances in the cluster that may have failed. + This includes this scheduler if it is checking in for the first time. - the DB Connection - The name of the trigger. - the number of rows deleted - + - Select the total number of calendars stored. + Create dummy objects for fired triggers + that have no scheduler state record. Checkin timestamp and interval are + left as zero on these dummy objects. - the DB Connection - the total number of calendars stored + + List of all current s - + - Select all of the stored calendars. + Cleanup the given database connection. This means restoring + any modified auto commit or transaction isolation connection + attributes, and then closing the underlying connection. - the DB Connection - - an array of calendar names - + + + This is separate from closeConnection() because the Spring + integration relies on being able to overload closeConnection() and + expects the same connection back that it originally returned + from the datasource. + + - - - Select the trigger that will be fired at the given fire time. + + + Closes the supplied connection. - the DB Connection - the time that the trigger will be fired - - a representing the - trigger that will be fired at the given fire time, or null if no - trigger will be fired at that time - + (Optional) - + - Select the next trigger which will fire to fire between the two given timestamps - in ascending order of fire time, and then descending by priority. + Rollback the supplied connection. + + (Optional) + + JobPersistenceException thrown if a SQLException occurs when the + connection is rolled back - The conn. - highest value of of the triggers (exclusive) - highest value of of the triggers (inclusive) - maximum number of trigger keys allow to acquired in the returning list. - A (never null, possibly empty) list of the identifiers (Key objects) of the next triggers to be fired. - + - Insert a fired trigger. + Commit the supplied connection. - the DB Connection - the trigger - the state that the trigger should be stored in - The job. - the number of rows inserted + The CTH. + if set to true opens a new transaction. + JobPersistenceException thrown if a SQLException occurs when the - + + + Execute the given callback in a transaction. Depending on the JobStore, + the surrounding transaction may be assumed to be already present + (managed). + + + This method just forwards to ExecuteInLock() with a null lockName. + + + + Execute the given callback having acquired the given lock. + Depending on the JobStore, the surrounding transaction may be + assumed to be already present (managed). + + + The name of the lock to acquire, for example + "TRIGGER_ACCESS". If null, then no lock is acquired, but the + lockCallback is still executed in a transaction. + + + The callback to execute after having acquired the given lock. + + + + + Execute the given callback having optionally acquired the given lock. + This uses the non-managed transaction connection. + + + The name of the lock to acquire, for example + "TRIGGER_ACCESS". If null, then no lock is acquired, but the + lockCallback is still executed in a non-managed transaction. + + + The callback to execute after having acquired the given lock. + + + + + + Get or set the datasource name. + + + + + Get or set the database connection manager. + + + + + Gets the log. + + The log. + + + + Get or sets the prefix that should be pre-pended to all table names. + + + + + Set whether string-only properties will be handled in JobDataMaps. + + + + + Get or set the instance Id of the Scheduler (must be unique within a cluster). + + + + + Get or set the instance Id of the Scheduler (must be unique within this server instance). + + + + + Gets or sets the number of retries before an error is logged for recovery operations. + + + + + Get or set whether this instance is part of a cluster. + + + + + Get or set the frequency at which this instance "checks-in" + with the other instances of the cluster. -- Affects the rate of + detecting failed instances. + + + + + Get or set the maximum number of misfired triggers that the misfire handling + thread will try to recover at one time (within one transaction). The + default is 20. + + + + + Gets or sets the database retry interval. + + The db retry interval. + + + + Get or set whether this instance should use database-based thread + synchronization. + + + + + Whether or not to obtain locks when inserting new jobs/triggers. + + - Update a fired trigger. + Defaults to , which is safest - some db's (such as + MS SQLServer) seem to require this to avoid deadlocks under high load, + while others seem to do fine without. Settings this to false means + isolation guarantees between job scheduling and trigger acquisition are + entirely enforced by the database. Depending on the database and it's + configuration this may cause unusual scheduling behaviors. + + + Setting this property to will provide a + significant performance increase during the addition of new jobs + and triggers. + + + + + The time span by which a trigger must have missed its + next-fire-time, in order for it to be considered "misfired" and thus + have its misfire instruction applied. + + + + + Don't call set autocommit(false) on connections obtained from the + DataSource. This can be helpful in a few situations, such as if you + have a driver that complains if it is called when it is already off. + + + + + Set the transaction isolation level of DB connections to sequential. + + + + + Whether or not the query and update to acquire a Trigger for firing + should be performed after obtaining an explicit DB lock (to avoid + possible race conditions on the trigger's db row). This is + is considered unnecessary for most databases (due to the nature of + the SQL update that is performed), and therefore a superfluous performance hit. + However, if batch acquisition is used, it is important for this behavior + to be used for all dbs. - - the DB Connection - - the trigger - - - the state that the trigger should be stored in - the number of rows inserted - + + + Get or set the ADO.NET driver delegate class name. + + + - Select the states of all fired-trigger records for a given trigger, or - trigger group if trigger name is . + The driver delegate's initialization string. - The DB connection. - Name of the trigger. - Name of the group. - a List of objects. - + - Select the states of all fired-trigger records for a given job, or job - group if job name is . + set the SQL statement to use to select and lock a row in the "locks" + table. - The DB connection. - Name of the job. - Name of the group. - a List of objects. + + + + + Get whether the threads spawned by this JobStore should be + marked as daemon. Possible threads include the + and the . + + + + + + Get whether to check to see if there are Triggers that have misfired + before actually acquiring the lock to recover them. This should be + set to false if the majority of the time, there are are misfired + Triggers. + + + + + + Get the driver delegate for DB operations. + + + + + Get whether String-only properties will be handled in JobDataMaps. + + + + + Indicates whether this job store supports persistence. + + + + + + + An interface for classes wishing to provide the service of loading classes + and resources within the scheduler... + + James House + Marko Lahma (.NET) + + + + Called to give the ClassLoadHelper a chance to Initialize itself, + including the opportunity to "steal" the class loader off of the calling + thread, which is the thread that is initializing Quartz. + + + + + Return the class with the given name. + + + + + Finds a resource with a given name. This method returns null if no + resource with this name is found. + + name of the desired resource + + a java.net.URL object + + + + + Finds a resource with a given name. This method returns null if no + resource with this name is found. + + name of the desired resource + + a java.io.InputStream object + - + - Select the states of all fired-trigger records for a given scheduler - instance. + Helper class for returning the composite result of trying + to recover misfired jobs. - The DB Connection - Name of the instance. - A list of FiredTriggerRecord objects. - + - Select the distinct instance names of all fired-trigger records. + Initializes a new instance of the class. - The conn. - - - This is useful when trying to identify orphaned fired triggers (a - fired trigger without a scheduler state record.) - + if set to true [has more misfired triggers]. + The processed misfired trigger count. + - + - Delete a fired trigger. + Gets a value indicating whether this instance has more misfired triggers. - the DB Connection - the fired trigger entry to delete - the number of rows deleted + + true if this instance has more misfired triggers; otherwise, false. + - + - Selects the job execution count. + Gets the processed misfired trigger count. - The DB connection. - The key of the job. - + The processed misfired trigger count. - + - Inserts the state of the scheduler. + Called by the QuartzScheduler before the is + used, in order to give the it a chance to Initialize. - The conn. - The instance id. - The check in time. - The interval. - + + - + - Deletes the state of the scheduler. + Called by the QuartzScheduler to inform the that + it should free up all of it's resources because the scheduler is + shutting down. - The database connection. - The instance id. - - + - Updates the state of the scheduler. + Gets the non managed TX connection. - The database connection. - The instance id. - The check in time. - + - A List of all current s. - - If instanceId is not null, then only the record for the identified - instance will be returned. - + Execute the given callback having optionally acquired the given lock. + Because CMT assumes that the connection is already part of a managed + transaction, it does not attempt to commit or rollback the + enclosing transaction. - The DB Connection - The instance id. - + + + + + + The name of the lock to acquire, for example + "TRIGGER_ACCESS". If null, then no lock is acquired, but the + txCallback is still executed in a transaction. + + Callback to execute. - + - Replace the table prefix in a query by replacing any occurrences of - "{0}" with the table prefix. + Instructs this job store whether connections should be automatically opened. - The unsubstitued query - The query, with proper table prefix substituted - + - Create a serialized version of an Object. + is meant to be used in a standalone environment. + Both commit and rollback will be handled by this class. - the object to serialize - Serialized object as byte array. + Jeffrey Wescott + James House + Marko Lahma (.NET) - + - Remove the transient data from and then create a serialized - version of a and returns the underlying bytes. + Called by the QuartzScheduler before the is + used, in order to give the it a chance to Initialize. - The data. - the serialized data as byte array + + - + - serialize + For , the non-managed TX connection is just + the normal connection because it is not CMT. + + + + + + Execute the given callback having optionally acquired the given lock. + For , because it manages its own transactions + and only has the one datasource, this is the same behavior as + . - The data. + + The name of the lock to acquire, for example "TRIGGER_ACCESS". + If null, then no lock is acquired, but the lockCallback is still + executed in a transaction. + + Callback to execute. + + + + - - - Convert the JobDataMap into a list of properties. + + + Exception class for when there is a failure obtaining or releasing a + resource lock. + + James House + Marko Lahma (.NET) - + - Convert the JobDataMap into a list of properties. + An exception that is thrown to indicate that there has been a failure in the + scheduler's underlying persistence mechanism. + James House + Marko Lahma (.NET) - + + + Create a with the given message. + + + + - This method should be overridden by any delegate subclasses that need - special handling for BLOBs. The default implementation uses standard - ADO.NET operations. + Initializes a new instance of the class. - The data reader, already queued to the correct row. - The column index for the BLOB. - The deserialized object from the DataReader BLOB. + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The class name is null or is zero (0). + The info parameter is null. - + + + Create a with the given message + and cause. + + + + - This method should be overridden by any delegate subclasses that need - special handling for BLOBs for job details. + Initializes a new instance of the class. - The result set, already queued to the correct row. - The column index for the BLOB. - The deserialized Object from the ResultSet BLOB. + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The class name is null or is zero (0). + The info parameter is null. - + - Selects the paused trigger groups. + This is a driver delegate for the MySQL ADO.NET driver. - The DB Connection. - + Marko Lahma @@ -5912,7 +6030,7 @@ - Return true, if day is defined to be exluded. + Return true, if day is defined to be excluded. @@ -6078,7 +6196,7 @@ Create a with a time range defined by the specified strings and no baseCalendar. - and + and must be in the format "HH:MM[:SS[:mmm]]" where:
  • @@ -6106,12 +6224,14 @@
+ The range starting time in millis. + The range ending time in millis. Create a with a time range defined by the specified strings and the specified baseCalendar. - and + and must be in the format "HH:MM[:SS[:mmm]]" where:
  • @@ -6143,6 +6263,8 @@
The base calendar for this calendar instance see BaseCalendar for more information on base calendar functionality. + The range starting time in millis. + The range ending time in millis. @@ -6176,7 +6298,7 @@ Create a with a time range defined by the - specified values and the specified . Values are + specified values and the specified . Values are subject to the following validations:
  • @@ -6193,6 +6315,8 @@
+ The base calendar for this calendar instance see BaseCalendar for more + information on base calendar functionality. The range starting hour of day. The range starting minute. The range starting second. @@ -6231,7 +6355,7 @@ Create a with a time range defined by the specified s and the specified - . The Calendars are subject to the following + . The Calendars are subject to the following considerations:
  • @@ -6248,6 +6372,8 @@
+ The base calendar for this calendar instance see BaseCalendar for more + information on base calendar functionality. The range starting calendar. The range ending calendar. @@ -6276,7 +6402,7 @@ Create a with a time range defined by the - specified values and the specified . The values + specified values and the specified . The values are subject to the following considerations:
  • @@ -6292,6 +6418,8 @@
+ The base calendar for this calendar instance see BaseCalendar for more + information on base calendar functionality. The range starting time in millis. The range ending time in millis. @@ -6323,7 +6451,7 @@ Returns the start time of the time range of the day - specified in . + specified in . a DateTime representing the start time of the @@ -6333,7 +6461,7 @@ Returns the end time of the time range of the day - specified in + specified in A DateTime representing the end time of the @@ -6395,7 +6523,7 @@ - Gets the end of day, pratically sets time parts to maximum allowed values. + Gets the end of day, practically sets time parts to maximum allowed values. The time. @@ -6527,7 +6655,7 @@ - Return true, if mday is defined to be exluded. + Return true, if day is defined to be excluded. @@ -6611,7 +6739,7 @@ - Return true, if wday is defined to be exluded. E. g. + Return true, if wday is defined to be excluded. E. g. saturday and sunday. @@ -6739,6 +6867,11 @@ + + + Create a GroupMatcher that matches all. + + Matches on the complete key being equal (both name and group). @@ -8391,16 +8524,21 @@ Create a with fire time dictated by the - resolved with respect to the specified - occurring from the until - the given . + resolved with respect to the specified + occurring from the until + the given . The name of the The group of the name of the executed on firetime Group of the executed on firetime - A set to the earliest time for the to start firing. + A set to the earliest time for the to start firing. A set to the time for the to quit repeat firing. + A cron expression dictating the firing sequence of the + + Specifies for which time zone the cronExpression should be interpreted, + i.e. the expression 0 0 10 * * ?, is resolved to 10:00 am in this time zone. + @@ -8597,7 +8735,7 @@ Get or sets the time at which the CronTrigger should quit - repeating - even if repeastCount isn't yet satisfied. + repeating - even if repeatCount isn't yet satisfied. @@ -8657,10 +8795,10 @@ and daysOfWeek is default to every day. The startTime default to current time-stamp now, while endTime has not value. - If startTime is before startTimeOfDay, then startTimeOfDay will be used and startTime has no affect. Else if startTime is - after startTimeOfDay, then the first fire time for that day will be the next interval after the startTime. For example, if - you set startingTimeOfDay=9am, endingTimeOfDay=11am, interval=15 mins, and startTime=9:33am, then the next fire time will - be 9:45pm. Note also that if you do not set startTime value, the trigger builder will default to current time, and current time + If startTime is before startTimeOfDay, then startTimeOfDay will be used and startTime has no affect other than to specify + the first day of firing. Else if startTime is after startTimeOfDay, then the first fire time for that day will be the next + interval after the startTime. For example, if you set startingTimeOfDay=9am, endingTimeOfDay=11am, interval=15 mins, and startTime=9:33am, + then the next fire time will be 9:45pm. Note also that if you do not set startTime value, the trigger builder will default to current time, and current time maybe before or after the startTimeOfDay! So be aware how you set your startTime. @@ -8946,9 +9084,10 @@ - + - Given fireTime time, we need to advance/calculate and return a time of next available week day. + Given fireTime time determine if it is on a valid day of week. If so, simply return it unaltered, + if not, advance to the next valid week day, and set the time of day to the start time of day. given next fireTime. flag to whether to advance day without check existing week day. This scenario @@ -9079,7 +9218,7 @@ - Get or set thhe number of times the should + Get or set the number of times the should repeat, after which it will be automatically deleted. @@ -9304,7 +9443,7 @@ - Get or set thhe number of times the should + Get or set the number of times the should repeat, after which it will be automatically deleted. @@ -10123,7 +10262,7 @@ - Create a JobExcecutionContext with the given context data. + Create a JobExecutionContext with the given context data. @@ -10294,7 +10433,7 @@ - Returns the fire instace id. + Returns the fire instance id. @@ -10925,10 +11064,9 @@ - + the unique identifier of the job instance to be interrupted (see - true if the identified job instance was found and interrupted. @@ -11041,7 +11179,7 @@ - Get a object describiing the settings + Get a object describing the settings and capabilities of the scheduler instance. Note that the data returned is an 'instantaneous' snap-shot, and that as @@ -11294,7 +11432,7 @@ JobFactories may be of use to those wishing to have their application produce instances via some special mechanism, such as to - give the opertunity for dependency injection. + give the opportunity for dependency injection. @@ -11399,6 +11537,12 @@ James House Marko Lahma (.NET) + + + Construct a instance to proxy the given + instance. + + returns true if the given JobGroup @@ -11417,7 +11561,7 @@ - Get a object describiing the settings + Get a object describing the settings and capabilities of the scheduler instance. Note that the data returned is an 'instantaneous' snap-shot, and that as @@ -11451,12 +11595,6 @@ Calls the equivalent method on the 'proxied' . - - - Construct a instance to proxy the given - instance. - - Calls the equivalent method on the 'proxied' . @@ -11730,7 +11868,7 @@ By default a properties are loaded from App.config's quartz section. If that fails, then the file is loaded "quartz.properties". If file does not exist, - default configration located (as a embedded resource) in Quartz.dll is loaded. If you + default configuration located (as a embedded resource) in Quartz.dll is loaded. If you wish to use a file other than these defaults, you must define the system property 'quartz.properties' to point to the file you want. @@ -11739,7 +11877,7 @@ information about the various settings available within the file. - Alternativly, you can explicitly Initialize the factory by calling one of + Alternatively, you can explicitly Initialize the factory by calling one of the methods before calling . @@ -12005,7 +12143,7 @@ - Ïnforms that certain file has been updated. + Informs that certain file has been updated. Name of the file. @@ -12062,7 +12200,7 @@ - Optional parameter that specifies the workling directory to be used by + Optional parameter that specifies the working directory to be used by the executed command. @@ -12139,6 +12277,15 @@ The host name of the smtp server. REQUIRED. + + The port of the smtp server. Optional. + + + Username for authenticated session. Password must also be set if username is used. Optional. + + + Password for authenticated session. Optional. + The e-mail address to send the mail to. REQUIRED. @@ -12157,6 +12304,9 @@ The e-mail message body. REQUIRED. + + The message subject and body content type. Optional. + Executes the job. @@ -12270,7 +12420,7 @@ is about to be executed. It is called after the method of this - interface. If the implementation vetos the execution (via + interface. If the implementation vetoes the execution (via returning ), the job's execute method will not be called. @@ -12347,7 +12497,7 @@ If for some reason there is a failure creating the trigger for the follow-up job (which would generally only be caused by a rare serious failure in the system, or the non-existence of the follow-up job), an error - messsage is logged, but no other action is taken. If you need more rigorous + message is logged, but no other action is taken. If you need more rigorous handling of the error, consider scheduling the triggering of the flow-up job within your job itself. @@ -12382,7 +12532,7 @@ Called by the when a is about to be executed (an associated - has occured). + has occurred). This method will not be invoked if the execution of the Job was vetoed by a . @@ -12395,7 +12545,7 @@ Called by the when a was about to be executed (an associated - has occured), but a vetoed it's + has occurred), but a vetoed it's execution. @@ -12470,7 +12620,7 @@ - Logs a history of all job executions (and execution vetos) via common + Logs a history of all job executions (and execution vetoes) via common logging. @@ -12508,7 +12658,7 @@ 4 String - The Triggers's group. + The Trigger's group. 5 @@ -12526,8 +12676,7 @@ The re-fire count from the JobExecutionContext. - The default message text is "Job {1}.{0} fired (by trigger {4}.{3}) at: - {2, date, HH:mm:ss MM/dd/yyyy" + The default message text is "Job {1}.{0} fired (by trigger {4}.{3}) at: {2:HH:mm:ss MM/dd/yyyy}" JobSuccessMessage - available message data are: @@ -12559,7 +12708,7 @@ - + @@ -12584,8 +12733,7 @@ result was set.
4 StringThe Triggers's group.The Trigger's group.
5
- The default message text is "Job {1}.{0} execution complete at {2, date, - HH:mm:ss MM/dd/yyyy} and reports: {8" + The default message text is "Job {1}.{0} execution complete at {2:HH:mm:ss MM/dd/yyyy} and reports: {8}" JobFailedMessage - available message data are: @@ -12617,7 +12765,7 @@ - + @@ -12641,8 +12789,7 @@
4 StringThe Triggers's group.The Trigger's group.
5
- The default message text is "Job {1}.{0} execution failed at {2, date, - HH:mm:ss MM/dd/yyyy} and reports: {8" + The default message text is "Job {1}.{0} execution failed at {2:HH:mm:ss MM/dd/yyyy} and reports: {8}" JobWasVetoedMessage - available message data are: @@ -12674,7 +12821,7 @@ - + @@ -12693,7 +12840,7 @@
4 StringThe Triggers's group.The Trigger's group.
5
The default message text is "Job {1}.{0} was vetoed. It was to be fired - (by trigger {4}.{3}) at: {2, date, HH:mm:ss MM/dd/yyyy" + (by trigger {4}.{3}) at: {2:HH:mm:ss MM/dd/yyyy}" Marko Lahma (.NET) @@ -12801,7 +12948,7 @@ Called by the when a was about to be executed (an associated - has occured), but a vetoed it's + has occurred), but a vetoed it's execution. @@ -13125,7 +13272,7 @@ This plugin catches the event of the VM terminating (such as upon a CRTL-C) - and tells the scheuler to Shutdown. + and tells the scheduler to Shutdown. James House @@ -13384,7 +13531,7 @@ This interface may be of use to those wishing to have their application produce instances via some special mechanism, such as to - give the opertunity for dependency injection. + give the opportunity for dependency injection. @@ -13404,7 +13551,7 @@ Scheduler will move all triggers associated with the Job into the state, which will require human intervention (e.g. an application restart after fixing whatever - configuration problem led to the issue wih instantiating the Job. + configuration problem led to the issue with instantiating the Job. The TriggerFiredBundle from which the @@ -13432,7 +13579,7 @@ Scheduler will move all triggers associated with the Job into the state, which will require human intervention (e.g. an application restart after fixing whatever - configuration problem led to the issue wih instantiating the Job. + configuration problem led to the issue with instantiating the Job. The TriggerFiredBundle from which the and other info relating to the trigger firing can be obtained. @@ -13459,7 +13606,7 @@ Scheduler will move all triggers associated with the Job into the state, which will require human intervention (e.g. an application restart after fixing whatever - configuration problem led to the issue wih instantiating the Job. + configuration problem led to the issue with instantiating the Job. The TriggerFiredBundle from which the @@ -13479,14 +13626,14 @@ Whether the JobInstantiation should fail and throw and exception if a key (name) and value (type) found in the JobDataMap does not - correspond to a proptery setter on the Job class. + correspond to a property setter on the Job class. Get or set whether a warning should be logged if a key (name) and value (type) found in the JobDataMap does not - correspond to a proptery setter on the Job class. + correspond to a property setter on the Job class. @@ -13494,7 +13641,7 @@ This class implements a that utilizes RAM as its storage device. - As you should know, the ramification of this is that access is extrememly + As you should know, the ramification of this is that access is extremely fast, but the data is completely volatile - therefore this should not be used if true persistence between program shutdowns is required. @@ -13623,7 +13770,7 @@ name and group was found and removed from the store. The to be removed. - Whether to delete orpahaned job details from scheduler if job becomes orphaned from removing the trigger. + Whether to delete orphaned job details from scheduler if job becomes orphaned from removing the trigger. @@ -13650,6 +13797,16 @@ The desired , or null if there is no match. + + + Determine whether a with the given identifier already + exists within the scheduler. + + + + the identifier to check for + true if a calendar exists with the given identifier + Determine whether a with the given identifier already @@ -14206,7 +14363,7 @@ method is called a few moments (or many moments) later. If this assumption does not hold true, it may result in extra JobStore queries and updates, and if clustering features - are being used, it may result in greater imballance of load. + are being used, it may result in greater imbalance of load. James House @@ -14403,7 +14560,7 @@ Called to give the ClassLoadHelper a chance to Initialize itself, - including the oportunity to "steal" the class loader off of the calling + including the opportunity to "steal" the class loader off of the calling thread, which is the thread that is initializing Quartz. @@ -15090,7 +15247,7 @@ Wrapper class to access thread local data. Data is either accessed from thread or HTTP Context's - data if HTTP Context is avaiable. + data if HTTP Context is available. Marko Lahma .NET @@ -15384,7 +15541,7 @@ The prefix for which to search. If it does not end in a "." then one will be added to it for search purposes. Whether to strip off the given in the result's keys. - Optional array of fully qualified prefixes to exclude. For example if is "a.b.c", then might be "a.b.c.ignore". + Optional array of fully qualified prefixes to exclude. For example if is "a.b.c", then might be "a.b.c.ignore". Group of that start with the given prefix, optionally have that prefix removed, and do not include properties that start with one of the given excluded prefixes. @@ -15605,6 +15762,21 @@ + + + TimeZoneInfo.GetUtcOffset(DateTimeOffset) is not supported under mono + + + + + + + + Tries to find time zone with given id, has ability do some fallbacks when necessary. + + System id of the time zone. + + @@ -18176,19 +18348,19 @@ - Create a JobExcecutionException, with the 're-fire immediately' flag set + Create a JobExecutionException, with the 're-fire immediately' flag set to . - Create a JobExcecutionException, with the given cause. + Create a JobExecutionException, with the given cause. The cause. - Create a JobExcecutionException, with the given message. + Create a JobExecutionException, with the given message. @@ -18200,19 +18372,19 @@ - Create a JobExcecutionException with the 're-fire immediately' flag set + Create a JobExecutionException with the 're-fire immediately' flag set to the given value. - Create a JobExcecutionException with the given underlying exception, and + Create a JobExecutionException with the given underlying exception, and the 're-fire immediately' flag set to the given value. - Create a JobExcecutionException with the given message, and underlying + Create a JobExecutionException with the given message, and underlying exception, and the 're-fire immediately' flag set to the given value. @@ -18592,14 +18764,14 @@ A constant group name used internally by the scheduler - clients should not use the value of this constant - ("RECOVERING_JOBS") for thename of a 's group. + ("RECOVERING_JOBS") for the name of a 's group. A constant group name used internally by the scheduler - clients should not use the value of this constant - ("FAILED_OVER_JOBS") for thename of a 's group. + ("FAILED_OVER_JOBS") for the name of a 's group. @@ -18645,6 +18817,12 @@ be different from the actual firing time - as a trigger doesn't always fire exactly on time. + + + A special date time to check against when signaling scheduling change when the signaled fire date suggestion is actually irrelevant. + We only want to signal the change. + + Holds context/environment data that can be made available to Jobs as they @@ -19733,7 +19911,7 @@ Compute the that is 1 second after the Nth firing of - the given , taking the triger's associated + the given , taking the trigger's associated into consideration. diff --git a/packages/Quartz.2.3.2/lib/net40/Quartz.pdb b/packages/Quartz.2.3.2/lib/net40/Quartz.pdb new file mode 100644 index 0000000..d42b45c Binary files /dev/null and b/packages/Quartz.2.3.2/lib/net40/Quartz.pdb differ diff --git a/packages/Quartz.2.2/lib/net40/Quartz.xml b/packages/Quartz.2.3.2/lib/net40/Quartz.xml similarity index 96% rename from packages/Quartz.2.2/lib/net40/Quartz.xml rename to packages/Quartz.2.3.2/lib/net40/Quartz.xml index 9ee197f..8ebb68e 100644 --- a/packages/Quartz.2.2/lib/net40/Quartz.xml +++ b/packages/Quartz.2.3.2/lib/net40/Quartz.xml @@ -68,7 +68,7 @@ - Constructor that prepolutates. + Constructor that prepopulates. @@ -673,7 +673,7 @@ - Removes the object from garbae collection protected list. + Removes the object from garbage collection protected list. The obj. @@ -1060,7 +1060,7 @@ Notifies the trigger listeners of completion. - The job executution context. + The job execution context. The instruction code to report to triggers. @@ -1071,7 +1071,7 @@ - Notifies the job listeners that job exucution was vetoed. + Notifies the job listeners that job execution was vetoed. The job execution context. @@ -1228,7 +1228,7 @@ Gets or sets a value indicating whether to signal on scheduling change. - true if schduler should signal on scheduling change; otherwise, false. + true if scheduler should signal on scheduling change; otherwise, false. @@ -1596,7 +1596,7 @@ Signals the main processing loop that a change in scheduling has been - made - in order to interrupt any sleeping that may be occuring while + made - in order to interrupt any sleeping that may be occurring while waiting for the fire time to arrive. @@ -1683,6 +1683,56 @@ Signals the scheduling change. + + + The DbMetadata factory based on application configuration + + + + + Base class for the DbMetadata Factory implementations + + + + + Gets the supported provider names. + + The enumeration of the supported provider names + + + + Gets the database metadata associated to the specified provider name. + + Name of the provider. + The metadata instance for the requested provider + + + + Initializes a new instance of the class. + + Name of the configuration section. + The provider name prefix. + The providerNamePrefix cannot be null or empty. + + + + Gets the properties parser. + + The properties parser + + + + Gets the supported provider names. + + The enumeration of the supported provider names + + + + Gets the database metadata associated to the specified provider name. + + Name of the provider. + The metadata instance for the specified name + Metadata information about specific ADO.NET driver library. Metadata is used to @@ -1822,7 +1872,7 @@ - Returns a new command object for executing SQL statments/Stored Procedures + Returns a new command object for executing SQL statements/Stored Procedures against the database. An new @@ -1878,9 +1928,15 @@ + + + Generates the valid provider names information. + + + - Returns a new command object for executing SQL statments/Stored Procedures + Returns a new command object for executing SQL statements/Stored Procedures against the database. An new @@ -1924,6 +1980,31 @@ The metadata. + + + The DbMetadata factory based on embedded assembly resource + + + + + Initializes a new instance of the class. + + Name of the resource. + Name of the property group (The prefix of the provider name). + + + + Gets the supported provider names. + + The enumeration of the supported provider names + + + + Gets the database metadata associated to the specified provider name. + + Name of the provider. + The metadata instance for the specified name + This interface can be implemented by any @@ -1970,7 +2051,7 @@ Replace the table prefix in a query by replacing any occurrences of "{0}" with the table prefix. - The unsubstitued query + The unsubstituted query The table prefix the scheduler name The query, with proper table prefix substituted @@ -2229,7 +2310,7 @@ - Initialization argumens holder for implementations. + Initialization arguments holder for implementations. @@ -2281,143 +2362,20 @@ settingName=settingValue|otherSettingName=otherSettingValue|... - - - Conveys the state of a fired-trigger record. - - James House - Marko Lahma (.NET) - - - - Gets or sets the fire instance id. - - The fire instance id. - - - - Gets or sets the fire timestamp. - - The fire timestamp. - - - - Gets or sets the scheduled fire timestamp. - - - - - Gets or sets a value indicating whether job disallows concurrent execution. - - - - - Gets or sets the job key. - - The job key. - - - - Gets or sets the scheduler instance id. - - The scheduler instance id. - - - - Gets or sets the trigger key. - - The trigger key. - - - - Gets or sets the state of the fire instance. - - The state of the fire instance. - - - - Gets or sets a value indicating whether [job requests recovery]. - - true if [job requests recovery]; otherwise, false. - - - - Gets or sets the priority. - - The priority. - - - - Service interface or modifying parameters - and resultset values. - - - - - Prepares a to be used to access database. - - Connection and tranasction pair - SQL to run - - - - - Adds a parameter to . - - Command to add parameter to - Parameter's name - Parameter's value - - - - Adds a parameter to . - - Command to add parameter to - Parameter's name - Parameter's value - Parameter's data type - - - - Gets the db presentation for boolean value. Subclasses can overwrite this behaviour. - - Value to map to database. - - - - - Gets the boolean value from db presentation. Subclasses can overwrite this behaviour. - - Value to map from database. - - - - - Gets the db presentation for date/time value. Subclasses can overwrite this behaviour. - - Value to map to database. - - - - - Gets the date/time value from db presentation. Subclasses can overwrite this behaviour. - - Value to map from database. - - - + - Gets the db presentation for time span value. Subclasses can overwrite this behaviour. + Delegate implementation for Firebird. - Value to map to database. - - + - Gets the time span value from db presentation. Subclasses can overwrite this behaviour. + This is meant to be an abstract base class for most, if not all, + implementations. Subclasses should override only those methods that need + special handling for the DBMS driver in question. - Value to map from database. - + Jeffrey Wescott + James House + Marko Lahma (.NET) @@ -3116,2399 +3074,2559 @@ - + - Exception class for when a driver delegate cannot be found for a given - configuration, or lack thereof. + Service interface or modifying parameters + and resultset values. - Jeffrey Wescott - Marko Lahma (.NET) - - - Base class for exceptions thrown by the Quartz . + + + Prepares a to be used to access database. - - SchedulerExceptions may contain a reference to another - , which was the underlying cause of the SchedulerException. - - James House - Marko Lahma (.NET) + Connection and transaction pair + SQL to run + - + - Initializes a new instance of the class. + Adds a parameter to . + Command to add parameter to + Parameter's name + Parameter's value - + - Initializes a new instance of the class. + Adds a parameter to . - The MSG. + Command to add parameter to + Parameter's name + Parameter's value + Parameter's data type - + - Initializes a new instance of the class. + Gets the db presentation for boolean value. Subclasses can overwrite this behaviour. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The class name is null or is zero (0). - The info parameter is null. + Value to map to database. + - + - Initializes a new instance of the class. + Gets the boolean value from db presentation. Subclasses can overwrite this behaviour. - The cause. + Value to map from database. + - + - Initializes a new instance of the class. + Gets the db presentation for date/time value. Subclasses can overwrite this behaviour. - The MSG. - The cause. + Value to map to database. + - + - Creates and returns a string representation of the current exception. + Gets the date/time value from db presentation. Subclasses can overwrite this behaviour. - - A string representation of the current exception. - - + Value to map from database. + - + - Initializes a new instance of the class. + Gets the db presentation for time span value. Subclasses can overwrite this behaviour. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The class name is null or is zero (0). - The info parameter is null. - - - - is meant to be used in an application-server - or other software framework environment that provides - container-managed-transactions. No commit / rollback will be handled by this class. - - - If you need commit / rollback, use - instead. - - Jeffrey Wescott - James House - Srinivas Venkatarangaiah - Marko Lahma (.NET) - - - - Contains base functionality for ADO.NET-based JobStore implementations. - - Jeffrey Wescott - James House - Marko Lahma (.NET) - - - - The interface to be implemented by classes that want to provide a - and storage mechanism for the - 's use. - - - Storage of s and s should be keyed - on the combination of their name and group for uniqueness. - - - - - - - - James House - Marko Lahma (.NET) + Value to map to database. + - + - Called by the QuartzScheduler before the is - used, in order to give the it a chance to Initialize. + Gets the time span value from db presentation. Subclasses can overwrite this behaviour. + Value to map from database. + - + - Called by the QuartzScheduler to inform the that - the scheduler has started. + Initializes the driver delegate. - + - Called by the QuartzScheduler to inform the JobStore that - the scheduler has been paused. + Insert the job detail record. + the DB Connection + the new state for the triggers + the first old state to update + the second old state to update + number of rows updated - + - Called by the QuartzScheduler to inform the JobStore that - the scheduler has resumed after being paused. + Get the names of all of the triggers that have misfired. + the DB Connection + The ts. + an array of objects - - - Called by the QuartzScheduler to inform the that - it should free up all of it's resources because the scheduler is - shutting down. + + + Select all of the triggers in a given state. + The DB Connection + The state the triggers must be in + an array of trigger s - + - Store the given and . + Get the names of all of the triggers in the given state that have + misfired - according to the given timestamp. - The to be stored. - The to be stored. - ObjectAlreadyExistsException + The DB Connection + The state. + The time stamp. + An array of objects - + - returns true if the given JobGroup is paused + Get the names of all of the triggers in the given state that have + misfired - according to the given timestamp. No more than count will + be returned. - - + The conn. + The state1. + The ts. + The most misfired triggers to return, negative for all + + Output parameter. A List of objects. Must not be null + + Whether there are more misfired triggers left to find beyond the given count. - + - returns true if the given TriggerGroup - is paused + Get the number of triggers in the given state that have + misfired - according to the given timestamp. - + + + - + - Store the given . + Get the names of all of the triggers in the given group and state that + have misfired. - The to be stored. - - If , any existing in the - with the same name and group should be - over-written. - + The DB Connection + Name of the group. + The state. + The timestamp. + an array of objects - + - Remove (delete) the with the given - key, and any s that reference - it. + Select all of the triggers for jobs that are requesting recovery. The + returned trigger objects will have unique "recoverXXX" trigger names and + will be in the + trigger group. - If removal of the results in an empty group, the - group should be removed from the 's list of - known group names. + In order to preserve the ordering of the triggers, the fire time will be + set from the ColumnFiredTime column in the TableFiredTriggers + table. The caller is responsible for calling + on each returned trigger. It is also up to the caller to insert the + returned triggers to ensure that they are fired. - - if a with the given name and - group was found and removed from the store. - + The DB Connection + an array of objects - + - Retrieve the for the given - . + Delete all fired triggers. - - The desired , or null if there is no match. - + The DB Connection. + The number of rows deleted. - + - Store the given . + Delete all fired triggers of the given instance. - The to be stored. - If , any existing in - the with the same name and group should - be over-written. - ObjectAlreadyExistsException + The DB Connection + The instance id. + The number of rows deleted - + - Remove (delete) the with the given key. + Clear (delete!) all scheduling data - all s, s + s. - - If removal of the results in an empty group, the - group should be removed from the 's list of - known group names. - - - If removal of the results in an 'orphaned' - that is not 'durable', then the should be deleted - also. - - - if a with the given - name and group was found and removed from the store. - - + - Remove (delete) the with the - given name, and store the new given one - which must be associated - with the same job. + Insert the job detail record. - The to be replaced. - The new to be stored. - - if a with the given - name and group was found and removed from the store. - + The DB Connection. + The job to insert. + Number of rows inserted. - + - Retrieve the given . + Gets the db presentation for boolean value. Subclasses can overwrite this behaviour. - - The desired , or null if there is no - match. - + Value to map to database. + - + - Determine whether a with the given identifier already - exists within the scheduler. + Gets the boolean value from db presentation. Subclasses can overwrite this behaviour. - - - the identifier to check for - true if a job exists with the given identifier + Value to map from database. + - + - Determine whether a with the given identifier already - exists within the scheduler. + Gets the db presentation for date/time value. Subclasses can overwrite this behaviour. - - - the identifier to check for - true if a trigger exists with the given identifier + Value to map to database. + - + - Clear (delete!) all scheduling data - all s, s - s. + Gets the date/time value from db presentation. Subclasses can overwrite this behaviour. - - + Value to map from database. + - + - Store the given . + Gets the db presentation for time span value. Subclasses can overwrite this behaviour. - The name. - The to be stored. - If , any existing - in the with the same name and group - should be over-written. - If , any s existing - in the that reference an existing - Calendar with the same name with have their next fire time - re-computed with the new . - ObjectAlreadyExistsException + Value to map to database. + - + - Remove (delete) the with the - given name. + Gets the time span value from db presentation. Subclasses can overwrite this behaviour. - - If removal of the would result in - s pointing to non-existent calendars, then a - will be thrown. - - The name of the to be removed. - - if a with the given name - was found and removed from the store. - + Value to map from database. + - + - Retrieve the given . + Update the job detail record. - The name of the to be retrieved. - - The desired , or null if there is no - match. - + The DB Connection. + The job to update. + Number of rows updated. - + - Get the number of s that are - stored in the . + Get the names of all of the triggers associated with the given job. - + The DB Connection. + The key identifying the job. + An array of objects - + - Get the number of s that are - stored in the . + Delete the job detail record for the given job. - + the DB Connection + The key identifying the job. + the number of rows deleted - + - Get the number of s that are - stored in the . + Check whether or not the given job is stateful. - + the DB Connection + The key identifying the job. + + true if the job exists and is stateful, false otherwise + - + - Get the names of all of the s that - have the given group name. - - If there are no jobs in the given group name, the result should be a - zero-length array (not ). - + Check whether or not the given job exists. - - + the DB Connection + The key identifying the job. + true if the job exists, false otherwise - + - Get the names of all of the s - that have the given group name. - - If there are no triggers in the given group name, the result should be a - zero-length array (not ). - + Update the job data map for the given job. + The conn. + the job to update + the number of rows updated - + - Get the names of all of the - groups. - - If there are no known group names, the result should be a zero-length - array (not ). - + Select the JobDetail object for a given job name / group name. + The DB Connection. + The key identifying the job. + The load helper. + The populated JobDetail object. - + + build Map from java.util.Properties encoding. + + - Get the names of all of the - groups. - - If there are no known group names, the result should be a zero-length - array (not ). - + Select the total number of jobs stored. + The DB Connection. + The total number of jobs stored. - + - Get the names of all of the s - in the . - - - If there are no Calendars in the given group name, the result should be - a zero-length array (not ). - + Select all of the job group names that are stored. + The DB Connection. + An array of group names. - + - Get all of the Triggers that are associated to the given Job. + Select all of the jobs contained in a given group. - - If there are no matches, a zero-length array should be returned. - + The DB Connection. + + An array of job names. - + - Get the current state of the identified . + Insert the base trigger data. - + the DB Connection + the trigger to insert + the state that the trigger should be stored in + The job detail. + the number of rows inserted - + - Pause the with the given key. + Insert the blob trigger data. + The DB Connection. + The trigger to insert. + The number of rows inserted. - + - Pause all of the s in the - given group. + Update the base trigger data. - - The JobStore should "remember" that the group is paused, and impose the - pause on any new triggers that are added to the group while the group is - paused. - + The DB Connection. + The trigger to insert. + The state that the trigger should be stored in. + The job detail. + The number of rows updated. - + - Pause the with the given key - by - pausing all of its current s. + Update the blob trigger data. + The DB Connection. + The trigger to insert. + The number of rows updated. - + - Pause all of the s in the given - group - by pausing all of their s. - - The JobStore should "remember" that the group is paused, and impose the - pause on any new jobs that are added to the group while the group is - paused. - + Check whether or not a trigger exists. - - + The DB Connection. + the key of the trigger + true if the trigger exists, false otherwise - + - Resume (un-pause) the with the - given key. - - - If the missed one or more fire-times, then the - 's misfire instruction will be applied. - + Update the state for a given trigger. - - + The DB Connection. + the key of the trigger + The new state for the trigger. + The number of rows updated. - + - Resume (un-pause) all of the s - in the given group. - - If any missed one or more fire-times, then the - 's misfire instruction will be applied. - + Update the given trigger to the given new state, if it is one of the + given old states. + The DB connection. + the key of the trigger + The new state for the trigger. + One of the old state the trigger must be in. + One of the old state the trigger must be in. + One of the old state the trigger must be in. + The number of rows updated. - + - Gets the paused trigger groups. - - - - - - Resume (un-pause) the with the - given key. - - If any of the 's s missed one - or more fire-times, then the 's misfire - instruction will be applied. - + Update all triggers in the given group to the given new state, if they + are in one of the given old states. + The DB connection. + + The new state for the trigger. + One of the old state the trigger must be in. + One of the old state the trigger must be in. + One of the old state the trigger must be in. + The number of rows updated. - + - Resume (un-pause) all of the s in - the given group. - - If any of the s had s that - missed one or more fire-times, then the 's - misfire instruction will be applied. - + Update the given trigger to the given new state, if it is in the given + old state. + the DB connection + the key of the trigger + the new state for the trigger + the old state the trigger must be in + int the number of rows updated - + - Pause all triggers - equivalent of calling - on every group. - - When is called (to un-pause), trigger misfire - instructions WILL be applied. - + Update all of the triggers of the given group to the given new state, if + they are in the given old state. - + the DB connection + + the new state for the trigger group + the old state the triggers must be in + int the number of rows updated - + - Resume (un-pause) all triggers - equivalent of calling - on every group. - - If any missed one or more fire-times, then the - 's misfire instruction will be applied. - - + Update the states of all triggers associated with the given job. - + the DB Connection + the key of the job + the new state for the triggers + the number of rows updated - + - Get a handle to the next trigger to be fired, and mark it as 'reserved' - by the calling scheduler. + Updates the state of the trigger states for job from other. - If > 0, the JobStore should only return a Trigger - that will fire no later than the time represented in this value as - milliseconds. - - + The conn. + Key of the job. + The state. + The old state. - - - - - Inform the that the scheduler no longer plans to - fire the given , that it had previously acquired - (reserved). + + + Delete the cron trigger data for a trigger. + the DB Connection + the key of the trigger + the number of rows deleted - + - Inform the that the scheduler is now firing the - given (executing its associated ), - that it had previously acquired (reserved). + Delete the base trigger data for a trigger. - - May return null if all the triggers or their calendars no longer exist, or - if the trigger was not successfully put into the 'executing' - state. Preference is to return an empty list if none of the triggers - could be fired. - + the DB Connection + the key of the trigger + the number of rows deleted - + - Inform the that the scheduler has completed the - firing of the given (and the execution its - associated ), and that the - in the given should be updated if the - is stateful. + Select the number of triggers associated with a given job. + the DB Connection + the key of the job + the number of triggers for the given job - + - Indicates whether job store supports persistence. + Select the triggers for a job - + the DB Connection + the key of the job + + an array of objects + associated with a given job. + - + - How long (in milliseconds) the implementation - estimates that it will take to release a trigger and acquire a new one. + Select the triggers for a calendar + The DB Connection. + Name of the calendar. + + An array of objects associated with a given job. + - + - Whether or not the implementation is clustered. + Select a trigger. - + the DB Connection + the key of the trigger + The object - + - Inform the of the Scheduler instance's Id, - prior to initialize being invoked. + Select a trigger's JobDataMap. + the DB Connection + the key of the trigger + The of the Trigger, never null, but possibly empty. - + - Inform the of the Scheduler instance's name, - prior to initialize being invoked. + Select a trigger's state value. + the DB Connection + the key of the trigger + The object - + - Tells the JobStore the pool size used to execute jobs. + Select a trigger status (state and next fire time). + the DB Connection + the key of the trigger + + a object, or null + - + - Initializes a new instance of the class. + Select the total number of triggers stored. + the DB Connection + the total number of triggers stored - + - Gets the connection and starts a new transaction. + Select all of the trigger group names that are stored. - + the DB Connection + + an array of group names + - + - Called by the QuartzScheduler before the is - used, in order to give it a chance to Initialize. + Select all of the triggers contained in a given group. + the DB Connection + + + an array of trigger names + - - - - + - Called by the QuartzScheduler to inform the JobStore that - the scheduler has been paused. + Inserts the paused trigger group. + The conn. + Name of the group. + - + - Called by the QuartzScheduler to inform the JobStore that - the scheduler has resumed after being paused. + Deletes the paused trigger group. + The conn. + Name of the group. + - + - Called by the QuartzScheduler to inform the that - it should free up all of it's resources because the scheduler is - shutting down. + Deletes all paused trigger groups. + The conn. + - + - Will recover any failed or misfired jobs and clean up the data store as - appropriate. + Determines whether the specified trigger group is paused. + The conn. + Name of the group. + + true if trigger group is paused; otherwise, false. + - + - Will recover any failed or misfired jobs and clean up the data store as - appropriate. + Determines whether given trigger group already exists. + The conn. + Name of the group. + + true if trigger group exists; otherwise, false. + - + - Store the given and . + Insert a new calendar. - Job to be stored. - Trigger to be stored. + the DB Connection + The name for the new calendar. + The calendar. + the number of rows inserted + IOException - + - returns true if the given JobGroup - is paused + Update a calendar. - - + the DB Connection + The name for the new calendar. + The calendar. + the number of rows updated + IOException - + - returns true if the given TriggerGroup - is paused + Check whether or not a calendar exists. - - + the DB Connection + The name of the calendar. + + true if the trigger exists, false otherwise + - + - Stores the given . - - The to be stored. - - If , any existing in the - with the same name & group should be over-written. - - - - - Insert or update a job. - + Select a calendar. + the DB Connection + The name of the calendar. + the Calendar + ClassNotFoundException + IOException - + - Check existence of a given job. + Check whether or not a calendar is referenced by any triggers. + the DB Connection + The name of the calendar. + + true if any triggers reference the calendar, false otherwise + - + - Store the given . + Delete a calendar. - The to be stored. - - If , any existing in - the with the same name & group should - be over-written. - - - if a with the same name/group already - exists, and replaceExisting is set to false. - + the DB Connection + The name of the trigger. + the number of rows deleted - + - Insert or update a trigger. + Select the total number of calendars stored. + the DB Connection + the total number of calendars stored - + - Check existence of a given trigger. + Select all of the stored calendars. + the DB Connection + + an array of calendar names + - + - Remove (delete) the with the given - name, and any s that reference - it. + Select the trigger that will be fired at the given fire time. - - - If removal of the results in an empty group, the - group should be removed from the 's list of - known group names. - + the DB Connection + the time that the trigger will be fired - if a with the given name & - group was found and removed from the store. + a representing the + trigger that will be fired at the given fire time, or null if no + trigger will be fired at that time - + - Delete a job and its listeners. + Select the next trigger which will fire to fire between the two given timestamps + in ascending order of fire time, and then descending by priority. - - + The conn. + highest value of of the triggers (exclusive) + highest value of of the triggers (inclusive) + maximum number of trigger keys allow to acquired in the returning list. + A (never null, possibly empty) list of the identifiers (Key objects) of the next triggers to be fired. - + - Delete a trigger, its listeners, and its Simple/Cron/BLOB sub-table entry. + Insert a fired trigger. - - - + the DB Connection + the trigger + the state that the trigger should be stored in + The job. + the number of rows inserted - + - Retrieve the for the given - . + + Update a fired trigger. + - The key identifying the job. - The desired , or null if there is no match. - - - - Remove (delete) the with the - given name. - - - - - If removal of the results in an empty group, the - group should be removed from the 's list of - known group names. - - - - If removal of the results in an 'orphaned' - that is not 'durable', then the should be deleted - also. - - - The key identifying the trigger. - - if a with the given - name & group was found and removed from the store. - + + + + the DB Connection + + the trigger + + + the state that the trigger should be stored in + the number of rows inserted - - + + + Select the states of all fired-trigger records for a given trigger, or + trigger group if trigger name is . + + The DB connection. + Name of the trigger. + Name of the group. + a List of objects. - + - Retrieve the given . + Select the states of all fired-trigger records for a given job, or job + group if job name is . - The key identifying the trigger. - The desired , or null if there is no match. + The DB connection. + Name of the job. + Name of the group. + a List of objects. - + - Get the current state of the identified . + Select the states of all fired-trigger records for a given scheduler + instance. - - - - - + The DB Connection + Name of the instance. + A list of FiredTriggerRecord objects. - + - Gets the state of the trigger. + Select the distinct instance names of all fired-trigger records. The conn. - The key identifying the trigger. + + This is useful when trying to identify orphaned fired triggers (a + fired trigger without a scheduler state record.) + - + - Store the given . + Delete a fired trigger. - The name of the calendar. - The to be stored. - - If , any existing - in the with the same name & group - should be over-written. - - - - if a with the same name already - exists, and replaceExisting is set to false. - - - - - Remove (delete) the with the given name. - - - If removal of the would result in - s pointing to non-existent calendars, then a - will be thrown. - - The name of the to be removed. - - if a with the given name - was found and removed from the store. - + the DB Connection + the fired trigger entry to delete + the number of rows deleted - + - Retrieve the given . + Selects the job execution count. - The name of the to be retrieved. - The desired , or null if there is no match. + The DB connection. + The key of the job. + - + - Get the number of s that are - stored in the . + Inserts the state of the scheduler. + The conn. + The instance id. + The check in time. + The interval. + - + - Get the number of s that are - stored in the . + Deletes the state of the scheduler. + The database connection. + The instance id. + - + - Get the number of s that are - stored in the . + Updates the state of the scheduler. + The database connection. + The instance id. + The check in time. + - + - Get the names of all of the s that - have the given group name. + A List of all current s. + + If instanceId is not null, then only the record for the identified + instance will be returned. + - - If there are no jobs in the given group name, the result should be a - zero-length array (not ). - + The DB Connection + The instance id. + - + - Determine whether a with the given identifier already - exists within the scheduler. + Replace the table prefix in a query by replacing any occurrences of + "{0}" with the table prefix. - - - the identifier to check for - true if a Job exists with the given identifier + The unsubstituted query + The query, with proper table prefix substituted - + - Determine whether a with the given identifier already - exists within the scheduler. + Create a serialized version of an Object. - - - the identifier to check for - true if a Trigger exists with the given identifier + the object to serialize + Serialized object as byte array. - + - Clear (delete!) all scheduling data - all s, s - s. + Remove the transient data from and then create a serialized + version of a and returns the underlying bytes. - - + The data. + the serialized data as byte array - + - Get the names of all of the s - that have the given group name. + serialize - - If there are no triggers in the given group name, the result should be a - zero-length array (not ). - + The data. + - - - Get the names of all of the - groups. + + + Convert the JobDataMap into a list of properties. - - - If there are no known group names, the result should be a zero-length - array (not ). - - + - Get the names of all of the - groups. + Convert the JobDataMap into a list of properties. - - - If there are no known group names, the result should be a zero-length - array (not ). - - + - Get the names of all of the s - in the . + This method should be overridden by any delegate subclasses that need + special handling for BLOBs. The default implementation uses standard + ADO.NET operations. - - If there are no Calendars in the given group name, the result should be - a zero-length array (not ). - + The data reader, already queued to the correct row. + The column index for the BLOB. + The deserialized object from the DataReader BLOB. - + - Get all of the Triggers that are associated to the given Job. + This method should be overridden by any delegate subclasses that need + special handling for BLOBs for job details. - - If there are no matches, a zero-length array should be returned. - + The result set, already queued to the correct row. + The column index for the BLOB. + The deserialized Object from the ResultSet BLOB. - + - Pause the with the given name. + Selects the paused trigger groups. + The DB Connection. + - + - Pause the with the given name. + Gets the select next trigger to acquire SQL clause. + FireBird version with ROWS support. + - + - Pause the with the given name - by - pausing all of its current s. + Conveys the state of a fired-trigger record. - + James House + Marko Lahma (.NET) - + - Pause all of the s in the given - group - by pausing all of their s. + Gets or sets the fire instance id. - + The fire instance id. - + - Determines if a Trigger for the given job should be blocked. - State can only transition to StatePausedBlocked/StateBlocked from - StatePaused/StateWaiting respectively. + Gets or sets the fire timestamp. - StatePausedBlocked, StateBlocked, or the currentState. + The fire timestamp. - + - Resume (un-pause) the with the - given name. + Gets or sets the scheduled fire timestamp. - - If the missed one or more fire-times, then the - 's misfire instruction will be applied. - - + - Resume (un-pause) the with the - given name. + Gets or sets a value indicating whether job disallows concurrent execution. - - If any of the 's s missed one - or more fire-times, then the 's misfire - instruction will be applied. - - - + - Resume (un-pause) all of the s in - the given group. + Gets or sets the job key. - - If any of the s had s that - missed one or more fire-times, then the 's - misfire instruction will be applied. - - + The job key. - + - Pause all of the s in the given group. + Gets or sets the scheduler instance id. - + The scheduler instance id. - + - Pause all of the s in the given group. + Gets or sets the trigger key. + The trigger key. - - - Pause all of the s in the - given group. + + + Gets or sets the state of the fire instance. + The state of the fire instance. - + - Resume (un-pause) all of the s - in the given group. - - If any missed one or more fire-times, then the - 's misfire instruction will be applied. - + Gets or sets a value indicating whether [job requests recovery]. + true if [job requests recovery]; otherwise, false. - + - Pause all triggers - equivalent of calling - on every group. - - When is called (to un-pause), trigger misfire - instructions WILL be applied. - + Gets or sets the priority. - - + The priority. - + - Resume (un-pause) all triggers - equivalent of calling - on every group. + Exception class for when a driver delegate cannot be found for a given + configuration, or lack thereof. + + Jeffrey Wescott + Marko Lahma (.NET) + + + + Base class for exceptions thrown by the Quartz . - If any missed one or more fire-times, then the - 's misfire instruction will be applied. + SchedulerExceptions may contain a reference to another + , which was the underlying cause of the SchedulerException. - + James House + Marko Lahma (.NET) - + - Resume (un-pause) all triggers - equivalent of calling - on every group. - - If any missed one or more fire-times, then the - 's misfire instruction will be applied. - + Initializes a new instance of the class. - - + - Get a handle to the next N triggers to be fired, and mark them as 'reserved' - by the calling scheduler. + Initializes a new instance of the class. - + The MSG. - + - Inform the that the scheduler no longer plans to - fire the given , that it had previously acquired - (reserved). + Initializes a new instance of the class. + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The class name is null or is zero (0). + The info parameter is null. - + - Inform the that the scheduler has completed the - firing of the given (and the execution its - associated ), and that the - in the given should be updated if the - is stateful. + Initializes a new instance of the class. + The cause. - + - Get a list of all scheduler instances in the cluster that may have failed. - This includes this scheduler if it is checking in for the first time. + Initializes a new instance of the class. + The MSG. + The cause. - + - Create dummy objects for fired triggers - that have no scheduler state record. Checkin timestamp and interval are - left as zero on these dummy objects. + Creates and returns a string representation of the current exception. - - List of all current s + + A string representation of the current exception. + + - + - Cleanup the given database connection. This means restoring - any modified auto commit or transaction isolation connection - attributes, and then closing the underlying connection. - - - - This is separate from closeConnection() because the Spring - integration relies on being able to overload closeConnection() and - expects the same connection back that it originally returned - from the datasource. - - - - - - Closes the supplied connection. + Initializes a new instance of the class. - (Optional) + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The class name is null or is zero (0). + The info parameter is null. - + - Rollback the supplied connection. - - (Optional) - - JobPersistenceException thrown if a SQLException occurs when the - connection is rolled back - + is meant to be used in an application-server + or other software framework environment that provides + container-managed-transactions. No commit / rollback will be handled by this class. + + + If you need commit / rollback, use + instead. + + Jeffrey Wescott + James House + Srinivas Venkatarangaiah + Marko Lahma (.NET) - + - Commit the supplied connection. + Contains base functionality for ADO.NET-based JobStore implementations. - The CTH. - if set to true opens a new transaction. - JobPersistenceException thrown if a SQLException occurs when the + Jeffrey Wescott + James House + Marko Lahma (.NET) - - - Execute the given callback in a transaction. Depending on the JobStore, - the surrounding transaction may be assumed to be already present - (managed). + + + The interface to be implemented by classes that want to provide a + and storage mechanism for the + 's use. - This method just forwards to ExecuteInLock() with a null lockName. + Storage of s and s should be keyed + on the combination of their name and group for uniqueness. + + + + + + + James House + Marko Lahma (.NET) - - - Execute the given callback having acquired the given lock. - Depending on the JobStore, the surrounding transaction may be - assumed to be already present (managed). - - - The name of the lock to acquire, for example - "TRIGGER_ACCESS". If null, then no lock is acquired, but the - lockCallback is still executed in a transaction. - - - The callback to excute after having acquired the given lock. - - - + - Execute the given callback having optionally acquired the given lock. - This uses the non-managed transaction connection. + Called by the QuartzScheduler before the is + used, in order to give the it a chance to Initialize. - - The name of the lock to acquire, for example - "TRIGGER_ACCESS". If null, then no lock is acquired, but the - lockCallback is still executed in a non-managed transaction. - - - The callback to excute after having acquired the given lock. - - - - - Get or set the datasource name. + + + Called by the QuartzScheduler to inform the that + the scheduler has started. - - - Get or set the database connection manager. + + + Called by the QuartzScheduler to inform the JobStore that + the scheduler has been paused. - + - Gets the log. + Called by the QuartzScheduler to inform the JobStore that + the scheduler has resumed after being paused. - The log. - - - Get or sets the prefix that should be pre-pended to all table names. + + + Called by the QuartzScheduler to inform the that + it should free up all of it's resources because the scheduler is + shutting down. - + - Set whether string-only properties will be handled in JobDataMaps. + Store the given and . + The to be stored. + The to be stored. + ObjectAlreadyExistsException - + - Get or set the instance Id of the Scheduler (must be unique within a cluster). + returns true if the given JobGroup is paused + + - + - Get or set the instance Id of the Scheduler (must be unique within this server instance). + returns true if the given TriggerGroup + is paused + + - - - Get or set whether this instance is part of a cluster. + + + Store the given . + The to be stored. + + If , any existing in the + with the same name and group should be + over-written. + - + - Get or set the frequency at which this instance "checks-in" - with the other instances of the cluster. -- Affects the rate of - detecting failed instances. + Remove (delete) the with the given + key, and any s that reference + it. + + If removal of the results in an empty group, the + group should be removed from the 's list of + known group names. + + + if a with the given name and + group was found and removed from the store. + - + - Get or set the maximum number of misfired triggers that the misfire handling - thread will try to recover at one time (within one transaction). The - default is 20. + Retrieve the for the given + . + + The desired , or null if there is no match. + - + - Gets or sets the database retry interval. + Store the given . - The db retry interval. + The to be stored. + If , any existing in + the with the same name and group should + be over-written. + ObjectAlreadyExistsException - + - Get or set whether this instance should use database-based thread - synchronization. - - - - - Whether or not to obtain locks when inserting new jobs/triggers. + Remove (delete) the with the given key. - Defaults to , which is safest - some db's (such as - MS SQLServer) seem to require this to avoid deadlocks under high load, - while others seem to do fine without. Settings this to false means - isolation guarantees between job scheduling and trigger acquisition are - entirely enforced by the database. Depending on the database and it's - configuration this may cause unusual scheduling behaviors. + If removal of the results in an empty group, the + group should be removed from the 's list of + known group names. - Setting this property to will provide a - significant performance increase during the addition of new jobs - and triggers. + If removal of the results in an 'orphaned' + that is not 'durable', then the should be deleted + also. + + if a with the given + name and group was found and removed from the store. + - - - The time span by which a trigger must have missed its - next-fire-time, in order for it to be considered "misfired" and thus - have its misfire instruction applied. + + + Remove (delete) the with the + given name, and store the new given one - which must be associated + with the same job. + The to be replaced. + The new to be stored. + + if a with the given + name and group was found and removed from the store. + - - - Don't call set autocommit(false) on connections obtained from the - DataSource. This can be helpfull in a few situations, such as if you - have a driver that complains if it is called when it is already off. + + + Retrieve the given . + + The desired , or null if there is no + match. + - - - Set the transaction isolation level of DB connections to sequential. + + + Determine whether a with the given identifier already + exists within the scheduler. + + + the identifier to check for + true if a calendar exists with the given identifier - + - Whether or not the query and update to acquire a Trigger for firing - should be performed after obtaining an explicit DB lock (to avoid - possible race conditions on the trigger's db row). This is - is considered unnecessary for most databases (due to the nature of - the SQL update that is performed), and therefore a superfluous performance hit. + Determine whether a with the given identifier already + exists within the scheduler. - However, if batch acquisition is used, it is important for this behavior - to be used for all dbs. + the identifier to check for + true if a job exists with the given identifier - - - Get or set the ADO.NET driver delegate class name. + + + Determine whether a with the given identifier already + exists within the scheduler. + + + the identifier to check for + true if a trigger exists with the given identifier - + - The driver delegate's initialization string. + Clear (delete!) all scheduling data - all s, s + s. + + - + - set the SQL statement to use to select and lock a row in the "locks" - table. + Store the given . - + The name. + The to be stored. + If , any existing + in the with the same name and group + should be over-written. + If , any s existing + in the that reference an existing + Calendar with the same name with have their next fire time + re-computed with the new . + ObjectAlreadyExistsException - + - Get whether the threads spawned by this JobStore should be - marked as daemon. Possible threads include the - and the . + Remove (delete) the with the + given name. - + + If removal of the would result in + s pointing to non-existent calendars, then a + will be thrown. + + The name of the to be removed. + + if a with the given name + was found and removed from the store. + - + - Get whether to check to see if there are Triggers that have misfired - before actually acquiring the lock to recover them. This should be - set to false if the majority of the time, there are are misfired - Triggers. + Retrieve the given . - + The name of the to be retrieved. + + The desired , or null if there is no + match. + - + - Get the driver delegate for DB operations. + Get the number of s that are + stored in the . + - + - Get whether String-only properties will be handled in JobDataMaps. + Get the number of s that are + stored in the . + - + - Indicates whether this job store supports persistence. + Get the number of s that are + stored in the . - - - - An interface for classes wishing to provide the service of loading classes - and resources within the scheduler... + + + Get the names of all of the s that + have the given group name. + + If there are no jobs in the given group name, the result should be a + zero-length array (not ). + - James House - Marko Lahma (.NET) + + - - - Called to give the ClassLoadHelper a chance to Initialize itself, - including the oportunity to "steal" the class loader off of the calling - thread, which is the thread that is initializing Quartz. + + + Get the names of all of the s + that have the given group name. + + If there are no triggers in the given group name, the result should be a + zero-length array (not ). + - - - Return the class with the given name. + + + Get the names of all of the + groups. + + If there are no known group names, the result should be a zero-length + array (not ). + - - - Finds a resource with a given name. This method returns null if no - resource with this name is found. + + + Get the names of all of the + groups. + + If there are no known group names, the result should be a zero-length + array (not ). + - name of the desired resource - - a java.net.URL object - - - - Finds a resource with a given name. This method returns null if no - resource with this name is found. + + + Get the names of all of the s + in the . + + + If there are no Calendars in the given group name, the result should be + a zero-length array (not ). + - name of the desired resource - - a java.io.InputStream object - - + - Helper class for returning the composite result of trying - to recover misfired jobs. + Get all of the Triggers that are associated to the given Job. + + If there are no matches, a zero-length array should be returned. + - + - Initializes a new instance of the class. + Get the current state of the identified . - if set to true [has more misfired triggers]. - The processed misfired trigger count. - + - + - Gets a value indicating whether this instance has more misfired triggers. + Pause the with the given key. - - true if this instance has more misfired triggers; otherwise, false. - - + - Gets the processed misfired trigger count. + Pause all of the s in the + given group. - The processed misfired trigger count. + + The JobStore should "remember" that the group is paused, and impose the + pause on any new triggers that are added to the group while the group is + paused. + - + - Called by the QuartzScheduler before the is - used, in order to give the it a chance to Initialize. + Pause the with the given key - by + pausing all of its current s. - - - + - Called by the QuartzScheduler to inform the that - it should free up all of it's resources because the scheduler is - shutting down. + Pause all of the s in the given + group - by pausing all of their s. + + The JobStore should "remember" that the group is paused, and impose the + pause on any new jobs that are added to the group while the group is + paused. + + + - + - Gets the non managed TX connection. + Resume (un-pause) the with the + given key. + + + If the missed one or more fire-times, then the + 's misfire instruction will be applied. + - + + - + - Execute the given callback having optionally acquired the given lock. - Because CMT assumes that the connection is already part of a managed - transaction, it does not attempt to commit or rollback the - enclosing transaction. + Resume (un-pause) all of the s + in the given group. + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + - - - - - - The name of the lock to acquire, for example - "TRIGGER_ACCESS". If null, then no lock is acquired, but the - txCallback is still executed in a transaction. - - Callback to execute. - + - Instructs this job store whether connections should be automatically opened. + Gets the paused trigger groups. + - + + + Resume (un-pause) the with the + given key. + + If any of the 's s missed one + or more fire-times, then the 's misfire + instruction will be applied. + + + + - is meant to be used in a standalone environment. - Both commit and rollback will be handled by this class. + Resume (un-pause) all of the s in + the given group. + + If any of the s had s that + missed one or more fire-times, then the 's + misfire instruction will be applied. + - Jeffrey Wescott - James House - Marko Lahma (.NET) - + - Called by the QuartzScheduler before the is - used, in order to give the it a chance to Initialize. + Pause all triggers - equivalent of calling + on every group. + + When is called (to un-pause), trigger misfire + instructions WILL be applied. + - - + - + - For , the non-managed TX connection is just - the normal connection because it is not CMT. - - + Resume (un-pause) all triggers - equivalent of calling + on every group. + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + + + + - + - Execute the given callback having optionally aquired the given lock. - For , because it manages its own transactions - and only has the one datasource, this is the same behavior as - . + Get a handle to the next trigger to be fired, and mark it as 'reserved' + by the calling scheduler. - - The name of the lock to aquire, for example "TRIGGER_ACCESS". - If null, then no lock is aquired, but the lockCallback is still - executed in a transaction. - - Callback to execute. + If > 0, the JobStore should only return a Trigger + that will fire no later than the time represented in this value as + milliseconds. + + - - - - + + - - - Exception class for when there is a failure obtaining or releasing a - resource lock. + + + Inform the that the scheduler no longer plans to + fire the given , that it had previously acquired + (reserved). - - James House - Marko Lahma (.NET) - + - An exception that is thrown to indicate that there has been a failure in the - scheduler's underlying persistence mechanism. + Inform the that the scheduler is now firing the + given (executing its associated ), + that it had previously acquired (reserved). - James House - Marko Lahma (.NET) + + May return null if all the triggers or their calendars no longer exist, or + if the trigger was not successfully put into the 'executing' + state. Preference is to return an empty list if none of the triggers + could be fired. + - - - Create a with the given message. - + + + Inform the that the scheduler has completed the + firing of the given (and the execution its + associated ), and that the + in the given should be updated if the + is stateful. - + - Initializes a new instance of the class. + Indicates whether job store supports persistence. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The class name is null or is zero (0). - The info parameter is null. + - - - Create a with the given message - and cause. - + + + How long (in milliseconds) the implementation + estimates that it will take to release a trigger and acquire a new one. - + - Initializes a new instance of the class. + Whether or not the implementation is clustered. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The class name is null or is zero (0). - The info parameter is null. + - + - This is a driver delegate for the MySQL ADO.NET driver. + Inform the of the Scheduler instance's Id, + prior to initialize being invoked. - Marko Lahma - + - This is meant to be an abstract base class for most, if not all, - implementations. Subclasses should override only those methods that need - special handling for the DBMS driver in question. + Inform the of the Scheduler instance's name, + prior to initialize being invoked. - Jeffrey Wescott - James House - Marko Lahma (.NET) - + - Initializes the driver delegate. + Tells the JobStore the pool size used to execute jobs. - + - Insert the job detail record. + Initializes a new instance of the class. - the DB Connection - the new state for the triggers - the first old state to update - the second old state to update - number of rows updated - + - Get the names of all of the triggers that have misfired. + Gets the connection and starts a new transaction. - the DB Connection - The ts. - an array of objects + - - - Select all of the triggers in a given state. + + + Called by the QuartzScheduler before the is + used, in order to give it a chance to Initialize. - The DB Connection - The state the triggers must be in - an array of trigger s - - - Get the names of all of the triggers in the given state that have - misfired - according to the given timestamp. - - The DB Connection - The state. - The time stamp. - An array of objects - - - - Get the names of all of the triggers in the given state that have - misfired - according to the given timestamp. No more than count will - be returned. - - The conn. - The state1. - The ts. - The most misfired triggers to return, negative for all - - Output parameter. A List of objects. Must not be null - - Whether there are more misfired triggers left to find beyond the given count. - - - - Get the number of triggers in the given state that have - misfired - according to the given timestamp. - - - - - - - - - Get the names of all of the triggers in the given group and state that - have misfired. - - The DB Connection - Name of the group. - The state. - The timestamp. - an array of objects + + - + - Select all of the triggers for jobs that are requesting recovery. The - returned trigger objects will have unique "recoverXXX" trigger names and - will be in the - trigger group. + Called by the QuartzScheduler to inform the JobStore that + the scheduler has been paused. - - In order to preserve the ordering of the triggers, the fire time will be - set from the ColumnFiredTime column in the TableFiredTriggers - table. The caller is responsible for calling - on each returned trigger. It is also up to the caller to insert the - returned triggers to ensure that they are fired. - - The DB Connection - an array of objects - + - Delete all fired triggers. + Called by the QuartzScheduler to inform the JobStore that + the scheduler has resumed after being paused. - The DB Connection. - The number of rows deleted. - + - Delete all fired triggers of the given instance. + Called by the QuartzScheduler to inform the that + it should free up all of it's resources because the scheduler is + shutting down. - The DB Connection - The instance id. - The number of rows deleted - + - Clear (delete!) all scheduling data - all s, s - s. + Will recover any failed or misfired jobs and clean up the data store as + appropriate. - - - + - Insert the job detail record. + Will recover any failed or misfired jobs and clean up the data store as + appropriate. - The DB Connection. - The job to insert. - Number of rows inserted. - + - Gets the db presentation for boolean value. Subclasses can overwrite this behaviour. + Store the given and . - Value to map to database. - + Job to be stored. + Trigger to be stored. - + - Gets the boolean value from db presentation. Subclasses can overwrite this behaviour. + returns true if the given JobGroup + is paused - Value to map from database. + - + - Gets the db presentation for date/time value. Subclasses can overwrite this behaviour. + returns true if the given TriggerGroup + is paused - Value to map to database. + - + - Gets the date/time value from db presentation. Subclasses can overwrite this behaviour. + Stores the given . - Value to map from database. - + The to be stored. + + If , any existing in the + with the same name & group should be over-written. + - - - Gets the db presentation for time span value. Subclasses can overwrite this behaviour. + + + Insert or update a job. + - Value to map to database. - - + - Gets the time span value from db presentation. Subclasses can overwrite this behaviour. + Check existence of a given job. - Value to map from database. - - + - Update the job detail record. + Store the given . - The DB Connection. - The job to update. - Number of rows updated. + The to be stored. + + If , any existing in + the with the same name & group should + be over-written. + + + if a with the same name/group already + exists, and replaceExisting is set to false. + - + - Get the names of all of the triggers associated with the given job. + Insert or update a trigger. - The DB Connection. - The key identifying the job. - An array of objects - + - Delete the job detail record for the given job. + Check existence of a given trigger. - the DB Connection - The key identifying the job. - the number of rows deleted - + - Check whether or not the given job is stateful. + Remove (delete) the with the given + name, and any s that reference + it. - the DB Connection - The key identifying the job. + + + If removal of the results in an empty group, the + group should be removed from the 's list of + known group names. + - true if the job exists and is stateful, false otherwise + if a with the given name & + group was found and removed from the store. - + - Check whether or not the given job exists. + Delete a job and its listeners. - the DB Connection - The key identifying the job. - true if the job exists, false otherwise + + - + - Update the job data map for the given job. + Delete a trigger, its listeners, and its Simple/Cron/BLOB sub-table entry. - The conn. - the job to update - the number of rows updated + + + - + - Select the JobDetail object for a given job name / group name. + Retrieve the for the given + . - The DB Connection. The key identifying the job. - The load helper. - The populated JobDetail object. + The desired , or null if there is no match. - - build Map from java.util.Properties encoding. + + + Remove (delete) the with the + given name. + + + + + If removal of the results in an empty group, the + group should be removed from the 's list of + known group names. + + + + If removal of the results in an 'orphaned' + that is not 'durable', then the should be deleted + also. + + + The key identifying the trigger. + + if a with the given + name & group was found and removed from the store. + - + + + + - Select the total number of jobs stored. + Retrieve the given . - The DB Connection. - The total number of jobs stored. + The key identifying the trigger. + The desired , or null if there is no match. - + - Select all of the job group names that are stored. + Get the current state of the identified . - The DB Connection. - An array of group names. + + + + + - + - Select all of the jobs contained in a given group. + Gets the state of the trigger. - The DB Connection. - - An array of job names. + The conn. + The key identifying the trigger. + - + - Insert the base trigger data. + Store the given . - the DB Connection - the trigger to insert - the state that the trigger should be stored in - The job detail. - the number of rows inserted + The name of the calendar. + The to be stored. + + If , any existing + in the with the same name & group + should be over-written. + + + + if a with the same name already + exists, and replaceExisting is set to false. + - + + + Remove (delete) the with the given name. + + + If removal of the would result in + s pointing to non-existent calendars, then a + will be thrown. + + The name of the to be removed. + + if a with the given name + was found and removed from the store. + + + - Insert the blob trigger data. + Retrieve the given . - The DB Connection. - The trigger to insert. - The number of rows inserted. + The name of the to be retrieved. + The desired , or null if there is no match. - + - Update the base trigger data. + Get the number of s that are + stored in the . - The DB Connection. - The trigger to insert. - The state that the trigger should be stored in. - The job detail. - The number of rows updated. - + - Update the blob trigger data. + Get the number of s that are + stored in the . - The DB Connection. - The trigger to insert. - The number of rows updated. - + - Check whether or not a trigger exists. + Get the number of s that are + stored in the . - The DB Connection. - the key of the trigger - true if the trigger exists, false otherwise - + - Update the state for a given trigger. + Get the names of all of the s that + have the given group name. - The DB Connection. - the key of the trigger - The new state for the trigger. - The number of rows updated. + + If there are no jobs in the given group name, the result should be a + zero-length array (not ). + - + - Update the given trigger to the given new state, if it is one of the - given old states. + Determine whether a with the given identifier already + exists within the scheduler. - The DB connection. - the key of the trigger - The new state for the trigger. - One of the old state the trigger must be in. - One of the old state the trigger must be in. - One of the old state the trigger must be in. - The number of rows updated. + + + the identifier to check for + true if a calendar exists with the given identifier - + - Update all triggers in the given group to the given new state, if they - are in one of the given old states. + Determine whether a with the given identifier already + exists within the scheduler. - The DB connection. - - The new state for the trigger. - One of the old state the trigger must be in. - One of the old state the trigger must be in. - One of the old state the trigger must be in. - The number of rows updated. + + + the identifier to check for + true if a Job exists with the given identifier - + - Update the given trigger to the given new state, if it is in the given - old state. + Determine whether a with the given identifier already + exists within the scheduler. - the DB connection - the key of the trigger - the new state for the trigger - the old state the trigger must be in - int the number of rows updated + + + the identifier to check for + true if a Trigger exists with the given identifier - + - Update all of the triggers of the given group to the given new state, if - they are in the given old state. + Clear (delete!) all scheduling data - all s, s + s. - the DB connection - - the new state for the trigger group - the old state the triggers must be in - int the number of rows updated + + - + - Update the states of all triggers associated with the given job. + Get the names of all of the s + that have the given group name. - the DB Connection - the key of the job - the new state for the triggers - the number of rows updated + + If there are no triggers in the given group name, the result should be a + zero-length array (not ). + - + - Updates the state of the trigger states for job from other. + Get the names of all of the + groups. - The conn. - Key of the job. - The state. - The old state. - + + + If there are no known group names, the result should be a zero-length + array (not ). + - + - Delete the cron trigger data for a trigger. + Get the names of all of the + groups. - the DB Connection - the key of the trigger - the number of rows deleted + + + If there are no known group names, the result should be a zero-length + array (not ). + - + - Delete the base trigger data for a trigger. + Get the names of all of the s + in the . - the DB Connection - the key of the trigger - the number of rows deleted + + If there are no Calendars in the given group name, the result should be + a zero-length array (not ). + - + - Select the number of triggers associated with a given job. + Get all of the Triggers that are associated to the given Job. - the DB Connection - the key of the job - the number of triggers for the given job + + If there are no matches, a zero-length array should be returned. + - + - Select the triggers for a job + Pause the with the given name. - the DB Connection - the key of the job - - an array of objects - associated with a given job. - - + - Select the triggers for a calendar + Pause the with the given name. - The DB Connection. - Name of the calendar. - - An array of objects associated with a given job. - - + - Select a trigger. + Pause the with the given name - by + pausing all of its current s. - the DB Connection - the key of the trigger - The object + - + - Select a trigger's JobDataMap. - - the DB Connection - the key of the trigger - The of the Trigger, never null, but possibly empty. - - - - Select a trigger's state value. + Pause all of the s in the given + group - by pausing all of their s. - the DB Connection - the key of the trigger - The object + - + - Select a trigger status (state and next fire time). + Determines if a Trigger for the given job should be blocked. + State can only transition to StatePausedBlocked/StateBlocked from + StatePaused/StateWaiting respectively. - the DB Connection - the key of the trigger - - a object, or null - + StatePausedBlocked, StateBlocked, or the currentState. - + - Select the total number of triggers stored. + Resume (un-pause) the with the + given name. - the DB Connection - the total number of triggers stored + + If the missed one or more fire-times, then the + 's misfire instruction will be applied. + - + - Select all of the trigger group names that are stored. + Resume (un-pause) the with the + given name. - the DB Connection - - an array of group names - + + If any of the 's s missed one + or more fire-times, then the 's misfire + instruction will be applied. + + - + - Select all of the triggers contained in a given group. + Resume (un-pause) all of the s in + the given group. - the DB Connection - - - an array of trigger names - + + If any of the s had s that + missed one or more fire-times, then the 's + misfire instruction will be applied. + + - + - Inserts the paused trigger group. + Pause all of the s in the given group. - The conn. - Name of the group. - + - + - Deletes the paused trigger group. + Pause all of the s in the given group. - The conn. - Name of the group. - - - - Deletes all paused trigger groups. + + + Pause all of the s in the + given group. - The conn. - - + - Determines whether the specified trigger group is paused. + Resume (un-pause) all of the s + in the given group. + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + - The conn. - Name of the group. - - true if trigger group is paused; otherwise, false. - - + - Determines whether given trigger group already exists. + Pause all triggers - equivalent of calling + on every group. + + When is called (to un-pause), trigger misfire + instructions WILL be applied. + - The conn. - Name of the group. - - true if trigger group exists; otherwise, false. - + + - + - Insert a new calendar. + Resume (un-pause) all triggers - equivalent of calling + on every group. - the DB Connection - The name for the new calendar. - The calendar. - the number of rows inserted - IOException + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + + - + - Update a calendar. + Resume (un-pause) all triggers - equivalent of calling + on every group. + + If any missed one or more fire-times, then the + 's misfire instruction will be applied. + - the DB Connection - The name for the new calendar. - The calendar. - the number of rows updated - IOException + - + - Check whether or not a calendar exists. + Get a handle to the next N triggers to be fired, and mark them as 'reserved' + by the calling scheduler. - the DB Connection - The name of the calendar. - - true if the trigger exists, false otherwise - + - + - Select a calendar. + Inform the that the scheduler no longer plans to + fire the given , that it had previously acquired + (reserved). - the DB Connection - The name of the calendar. - the Calendar - ClassNotFoundException - IOException - + - Check whether or not a calendar is referenced by any triggers. + Inform the that the scheduler has completed the + firing of the given (and the execution its + associated ), and that the + in the given should be updated if the + is stateful. - the DB Connection - The name of the calendar. - - true if any triggers reference the calendar, false otherwise - - + - Delete a calendar. + Get a list of all scheduler instances in the cluster that may have failed. + This includes this scheduler if it is checking in for the first time. - the DB Connection - The name of the trigger. - the number of rows deleted - + - Select the total number of calendars stored. + Create dummy objects for fired triggers + that have no scheduler state record. Checkin timestamp and interval are + left as zero on these dummy objects. - the DB Connection - the total number of calendars stored + + List of all current s - + - Select all of the stored calendars. + Cleanup the given database connection. This means restoring + any modified auto commit or transaction isolation connection + attributes, and then closing the underlying connection. - the DB Connection - - an array of calendar names - + + + This is separate from closeConnection() because the Spring + integration relies on being able to overload closeConnection() and + expects the same connection back that it originally returned + from the datasource. + + - - - Select the trigger that will be fired at the given fire time. + + + Closes the supplied connection. - the DB Connection - the time that the trigger will be fired - - a representing the - trigger that will be fired at the given fire time, or null if no - trigger will be fired at that time - + (Optional) - + - Select the next trigger which will fire to fire between the two given timestamps - in ascending order of fire time, and then descending by priority. + Rollback the supplied connection. + + (Optional) + + JobPersistenceException thrown if a SQLException occurs when the + connection is rolled back - The conn. - highest value of of the triggers (exclusive) - highest value of of the triggers (inclusive) - maximum number of trigger keys allow to acquired in the returning list. - A (never null, possibly empty) list of the identifiers (Key objects) of the next triggers to be fired. - + - Insert a fired trigger. + Commit the supplied connection. - the DB Connection - the trigger - the state that the trigger should be stored in - The job. - the number of rows inserted + The CTH. + if set to true opens a new transaction. + JobPersistenceException thrown if a SQLException occurs when the - + + + Execute the given callback in a transaction. Depending on the JobStore, + the surrounding transaction may be assumed to be already present + (managed). + + + This method just forwards to ExecuteInLock() with a null lockName. + + + + Execute the given callback having acquired the given lock. + Depending on the JobStore, the surrounding transaction may be + assumed to be already present (managed). + + + The name of the lock to acquire, for example + "TRIGGER_ACCESS". If null, then no lock is acquired, but the + lockCallback is still executed in a transaction. + + + The callback to execute after having acquired the given lock. + + + + + Execute the given callback having optionally acquired the given lock. + This uses the non-managed transaction connection. + + + The name of the lock to acquire, for example + "TRIGGER_ACCESS". If null, then no lock is acquired, but the + lockCallback is still executed in a non-managed transaction. + + + The callback to execute after having acquired the given lock. + + + + + + Get or set the datasource name. + + + + + Get or set the database connection manager. + + + + + Gets the log. + + The log. + + + + Get or sets the prefix that should be pre-pended to all table names. + + + + + Set whether string-only properties will be handled in JobDataMaps. + + + + + Get or set the instance Id of the Scheduler (must be unique within a cluster). + + + + + Get or set the instance Id of the Scheduler (must be unique within this server instance). + + + + + Gets or sets the number of retries before an error is logged for recovery operations. + + + + + Get or set whether this instance is part of a cluster. + + + + + Get or set the frequency at which this instance "checks-in" + with the other instances of the cluster. -- Affects the rate of + detecting failed instances. + + + + + Get or set the maximum number of misfired triggers that the misfire handling + thread will try to recover at one time (within one transaction). The + default is 20. + + + + + Gets or sets the database retry interval. + + The db retry interval. + + + + Get or set whether this instance should use database-based thread + synchronization. + + + + + Whether or not to obtain locks when inserting new jobs/triggers. + + - Update a fired trigger. + Defaults to , which is safest - some db's (such as + MS SQLServer) seem to require this to avoid deadlocks under high load, + while others seem to do fine without. Settings this to false means + isolation guarantees between job scheduling and trigger acquisition are + entirely enforced by the database. Depending on the database and it's + configuration this may cause unusual scheduling behaviors. + + + Setting this property to will provide a + significant performance increase during the addition of new jobs + and triggers. + + + + + The time span by which a trigger must have missed its + next-fire-time, in order for it to be considered "misfired" and thus + have its misfire instruction applied. + + + + + Don't call set autocommit(false) on connections obtained from the + DataSource. This can be helpful in a few situations, such as if you + have a driver that complains if it is called when it is already off. + + + + + Set the transaction isolation level of DB connections to sequential. + + + + + Whether or not the query and update to acquire a Trigger for firing + should be performed after obtaining an explicit DB lock (to avoid + possible race conditions on the trigger's db row). This is + is considered unnecessary for most databases (due to the nature of + the SQL update that is performed), and therefore a superfluous performance hit. + However, if batch acquisition is used, it is important for this behavior + to be used for all dbs. - - the DB Connection - - the trigger - - - the state that the trigger should be stored in - the number of rows inserted - + + + Get or set the ADO.NET driver delegate class name. + + + - Select the states of all fired-trigger records for a given trigger, or - trigger group if trigger name is . + The driver delegate's initialization string. - The DB connection. - Name of the trigger. - Name of the group. - a List of objects. - + - Select the states of all fired-trigger records for a given job, or job - group if job name is . + set the SQL statement to use to select and lock a row in the "locks" + table. - The DB connection. - Name of the job. - Name of the group. - a List of objects. + + + + + Get whether the threads spawned by this JobStore should be + marked as daemon. Possible threads include the + and the . + + + + + + Get whether to check to see if there are Triggers that have misfired + before actually acquiring the lock to recover them. This should be + set to false if the majority of the time, there are are misfired + Triggers. + + + + + + Get the driver delegate for DB operations. + + + + + Get whether String-only properties will be handled in JobDataMaps. + + + + + Indicates whether this job store supports persistence. + + + + + + + An interface for classes wishing to provide the service of loading classes + and resources within the scheduler... + + James House + Marko Lahma (.NET) + + + + Called to give the ClassLoadHelper a chance to Initialize itself, + including the opportunity to "steal" the class loader off of the calling + thread, which is the thread that is initializing Quartz. + + + + + Return the class with the given name. + + + + + Finds a resource with a given name. This method returns null if no + resource with this name is found. + + name of the desired resource + + a java.net.URL object + + + + + Finds a resource with a given name. This method returns null if no + resource with this name is found. + + name of the desired resource + + a java.io.InputStream object + - + - Select the states of all fired-trigger records for a given scheduler - instance. + Helper class for returning the composite result of trying + to recover misfired jobs. - The DB Connection - Name of the instance. - A list of FiredTriggerRecord objects. - + - Select the distinct instance names of all fired-trigger records. + Initializes a new instance of the class. - The conn. - - - This is useful when trying to identify orphaned fired triggers (a - fired trigger without a scheduler state record.) - + if set to true [has more misfired triggers]. + The processed misfired trigger count. + - + - Delete a fired trigger. + Gets a value indicating whether this instance has more misfired triggers. - the DB Connection - the fired trigger entry to delete - the number of rows deleted + + true if this instance has more misfired triggers; otherwise, false. + - + - Selects the job execution count. + Gets the processed misfired trigger count. - The DB connection. - The key of the job. - + The processed misfired trigger count. - + - Inserts the state of the scheduler. + Called by the QuartzScheduler before the is + used, in order to give the it a chance to Initialize. - The conn. - The instance id. - The check in time. - The interval. - + + - + - Deletes the state of the scheduler. + Called by the QuartzScheduler to inform the that + it should free up all of it's resources because the scheduler is + shutting down. - The database connection. - The instance id. - - + - Updates the state of the scheduler. + Gets the non managed TX connection. - The database connection. - The instance id. - The check in time. - + - A List of all current s. - - If instanceId is not null, then only the record for the identified - instance will be returned. - + Execute the given callback having optionally acquired the given lock. + Because CMT assumes that the connection is already part of a managed + transaction, it does not attempt to commit or rollback the + enclosing transaction. - The DB Connection - The instance id. - + + + + + + The name of the lock to acquire, for example + "TRIGGER_ACCESS". If null, then no lock is acquired, but the + txCallback is still executed in a transaction. + + Callback to execute. - + - Replace the table prefix in a query by replacing any occurrences of - "{0}" with the table prefix. + Instructs this job store whether connections should be automatically opened. - The unsubstitued query - The query, with proper table prefix substituted - + - Create a serialized version of an Object. + is meant to be used in a standalone environment. + Both commit and rollback will be handled by this class. - the object to serialize - Serialized object as byte array. + Jeffrey Wescott + James House + Marko Lahma (.NET) - + - Remove the transient data from and then create a serialized - version of a and returns the underlying bytes. + Called by the QuartzScheduler before the is + used, in order to give the it a chance to Initialize. - The data. - the serialized data as byte array + + - + - serialize + For , the non-managed TX connection is just + the normal connection because it is not CMT. + + + + + + Execute the given callback having optionally acquired the given lock. + For , because it manages its own transactions + and only has the one datasource, this is the same behavior as + . - The data. + + The name of the lock to acquire, for example "TRIGGER_ACCESS". + If null, then no lock is acquired, but the lockCallback is still + executed in a transaction. + + Callback to execute. + + + + - - - Convert the JobDataMap into a list of properties. + + + Exception class for when there is a failure obtaining or releasing a + resource lock. + + James House + Marko Lahma (.NET) - + - Convert the JobDataMap into a list of properties. + An exception that is thrown to indicate that there has been a failure in the + scheduler's underlying persistence mechanism. + James House + Marko Lahma (.NET) - + + + Create a with the given message. + + + + - This method should be overridden by any delegate subclasses that need - special handling for BLOBs. The default implementation uses standard - ADO.NET operations. + Initializes a new instance of the class. - The data reader, already queued to the correct row. - The column index for the BLOB. - The deserialized object from the DataReader BLOB. + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The class name is null or is zero (0). + The info parameter is null. - + + + Create a with the given message + and cause. + + + + - This method should be overridden by any delegate subclasses that need - special handling for BLOBs for job details. + Initializes a new instance of the class. - The result set, already queued to the correct row. - The column index for the BLOB. - The deserialized Object from the ResultSet BLOB. + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The class name is null or is zero (0). + The info parameter is null. - + - Selects the paused trigger groups. + This is a driver delegate for the MySQL ADO.NET driver. - The DB Connection. - + Marko Lahma @@ -5912,7 +6030,7 @@ - Return true, if day is defined to be exluded. + Return true, if day is defined to be excluded. @@ -6078,7 +6196,7 @@ Create a with a time range defined by the specified strings and no baseCalendar. - and + and must be in the format "HH:MM[:SS[:mmm]]" where:
  • @@ -6106,12 +6224,14 @@
+ The range starting time in millis. + The range ending time in millis. Create a with a time range defined by the specified strings and the specified baseCalendar. - and + and must be in the format "HH:MM[:SS[:mmm]]" where:
  • @@ -6143,6 +6263,8 @@
The base calendar for this calendar instance see BaseCalendar for more information on base calendar functionality. + The range starting time in millis. + The range ending time in millis. @@ -6176,7 +6298,7 @@ Create a with a time range defined by the - specified values and the specified . Values are + specified values and the specified . Values are subject to the following validations:
  • @@ -6193,6 +6315,8 @@
+ The base calendar for this calendar instance see BaseCalendar for more + information on base calendar functionality. The range starting hour of day. The range starting minute. The range starting second. @@ -6231,7 +6355,7 @@ Create a with a time range defined by the specified s and the specified - . The Calendars are subject to the following + . The Calendars are subject to the following considerations:
  • @@ -6248,6 +6372,8 @@
+ The base calendar for this calendar instance see BaseCalendar for more + information on base calendar functionality. The range starting calendar. The range ending calendar. @@ -6276,7 +6402,7 @@ Create a with a time range defined by the - specified values and the specified . The values + specified values and the specified . The values are subject to the following considerations:
  • @@ -6292,6 +6418,8 @@
+ The base calendar for this calendar instance see BaseCalendar for more + information on base calendar functionality. The range starting time in millis. The range ending time in millis. @@ -6323,7 +6451,7 @@ Returns the start time of the time range of the day - specified in . + specified in . a DateTime representing the start time of the @@ -6333,7 +6461,7 @@ Returns the end time of the time range of the day - specified in + specified in A DateTime representing the end time of the @@ -6395,7 +6523,7 @@ - Gets the end of day, pratically sets time parts to maximum allowed values. + Gets the end of day, practically sets time parts to maximum allowed values. The time. @@ -6527,7 +6655,7 @@ - Return true, if mday is defined to be exluded. + Return true, if day is defined to be excluded. @@ -6611,7 +6739,7 @@ - Return true, if wday is defined to be exluded. E. g. + Return true, if wday is defined to be excluded. E. g. saturday and sunday. @@ -6739,6 +6867,11 @@ + + + Create a GroupMatcher that matches all. + + Matches on the complete key being equal (both name and group). @@ -8391,16 +8524,21 @@ Create a with fire time dictated by the - resolved with respect to the specified - occurring from the until - the given . + resolved with respect to the specified + occurring from the until + the given . The name of the The group of the name of the executed on firetime Group of the executed on firetime - A set to the earliest time for the to start firing. + A set to the earliest time for the to start firing. A set to the time for the to quit repeat firing. + A cron expression dictating the firing sequence of the + + Specifies for which time zone the cronExpression should be interpreted, + i.e. the expression 0 0 10 * * ?, is resolved to 10:00 am in this time zone. + @@ -8597,7 +8735,7 @@ Get or sets the time at which the CronTrigger should quit - repeating - even if repeastCount isn't yet satisfied. + repeating - even if repeatCount isn't yet satisfied. @@ -8657,10 +8795,10 @@ and daysOfWeek is default to every day. The startTime default to current time-stamp now, while endTime has not value. - If startTime is before startTimeOfDay, then startTimeOfDay will be used and startTime has no affect. Else if startTime is - after startTimeOfDay, then the first fire time for that day will be the next interval after the startTime. For example, if - you set startingTimeOfDay=9am, endingTimeOfDay=11am, interval=15 mins, and startTime=9:33am, then the next fire time will - be 9:45pm. Note also that if you do not set startTime value, the trigger builder will default to current time, and current time + If startTime is before startTimeOfDay, then startTimeOfDay will be used and startTime has no affect other than to specify + the first day of firing. Else if startTime is after startTimeOfDay, then the first fire time for that day will be the next + interval after the startTime. For example, if you set startingTimeOfDay=9am, endingTimeOfDay=11am, interval=15 mins, and startTime=9:33am, + then the next fire time will be 9:45pm. Note also that if you do not set startTime value, the trigger builder will default to current time, and current time maybe before or after the startTimeOfDay! So be aware how you set your startTime. @@ -8946,9 +9084,10 @@ - + - Given fireTime time, we need to advance/calculate and return a time of next available week day. + Given fireTime time determine if it is on a valid day of week. If so, simply return it unaltered, + if not, advance to the next valid week day, and set the time of day to the start time of day. given next fireTime. flag to whether to advance day without check existing week day. This scenario @@ -9079,7 +9218,7 @@ - Get or set thhe number of times the should + Get or set the number of times the should repeat, after which it will be automatically deleted. @@ -9304,7 +9443,7 @@ - Get or set thhe number of times the should + Get or set the number of times the should repeat, after which it will be automatically deleted. @@ -10123,7 +10262,7 @@ - Create a JobExcecutionContext with the given context data. + Create a JobExecutionContext with the given context data. @@ -10294,7 +10433,7 @@ - Returns the fire instace id. + Returns the fire instance id. @@ -10925,10 +11064,9 @@ - + the unique identifier of the job instance to be interrupted (see - true if the identified job instance was found and interrupted. @@ -11041,7 +11179,7 @@ - Get a object describiing the settings + Get a object describing the settings and capabilities of the scheduler instance. Note that the data returned is an 'instantaneous' snap-shot, and that as @@ -11294,7 +11432,7 @@ JobFactories may be of use to those wishing to have their application produce instances via some special mechanism, such as to - give the opertunity for dependency injection. + give the opportunity for dependency injection. @@ -11399,6 +11537,12 @@ James House Marko Lahma (.NET) + + + Construct a instance to proxy the given + instance. + + returns true if the given JobGroup @@ -11417,7 +11561,7 @@ - Get a object describiing the settings + Get a object describing the settings and capabilities of the scheduler instance. Note that the data returned is an 'instantaneous' snap-shot, and that as @@ -11451,12 +11595,6 @@ Calls the equivalent method on the 'proxied' . - - - Construct a instance to proxy the given - instance. - - Calls the equivalent method on the 'proxied' . @@ -11730,7 +11868,7 @@ By default a properties are loaded from App.config's quartz section. If that fails, then the file is loaded "quartz.properties". If file does not exist, - default configration located (as a embedded resource) in Quartz.dll is loaded. If you + default configuration located (as a embedded resource) in Quartz.dll is loaded. If you wish to use a file other than these defaults, you must define the system property 'quartz.properties' to point to the file you want. @@ -11739,7 +11877,7 @@ information about the various settings available within the file. - Alternativly, you can explicitly Initialize the factory by calling one of + Alternatively, you can explicitly Initialize the factory by calling one of the methods before calling . @@ -12005,7 +12143,7 @@ - Ïnforms that certain file has been updated. + Informs that certain file has been updated. Name of the file. @@ -12062,7 +12200,7 @@ - Optional parameter that specifies the workling directory to be used by + Optional parameter that specifies the working directory to be used by the executed command. @@ -12139,6 +12277,15 @@ The host name of the smtp server. REQUIRED. + + The port of the smtp server. Optional. + + + Username for authenticated session. Password must also be set if username is used. Optional. + + + Password for authenticated session. Optional. + The e-mail address to send the mail to. REQUIRED. @@ -12157,6 +12304,9 @@ The e-mail message body. REQUIRED. + + The message subject and body content type. Optional. + Executes the job. @@ -12270,7 +12420,7 @@ is about to be executed. It is called after the method of this - interface. If the implementation vetos the execution (via + interface. If the implementation vetoes the execution (via returning ), the job's execute method will not be called. @@ -12347,7 +12497,7 @@ If for some reason there is a failure creating the trigger for the follow-up job (which would generally only be caused by a rare serious failure in the system, or the non-existence of the follow-up job), an error - messsage is logged, but no other action is taken. If you need more rigorous + message is logged, but no other action is taken. If you need more rigorous handling of the error, consider scheduling the triggering of the flow-up job within your job itself. @@ -12382,7 +12532,7 @@ Called by the when a is about to be executed (an associated - has occured). + has occurred). This method will not be invoked if the execution of the Job was vetoed by a . @@ -12395,7 +12545,7 @@ Called by the when a was about to be executed (an associated - has occured), but a vetoed it's + has occurred), but a vetoed it's execution. @@ -12470,7 +12620,7 @@ - Logs a history of all job executions (and execution vetos) via common + Logs a history of all job executions (and execution vetoes) via common logging. @@ -12508,7 +12658,7 @@ 4 String - The Triggers's group. + The Trigger's group. 5 @@ -12526,8 +12676,7 @@ The re-fire count from the JobExecutionContext. - The default message text is "Job {1}.{0} fired (by trigger {4}.{3}) at: - {2, date, HH:mm:ss MM/dd/yyyy" + The default message text is "Job {1}.{0} fired (by trigger {4}.{3}) at: {2:HH:mm:ss MM/dd/yyyy}" JobSuccessMessage - available message data are: @@ -12559,7 +12708,7 @@ - + @@ -12584,8 +12733,7 @@ result was set.
4 StringThe Triggers's group.The Trigger's group.
5
- The default message text is "Job {1}.{0} execution complete at {2, date, - HH:mm:ss MM/dd/yyyy} and reports: {8" + The default message text is "Job {1}.{0} execution complete at {2:HH:mm:ss MM/dd/yyyy} and reports: {8}" JobFailedMessage - available message data are: @@ -12617,7 +12765,7 @@ - + @@ -12641,8 +12789,7 @@
4 StringThe Triggers's group.The Trigger's group.
5
- The default message text is "Job {1}.{0} execution failed at {2, date, - HH:mm:ss MM/dd/yyyy} and reports: {8" + The default message text is "Job {1}.{0} execution failed at {2:HH:mm:ss MM/dd/yyyy} and reports: {8}" JobWasVetoedMessage - available message data are: @@ -12674,7 +12821,7 @@ - + @@ -12693,7 +12840,7 @@
4 StringThe Triggers's group.The Trigger's group.
5
The default message text is "Job {1}.{0} was vetoed. It was to be fired - (by trigger {4}.{3}) at: {2, date, HH:mm:ss MM/dd/yyyy" + (by trigger {4}.{3}) at: {2:HH:mm:ss MM/dd/yyyy}" Marko Lahma (.NET) @@ -12801,7 +12948,7 @@ Called by the when a was about to be executed (an associated - has occured), but a vetoed it's + has occurred), but a vetoed it's execution. @@ -13125,7 +13272,7 @@ This plugin catches the event of the VM terminating (such as upon a CRTL-C) - and tells the scheuler to Shutdown. + and tells the scheduler to Shutdown. James House @@ -13384,7 +13531,7 @@ This interface may be of use to those wishing to have their application produce instances via some special mechanism, such as to - give the opertunity for dependency injection. + give the opportunity for dependency injection. @@ -13404,7 +13551,7 @@ Scheduler will move all triggers associated with the Job into the state, which will require human intervention (e.g. an application restart after fixing whatever - configuration problem led to the issue wih instantiating the Job. + configuration problem led to the issue with instantiating the Job. The TriggerFiredBundle from which the @@ -13432,7 +13579,7 @@ Scheduler will move all triggers associated with the Job into the state, which will require human intervention (e.g. an application restart after fixing whatever - configuration problem led to the issue wih instantiating the Job. + configuration problem led to the issue with instantiating the Job. The TriggerFiredBundle from which the and other info relating to the trigger firing can be obtained. @@ -13459,7 +13606,7 @@ Scheduler will move all triggers associated with the Job into the state, which will require human intervention (e.g. an application restart after fixing whatever - configuration problem led to the issue wih instantiating the Job. + configuration problem led to the issue with instantiating the Job. The TriggerFiredBundle from which the @@ -13479,14 +13626,14 @@ Whether the JobInstantiation should fail and throw and exception if a key (name) and value (type) found in the JobDataMap does not - correspond to a proptery setter on the Job class. + correspond to a property setter on the Job class. Get or set whether a warning should be logged if a key (name) and value (type) found in the JobDataMap does not - correspond to a proptery setter on the Job class. + correspond to a property setter on the Job class. @@ -13494,7 +13641,7 @@ This class implements a that utilizes RAM as its storage device. - As you should know, the ramification of this is that access is extrememly + As you should know, the ramification of this is that access is extremely fast, but the data is completely volatile - therefore this should not be used if true persistence between program shutdowns is required. @@ -13623,7 +13770,7 @@ name and group was found and removed from the store. The to be removed. - Whether to delete orpahaned job details from scheduler if job becomes orphaned from removing the trigger. + Whether to delete orphaned job details from scheduler if job becomes orphaned from removing the trigger. @@ -13650,6 +13797,16 @@ The desired , or null if there is no match. + + + Determine whether a with the given identifier already + exists within the scheduler. + + + + the identifier to check for + true if a calendar exists with the given identifier + Determine whether a with the given identifier already @@ -14206,7 +14363,7 @@ method is called a few moments (or many moments) later. If this assumption does not hold true, it may result in extra JobStore queries and updates, and if clustering features - are being used, it may result in greater imballance of load. + are being used, it may result in greater imbalance of load. James House @@ -14403,7 +14560,7 @@ Called to give the ClassLoadHelper a chance to Initialize itself, - including the oportunity to "steal" the class loader off of the calling + including the opportunity to "steal" the class loader off of the calling thread, which is the thread that is initializing Quartz. @@ -15090,7 +15247,7 @@ Wrapper class to access thread local data. Data is either accessed from thread or HTTP Context's - data if HTTP Context is avaiable. + data if HTTP Context is available. Marko Lahma .NET @@ -15384,7 +15541,7 @@ The prefix for which to search. If it does not end in a "." then one will be added to it for search purposes. Whether to strip off the given in the result's keys. - Optional array of fully qualified prefixes to exclude. For example if is "a.b.c", then might be "a.b.c.ignore". + Optional array of fully qualified prefixes to exclude. For example if is "a.b.c", then might be "a.b.c.ignore". Group of that start with the given prefix, optionally have that prefix removed, and do not include properties that start with one of the given excluded prefixes. @@ -15605,6 +15762,21 @@ + + + TimeZoneInfo.GetUtcOffset(DateTimeOffset) is not supported under mono + + + + + + + + Tries to find time zone with given id, has ability do some fallbacks when necessary. + + System id of the time zone. + + @@ -18176,19 +18348,19 @@ - Create a JobExcecutionException, with the 're-fire immediately' flag set + Create a JobExecutionException, with the 're-fire immediately' flag set to . - Create a JobExcecutionException, with the given cause. + Create a JobExecutionException, with the given cause. The cause. - Create a JobExcecutionException, with the given message. + Create a JobExecutionException, with the given message. @@ -18200,19 +18372,19 @@ - Create a JobExcecutionException with the 're-fire immediately' flag set + Create a JobExecutionException with the 're-fire immediately' flag set to the given value. - Create a JobExcecutionException with the given underlying exception, and + Create a JobExecutionException with the given underlying exception, and the 're-fire immediately' flag set to the given value. - Create a JobExcecutionException with the given message, and underlying + Create a JobExecutionException with the given message, and underlying exception, and the 're-fire immediately' flag set to the given value. @@ -18592,14 +18764,14 @@ A constant group name used internally by the scheduler - clients should not use the value of this constant - ("RECOVERING_JOBS") for thename of a 's group. + ("RECOVERING_JOBS") for the name of a 's group. A constant group name used internally by the scheduler - clients should not use the value of this constant - ("FAILED_OVER_JOBS") for thename of a 's group. + ("FAILED_OVER_JOBS") for the name of a 's group. @@ -18645,6 +18817,12 @@ be different from the actual firing time - as a trigger doesn't always fire exactly on time. + + + A special date time to check against when signaling scheduling change when the signaled fire date suggestion is actually irrelevant. + We only want to signal the change. + + Holds context/environment data that can be made available to Jobs as they @@ -19733,7 +19911,7 @@ Compute the that is 1 second after the Nth firing of - the given , taking the triger's associated + the given , taking the trigger's associated into consideration. diff --git a/packages/log4net.1.2.10/lib/1.0/log4net.dll b/packages/log4net.1.2.10/lib/1.0/log4net.dll deleted file mode 100644 index 9e8d77b..0000000 Binary files a/packages/log4net.1.2.10/lib/1.0/log4net.dll and /dev/null differ diff --git a/packages/log4net.1.2.10/lib/1.1/log4net.dll b/packages/log4net.1.2.10/lib/1.1/log4net.dll deleted file mode 100644 index 995816f..0000000 Binary files a/packages/log4net.1.2.10/lib/1.1/log4net.dll and /dev/null differ diff --git a/packages/log4net.1.2.10/lib/2.0/log4net.dll b/packages/log4net.1.2.10/lib/2.0/log4net.dll deleted file mode 100644 index ffc57e1..0000000 Binary files a/packages/log4net.1.2.10/lib/2.0/log4net.dll and /dev/null differ diff --git a/packages/log4net.1.2.10/log4net.1.2.10.nupkg b/packages/log4net.1.2.10/log4net.1.2.10.nupkg deleted file mode 100644 index 1495fd7..0000000 Binary files a/packages/log4net.1.2.10/log4net.1.2.10.nupkg and /dev/null differ diff --git a/packages/log4net.1.2.10/lib/1.0/log4net.xml b/packages/log4net.2.0.3/lib/net10-full/log4net.xml similarity index 89% rename from packages/log4net.1.2.10/lib/1.0/log4net.xml rename to packages/log4net.2.0.3/lib/net10-full/log4net.xml index 494fb84..28907a5 100644 --- a/packages/log4net.1.2.10/lib/1.0/log4net.xml +++ b/packages/log4net.2.0.3/lib/net10-full/log4net.xml @@ -109,7 +109,7 @@ the underlying database in one go. - Subclasses should override the + Subclasses should override the method to deliver the buffered events. The BufferingAppenderSkeleton maintains a fixed size cyclic @@ -119,14 +119,14 @@ A is used to inspect each event as it arrives in the appender. If the triggers, then the current buffer is sent immediately - (see ). Otherwise the event + (see ). Otherwise the event is stored in the buffer. For example, an evaluator can be used to deliver the events immediately when an ERROR event arrives. The buffering appender can be configured in a mode. By default the appender is NOT lossy. When the buffer is full all - the buffered events are sent with . + the buffered events are sent with . If the property is set to true then the buffer will not be sent when it is full, and new events arriving in the appender will overwrite the oldest event in the buffer. @@ -152,7 +152,7 @@ Appenders can also implement the interface. Therefore - they would require that the method + they would require that the method be called after the appenders properties have been configured. @@ -170,7 +170,7 @@ Appenders can also implement the interface. Therefore - they would require that the method + they would require that the method be called after the appenders properties have been configured. @@ -178,38 +178,38 @@ Gert Driesen - - Closes the appender and releases resources. - - - - Releases any resources allocated within the appender such as file handles, - network connections, etc. - - - It is a programming error to append to a closed appender. - - + + Closes the appender and releases resources. + + + + Releases any resources allocated within the appender such as file handles, + network connections, etc. + + + It is a programming error to append to a closed appender. + + - - Log the logging event in Appender specific way. - - The event to log - - - This method is called to log a message into this appender. - - + + Log the logging event in Appender specific way. + + The event to log + + + This method is called to log a message into this appender. + + - - Gets or sets the name of this appender. - - The name of the appender. - - The name uniquely identifies the appender. - + + Gets or sets the name of this appender. + + The name of the appender. + + The name uniquely identifies the appender. + @@ -225,15 +225,15 @@ Nicko Cadell - - Log the array of logging events in Appender specific way. - - The events to log - - - This method is called to log an array of events into this appender. - - + + Log the array of logging events in Appender specific way. + + The events to log + + + This method is called to log an array of events into this appender. + + @@ -254,38 +254,38 @@ Nicko Cadell - - Activate the options that were previously set with calls to properties. - - - - This allows an object to defer activation of its options until all - options have been set. This is required for components which have - related options that remain ambiguous until all are set. - - - If a component implements this interface then this method must be called - after its properties have been set before the component can be used. - - + + Activate the options that were previously set with calls to properties. + + + + This allows an object to defer activation of its options until all + options have been set. This is required for components which have + related options that remain ambiguous until all are set. + + + If a component implements this interface then this method must be called + after its properties have been set before the component can be used. + + - - Initial buffer size - + + Initial buffer size + - - Maximum buffer size before it is recycled - + + Maximum buffer size before it is recycled + - - Default constructor - - - Empty default constructor - + + Default constructor + + + Empty default constructor + @@ -340,13 +340,13 @@ Performs threshold checks and invokes filters before delegating actual logging to the subclasses specific - method. + method. The event to log. This method cannot be overridden by derived classes. A - derived class should override the method + derived class should override the method which is called by this method. @@ -368,14 +368,14 @@ - Calls and checks that + Calls and checks that it returns true. If all of the above steps succeed then the - will be passed to the abstract method. + will be passed to the abstract method. @@ -383,13 +383,13 @@ Performs threshold checks and invokes filters before delegating actual logging to the subclasses specific - method. + method. The array of events to log. This method cannot be overridden by derived classes. A - derived class should override the method + derived class should override the method which is called by this method. @@ -399,26 +399,26 @@ - Checks that the severity of the + Checks that the severity of the is greater than or equal to the of this appender. Checks that the chain accepts the - . + . - Calls and checks that + Calls and checks that it returns true. If all of the above steps succeed then the - will be passed to the method. + will be passed to the method. @@ -456,29 +456,29 @@ - - Adds a filter to the end of the filter chain. - - the filter to add to this appender - - - The Filters are organized in a linked list. - - - Setting this property causes the new filter to be pushed onto the - back of the filter chain. - - + + Adds a filter to the end of the filter chain. + + the filter to add to this appender + + + The Filters are organized in a linked list. + + + Setting this property causes the new filter to be pushed onto the + back of the filter chain. + + - - Clears the filter list for this appender. - - - - Clears the filter list for this appender. - - + + Clears the filter list for this appender. + + + + Clears the filter list for this appender. + + @@ -496,19 +496,19 @@ - - Is called when the appender is closed. Derived classes should override - this method if resources need to be released. - - - - Releases any resources allocated within the appender such as file handles, - network connections, etc. - - - It is a programming error to append to a closed appender. - - + + Is called when the appender is closed. Derived classes should override + this method if resources need to be released. + + + + Releases any resources allocated within the appender such as file handles, + network connections, etc. + + + It is a programming error to append to a closed appender. + + @@ -521,50 +521,50 @@ A subclass must implement this method to perform logging of the . - This method will be called by + This method will be called by if all the conditions listed for that method are met. To restrict the logging of events in the appender - override the method. + override the method. - - Append a bulk array of logging events. - - the array of logging events - - - This base class implementation calls the - method for each element in the bulk array. - - - A sub class that can better process a bulk array of events should - override this method in addition to . - - + + Append a bulk array of logging events. + + the array of logging events + + + This base class implementation calls the + method for each element in the bulk array. + + + A sub class that can better process a bulk array of events should + override this method in addition to . + + - - Called before as a precondition. - - - - This method is called by - before the call to the abstract method. - - - This method can be overridden in a subclass to extend the checks - made before the event is passed to the method. - - - A subclass should ensure that they delegate this call to - this base class if it is overridden. - - - true if the call to should proceed. + + Called before as a precondition. + + + + This method is called by + before the call to the abstract method. + + + This method can be overridden in a subclass to extend the checks + made before the event is passed to the method. + + + A subclass should ensure that they delegate this call to + this base class if it is overridden. + + + true if the call to should proceed. @@ -585,7 +585,7 @@ Where possible use the alternative version of this method - . + . That method streams the rendering onto an existing Writer which can give better performance if the caller already has a open and ready for writing. @@ -610,9 +610,9 @@ will append the exception text to the rendered string. - Use this method in preference to + Use this method in preference to where possible. If, however, the caller needs to render the event - to a string then does + to a string then does provide an efficient mechanism for doing so. @@ -689,14 +689,23 @@ - - The guard prevents an appender from repeatedly calling its own DoAppend method - + + The guard prevents an appender from repeatedly calling its own DoAppend method + - - StringWriter used to render events - + + StringWriter used to render events + + + + + The fully qualified type of the AppenderSkeleton class. + + + Used by the internal logger to record the Type of the + log message. + @@ -730,16 +739,16 @@ - - The filter chain. - - The head of the filter chain filter chain. - - - Returns the head Filter. The Filters are organized in a linked list - and so all Filters on this Appender are available through the result. - - + + The filter chain. + + The head of the filter chain filter chain. + + + Returns the head Filter. The Filters are organized in a linked list + and so all Filters on this Appender are available through the result. + + @@ -754,15 +763,15 @@ - - Gets or sets the name of this appender. - - The name of the appender. - - - The name uniquely identifies the appender. - - + + Gets or sets the name of this appender. + + The name of the appender. + + + The name uniquely identifies the appender. + + @@ -775,7 +784,7 @@ then the appender should return true. - This default implementation always returns true. + This default implementation always returns false. @@ -783,13 +792,13 @@ - - The default buffer size. - - - The default size of the cyclic buffer used to store events. - This is set to 512 by default. - + + The default buffer size. + + + The default size of the cyclic buffer used to store events. + This is set to 512 by default. + @@ -887,7 +896,7 @@ - This method is called by the method. + This method is called by the method. the event to log @@ -911,34 +920,34 @@ Before the event is stored in the buffer it is fixed - (see ) to ensure that + (see ) to ensure that any data referenced by the event will be valid when the buffer is processed. - - Sends the contents of the buffer. - - The first logging event. - The buffer containing the events that need to be send. - - - The subclass must override . - - + + Sends the contents of the buffer. + + The first logging event. + The buffer containing the events that need to be send. + + + The subclass must override . + + - - Sends the events. - - The events that need to be send. - - - The subclass must override this method to process the buffered events. - - + + Sends the events. + + The events that need to be send. + + + The subclass must override this method to process the buffered events. + + @@ -949,9 +958,9 @@ - - The cyclic buffer used to store the logging events. - + + The cyclic buffer used to store the logging events. + @@ -978,28 +987,28 @@ - - The triggering event evaluator filters discarded events. - - - The object that is used to determine if an event that is discarded should - really be discarded or if it should be sent to the appenders. - This field can be null, which indicates that all discarded events will - be discarded. - + + The triggering event evaluator filters discarded events. + + + The object that is used to determine if an event that is discarded should + really be discarded or if it should be sent to the appenders. + This field can be null, which indicates that all discarded events will + be discarded. + - - Value indicating which fields in the event should be fixed - - - By default all fields are fixed - + + Value indicating which fields in the event should be fixed + + + By default all fields are fixed + - - The events delivered to the subclass must be fixed. - + + The events delivered to the subclass must be fixed. + @@ -1059,7 +1068,7 @@ The evaluator will be called for each event that is appended to this appender. If the evaluator triggers then the current buffer will - immediately be sent (see ). + immediately be sent (see ). If is set to true then an must be specified. @@ -1076,28 +1085,28 @@ The evaluator will be called for each event that is discarded from this appender. If the evaluator triggers then the current buffer will immediately - be sent (see ). + be sent (see ). - - Gets or sets a value indicating if only part of the logging event data - should be fixed. - - - true if the appender should only fix part of the logging event - data, otherwise false. The default is false. - - - - Setting this property to true will cause only part of the - event data to be fixed and serialized. This will improve performance. - - - See for more information. - - + + Gets or sets a value indicating if only part of the logging event data + should be fixed. + + + true if the appender should only fix part of the logging event + data, otherwise false. The default is false. + + + + Setting this property to true will cause only part of the + event data to be fixed and serialized. This will improve performance. + + + See for more information. + + @@ -1142,37 +1151,37 @@ - - Override the parent method to close the database - - - - Closes the database command and database connection. - - + + Override the parent method to close the database + + + + Closes the database command and database connection. + + - - Inserts the events into the database. - - The events to insert into the database. - - - Insert all the events specified in the - array into the database. - - + + Inserts the events into the database. + + The events to insert into the database. + + + Insert all the events specified in the + array into the database. + + - - Adds a parameter to the command. - - The parameter to add to the command. - - - Adds a parameter to the ordered list of command parameters. - - + + Adds a parameter to the command. + + The parameter to add to the command. + + + Adds a parameter to the ordered list of command parameters. + + @@ -1201,10 +1210,27 @@ Text that can be passed to a . - + - Connects to the database. - + Creates an instance used to connect to the database. + + + This method is called whenever a new IDbConnection is needed (i.e. when a reconnect is necessary). + + The of the object. + The connectionString output from the ResolveConnectionString method. + An instance with a valid connection string. + + + + Resolves the connection string from the ConnectionString, ConnectionStringName, or AppSettingsKey + property. + + + ConnectiongStringName is only supported on .NET 2.0 and higher. + + Additional information describing the connection string. + A connection string used to connect to the database. @@ -1224,21 +1250,42 @@ The of the ADO.NET provider - - Prepares the database command and initialize the parameters. - + + Prepares the database command and initialize the parameters. + - + + + Connects to the database. + + + + + Cleanup the existing command. + + + If true, a message will be written using LogLog.Warn if an exception is encountered when calling Dispose. + + + - Flag to indicate if we are using a command object + Cleanup the existing connection. - - Set to true when the appender is to use a prepared - statement or stored procedure to insert into the database. - + Calls the IDbConnection's method. + + + Flag to indicate if we are using a command object + + + + Set to true when the appender is to use a prepared + statement or stored procedure to insert into the database. + + + The list of objects. @@ -1250,9 +1297,9 @@ - - The security context to use for privileged calls - + + The security context to use for privileged calls + @@ -1261,14 +1308,19 @@ - - The database command. - + + The database command. + - - Database connection string. - + + Database connection string. + + + + + The appSettings key from App.Config that contains the connection string. + @@ -1276,24 +1328,33 @@ - - The text of the command. - + + The text of the command. + - - The command type. - + + The command type. + - - Indicates whether to use transactions when writing to the database. - + + Indicates whether to use transactions when writing to the database. + - - Indicates whether to use transactions when writing to the database. - + + Indicates whether to use transactions when writing to the database. + + + + + The fully qualified type of the AdoNetAppender class. + + + Used by the internal logger to record the Type of the + log message. + @@ -1319,6 +1380,11 @@ "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;" + + + The appSettings key from App.Config that contains the connection string. + + Gets or sets the type name of the connection @@ -1395,24 +1461,24 @@ - - Should transactions be used to insert logging events in the database. - - - true if transactions should be used to insert logging events in - the database, otherwise false. The default value is true. - - - - Gets or sets a value that indicates whether transactions should be used - to insert logging events in the database. - - - When set a single transaction will be used to insert the buffered events - into the database. Otherwise each event will be inserted without using - an explicit transaction. - - + + Should transactions be used to insert logging events in the database. + + + true if transactions should be used to insert logging events in + the database, otherwise false. The default value is true. + + + + Gets or sets a value that indicates whether transactions should be used + to insert logging events in the database. + + + When set a single transaction will be used to insert the buffered events + into the database. Otherwise each event will be inserted without using + an explicit transaction. + + @@ -1431,30 +1497,30 @@ - - Should this appender try to reconnect to the database on error. - - - true if the appender should try to reconnect to the database after an - error has occurred, otherwise false. The default value is false, - i.e. not to try to reconnect. - - - - The default behaviour is for the appender not to try to reconnect to the - database if an error occurs. Subsequent logging events are discarded. - - - To force the appender to attempt to reconnect to the database set this - property to true. - - - When the appender attempts to connect to the database there may be a - delay of up to the connection timeout specified in the connection string. - This delay will block the calling application's thread. - Until the connection can be reestablished this potential delay may occur multiple times. - - + + Should this appender try to reconnect to the database on error. + + + true if the appender should try to reconnect to the database after an + error has occurred, otherwise false. The default value is false, + i.e. not to try to reconnect. + + + + The default behaviour is for the appender not to try to reconnect to the + database if an error occurs. Subsequent logging events are discarded. + + + To force the appender to attempt to reconnect to the database set this + property to true. + + + When the appender attempts to connect to the database there may be a + delay of up to the connection timeout specified in the connection string. + This delay will block the calling application's thread. + Until the connection can be reestablished this potential delay may occur multiple times. + + @@ -1495,59 +1561,59 @@ - - Prepare the specified database command object. - - The command to prepare. - - - Prepares the database command object by adding - this parameter to its collection of parameters. - - + + Prepare the specified database command object. + + The command to prepare. + + + Prepares the database command object by adding + this parameter to its collection of parameters. + + - - Renders the logging event and set the parameter value in the command. - - The command containing the parameter. - The event to be rendered. - - - Renders the logging event using this parameters layout - object. Sets the value of the parameter on the command object. - - + + Renders the logging event and set the parameter value in the command. + + The command containing the parameter. + The event to be rendered. + + + Renders the logging event using this parameters layout + object. Sets the value of the parameter on the command object. + + - - The name of this parameter. - + + The name of this parameter. + - - The database type for this parameter. - + + The database type for this parameter. + - - Flag to infer type rather than use the DbType - + + Flag to infer type rather than use the DbType + - - The precision for this parameter. - + + The precision for this parameter. + - - The scale for this parameter. - + + The scale for this parameter. + - - The size for this parameter. - + + The size for this parameter. + @@ -1556,19 +1622,19 @@ - - Gets or sets the name of this parameter. - - - The name of this parameter. - - - - The name of this parameter. The parameter name - must match up to a named parameter to the SQL stored procedure - or prepared statement. - - + + Gets or sets the name of this parameter. + + + The name of this parameter. + + + + The name of this parameter. The parameter name + must match up to a named parameter to the SQL stored procedure + or prepared statement. + + @@ -1641,6 +1707,9 @@ This property is optional. If not specified the ADO.NET provider will attempt to infer the size from the value. + + For BLOB data types like VARCHAR(max) it may be impossible to infer the value automatically, use -1 as the size in this case. + @@ -1767,9 +1836,9 @@ - - Ansi code to reset terminal - + + Ansi code to reset terminal + @@ -1794,53 +1863,53 @@ - - This method is called by the method. - - The event to log. - - - Writes the event to the console. - - - The format of the output will depend on the appender's layout. - - + + This method is called by the method. + + The event to log. + + + Writes the event to the console. + + + The format of the output will depend on the appender's layout. + + - - Initialize the options for this appender - - - - Initialize the level to color mappings set on this appender. - - + + Initialize the options for this appender + + + + Initialize the level to color mappings set on this appender. + + - - Flag to write output to the error stream rather than the standard output stream - + + Flag to write output to the error stream rather than the standard output stream + - - Mapping from level object to color value - + + Mapping from level object to color value + - - Target is the value of the console output stream. - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - + + Target is the value of the console output stream. + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + @@ -1866,42 +1935,47 @@ - - text is bright - + + text is bright + - - text is dim - + + text is dim + - - text is underlined - + + text is underlined + - - text is blinking - - - Not all terminals support this attribute - + + text is blinking + + + Not all terminals support this attribute + - - text and background colors are reversed - + + text and background colors are reversed + - - text is hidden - + + text is hidden + - - text is displayed with a strikethrough - + + text is displayed with a strikethrough + + + + + text color is light + @@ -1916,55 +1990,55 @@ - - color is black - + + color is black + - - color is red - + + color is red + - - color is green - + + color is green + - - color is yellow - + + color is yellow + - - color is blue - + + color is blue + - - color is magenta - + + color is magenta + - - color is cyan - + + color is cyan + - - color is white - + + color is white + - - A class to act as a mapping between the level that a logging call is made at and - the color it should be displayed as. - - - - Defines the mapping between a level and the color it should be displayed in. - - + + A class to act as a mapping between the level that a logging call is made at and + the color it should be displayed as. + + + + Defines the mapping between a level and the color it should be displayed in. + + @@ -1979,24 +2053,24 @@ Nicko Cadell - - Default protected constructor - - - - Default protected constructor - - + + Default protected constructor + + + + Default protected constructor + + - - Initialize any options defined on this entry - - - - Should be overridden by any classes that need to initialise based on their options - - + + Initialize any options defined on this entry + + + + Should be overridden by any classes that need to initialise based on their options + + @@ -2024,37 +2098,37 @@ - - The mapped foreground color for the specified level - - - - Required property. - The mapped foreground color for the specified level - - + + The mapped foreground color for the specified level + + + + Required property. + The mapped foreground color for the specified level + + - - The mapped background color for the specified level - - - - Required property. - The mapped background color for the specified level - - + + The mapped background color for the specified level + + + + Required property. + The mapped background color for the specified level + + - - The color attributes for the specified level - - - - Required property. - The color attributes for the specified level - - + + The color attributes for the specified level + + + + Required property. + The color attributes for the specified level + + @@ -2069,40 +2143,40 @@ Nicko Cadell - - Creates a read-only wrapper for a AppenderCollection instance. - - list to create a readonly wrapper arround - - An AppenderCollection wrapper that is read-only. - + + Creates a read-only wrapper for a AppenderCollection instance. + + list to create a readonly wrapper arround + + An AppenderCollection wrapper that is read-only. + - - An empty readonly static AppenderCollection - + + An empty readonly static AppenderCollection + - - Initializes a new instance of the AppenderCollection class - that is empty and has the default initial capacity. - + + Initializes a new instance of the AppenderCollection class + that is empty and has the default initial capacity. + - - Initializes a new instance of the AppenderCollection class - that has the specified initial capacity. - - - The number of elements that the new AppenderCollection is initially capable of storing. - + + Initializes a new instance of the AppenderCollection class + that has the specified initial capacity. + + + The number of elements that the new AppenderCollection is initially capable of storing. + - - Initializes a new instance of the AppenderCollection class - that contains elements copied from the specified AppenderCollection. - - The AppenderCollection whose elements are copied to the new collection. + + Initializes a new instance of the AppenderCollection class + that contains elements copied from the specified AppenderCollection. + + The AppenderCollection whose elements are copied to the new collection. @@ -2119,11 +2193,11 @@ The collection whose elements are copied to the new list. - - Allow subclasses to avoid our default constructors - - - + + Allow subclasses to avoid our default constructors + + + @@ -2148,9 +2222,9 @@ The index at which the value has been added. - - Removes all elements from the AppenderCollection. - + + Removes all elements from the AppenderCollection. + @@ -2236,45 +2310,45 @@ The new of the AppenderCollection. - - Sets the capacity to the actual number of elements. - + + Sets the capacity to the actual number of elements. + - - Return the collection elements as an array - - the array + + Return the collection elements as an array + + the array - is less than zero + is less than zero -or- - is equal to or greater than . + is equal to or greater than . - is less than zero + is less than zero -or- - is equal to or greater than . + is equal to or greater than . - - Gets the number of elements actually contained in the AppenderCollection. - + + Gets the number of elements actually contained in the AppenderCollection. + - - Gets a value indicating whether access to the collection is synchronized (thread-safe). - - true if access to the ICollection is synchronized (thread-safe); otherwise, false. + + Gets a value indicating whether access to the collection is synchronized (thread-safe). + + true if access to the ICollection is synchronized (thread-safe); otherwise, false. - - Gets an object that can be used to synchronize access to the collection. - + + Gets an object that can be used to synchronize access to the collection. + @@ -2288,21 +2362,21 @@ - - Gets a value indicating whether the collection has a fixed size. - - true if the collection has a fixed size; otherwise, false. The default is false + + Gets a value indicating whether the collection has a fixed size. + + true if the collection has a fixed size; otherwise, false. The default is false - - Gets a value indicating whether the IList is read-only. - - true if the collection is read-only; otherwise, false. The default is false + + Gets a value indicating whether the IList is read-only. + + true if the collection is read-only; otherwise, false. The default is false - - Gets or sets the number of elements the AppenderCollection can contain. - + + Gets or sets the number of elements the AppenderCollection can contain. + @@ -2323,26 +2397,26 @@ - - Sets the enumerator to its initial position, before the first element in the collection. - + + Sets the enumerator to its initial position, before the first element in the collection. + - - Gets the current element in the collection. - + + Gets the current element in the collection. + - - Type visible only to our subclasses - Used to access protected constructor - - + + Type visible only to our subclasses + Used to access protected constructor + + - - A value - + + A value + @@ -2351,10 +2425,10 @@ - - Initializes a new instance of the Enumerator class. - - + + Initializes a new instance of the Enumerator class. + + @@ -2369,17 +2443,17 @@ - - Sets the enumerator to its initial position, before the first element in the collection. - + + Sets the enumerator to its initial position, before the first element in the collection. + - - Gets the current element in the collection. - + + Gets the current element in the collection. + - + @@ -2399,12 +2473,14 @@ whether tracing is displayed to a page, to the trace viewer, or both. - The logging event is passed to the or - method depending on the level of the logging event. + The logging event is passed to the or + method depending on the level of the logging event. + The event's logger name is the default value for the category parameter of the Write/Warn method. Nicko Cadell Gert Driesen + Ron Grabowski @@ -2429,6 +2505,11 @@ + + + Defaults to %logger + + This appender requires a to be set. @@ -2440,6 +2521,19 @@ + + + The category parameter sent to the Trace method. + + + + Defaults to %logger which will use the logger name of the current + as the category parameter. + + + + + Buffers events and then forwards them to attached appenders. @@ -2460,55 +2554,55 @@ Gert Driesen - - Interface for attaching appenders to objects. - - - - Interface for attaching, removing and retrieving appenders. - - - Nicko Cadell - Gert Driesen + + Interface for attaching appenders to objects. + + + + Interface for attaching, removing and retrieving appenders. + + + Nicko Cadell + Gert Driesen - - Attaches an appender. - - The appender to add. - - - Add the specified appender. The implementation may - choose to allow or deny duplicate appenders. - - + + Attaches an appender. + + The appender to add. + + + Add the specified appender. The implementation may + choose to allow or deny duplicate appenders. + + - - Gets an attached appender with the specified name. - - The name of the appender to get. - - The appender with the name specified, or null if no appender with the - specified name is found. - - - - Returns an attached appender with the specified. - If no appender with the specified name is found null will be - returned. - - + + Gets an attached appender with the specified name. + + The name of the appender to get. + + The appender with the name specified, or null if no appender with the + specified name is found. + + + + Returns an attached appender with the specified. + If no appender with the specified name is found null will be + returned. + + - - Removes all attached appenders. - - - - Removes and closes all attached appenders - - + + Removes all attached appenders. + + + + Removes and closes all attached appenders + + @@ -2539,20 +2633,20 @@ - - Gets all attached appenders. - - - A collection of attached appenders. - - - - Gets a collection of attached appenders. - If there are no attached appenders the - implementation should return an empty - collection rather than null. - - + + Gets all attached appenders. + + + A collection of attached appenders. + + + + Gets a collection of attached appenders. + If there are no attached appenders the + implementation should return an empty + collection rather than null. + + @@ -2565,29 +2659,29 @@ - - Closes the appender and releases resources. - - - - Releases any resources allocated within the appender such as file handles, - network connections, etc. - - - It is a programming error to append to a closed appender. - - + + Closes the appender and releases resources. + + + + Releases any resources allocated within the appender such as file handles, + network connections, etc. + + + It is a programming error to append to a closed appender. + + - - Send the events. - - The events that need to be send. - - - Forwards the events to the attached appenders. - - + + Send the events. + + The events that need to be send. + + + Forwards the events to the attached appenders. + + @@ -2603,28 +2697,28 @@ - - Looks for the appender with the specified name. - - The name of the appender to lookup. - - The appender with the specified name, or null. - - - - Get the named appender attached to this buffering appender. - - + + Looks for the appender with the specified name. + + The name of the appender to lookup. + + The appender with the specified name, or null. + + + + Get the named appender attached to this buffering appender. + + - - Removes all previously added appenders from this appender. - - - - This is useful when re-reading configuration information. - - + + Removes all previously added appenders from this appender. + + + + This is useful when re-reading configuration information. + + @@ -2796,73 +2890,73 @@ - - This method is called by the method. - - The event to log. - - - Writes the event to the console. - - - The format of the output will depend on the appender's layout. - - + + This method is called by the method. + + The event to log. + + + Writes the event to the console. + + + The format of the output will depend on the appender's layout. + + - - Initialize the options for this appender - - - - Initialize the level to color mappings set on this appender. - - + + Initialize the options for this appender + + + + Initialize the level to color mappings set on this appender. + + - - Flag to write output to the error stream rather than the standard output stream - + + Flag to write output to the error stream rather than the standard output stream + - - Mapping from level object to color value - + + Mapping from level object to color value + + + The console output stream writer to write to + + + + This writer is not thread safe. + + + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + - The console output stream writer to write to + This appender requires a to be set. + true - This writer is not thread safe. - - - - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - - - - This appender requires a to be set. - - true - - - This appender requires a to be set. + This appender requires a to be set. @@ -2879,55 +2973,55 @@ - - color is blue - + + color is blue + - - color is green - + + color is green + - - color is red - + + color is red + - - color is white - + + color is white + - - color is yellow - + + color is yellow + - - color is purple - + + color is purple + - - color is cyan - + + color is cyan + - - color is intensified - + + color is intensified + - - A class to act as a mapping between the level that a logging call is made at and - the color it should be displayed as. - - - - Defines the mapping between a level and the color it should be displayed in. - - + + A class to act as a mapping between the level that a logging call is made at and + the color it should be displayed as. + + + + Defines the mapping between a level and the color it should be displayed in. + + @@ -2940,26 +3034,26 @@ - - The mapped foreground color for the specified level - - - - Required property. - The mapped foreground color for the specified level. - - + + The mapped foreground color for the specified level + + + + Required property. + The mapped foreground color for the specified level. + + - - The mapped background color for the specified level - - - - Required property. - The mapped background color for the specified level. - - + + The mapped background color for the specified level + + + + Required property. + The mapped background color for the specified level. + + @@ -3051,34 +3145,34 @@ - - This method is called by the method. - - The event to log. - - - Writes the event to the console. - - - The format of the output will depend on the appender's layout. - - + + This method is called by the method. + + The event to log. + + + Writes the event to the console. + + + The format of the output will depend on the appender's layout. + + - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + @@ -3103,7 +3197,7 @@ debug system. - Events are written using the + Events are written using the method. The event's logger name is passed as the value for the category name to the Write method. @@ -3162,24 +3256,24 @@ - - Gets or sets a value that indicates whether the appender will - flush at the end of each write. - - - The default behavior is to flush at the end of each - write. If the option is set tofalse, then the underlying - stream can defer writing to physical medium to a later time. - - - Avoiding the flush operation at the end of each append results - in a performance gain of 10 to 20 percent. However, there is safety - trade-off involved in skipping flushing. Indeed, when flushing is - skipped, then it is likely that the last few log events will not - be recorded on disk when the application exits. This is a high - price to pay even for a 20% performance gain. - - + + Gets or sets a value that indicates whether the appender will + flush at the end of each write. + + + The default behavior is to flush at the end of each + write. If the option is set tofalse, then the underlying + stream can defer writing to physical medium to a later time. + + + Avoiding the flush operation at the end of each append results + in a performance gain of 10 to 20 percent. However, there is safety + trade-off involved in skipping flushing. Indeed, when flushing is + skipped, then it is likely that the last few log events will not + be recorded on disk when the application exits. This is a high + price to pay even for a 20% performance gain. + + @@ -3198,8 +3292,17 @@ + The appender will fail if you try to write using an event source that doesn't exist unless it is running with local administrator privileges. + See also http://logging.apache.org/log4net/release/faq.html#trouble-EventLog + + The EventID of the event log entry can be - set using the EventLogEventID property () + set using the EventID property () + on the . + + + The Category of the event log entry can be + set using the Category property () on the . @@ -3288,16 +3391,16 @@ - - Create an event log source - - - Uses different API calls under NET_2_0 - + + Create an event log source + + + Uses different API calls under NET_2_0 + - This method is called by the + This method is called by the method. the event to log @@ -3315,10 +3418,10 @@ - Get the equivalent for a + Get the equivalent for a the Level to convert to an EventLogEntryType - The equivalent for a + The equivalent for a Because there are fewer applicable values to use in logging levels than there are in the @@ -3327,10 +3430,10 @@ - - The log name is the section in the event logs where the messages - are stored. - + + The log name is the section in the event logs where the messages + are stored. + @@ -3339,20 +3442,102 @@ - - The name of the machine which holds the event log. This is - currently only allowed to be '.' i.e. the current machine. - + + The name of the machine which holds the event log. This is + currently only allowed to be '.' i.e. the current machine. + - - Mapping from level object to EventLogEntryType - + + Mapping from level object to EventLogEntryType + - - The security context to use for privileged calls - + + The security context to use for privileged calls + + + + + The event ID to use unless one is explicitly specified via the LoggingEvent's properties. + + + + + The event category to use unless one is explicitly specified via the LoggingEvent's properties. + + + + + The fully qualified type of the EventLogAppender class. + + + Used by the internal logger to record the Type of the + log message. + + + + + The maximum size supported by default. + + + http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx + The 32766 documented max size is two bytes shy of 32K (I'm assuming 32766 + may leave space for a two byte null terminator of #0#0). The 32766 max + length is what the .NET 4.0 source code checks for, but this is WRONG! + Strings with a length > 31839 on Windows Vista or higher can CORRUPT + the event log! See: System.Diagnostics.EventLogInternal.InternalWriteEvent() + for the use of the 32766 max size. + + + + + The maximum size supported by a windows operating system that is vista + or newer. + + + See ReportEvent API: + http://msdn.microsoft.com/en-us/library/aa363679(VS.85).aspx + ReportEvent's lpStrings parameter: + "A pointer to a buffer containing an array of + null-terminated strings that are merged into the message before Event Viewer + displays the string to the user. This parameter must be a valid pointer + (or NULL), even if wNumStrings is zero. Each string is limited to 31,839 characters." + + Going beyond the size of 31839 will (at some point) corrupt the event log on Windows + Vista or higher! It may succeed for a while...but you will eventually run into the + error: "System.ComponentModel.Win32Exception : A device attached to the system is + not functioning", and the event log will then be corrupt (I was able to corrupt + an event log using a length of 31877 on Windows 7). + + The max size for Windows Vista or higher is documented here: + http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx. + Going over this size may succeed a few times but the buffer will overrun and + eventually corrupt the log (based on testing). + + The maxEventMsgSize size is based on the max buffer size of the lpStrings parameter of the ReportEvent API. + The documented max size for EventLog.WriteEntry for Windows Vista and higher is 31839, but I'm leaving room for a + terminator of #0#0, as we cannot see the source of ReportEvent (though we could use an API monitor to examine the + buffer, given enough time). + + + + + The maximum size that the operating system supports for + a event log message. + + + Used to determine the maximum string length that can be written + to the operating system event log and eventually truncate a string + that exceeds the limits. + + + + + This method determines the maximum event log message size allowed for + the current environment. + + @@ -3375,31 +3560,31 @@ - - Property used to set the Application name. This appears in the - event logs when logging. - - - The string used to distinguish events from different sources. - - - Sets the event log source property. - + + Property used to set the Application name. This appears in the + event logs when logging. + + + The string used to distinguish events from different sources. + + + Sets the event log source property. + - - This property is used to return the name of the computer to use - when accessing the event logs. Currently, this is the current - computer, denoted by a dot "." - - - The string name of the machine holding the event log that - will be logged into. - - - This property cannot be changed. It is currently set to '.' - i.e. the local machine. This may be changed in future. - + + This property is used to return the name of the computer to use + when accessing the event logs. Currently, this is the current + computer, denoted by a dot "." + + + The string name of the machine holding the event log that + will be logged into. + + + This property cannot be changed. It is currently set to '.' + i.e. the local machine. This may be changed in future. + @@ -3420,28 +3605,54 @@ - + - This appender requires a to be set. + Gets or sets the EventId to use unless one is explicitly specified via the LoggingEvent's properties. - true - This appender requires a to be set. + The EventID of the event log entry will normally be + set using the EventID property () + on the . + This property provides the fallback value which defaults to 0. - + + + Gets or sets the Category to use unless one is explicitly specified via the LoggingEvent's properties. + + + + The Category of the event log entry will normally be + set using the Category property () + on the . + This property provides the fallback value which defaults to 0. + + + + - A class to act as a mapping between the level that a logging call is made at and - the color it should be displayed as. + This appender requires a to be set. + true - Defines the mapping between a level and its event log entry type. + This appender requires a to be set. + + + A class to act as a mapping between the level that a logging call is made at and + the color it should be displayed as. + + + + Defines the mapping between a level and its event log entry type. + + + The for this entry @@ -3488,8 +3699,13 @@ the property. The default behavior, implemented by is to obtain an exclusive write lock on the file until this appender is closed. - The alternative model, , only holds a - write lock while the appender is writing a logging event. + The alternative models only hold a + write lock while the appender is writing a logging event () + or synchronize by using a named system wide Mutex (). + + + All locking strategies have issues and you should seriously consider using a different strategy that + avoids having multiple processes logging to the same file. Nicko Cadell @@ -3557,53 +3773,53 @@ - - This method determines if there is a sense in attempting to append. - - - - This method checked if an output target has been set and if a - layout has been set. - - - false if any of the preconditions fail. + + This method determines if there is a sense in attempting to append. + + + + This method checks if an output target has been set and if a + layout has been set. + + + false if any of the preconditions fail. - - This method is called by the - method. - - The event to log. - - - Writes a log statement to the output stream if the output stream exists - and is writable. - - - The format of the output will depend on the appender's layout. - - + + This method is called by the + method. + + The event to log. + + + Writes a log statement to the output stream if the output stream exists + and is writable. + + + The format of the output will depend on the appender's layout. + + - - This method is called by the - method. - - The array of events to log. - - - This method writes all the bulk logged events to the output writer - before flushing the stream. - - + + This method is called by the + method. + + The array of events to log. + + + This method writes all the bulk logged events to the output writer + before flushing the stream. + + - - Close this appender instance. The underlying stream or writer is also closed. - - - Closed appenders cannot be reused. - + + Close this appender instance. The underlying stream or writer is also closed. + + + Closed appenders cannot be reused. + @@ -3692,30 +3908,39 @@ + + + The fully qualified type of the TextWriterAppender class. + + + Used by the internal logger to record the Type of the + log message. + + - - Gets or set whether the appender will flush at the end - of each append operation. - - - - The default behavior is to flush at the end of each - append operation. - - - If this option is set to false, then the underlying - stream can defer persisting the logging event to a later - time. - - - - Avoiding the flush operation at the end of each append results in - a performance gain of 10 to 20 percent. However, there is safety - trade-off involved in skipping flushing. Indeed, when flushing is - skipped, then it is likely that the last few log events will not - be recorded on disk when the application exits. This is a high - price to pay even for a 20% performance gain. - + + Gets or set whether the appender will flush at the end + of each append operation. + + + + The default behavior is to flush at the end of each + append operation. + + + If this option is set to false, then the underlying + stream can defer persisting the logging event to a later + time. + + + + Avoiding the flush operation at the end of each append results in + a performance gain of 10 to 20 percent. However, there is safety + trade-off involved in skipping flushing. Indeed, when flushing is + skipped, then it is likely that the last few log events will not + be recorded on disk when the application exits. This is a high + price to pay even for a 20% performance gain. + @@ -3770,40 +3995,40 @@ - - Default constructor - - - - Default constructor - - + + Default constructor + + + + Default constructor + + - - Construct a new appender using the layout, file and append mode. - - the layout to use with this appender - the full path to the file to write to - flag to indicate if the file should be appended to - - - Obsolete constructor. - - + + Construct a new appender using the layout, file and append mode. + + the layout to use with this appender + the full path to the file to write to + flag to indicate if the file should be appended to + + + Obsolete constructor. + + - - Construct a new appender using the layout and file specified. - The file will be appended to. - - the layout to use with this appender - the full path to the file to write to - - - Obsolete constructor. - - + + Construct a new appender using the layout and file specified. + The file will be appended to. + + the layout to use with this appender + the full path to the file to write to + + + Obsolete constructor. + + @@ -3837,44 +4062,44 @@ - - Called to initialize the file writer - - - - Will be called for each logged message until the file is - successfully opened. - - + + Called to initialize the file writer + + + + Will be called for each logged message until the file is + successfully opened. + + - - This method is called by the - method. - - The event to log. - - - Writes a log statement to the output stream if the output stream exists - and is writable. - - - The format of the output will depend on the appender's layout. - - + + This method is called by the + method. + + The event to log. + + + Writes a log statement to the output stream if the output stream exists + and is writable. + + + The format of the output will depend on the appender's layout. + + - - This method is called by the - method. - - The array of events to log. - - - Acquires the output file locks once before writing all the events to - the stream. - - + + This method is called by the + method. + + The array of events to log. + + + Acquires the output file locks once before writing all the events to + the stream. + + @@ -3931,21 +4156,21 @@ - - Sets and opens the file where the log output will go. The specified file must be writable. - - The path to the log file. Must be a fully qualified path. - If true will append to fileName. Otherwise will truncate fileName - - - If there was already an opened file, then the previous file - is closed first. - - - This method will ensure that the directory structure - for the specified exists. - - + + Sets and opens the file where the log output will go. The specified file must be writable. + + The path to the log file. Must be a fully qualified path. + If true will append to fileName. Otherwise will truncate fileName + + + If there was already an opened file, then the previous file + is closed first. + + + This method will ensure that the directory structure + for the specified exists. + + @@ -3954,9 +4179,9 @@ the file stream that has been opened for writing - This implementation of creates a + This implementation of creates a over the and passes it to the - method. + method. This method can be overridden by sub classes that want to wrap the @@ -3978,96 +4203,105 @@ - - Convert a path into a fully qualified path. - - The path to convert. - The fully qualified path. - - - Converts the path specified to a fully - qualified path. If the path is relative it is - taken as relative from the application base - directory. - - + + Convert a path into a fully qualified path. + + The path to convert. + The fully qualified path. + + + Converts the path specified to a fully + qualified path. If the path is relative it is + taken as relative from the application base + directory. + + - - Flag to indicate if we should append to the file - or overwrite the file. The default is to append. - + + Flag to indicate if we should append to the file + or overwrite the file. The default is to append. + - - The name of the log file. - + + The name of the log file. + - - The encoding to use for the file stream. - + + The encoding to use for the file stream. + - - The security context to use for privileged calls - + + The security context to use for privileged calls + - - The stream to log to. Has added locking semantics - + + The stream to log to. Has added locking semantics + - - The locking model to use - + + The locking model to use + + + + + The fully qualified type of the FileAppender class. + + + Used by the internal logger to record the Type of the + log message. + + + Gets or sets the path to the file that logging will be written to. + + + The path to the file that logging will be written to. + + + + If the path is relative it is taken as relative from + the application base directory. + + + + + + Gets or sets a flag that indicates whether the file should be + appended to or overwritten. + + + Indicates whether the file should be appended to or overwritten. + + + + If the value is set to false then the file will be overwritten, if + it is set to true then the file will be appended to. + + The default value is true. + + + - Gets or sets the path to the file that logging will be written to. + Gets or sets used to write to the file. - The path to the file that logging will be written to. + The used to write to the file. - If the path is relative it is taken as relative from - the application base directory. + The default encoding set is + which is the encoding for the system's current ANSI code page. - - - Gets or sets a flag that indicates whether the file should be - appended to or overwritten. - - - Indicates whether the file should be appended to or overwritten. - - - - If the value is set to false then the file will be overwritten, if - it is set to true then the file will be appended to. - - The default value is true. - - - - - Gets or sets used to write to the file. - - - The used to write to the file. - - - - The default encoding set is - which is the encoding for the system's current ANSI code page. - - - - + Gets or sets the used to write to the file. @@ -4095,9 +4329,10 @@ Gets or sets the used to handle locking of the file. - There are two built in locking models, and . - The former locks the file from the start of logging to the end and the - later lock only for the minimal amount of time when logging each message. + There are three built in locking models, , and . + The first locks the file from the start of logging to the end, the + second locks only for the minimal amount of time when logging each message + and the last synchronizes processes using a named system wide Mutex. The default locking model is the . @@ -4111,9 +4346,9 @@ - - True asynchronous writes are not supported, the implementation forces a synchronous write. - + + True asynchronous writes are not supported, the implementation forces a synchronous write. + @@ -4204,14 +4439,14 @@ - - Close the file - - - - Close the file. No further writes will be made. - - + + Close the file + + + + Close the file. No further writes will be made. + + @@ -4237,6 +4472,33 @@ + + + Helper method that creates a FileStream under CurrentAppender's SecurityContext. + + + + Typically called during OpenFile or AcquireLock. + + + If the directory portion of the does not exist, it is created + via Directory.CreateDirecctory. + + + + + + + + + + Helper method to close under CurrentAppender's SecurityContext. + + + Does not set to null. + + + Gets or sets the for this LockingModel @@ -4286,35 +4548,35 @@ - - Close the file - - - - Close the file. No further writes will be made. - - + + Close the file + + + + Close the file. No further writes will be made. + + - - Acquire the lock on the file - - A stream that is ready to be written to. - - - Does nothing. The lock is already taken - - + + Acquire the lock on the file + + A stream that is ready to be written to. + + + Does nothing. The lock is already taken + + - - Release the lock on the file - - - - Does nothing. The lock will be released when the file is closed. - - + + Release the lock on the file + + + + Does nothing. The lock will be released when the file is closed. + + @@ -4346,14 +4608,14 @@ - - Close the file - - - - Close the file. No further writes will be made. - - + + Close the file + + + + Close the file. No further writes will be made. + + @@ -4379,18 +4641,67 @@ - + + + Provides cross-process file locking. + + Ron Grabowski + Steve Wranovsky + + - This appender forwards logging events to attached appenders. + Open the file specified and prepare for logging. + The filename to use + Whether to append to the file, or overwrite + The encoding to use - The forwarding appender can be used to specify different thresholds - and filters for the same appender at different locations within the hierarchy. - - - Nicko Cadell - Gert Driesen + Open the file specified and prepare for logging. + No writes will be made until is called. + Must be called before any calls to , + - and . + + + + + + Close the file + + + + Close the file. No further writes will be made. + + + + + + Acquire the lock on the file + + A stream that is ready to be written to. + + + Does nothing. The lock is already taken + + + + + + + + + + + This appender forwards logging events to attached appenders. + + + + The forwarding appender can be used to specify different thresholds + and filters for the same appender at different locations within the hierarchy. + + + Nicko Cadell + Gert Driesen @@ -4403,40 +4714,40 @@ - - Closes the appender and releases resources. - - - - Releases any resources allocated within the appender such as file handles, - network connections, etc. - - - It is a programming error to append to a closed appender. - - + + Closes the appender and releases resources. + + + + Releases any resources allocated within the appender such as file handles, + network connections, etc. + + + It is a programming error to append to a closed appender. + + - - Forward the logging event to the attached appenders - - The event to log. - - - Delivers the logging event to all the attached appenders. - - + + Forward the logging event to the attached appenders + + The event to log. + + + Delivers the logging event to all the attached appenders. + + - - Forward the logging events to the attached appenders - - The array of events to log. - - - Delivers the logging events to all the attached appenders. - - + + Forward the logging events to the attached appenders + + The array of events to log. + + + Delivers the logging events to all the attached appenders. + + @@ -4452,28 +4763,28 @@ - - Looks for the appender with the specified name. - - The name of the appender to lookup. - - The appender with the specified name, or null. - - - - Get the named appender attached to this appender. - - + + Looks for the appender with the specified name. + + The name of the appender to lookup. + + The appender with the specified name, or null. + + + + Get the named appender attached to this appender. + + - - Removes all previously added appenders from this appender. - - - - This is useful when re-reading configuration information. - - + + Removes all previously added appenders from this appender. + + + + This is useful when re-reading configuration information. + + @@ -4591,48 +4902,48 @@ - - This method is called by the method. - - The event to log. - - - Writes the event to a remote syslog daemon. - - - The format of the output will depend on the appender's layout. - - + + This method is called by the method. + + The event to log. + + + Writes the event to a remote syslog daemon. + + + The format of the output will depend on the appender's layout. + + - - Close the syslog when the appender is closed - - - - Close the syslog when the appender is closed - - + + Close the syslog when the appender is closed + + + + Close the syslog when the appender is closed + + - - Translates a log4net level to a syslog severity. - - A log4net level. - A syslog severity. - - - Translates a log4net level to a syslog severity. - - + + Translates a log4net level to a syslog severity. + + A log4net level. + A syslog severity. + + + Translates a log4net level to a syslog severity. + + - - Generate a syslog priority. - - The syslog facility. - The syslog severity. - A syslog priority. + + Generate a syslog priority. + + The syslog facility. + The syslog severity. + A syslog priority. @@ -4640,45 +4951,45 @@ - - The message identity - + + The message identity + - - Marshaled handle to the identity string. We have to hold on to the - string as the openlog and syslog APIs just hold the - pointer to the ident and dereference it for each log message. - + + Marshaled handle to the identity string. We have to hold on to the + string as the openlog and syslog APIs just hold the + pointer to the ident and dereference it for each log message. + - - Mapping from level object to syslog severity - + + Mapping from level object to syslog severity + - - Open connection to system logger. - + + Open connection to system logger. + - - Generate a log message. - - - - The libc syslog method takes a format string and a variable argument list similar - to the classic printf function. As this type of vararg list is not supported - by C# we need to specify the arguments explicitly. Here we have specified the - format string with a single message argument. The caller must set the format - string to "%s". - - + + Generate a log message. + + + + The libc syslog method takes a format string and a variable argument list similar + to the classic printf function. As this type of vararg list is not supported + by C# we need to specify the arguments explicitly. Here we have specified the + format string with a single message argument. The caller must set the format + string to "%s". + + - - Close descriptor used to write to system logger. - + + Close descriptor used to write to system logger. + @@ -4727,44 +5038,44 @@ - - system is unusable - + + system is unusable + - - action must be taken immediately - + + action must be taken immediately + - - critical conditions - + + critical conditions + - - error conditions - + + error conditions + - - warning conditions - + + warning conditions + - - normal but significant condition - + + normal but significant condition + - - informational - + + informational + - - debug-level messages - + + debug-level messages + @@ -4778,147 +5089,147 @@ - - kernel messages - + + kernel messages + - - random user-level messages - + + random user-level messages + - - mail system - + + mail system + - - system daemons - + + system daemons + - - security/authorization messages - + + security/authorization messages + - - messages generated internally by syslogd - + + messages generated internally by syslogd + - - line printer subsystem - + + line printer subsystem + - - network news subsystem - + + network news subsystem + - - UUCP subsystem - + + UUCP subsystem + - - clock (cron/at) daemon - + + clock (cron/at) daemon + - - security/authorization messages (private) - + + security/authorization messages (private) + - - ftp daemon - + + ftp daemon + - - NTP subsystem - + + NTP subsystem + - - log audit - + + log audit + - - log alert - + + log alert + - - clock daemon - + + clock daemon + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - A class to act as a mapping between the level that a logging call is made at and - the syslog severity that is should be logged at. - - - - A class to act as a mapping between the level that a logging call is made at and - the syslog severity that is should be logged at. - - + + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + + + + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + + - - The mapped syslog severity for the specified level - - - - Required property. - The mapped syslog severity for the specified level - - + + The mapped syslog severity for the specified level + + + + Required property. + The mapped syslog severity for the specified level + + @@ -4934,7 +5245,7 @@ the current list of events that have been appended. - Use the method to clear the + Use the method to clear the current list of events. @@ -4953,74 +5264,74 @@ - - Gets the events that have been logged. - - The events that have been logged - - - Gets the events that have been logged. - - + + Gets the events that have been logged. + + The events that have been logged + + + Gets the events that have been logged. + + - - This method is called by the method. - - the event to log - - Stores the in the events list. - + + This method is called by the method. + + the event to log + + Stores the in the events list. + - - Clear the list of events - - - Clear the list of events - + + Clear the list of events + + + Clear the list of events + - - The list of events that have been appended. - + + The list of events that have been appended. + - - Value indicating which fields in the event should be fixed - - - By default all fields are fixed - + + Value indicating which fields in the event should be fixed + + + By default all fields are fixed + + + Gets or sets a value indicating whether only part of the logging event + data should be fixed. + + + true if the appender should only fix part of the logging event + data, otherwise false. The default is false. + + + + Setting this property to true will cause only part of the event + data to be fixed and stored in the appender, hereby improving performance. + + + See for more information. + + + + - Gets or sets a value indicating whether only part of the logging event - data should be fixed. + Gets or sets the fields that will be fixed in the event - - true if the appender should only fix part of the logging event - data, otherwise false. The default is false. - - Setting this property to true will cause only part of the event - data to be fixed and stored in the appender, hereby improving performance. - - - See for more information. - - - - - - Gets or sets the fields that will be fixed in the event - - - - The logging event needs to have certain thread specific values - captured before it can be buffered. See - for details. + The logging event needs to have certain thread specific values + captured before it can be buffered. See + for details. @@ -5054,10 +5365,10 @@ Send a message to a user account on the local machine - = <name of the local machine> + = <name of the local machine> - = <user name> + = <user name> @@ -5065,10 +5376,10 @@ Send a message to a user account on a remote machine - = <name of the remote machine> + = <name of the remote machine> - = <user name> + = <user name> @@ -5076,10 +5387,10 @@ Send a message to a domain user account - = <name of a domain controller | uninitialized> + = <name of a domain controller | uninitialized> - = <user name> + = <user name> @@ -5087,7 +5398,7 @@ Send a message to all the names in a workgroup or domain - = <workgroup name | domain name>* + = <workgroup name | domain name>* @@ -5095,10 +5406,10 @@ Send a message from the local machine to a remote machine - = <name of the local machine | uninitialized> + = <name of the local machine | uninitialized> - = <name of the remote machine> + = <name of the remote machine> @@ -5128,32 +5439,32 @@ Gert Driesen - - The DNS or NetBIOS name of the server on which the function is to execute. - + + The DNS or NetBIOS name of the server on which the function is to execute. + - - The sender of the network message. - + + The sender of the network message. + - - The message alias to which the message should be sent. - + + The message alias to which the message should be sent. + - - The security context to use for privileged calls - + + The security context to use for privileged calls + - - Initializes the appender. - - - The default constructor initializes all fields to their default values. - + + Initializes the appender. + + + The default constructor initializes all fields to their default values. + @@ -5178,109 +5489,109 @@ The required property was not specified. - - This method is called by the method. - - The event to log. - - - Sends the event using a network message. - - + + This method is called by the method. + + The event to log. + + + Sends the event using a network message. + + - - Sends a buffer of information to a registered message alias. - - The DNS or NetBIOS name of the server on which the function is to execute. - The message alias to which the message buffer should be sent - The originator of the message. - The message text. - The length, in bytes, of the message text. - - - The following restrictions apply for sending network messages: - - - - - Platform - Requirements - - - Windows NT - - - No special group membership is required to send a network message. - - - Admin, Accounts, Print, or Server Operator group membership is required to - successfully send a network message on a remote server. - - - - - Windows 2000 or later - - - If you send a message on a domain controller that is running Active Directory, - access is allowed or denied based on the access control list (ACL) for the securable - object. The default ACL permits only Domain Admins and Account Operators to send a network message. - - - On a member server or workstation, only Administrators and Server Operators can send a network message. - - - - - - - For more information see Security Requirements for the Network Management Functions. - - - - - If the function succeeds, the return value is zero. - - + + Sends a buffer of information to a registered message alias. + + The DNS or NetBIOS name of the server on which the function is to execute. + The message alias to which the message buffer should be sent + The originator of the message. + The message text. + The length, in bytes, of the message text. + + + The following restrictions apply for sending network messages: + + + + + Platform + Requirements + + + Windows NT + + + No special group membership is required to send a network message. + + + Admin, Accounts, Print, or Server Operator group membership is required to + successfully send a network message on a remote server. + + + + + Windows 2000 or later + + + If you send a message on a domain controller that is running Active Directory, + access is allowed or denied based on the access control list (ACL) for the securable + object. The default ACL permits only Domain Admins and Account Operators to send a network message. + + + On a member server or workstation, only Administrators and Server Operators can send a network message. + + + + + + + For more information see Security Requirements for the Network Management Functions. + + + + + If the function succeeds, the return value is zero. + + - - Gets or sets the sender of the message. - - - The sender of the message. - - - If this property is not specified, the message is sent from the local computer. - + + Gets or sets the sender of the message. + + + The sender of the message. + + + If this property is not specified, the message is sent from the local computer. + - - Gets or sets the message alias to which the message should be sent. - - - The recipient of the message. - - - This property should always be specified in order to send a message. - + + Gets or sets the message alias to which the message should be sent. + + + The recipient of the message. + + + This property should always be specified in order to send a message. + - - Gets or sets the DNS or NetBIOS name of the remote server on which the function is to execute. - - - DNS or NetBIOS name of the remote server on which the function is to execute. - - - - For Windows NT 4.0 and earlier, the string should begin with \\. - - - If this property is not specified, the local computer is used. - - + + Gets or sets the DNS or NetBIOS name of the remote server on which the function is to execute. + + + DNS or NetBIOS name of the remote server on which the function is to execute. + + + + For Windows NT 4.0 and earlier, the string should begin with \\. + + + If this property is not specified, the local computer is used. + + @@ -5310,21 +5621,21 @@ - - Appends log events to the OutputDebugString system. - - - - OutputDebugStringAppender appends log events to the - OutputDebugString system. - - - The string is passed to the native OutputDebugString - function. - - - Nicko Cadell - Gert Driesen + + Appends log events to the OutputDebugString system. + + + + OutputDebugStringAppender appends log events to the + OutputDebugString system. + + + The string is passed to the native OutputDebugString + function. + + + Nicko Cadell + Gert Driesen @@ -5337,26 +5648,26 @@ - - Write the logging event to the output debug string API - - the event to log - - - Write the logging event to the output debug string API - - + + Write the logging event to the output debug string API + + the event to log + + + Write the logging event to the output debug string API + + - - Stub for OutputDebugString native method - - the string to output - - - Stub for OutputDebugString native method - - + + Stub for OutputDebugString native method + + the string to output + + + Stub for OutputDebugString native method + + @@ -5465,8 +5776,7 @@ Try remoteEndPoint = new IPEndPoint(IPAddress.Any, 0) udpClient = new UdpClient(8080) - - While True + While True buffer = udpClient.Receive(ByRef remoteEndPoint) loggingEvent = System.Text.Encoding.Unicode.GetString(buffer) Console.WriteLine(loggingEvent) @@ -5524,7 +5834,7 @@ - This method is called by the method. + This method is called by the method. The event to log. @@ -5563,21 +5873,21 @@ - - The IP address of the remote host or multicast group to which - the logging event will be sent. - + + The IP address of the remote host or multicast group to which + the logging event will be sent. + - - The TCP port number of the remote host or multicast group to - which the logging event will be sent. - + + The TCP port number of the remote host or multicast group to + which the logging event will be sent. + - - The cached remote endpoint to which the logging events will be sent. - + + The cached remote endpoint to which the logging events will be sent. + @@ -5591,9 +5901,9 @@ - - The encoding to use for the packet. - + + The encoding to use for the packet. + @@ -5752,9 +6062,19 @@ - - Syslog port 514 - + + Syslog port 514 + + + + + Initial buffer size + + + + + Maximum buffer size before it is recycled + @@ -5777,53 +6097,53 @@ - - This method is called by the method. - - The event to log. - - - Writes the event to a remote syslog daemon. - - - The format of the output will depend on the appender's layout. - - + + This method is called by the method. + + The event to log. + + + Writes the event to a remote syslog daemon. + + + The format of the output will depend on the appender's layout. + + - - Initialize the options for this appender - - - - Initialize the level to syslog severity mappings set on this appender. - - + + Initialize the options for this appender + + + + Initialize the level to syslog severity mappings set on this appender. + + - - Translates a log4net level to a syslog severity. - - A log4net level. - A syslog severity. - - - Translates a log4net level to a syslog severity. - - + + Translates a log4net level to a syslog severity. + + A log4net level. + A syslog severity. + + + Translates a log4net level to a syslog severity. + + - - Generate a syslog priority. - - The syslog facility. - The syslog severity. - A syslog priority. - - - Generate a syslog priority. - - + + Generate a syslog priority. + + The syslog facility. + The syslog severity. + A syslog priority. + + + Generate a syslog priority. + + @@ -5831,14 +6151,14 @@ - - The message identity - + + The message identity + - - Mapping from level object to syslog severity - + + Mapping from level object to syslog severity + @@ -5864,207 +6184,207 @@ - - syslog severities - - - - The syslog severities. - - + + syslog severities + + + + The syslog severities. + + - - system is unusable - + + system is unusable + - - action must be taken immediately - + + action must be taken immediately + - - critical conditions - + + critical conditions + - - error conditions - + + error conditions + - - warning conditions - + + warning conditions + - - normal but significant condition - + + normal but significant condition + - - informational - + + informational + - - debug-level messages - + + debug-level messages + - - syslog facilities - - - - The syslog facilities - - + + syslog facilities + + + + The syslog facilities + + - - kernel messages - + + kernel messages + - - random user-level messages - + + random user-level messages + - - mail system - + + mail system + - - system daemons - + + system daemons + - - security/authorization messages - + + security/authorization messages + - - messages generated internally by syslogd - + + messages generated internally by syslogd + - - line printer subsystem - + + line printer subsystem + - - network news subsystem - + + network news subsystem + - - UUCP subsystem - + + UUCP subsystem + - - clock (cron/at) daemon - + + clock (cron/at) daemon + - - security/authorization messages (private) - + + security/authorization messages (private) + - - ftp daemon - + + ftp daemon + - - NTP subsystem - + + NTP subsystem + - - log audit - + + log audit + - - log alert - + + log alert + - - clock daemon - + + clock daemon + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - A class to act as a mapping between the level that a logging call is made at and - the syslog severity that is should be logged at. - - - - A class to act as a mapping between the level that a logging call is made at and - the syslog severity that is should be logged at. - - + + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + + + + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + + - - The mapped syslog severity for the specified level - - - - Required property. - The mapped syslog severity for the specified level - - + + The mapped syslog severity for the specified level + + + + Required property. + The mapped syslog severity for the specified level + + @@ -6184,14 +6504,14 @@ - - A work item is being queued into the thread pool - + + A work item is being queued into the thread pool + - - A work item from the thread pool has completed - + + A work item from the thread pool has completed + @@ -6205,28 +6525,28 @@ the logging events to send - - The URL of the remote sink. - + + The URL of the remote sink. + - - The local proxy (.NET remoting) for the remote logging sink. - + + The local proxy (.NET remoting) for the remote logging sink. + - - The number of queued callbacks currently waiting or executing - + + The number of queued callbacks currently waiting or executing + - - Event used to signal when there are no queued work items - - - This event is set when there are no queued work items. In this - state it is safe to close the appender. - + + Event used to signal when there are no queued work items + + + This event is set when there are no queued work items. In this + state it is safe to close the appender. + @@ -6255,15 +6575,15 @@ - - Delivers logging events to the remote sink - - Array of events to log. - - - Delivers logging events to the remote sink - - + + Delivers logging events to the remote sink + + Array of events to log. + + + Delivers logging events to the remote sink + + @@ -6359,52 +6679,61 @@ + + + The fully qualified type of the RollingFileAppender class. + + + Used by the internal logger to record the Type of the + log message. + + - - Sets the quiet writer being used. - - - This method can be overridden by sub classes. - - the writer to set + + Sets the quiet writer being used. + + + This method can be overridden by sub classes. + + the writer to set - - Write out a logging event. - - the event to write to file. - - - Handles append time behavior for RollingFileAppender. This checks - if a roll over either by date (checked first) or time (checked second) - is need and then appends to the file last. - - + + Write out a logging event. + + the event to write to file. + + + Handles append time behavior for RollingFileAppender. This checks + if a roll over either by date (checked first) or time (checked second) + is need and then appends to the file last. + + - - Write out an array of logging events. - - the events to write to file. - - - Handles append time behavior for RollingFileAppender. This checks - if a roll over either by date (checked first) or time (checked second) - is need and then appends to the file last. - - + + Write out an array of logging events. + + the events to write to file. + + + Handles append time behavior for RollingFileAppender. This checks + if a roll over either by date (checked first) or time (checked second) + is need and then appends to the file last. + + - - Performs any required rolling before outputting the next event - - - - Handles append time behavior for RollingFileAppender. This checks - if a roll over either by date (checked first) or time (checked second) - is need and then appends to the file last. - - + + Performs any required rolling before outputting the next event + + + + Handles append time behavior for RollingFileAppender. This checks + if a roll over either by date (checked first) or time (checked second) + is need and then appends to the file last. + + @@ -6433,30 +6762,30 @@ - - Determines curSizeRollBackups (only within the current roll point) - + + Determines curSizeRollBackups (only within the current roll point) + - - Generates a wildcard pattern that can be used to find all files - that are similar to the base file name. - - - + + Generates a wildcard pattern that can be used to find all files + that are similar to the base file name. + + + - - Builds a list of filenames for all files matching the base filename plus a file - pattern. - - - + + Builds a list of filenames for all files matching the base filename plus a file + pattern. + + + - - Initiates a roll over if needed for crossing a date boundary since the last run. - + + Initiates a roll over if needed for crossing a date boundary since the last run. + @@ -6474,39 +6803,50 @@ - - Does the work of bumping the 'current' file counter higher - to the highest count when an incremental file name is seen. - The highest count is either the first file (when count direction - is greater than 0) or the last file (when count direction less than 0). - In either case, we want to know the highest count that is present. - - - + + Does the work of bumping the 'current' file counter higher + to the highest count when an incremental file name is seen. + The highest count is either the first file (when count direction + is greater than 0) or the last file (when count direction less than 0). + In either case, we want to know the highest count that is present. + + + + + + + Attempts to extract a number from the end of the file name that indicates + the number of the times the file has been rolled over. + + + Certain date pattern extensions like yyyyMMdd will be parsed as valid backup indexes. + + + - - Takes a list of files and a base file name, and looks for - 'incremented' versions of the base file. Bumps the max - count up to the highest count seen. - - - + + Takes a list of files and a base file name, and looks for + 'incremented' versions of the base file. Bumps the max + count up to the highest count seen. + + + - - Calculates the RollPoint for the datePattern supplied. - - the date pattern to calculate the check period for - The RollPoint that is most accurate for the date pattern supplied - - Essentially the date pattern is examined to determine what the - most suitable roll point is. The roll point chosen is the roll point - with the smallest period that can be detected using the date pattern - supplied. i.e. if the date pattern only outputs the year, month, day - and hour then the smallest roll point that can be detected would be - and hourly roll point as minutes could not be detected. - + + Calculates the RollPoint for the datePattern supplied. + + the date pattern to calculate the check period for + The RollPoint that is most accurate for the date pattern supplied + + Essentially the date pattern is examined to determine what the + most suitable roll point is. The roll point chosen is the roll point + with the smallest period that can be detected using the date pattern + supplied. i.e. if the date pattern only outputs the year, month, day + and hour then the smallest roll point that can be detected would be + and hourly roll point as minutes could not be detected. + @@ -6531,85 +6871,93 @@ + + + + + + .1, .2, .3, etc. + + - - Rollover the file(s) to date/time tagged file(s). - - set to true if the file to be rolled is currently open - - - Rollover the file(s) to date/time tagged file(s). - Resets curSizeRollBackups. - If fileIsOpen is set then the new file is opened (through SafeOpenFile). - - + + Rollover the file(s) to date/time tagged file(s). + + set to true if the file to be rolled is currently open + + + Rollover the file(s) to date/time tagged file(s). + Resets curSizeRollBackups. + If fileIsOpen is set then the new file is opened (through SafeOpenFile). + + - - Renames file to file . - - Name of existing file to roll. - New name for file. - - - Renames file to file . It - also checks for existence of target file and deletes if it does. - - + + Renames file to file . + + Name of existing file to roll. + New name for file. + + + Renames file to file . It + also checks for existence of target file and deletes if it does. + + - - Test if a file exists at a specified path - - the path to the file - true if the file exists - - - Test if a file exists at a specified path - - + + Test if a file exists at a specified path + + the path to the file + true if the file exists + + + Test if a file exists at a specified path + + - - Deletes the specified file if it exists. - - The file to delete. - - - Delete a file if is exists. - The file is first moved to a new filename then deleted. - This allows the file to be removed even when it cannot - be deleted, but it still can be moved. - - + + Deletes the specified file if it exists. + + The file to delete. + + + Delete a file if is exists. + The file is first moved to a new filename then deleted. + This allows the file to be removed even when it cannot + be deleted, but it still can be moved. + + - - Implements file roll base on file size. - - - - If the maximum number of size based backups is reached - (curSizeRollBackups == maxSizeRollBackups) then the oldest - file is deleted -- its index determined by the sign of countDirection. - If countDirection < 0, then files - {File.1, ..., File.curSizeRollBackups -1} - are renamed to {File.2, ..., - File.curSizeRollBackups}. Moreover, File is - renamed File.1 and closed. - - - A new file is created to receive further log output. - - - If maxSizeRollBackups is equal to zero, then the - File is truncated with no backup files created. - - - If maxSizeRollBackups < 0, then File is - renamed if needed and no files are deleted. - - + + Implements file roll base on file size. + + + + If the maximum number of size based backups is reached + (curSizeRollBackups == maxSizeRollBackups) then the oldest + file is deleted -- its index determined by the sign of countDirection. + If countDirection < 0, then files + {File.1, ..., File.curSizeRollBackups -1} + are renamed to {File.2, ..., + File.curSizeRollBackups}. Moreover, File is + renamed File.1 and closed. + + + A new file is created to receive further log output. + + + If maxSizeRollBackups is equal to zero, then the + File is truncated with no backup files created. + + + If maxSizeRollBackups < 0, then File is + renamed if needed and no files are deleted. + + @@ -6640,107 +6988,130 @@ - - Get the start time of the next window for the current rollpoint - - the current date - the type of roll point we are working with - the start time for the next roll point an interval after the currentDateTime date - - - Returns the date of the next roll point after the currentDateTime date passed to the method. - - - The basic strategy is to subtract the time parts that are less significant - than the rollpoint from the current time. This should roll the time back to - the start of the time window for the current rollpoint. Then we add 1 window - worth of time and get the start time of the next window for the rollpoint. - - + + Get the start time of the next window for the current rollpoint + + the current date + the type of roll point we are working with + the start time for the next roll point an interval after the currentDateTime date + + + Returns the date of the next roll point after the currentDateTime date passed to the method. + + + The basic strategy is to subtract the time parts that are less significant + than the rollpoint from the current time. This should roll the time back to + the start of the time window for the current rollpoint. Then we add 1 window + worth of time and get the start time of the next window for the rollpoint. + + - - This object supplies the current date/time. Allows test code to plug in - a method to control this class when testing date/time based rolling. - + + This object supplies the current date/time. Allows test code to plug in + a method to control this class when testing date/time based rolling. The default + implementation uses the underlying value of DateTime.Now. + - - The date pattern. By default, the pattern is set to ".yyyy-MM-dd" - meaning daily rollover. - + + The date pattern. By default, the pattern is set to ".yyyy-MM-dd" + meaning daily rollover. + - - The actual formatted filename that is currently being written to - or will be the file transferred to on roll over - (based on staticLogFileName). - + + The actual formatted filename that is currently being written to + or will be the file transferred to on roll over + (based on staticLogFileName). + - - The timestamp when we shall next recompute the filename. - + + The timestamp when we shall next recompute the filename. + - - Holds date of last roll over - + + Holds date of last roll over + - - The type of rolling done - + + The type of rolling done + - - The default maximum file size is 10MB - + + The default maximum file size is 10MB + - - There is zero backup files by default - + + There is zero backup files by default + - - How many sized based backups have been made so far - + + How many sized based backups have been made so far + - - The rolling file count direction. - + + The rolling file count direction. + - - The rolling mode used in this appender. - + + The rolling mode used in this appender. + - - Cache flag set if we are rolling by date. - + + Cache flag set if we are rolling by date. + - - Cache flag set if we are rolling by size. - + + Cache flag set if we are rolling by size. + - - Value indicating whether to always log to the same file. - + + Value indicating whether to always log to the same file. + + + + + Value indicating whether to preserve the file name extension when rolling. + - - FileName provided in configuration. Used for rolling properly - + + FileName provided in configuration. Used for rolling properly + + + The 1st of January 1970 in UTC + + + - The 1st of January 1970 in UTC + Gets or sets the strategy for determining the current date and time. The default + implementation is to use LocalDateTime which internally calls through to DateTime.Now. + + An implementation of the interface which returns the current date and time. + + + + Gets or sets the used to return the current date and time. + + + The default strategy is . + + @@ -6878,113 +7249,129 @@ + + + Gets or sets a value indicating whether to preserve the file name extension when rolling. + + + true if the file name extension should be preserved. + + + + By default file.log is rolled to file.log.yyyy-MM-dd or file.log.curSizeRollBackup. + However, under Windows the new file name will loose any program associations as the + extension is changed. Optionally file.log can be renamed to file.yyyy-MM-dd.log or + file.curSizeRollBackup.log to maintain any program associations. + + + - - Gets or sets a value indicating whether to always log to - the same file. - - - true if always should be logged to the same file, otherwise false. - - - - By default file.log is always the current file. Optionally - file.log.yyyy-mm-dd for current formatted datePattern can by the currently - logging file (or file.log.curSizeRollBackup or even - file.log.yyyy-mm-dd.curSizeRollBackup). - - - This will make time based rollovers with a large number of backups - much faster as the appender it won't have to rename all the backups! - - + + Gets or sets a value indicating whether to always log to + the same file. + + + true if always should be logged to the same file, otherwise false. + + + + By default file.log is always the current file. Optionally + file.log.yyyy-mm-dd for current formatted datePattern can by the currently + logging file (or file.log.curSizeRollBackup or even + file.log.yyyy-mm-dd.curSizeRollBackup). + + + This will make time based rollovers with a large number of backups + much faster as the appender it won't have to rename all the backups! + + - - Style of rolling to use - - - - Style of rolling to use - - + + Style of rolling to use + + + + Style of rolling to use + + - - Roll files once per program execution - - - - Roll files once per program execution. - Well really once each time this appender is - configured. - - - Setting this option also sets AppendToFile to - false on the RollingFileAppender, otherwise - this appender would just be a normal file appender. - - + + Roll files once per program execution + + + + Roll files once per program execution. + Well really once each time this appender is + configured. + + + Setting this option also sets AppendToFile to + false on the RollingFileAppender, otherwise + this appender would just be a normal file appender. + + - - Roll files based only on the size of the file - + + Roll files based only on the size of the file + - - Roll files based only on the date - + + Roll files based only on the date + - - Roll files based on both the size and date of the file - + + Roll files based on both the size and date of the file + - - The code assumes that the following 'time' constants are in a increasing sequence. - - - - The code assumes that the following 'time' constants are in a increasing sequence. - - + + The code assumes that the following 'time' constants are in a increasing sequence. + + + + The code assumes that the following 'time' constants are in a increasing sequence. + + - - Roll the log not based on the date - + + Roll the log not based on the date + - - Roll the log for each minute - + + Roll the log for each minute + - - Roll the log for each hour - + + Roll the log for each hour + - - Roll the log twice a day (midday and midnight) - + + Roll the log twice a day (midday and midnight) + - - Roll the log each day (midnight) - + + Roll the log each day (midnight) + - - Roll the log each week - + + Roll the log each week + - - Roll the log each month - + + Roll the log each month + @@ -6997,31 +7384,31 @@ - - Gets the current time. - - The current time. - - - Gets the current time. - - - - + + Gets the current time. + + The current time. + + + Gets the current time. + + + + Default implementation of that returns the current time. - - - Gets the current time. - - The current time. - - - Gets the current time. - - + + + Gets the current time. + + The current time. + + + Gets the current time. + + @@ -7058,118 +7445,162 @@ Gert Driesen - - Default constructor - - - - Default constructor - - + + Default constructor + + + + Default constructor + + - - Sends the contents of the cyclic buffer as an e-mail message. - - The logging events to send. + + Sends the contents of the cyclic buffer as an e-mail message. + + The logging events to send. - - Send the email message - - the body text to include in the mail + + Send the email message + + the body text to include in the mail + + Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses (use semicolon on .NET 1.1 and comma for later versions). + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + + Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses + that will be carbon copied (use semicolon on .NET 1.1 and comma for later versions). + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + + Gets or sets a semicolon-delimited list of recipient e-mail addresses + that will be blind carbon copied. + + + A semicolon-delimited list of e-mail addresses. + + + + A semicolon-delimited list of recipient e-mail addresses. + + + + + + Gets or sets the e-mail address of the sender. + + + The e-mail address of the sender. + + + + The e-mail address of the sender. + + + + + + Gets or sets the subject line of the e-mail message. + + + The subject line of the e-mail message. + + + + The subject line of the e-mail message. + + + + + + Gets or sets the name of the SMTP relay mail server to use to send + the e-mail messages. + + + The name of the e-mail relay server. If SmtpServer is not set, the + name of the local SMTP server is used. + + + + The name of the e-mail relay server. If SmtpServer is not set, the + name of the local SMTP server is used. + + + + + + Obsolete + + + Use the BufferingAppenderSkeleton Fix methods instead + + + + Obsolete property. + + + + - Gets or sets a semicolon-delimited list of recipient e-mail addresses. + The mode to use to authentication with the SMTP server - - A semicolon-delimited list of e-mail addresses. - + Authentication is only available on the MS .NET 1.1 runtime. - A semicolon-delimited list of recipient e-mail addresses. + Valid Authentication mode values are: , + , and . + The default value is . When using + you must specify the + and to use to authenticate. + When using the Windows credentials for the current + thread, if impersonating, or the process will be used to authenticate. - + - Gets or sets the e-mail address of the sender. + The username to use to authenticate with the SMTP server - - The e-mail address of the sender. - - - The e-mail address of the sender. - - - - - - Gets or sets the subject line of the e-mail message. - - - The subject line of the e-mail message. - - - - The subject line of the e-mail message. - - - - - - Gets or sets the name of the SMTP relay mail server to use to send - the e-mail messages. - - - The name of the e-mail relay server. If SmtpServer is not set, the - name of the local SMTP server is used. - - - - The name of the e-mail relay server. If SmtpServer is not set, the - name of the local SMTP server is used. - - - - - - Obsolete - - - Use the BufferingAppenderSkeleton Fix methods instead - - - - Obsolete property. - - - - - - The mode to use to authentication with the SMTP server - - - Authentication is only available on the MS .NET 1.1 runtime. - - Valid Authentication mode values are: , - , and . - The default value is . When using - you must specify the - and to use to authenticate. - When using the Windows credentials for the current - thread, if impersonating, or the process will be used to authenticate. - - - - - - The username to use to authenticate with the SMTP server - - - Authentication is only available on the MS .NET 1.1 runtime. + Authentication is only available on the MS .NET 1.1 runtime. A and must be specified when is set to , @@ -7191,17 +7622,17 @@ - - The port on which the SMTP server is listening - - - Server Port is only available on the MS .NET 1.1 runtime. - - The port on which the SMTP server is listening. The default - port is 25. The Port can only be changed when running on - the MS .NET 1.1 runtime. - - + + The port on which the SMTP server is listening + + + Server Port is only available on the MS .NET 1.1 runtime. + + The port on which the SMTP server is listening. The default + port is 25. The Port can only be changed when running on + the MS .NET 1.1 runtime. + + @@ -7221,6 +7652,22 @@ + + + Gets or sets the subject encoding to be used. + + + The default encoding is the operating system's current ANSI codepage. + + + + + Gets or sets the body encoding to be used. + + + The default encoding is the operating system's current ANSI codepage. + + This appender requires a to be set. @@ -7243,25 +7690,25 @@ - - No authentication - + + No authentication + - - Basic authentication. - - - Requires a username and password to be supplied - + + Basic authentication. + + + Requires a username and password to be supplied + - - Integrated authentication - - - Uses the Windows credentials from the current thread or process to authenticate. - + + Integrated authentication + + + Uses the Windows credentials from the current thread or process to authenticate. + @@ -7289,25 +7736,25 @@ Nicko Cadell - - Default constructor - - - - Default constructor - - + + Default constructor + + + + Default constructor + + - - Sends the contents of the cyclic buffer as an e-mail message. - - The logging events to send. - - - Sends the contents of the cyclic buffer as an e-mail message. - - + + Sends the contents of the cyclic buffer as an e-mail message. + + The logging events to send. + + + Sends the contents of the cyclic buffer as an e-mail message. + + @@ -7328,74 +7775,74 @@ - - Convert a path into a fully qualified path. - - The path to convert. - The fully qualified path. - - - Converts the path specified to a fully - qualified path. If the path is relative it is - taken as relative from the application base - directory. - - + + Convert a path into a fully qualified path. + + The path to convert. + The fully qualified path. + + + Converts the path specified to a fully + qualified path. If the path is relative it is + taken as relative from the application base + directory. + + - - The security context to use for privileged calls - + + The security context to use for privileged calls + - - Gets or sets a semicolon-delimited list of recipient e-mail addresses. - - - A semicolon-delimited list of e-mail addresses. - - - - A semicolon-delimited list of e-mail addresses. - - + + Gets or sets a semicolon-delimited list of recipient e-mail addresses. + + + A semicolon-delimited list of e-mail addresses. + + + + A semicolon-delimited list of e-mail addresses. + + - - Gets or sets the e-mail address of the sender. - - - The e-mail address of the sender. - - - - The e-mail address of the sender. - - + + Gets or sets the e-mail address of the sender. + + + The e-mail address of the sender. + + + + The e-mail address of the sender. + + - - Gets or sets the subject line of the e-mail message. - - - The subject line of the e-mail message. - - - - The subject line of the e-mail message. - - + + Gets or sets the subject line of the e-mail message. + + + The subject line of the e-mail message. + + + + The subject line of the e-mail message. + + - - Gets or sets the path to write the messages to. - - - - Gets or sets the path to write the messages to. This should be the same - as that used by the agent sending the messages. - - + + Gets or sets the path to write the messages to. + + + + Gets or sets the path to write the messages to. This should be the same + as that used by the agent sending the messages. + + @@ -7444,24 +7891,33 @@ Nicko Cadell - - Default constructor - - - - Default constructor - - + + Default constructor + + + + Default constructor + + + + + + The fully qualified type of the TelnetAppender class. + + + Used by the internal logger to record the Type of the + log message. + - - Overrides the parent method to close the socket handler - - - - Closes all the outstanding connections. - - + + Overrides the parent method to close the socket handler + + + + Closes all the outstanding connections. + + @@ -7485,15 +7941,15 @@ - - Writes the logging event to each connected client. - - The event to log. - - - Writes the logging event to each connected client. - - + + Writes the logging event to each connected client. + + The event to log. + + + Writes the logging event to each connected client. + + @@ -7523,97 +7979,97 @@ - - Helper class to manage connected clients - - - - The SocketHandler class is used to accept connections from - clients. It is threaded so that clients can connect/disconnect - asynchronously. - - + + Helper class to manage connected clients + + + + The SocketHandler class is used to accept connections from + clients. It is threaded so that clients can connect/disconnect + asynchronously. + + - - Opens a new server port on - - the local port to listen on for connections - - - Creates a socket handler on the specified local server port. - - + + Opens a new server port on + + the local port to listen on for connections + + + Creates a socket handler on the specified local server port. + + - - Sends a string message to each of the connected clients - - the text to send - - - Sends a string message to each of the connected clients - - + + Sends a string message to each of the connected clients + + the text to send + + + Sends a string message to each of the connected clients + + - - Add a client to the internal clients list - - client to add + + Add a client to the internal clients list + + client to add - - Remove a client from the internal clients list - - client to remove + + Remove a client from the internal clients list + + client to remove - - Callback used to accept a connection on the server socket - - The result of the asynchronous operation - - - On connection adds to the list of connections - if there are two many open connections you will be disconnected - - + + Callback used to accept a connection on the server socket + + The result of the asynchronous operation + + + On connection adds to the list of connections + if there are two many open connections you will be disconnected + + - - Close all network connections - - - - Make sure we close all network connections - - + + Close all network connections + + + + Make sure we close all network connections + + - - Test if this handler has active connections - - - true if this handler has active connections - - - - This property will be true while this handler has - active connections, that is at least one connection that - the handler will attempt to send a message to. - - + + Test if this handler has active connections + + + true if this handler has active connections + + + + This property will be true while this handler has + active connections, that is at least one connection that + the handler will attempt to send a message to. + + - - Class that represents a client connected to this handler - - - - Class that represents a client connected to this handler - - + + Class that represents a client connected to this handler + + + + Class that represents a client connected to this handler + + @@ -7627,25 +8083,25 @@ - - Write a string to the client - - string to send - - - Write a string to the client - - + + Write a string to the client + + string to send + + + Write a string to the client + + - - Cleanup the clients connection - - - - Close the socket connection. - - + + Cleanup the clients connection + + + + Close the socket connection. + + @@ -7660,7 +8116,8 @@ Events are written using the System.Diagnostics.Trace.Write(string,string) - method. The event's logger name is passed as the value for the category name to the Write method. + method. The event's logger name is the default value for the category parameter + of the Write method. Compact Framework
@@ -7673,6 +8130,7 @@ Douglas de la Torre Nicko Cadell Gert Driesen + Ron Grabowski @@ -7724,24 +8182,42 @@ The default value is true. + + + Defaults to %logger + + + + Gets or sets a value that indicates whether the appender will + flush at the end of each write. + + + The default behavior is to flush at the end of each + write. If the option is set tofalse, then the underlying + stream can defer writing to physical medium to a later time. + + + Avoiding the flush operation at the end of each append results + in a performance gain of 10 to 20 percent. However, there is safety + trade-off involved in skipping flushing. Indeed, when flushing is + skipped, then it is likely that the last few log events will not + be recorded on disk when the application exits. This is a high + price to pay even for a 20% performance gain. + + + + - Gets or sets a value that indicates whether the appender will - flush at the end of each write. + The category parameter sent to the Trace method. - The default behavior is to flush at the end of each - write. If the option is set tofalse, then the underlying - stream can defer writing to physical medium to a later time. - - Avoiding the flush operation at the end of each append results - in a performance gain of 10 to 20 percent. However, there is safety - trade-off involved in skipping flushing. Indeed, when flushing is - skipped, then it is likely that the last few log events will not - be recorded on disk when the application exits. This is a high - price to pay even for a 20% performance gain. + Defaults to %logger which will use the logger name of the current + as the category parameter. + + @@ -7814,17 +8290,17 @@ - - Gets or sets the repository to alias to this assemby's repository. - - - The repository to alias to this assemby's repository. - - - - The name of the repository to alias to this assemby's repository. - - + + Gets or sets the repository to alias to this assemby's repository. + + + The repository to alias to this assemby's repository. + + + + The name of the repository to alias to this assemby's repository. + + @@ -7853,13 +8329,22 @@ Appenders can also implement the interface. Therefore - they would require that the method + they would require that the method be called after the appenders properties have been configured. Nicko Cadell Gert Driesen + + + The fully qualified type of the BasicConfigurator class. + + + Used by the internal logger to record the Type of the + log message. + + Initializes a new instance of the class. @@ -7885,15 +8370,26 @@ - - Initializes the log4net system using the specified appender. - - The appender to use to log all logging events. - - - Initializes the log4net system using the specified appender. - - + + Initializes the log4net system using the specified appender. + + The appender to use to log all logging events. + + + Initializes the log4net system using the specified appender. + + + + + + Initializes the log4net system using the specified appenders. + + The appenders to use to log all logging events. + + + Initializes the log4net system using the specified appenders. + + @@ -7922,32 +8418,44 @@ - - - Base class for all log4net configuration attributes. - - - This is an abstract class that must be extended by - specific configurators. This attribute allows the - configurator to be parameterized by an assembly level - attribute. - - Nicko Cadell - Gert Driesen - - + - Constructor used by subclasses. + Initializes the using the specified appenders. - the ordering priority for this configurator + The repository to configure. + The appenders to use to log all logging events. - The is used to order the configurator - attributes before they are invoked. Higher priority configurators are executed - before lower priority ones. + Initializes the using the specified appender. + + + Base class for all log4net configuration attributes. + + + This is an abstract class that must be extended by + specific configurators. This attribute allows the + configurator to be parameterized by an assembly level + attribute. + + Nicko Cadell + Gert Driesen + + + + Constructor used by subclasses. + + the ordering priority for this configurator + + + The is used to order the configurator + attributes before they are invoked. Higher priority configurators are executed + before lower priority ones. + + + Configures the for the specified assembly. @@ -8045,19 +8553,19 @@ - - Gets or sets the name of the logging repository. - - - The string name to use as the name of the repository associated with this - assembly. - - - - This value does not have to be unique. Several assemblies can share the - same repository. They will share the logging configuration of the repository. - - + + Gets or sets the name of the logging repository. + + + The string name to use as the name of the repository associated with this + assembly. + + + + This value does not have to be unique. Several assemblies can share the + same repository. They will share the logging configuration of the repository. + + @@ -8119,27 +8627,27 @@ Gert Driesen - - Private constructor - + + Private constructor + - - Automatically configures the log4net system based on the - application's configuration settings. - - - - DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. - - Each application has a configuration file. This has the - same name as the application with '.config' appended. - This file is XML and calling this function prompts the - configurator to look in that file for a section called - log4net that contains the configuration data. - - - + + Automatically configures the log4net system based on the + application's configuration settings. + + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + Each application has a configuration file. This has the + same name as the application with '.config' appended. + This file is XML and calling this function prompts the + configurator to look in that file for a section called + log4net that contains the configuration data. + + + Automatically configures the using settings stored in the application's configuration file. @@ -8157,17 +8665,17 @@ The repository to configure. - - Configures log4net using a log4net element - - - - DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. - - Loads the log4net configuration from the XML element - supplied as . - - The element to parse. + + Configures log4net using a log4net element + + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + Loads the log4net configuration from the XML element + supplied as . + + The element to parse. @@ -8185,67 +8693,67 @@ The element to parse. - - Configures log4net using the specified configuration file. - - The XML file to load the configuration from. - - - DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. - - - The configuration file must be valid XML. It must contain - at least one element called log4net that holds - the log4net configuration data. - - - The log4net configuration file can possible be specified in the application's - configuration file (either MyAppName.exe.config for a - normal application on Web.config for an ASP.NET application). - - - The following example configures log4net using a configuration file, of which the - location is stored in the application's configuration file : - - - using log4net.Config; - using System.IO; - using System.Configuration; - - ... - - DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); - - - In the .config file, the path to the log4net can be specified like this : - - - - - - - - - + + Configures log4net using the specified configuration file. + + The XML file to load the configuration from. + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + + The configuration file must be valid XML. It must contain + at least one element called log4net that holds + the log4net configuration data. + + + The log4net configuration file can possible be specified in the application's + configuration file (either MyAppName.exe.config for a + normal application on Web.config for an ASP.NET application). + + + The following example configures log4net using a configuration file, of which the + location is stored in the application's configuration file : + + + using log4net.Config; + using System.IO; + using System.Configuration; + + ... + + DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); + + + In the .config file, the path to the log4net can be specified like this : + + + + + + + + + - - Configures log4net using the specified configuration file. - - A stream to load the XML configuration from. - - - DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. - - - The configuration data must be valid XML. It must contain - at least one element called log4net that holds - the log4net configuration data. - - - Note that this method will NOT close the stream parameter. - - + + Configures log4net using the specified configuration file. + + A stream to load the XML configuration from. + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + + The configuration data must be valid XML. It must contain + at least one element called log4net that holds + the log4net configuration data. + + + Note that this method will NOT close the stream parameter. + + @@ -8335,10 +8843,10 @@ For more information on how to configure log4net using - a separate configuration file, see . + a separate configuration file, see . - + @@ -8363,10 +8871,10 @@ For more information on how to configure log4net using - a separate configuration file, see . + a separate configuration file, see . - + @@ -8382,7 +8890,7 @@ Use this attribute to configure the - without calling one of the + without calling one of the methods. @@ -8400,7 +8908,7 @@ Use this attribute to configure the - without calling one of the + without calling one of the methods. @@ -8431,7 +8939,7 @@ If you cannot guarantee the order in which log4net calls will be made from different assemblies you must use programmatic configuration instead, i.e. - call the method directly. + call the method directly. @@ -8439,14 +8947,14 @@ Gert Driesen - - Default constructor - - - - Default constructor - - + + Default constructor + + + + Default constructor + + @@ -8462,14 +8970,14 @@ configure it. - The does not extend . + The does not extend . - - Attempt to load configuration from the local file system - - The assembly that this attribute was defined on. - The repository to configure. + + Attempt to load configuration from the local file system + + The assembly that this attribute was defined on. + The repository to configure. @@ -8479,11 +8987,20 @@ the FileInfo pointing to the config file - - Attempt to load configuration from a URI - - The assembly that this attribute was defined on. - The repository to configure. + + Attempt to load configuration from a URI + + The assembly that this attribute was defined on. + The repository to configure. + + + + The fully qualified type of the XmlConfiguratorAttribute class. + + + Used by the internal logger to record the Type of the + log message. + @@ -8528,53 +9045,53 @@ - - Gets or sets a value indicating whether to watch the configuration file. - - - true if the configuration should be watched, false otherwise. - - - - If this flag is specified and set to true then the framework - will watch the configuration file and will reload the config each time - the file is modified. - - - The config file can only be watched if it is loaded from local disk. - In a No-Touch (Smart Client) deployment where the application is downloaded - from a web server the config file may not reside on the local disk - and therefore it may not be able to watch it. - - - Watching configuration is not supported on the SSCLI. - - + + Gets or sets a value indicating whether to watch the configuration file. + + + true if the configuration should be watched, false otherwise. + + + + If this flag is specified and set to true then the framework + will watch the configuration file and will reload the config each time + the file is modified. + + + The config file can only be watched if it is loaded from local disk. + In a No-Touch (Smart Client) deployment where the application is downloaded + from a web server the config file may not reside on the local disk + and therefore it may not be able to watch it. + + + Watching configuration is not supported on the SSCLI. + + - - Class to register for the log4net section of the configuration file - - - The log4net section of the configuration file needs to have a section - handler registered. This is the section handler used. It simply returns - the XML element that is the root of the section. - - - Example of registering the log4net section handler : - - - -
- - - log4net configuration XML goes here - - - - - Nicko Cadell - Gert Driesen + + Class to register for the log4net section of the configuration file + + + The log4net section of the configuration file needs to have a section + handler registered. This is the section handler used. It simply returns + the XML element that is the root of the section. + + + Example of registering the log4net section handler : + + + +
+ + + log4net configuration XML goes here + + + + + Nicko Cadell + Gert Driesen @@ -8616,27 +9133,27 @@ Gert Driesen - - Interface used to create plugins. - - - - Interface used to create a plugin. - - - Nicko Cadell - Gert Driesen + + Interface used to create plugins. + + + + Interface used to create a plugin. + + + Nicko Cadell + Gert Driesen - - Creates the plugin object. - - the new plugin instance - - - Create and return a new plugin instance. - - + + Creates the plugin object. + + the new plugin instance + + + Create and return a new plugin instance. + + @@ -8678,29 +9195,29 @@ The plugin object. - - Returns a representation of the properties of this object. - - - - Overrides base class method to - return a representation of the properties of this object. - - - A representation of the properties of this object + + Returns a representation of the properties of this object. + + + + Overrides base class method to + return a representation of the properties of this object. + + + A representation of the properties of this object - - Gets or sets the type for the plugin. - - - The type for the plugin. - - - - The type for the plugin. - - + + Gets or sets the type for the plugin. + + + The type for the plugin. + + + + The type for the plugin. + + @@ -8729,7 +9246,7 @@ Use this attribute to configure the - without calling one of the + without calling one of the methods. @@ -8760,6 +9277,15 @@ + + + The fully qualified type of the SecurityContextProviderAttribute class. + + + Used by the internal logger to record the Type of the + log message. + + Gets or sets the type of the provider to use. @@ -8787,9 +9313,9 @@ Gert Driesen - - Private constructor - + + Private constructor + @@ -8836,16 +9362,16 @@ The repository to configure. - - Configures log4net using a log4net element - - - - Loads the log4net configuration from the XML element - supplied as . - - - The element to parse. + + Configures log4net using a log4net element + + + + Loads the log4net configuration from the XML element + supplied as . + + + The element to parse. @@ -8928,20 +9454,20 @@ - - Configures log4net using the specified configuration data stream. - - A stream to load the XML configuration from. - - - The configuration data must be valid XML. It must contain - at least one element called log4net that holds - the log4net configuration data. - - - Note that this method will NOT close the stream parameter. - - + + Configures log4net using the specified configuration data stream. + + A stream to load the XML configuration from. + + + The configuration data must be valid XML. It must contain + at least one element called log4net that holds + the log4net configuration data. + + + Note that this method will NOT close the stream parameter. + + @@ -9051,10 +9577,10 @@ For more information on how to configure log4net using - a separate configuration file, see . + a separate configuration file, see . - + @@ -9076,12 +9602,12 @@ For more information on how to configure log4net using - a separate configuration file, see . + a separate configuration file, see . - + - + Configures the specified repository using a log4net element. @@ -9098,6 +9624,22 @@ + + + Maps repository names to ConfigAndWatchHandler instances to allow a particular + ConfigAndWatchHandler to dispose of its FileSystemWatcher when a repository is + reconfigured. + + + + + The fully qualified type of the XmlConfigurator class. + + + Used by the internal logger to record the Type of the + log message. + + Class used to watch config files. @@ -9117,41 +9659,36 @@ - - The default amount of time to wait after receiving notification - before reloading the config file. - - - - - Watch a specified config file used to configure a repository - - The repository to configure. - The configuration file to watch. - - - Watch a specified config file used to configure a repository - - + + The default amount of time to wait after receiving notification + before reloading the config file. + - - Holds the FileInfo used to configure the XmlConfigurator - + + Holds the FileInfo used to configure the XmlConfigurator + - - Holds the repository being configured. - + + Holds the repository being configured. + - - The timer used to compress the notification events. - + + The timer used to compress the notification events. + + + + + Watches file for changes. This object should be disposed when no longer + needed to free system handles on the watched resources. + - Initializes a new instance of the class. + Initializes a new instance of the class to + watch a specified config file used to configure a repository. The repository to configure. The configuration file to watch. @@ -9186,10 +9723,15 @@ - - Called by the timer when the configuration has been updated. - - null + + Called by the timer when the configuration has been updated. + + null + + + + Release the handles held by the watcher and timer. + @@ -9251,7 +9793,7 @@ The named Lookup a named . This is the repository created by - calling . + calling . @@ -9264,7 +9806,7 @@ The created will be associated with the domain - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -9284,24 +9826,24 @@ The created will be associated with the name - specified such that a call to with the + specified such that a call to with the same name will return the same repository instance. - - Test if a named repository exists - - the named repository to check - true if the repository exists - - - Test if a named repository exists. Use - to create a new repository and to retrieve - a repository. - - + + Test if a named repository exists + + the named repository to check + true if the repository exists + + + Test if a named repository exists. Use + to create a new repository and to retrieve + a repository. + + @@ -9374,7 +9916,7 @@ Get the named . The default repository is log4net-default-repository. Other repositories - must be created using the . + must be created using the . If the named repository does not exist an exception is thrown. @@ -9414,7 +9956,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same repository specified will return the same repository instance. @@ -9429,18 +9971,18 @@ throw if the already exists - - Test if a named repository exists - - the named repository to check - true if the repository exists - - - Test if a named repository exists. Use - to create a new repository and to retrieve - a repository. - - + + Test if a named repository exists + + the named repository to check + true if the repository exists + + + Test if a named repository exists. Use + to create a new repository and to retrieve + a repository. + + @@ -9453,6 +9995,15 @@ + + + The fully qualified type of the CompactRepositorySelector class. + + + Used by the internal logger to record the Type of the + log message. + + Notify the registered listeners that the repository has been created @@ -9547,7 +10098,7 @@ does not exist a is thrown. - Use to create a repository. + Use to create a repository. is . @@ -9563,7 +10114,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -9603,7 +10154,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -9642,7 +10193,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same repository specified will return the same repository instance. @@ -9650,18 +10201,18 @@ already exists. - - Test if a named repository exists - - the named repository to check - true if the repository exists - - - Test if a named repository exists. Use - to create a new repository and to retrieve - a repository. - - + + Test if a named repository exists + + the named repository to check + true if the repository exists + + + Test if a named repository exists. Use + to create a new repository and to retrieve + a repository. + + @@ -9753,6 +10304,15 @@ is . + + + The fully qualified type of the DefaultRepositorySelector class. + + + Used by the internal logger to record the Type of the + log message. + + Event to notify that a logger repository has been created. @@ -9770,102 +10330,190 @@ - - Defined error codes that can be passed to the method. - - - - Values passed to the method. - - - Nicko Cadell + + Defined error codes that can be passed to the method. + + + + Values passed to the method. + + + Nicko Cadell - - A general error - + + A general error + - - Error while writing output - + + Error while writing output + - - Failed to flush file - + + Failed to flush file + - - Failed to close file - + + Failed to close file + - - Unable to open output file - + + Unable to open output file + - - No layout specified - + + No layout specified + - - Failed to parse address - + + Failed to parse address + - + - Appenders may delegate their error handling to an . + An evaluator that triggers on an Exception type - Error handling is a particularly tedious to get right because by - definition errors are hard to predict and to reproduce. + This evaluator will trigger if the type of the Exception + passed to + is equal to a Type in . /// - Nicko Cadell - Gert Driesen + Drew Schaeffer - + - Handles the error and information about the error condition is passed as - a parameter. + Test if an triggers an action - The message associated with the error. - The that was thrown when the error occurred. - The error code associated with the error. - Handles the error and information about the error condition is passed as - a parameter. + Implementations of this interface allow certain appenders to decide + when to perform an appender specific action. + + + The action or behavior triggered is defined by the implementation. + Nicko Cadell - + + + Test if this event triggers the action + + The event to check + true if this event triggers the action, otherwise false + + + Return true if this event triggers the action + + + + + + The type that causes the trigger to fire. + + + - Prints the error message passed as a parameter. + Causes subclasses of to cause the trigger to fire. + + + + + Default ctor to allow dynamic creation through a configurator. + + + + + Constructs an evaluator and initializes to trigger on + + the type that triggers this evaluator. + If true, this evaluator will trigger on subclasses of . + + + + Is this the triggering event? + + The event to check + This method returns true, if the logging event Exception + Type is . + Otherwise it returns false + + + This evaluator will trigger if the Exception Type of the event + passed to + is . + + + + + + The type that triggers this evaluator. + + + + + If true, this evaluator will trigger on subclasses of . + + + + + Appenders may delegate their error handling to an . + + + + Error handling is a particularly tedious to get right because by + definition errors are hard to predict and to reproduce. + + + Nicko Cadell + Gert Driesen + + + + Handles the error and information about the error condition is passed as + a parameter. The message associated with the error. The that was thrown when the error occurred. + The error code associated with the error. - See . + Handles the error and information about the error condition is passed as + a parameter. - + Prints the error message passed as a parameter. The message associated with the error. + The that was thrown when the error occurred. - See . + See . + + + Prints the error message passed as a parameter. + + The message associated with the error. + + + See . + + + Interface for objects that require fixing. @@ -9888,63 +10536,63 @@ Nicko Cadell - - Get a portable version of this object - - the portable instance of this object - - - Get a portable instance object that represents the current - state of this object. The portable object can be stored - and logged from any thread with identical results. - - + + Get a portable version of this object + + the portable instance of this object + + + Get a portable instance object that represents the current + state of this object. The portable object can be stored + and logged from any thread with identical results. + + - - Interface that all loggers implement - - - - This interface supports logging events and testing if a level - is enabled for logging. - - - These methods will not throw exceptions. Note to implementor, ensure - that the implementation of these methods cannot allow an exception - to be thrown to the caller. - - - Nicko Cadell - Gert Driesen + + Interface that all loggers implement + + + + This interface supports logging events and testing if a level + is enabled for logging. + + + These methods will not throw exceptions. Note to implementor, ensure + that the implementation of these methods cannot allow an exception + to be thrown to the caller. + + + Nicko Cadell + Gert Driesen - - This generic form is intended to be used by wrappers. - - The declaring type of the method that is - the stack boundary into the logging system for this call. - The level of the message to be logged. - The message object to log. - the exception to log, including its stack trace. Pass null to not log an exception. - - - Generates a logging event for the specified using - the and . - - + + This generic form is intended to be used by wrappers. + + The declaring type of the method that is + the stack boundary into the logging system for this call. + The level of the message to be logged. + The message object to log. + the exception to log, including its stack trace. Pass null to not log an exception. + + + Generates a logging event for the specified using + the and . + + - - This is the most generic printing method that is intended to be used - by wrappers. - - The event being logged. - - - Logs the specified logging event through this logger. - - + + This is the most generic printing method that is intended to be used + by wrappers. + + The event being logged. + + + Logs the specified logging event through this logger. + + @@ -9961,17 +10609,17 @@ - - Gets the name of the logger. - - - The name of the logger. - - - - The name of this logger - - + + Gets the name of the logger. + + + The name of the logger. + + + + The name of this logger + + @@ -9989,18 +10637,18 @@ - - Base interface for all wrappers - - - - Base interface for all wrappers. - - - All wrappers must implement this interface. - - - Nicko Cadell + + Base interface for all wrappers + + + + Base interface for all wrappers. + + + All wrappers must implement this interface. + + + Nicko Cadell @@ -10072,33 +10720,6 @@ - - - Test if an triggers an action - - - - Implementations of this interface allow certain appenders to decide - when to perform an appender specific action. - - - The action or behavior triggered is defined by the implementation. - - - Nicko Cadell - - - - Test if this event triggers the action - - The event to check - true if this event triggers the action, otherwise false - - - Return true if this event triggers the action - - - Defines the default set of levels recognized by the system. @@ -10410,6 +11031,12 @@ The level designates a higher level than all the rest. + + + The level designates very severe error events. + System unusable, emergencies. + + The level designates very severe error events. @@ -10505,43 +11132,43 @@ - - Gets the name of this level. - - - The name of this level. - - - - Gets the name of this level. - - + + Gets the name of this level. + + + The name of this level. + + + + Gets the name of this level. + + - - Gets the value of this level. - - - The value of this level. - - - - Gets the value of this level. - - + + Gets the value of this level. + + + The value of this level. + + + + Gets the value of this level. + + - - Gets the display name of this level. - - - The display name of this level. - - - - Gets the display name of this level. - - + + Gets the display name of this level. + + + The display name of this level. + + + + Gets the display name of this level. + + @@ -10550,35 +11177,35 @@ Nicko Cadell - - Creates a read-only wrapper for a LevelCollection instance. - - list to create a readonly wrapper arround - - A LevelCollection wrapper that is read-only. - + + Creates a read-only wrapper for a LevelCollection instance. + + list to create a readonly wrapper arround + + A LevelCollection wrapper that is read-only. + - - Initializes a new instance of the LevelCollection class - that is empty and has the default initial capacity. - + + Initializes a new instance of the LevelCollection class + that is empty and has the default initial capacity. + - - Initializes a new instance of the LevelCollection class - that has the specified initial capacity. - - - The number of elements that the new LevelCollection is initially capable of storing. - + + Initializes a new instance of the LevelCollection class + that has the specified initial capacity. + + + The number of elements that the new LevelCollection is initially capable of storing. + - - Initializes a new instance of the LevelCollection class - that contains elements copied from the specified LevelCollection. - - The LevelCollection whose elements are copied to the new collection. + + Initializes a new instance of the LevelCollection class + that contains elements copied from the specified LevelCollection. + + The LevelCollection whose elements are copied to the new collection. @@ -10595,10 +11222,10 @@ The collection whose elements are copied to the new list. - - Allow subclasses to avoid our default constructors - - + + Allow subclasses to avoid our default constructors + + @@ -10623,9 +11250,9 @@ The index at which the value has been added. - - Removes all elements from the LevelCollection. - + + Removes all elements from the LevelCollection. + @@ -10711,39 +11338,39 @@ The new of the LevelCollection. - - Sets the capacity to the actual number of elements. - + + Sets the capacity to the actual number of elements. + - is less than zero + is less than zero -or- - is equal to or greater than . + is equal to or greater than . - is less than zero + is less than zero -or- - is equal to or greater than . + is equal to or greater than . - - Gets the number of elements actually contained in the LevelCollection. - + + Gets the number of elements actually contained in the LevelCollection. + - - Gets a value indicating whether access to the collection is synchronized (thread-safe). - - true if access to the ICollection is synchronized (thread-safe); otherwise, false. + + Gets a value indicating whether access to the collection is synchronized (thread-safe). + + true if access to the ICollection is synchronized (thread-safe); otherwise, false. - - Gets an object that can be used to synchronize access to the collection. - + + Gets an object that can be used to synchronize access to the collection. + @@ -10757,21 +11384,21 @@ - - Gets a value indicating whether the collection has a fixed size. - - true if the collection has a fixed size; otherwise, false. The default is false + + Gets a value indicating whether the collection has a fixed size. + + true if the collection has a fixed size; otherwise, false. The default is false - - Gets a value indicating whether the IList is read-only. - - true if the collection is read-only; otherwise, false. The default is false + + Gets a value indicating whether the IList is read-only. + + true if the collection is read-only; otherwise, false. The default is false - - Gets or sets the number of elements the LevelCollection can contain. - + + Gets or sets the number of elements the LevelCollection can contain. + @@ -10791,25 +11418,25 @@ - - Sets the enumerator to its initial position, before the first element in the collection. - + + Sets the enumerator to its initial position, before the first element in the collection. + - - Gets the current element in the collection. - + + Gets the current element in the collection. + - - Type visible only to our subclasses - Used to access protected constructor - + + Type visible only to our subclasses + Used to access protected constructor + - - A value - + + A value + @@ -10817,10 +11444,10 @@ - - Initializes a new instance of the Enumerator class. - - + + Initializes a new instance of the Enumerator class. + + @@ -10835,14 +11462,14 @@ - - Sets the enumerator to its initial position, before the first element in the collection. - + + Sets the enumerator to its initial position, before the first element in the collection. + - - Gets the current element in the collection. - + + Gets the current element in the collection. + @@ -10851,7 +11478,7 @@ This evaluator will trigger if the level of the event - passed to + passed to is equal to or greater than the level. @@ -10859,9 +11486,9 @@ Nicko Cadell - - The threshold for triggering - + + The threshold for triggering + @@ -10873,7 +11500,7 @@ This evaluator will trigger if the level of the event - passed to + passed to is equal to or greater than the level. @@ -10890,7 +11517,7 @@ This evaluator will trigger if the level of the event - passed to + passed to is equal to or greater than the level. @@ -10907,7 +11534,7 @@ This evaluator will trigger if the level of the event - passed to + passed to is equal to or greater than the level. @@ -10923,7 +11550,7 @@ This evaluator will trigger if the level of the event - passed to + passed to is equal to or greater than the level. @@ -10943,67 +11570,67 @@ Nicko Cadell - - Mapping from level name to Level object. The - level name is case insensitive - + + Mapping from level name to Level object. The + level name is case insensitive + - - Construct the level map - - - - Construct the level map. - - + + Construct the level map + + + + Construct the level map. + + - - Clear the internal maps of all levels - - - - Clear the internal maps of all levels - - + + Clear the internal maps of all levels + + + + Clear the internal maps of all levels + + - - Create a new Level and add it to the map - - the string to display for the Level - the level value to give to the Level - - - Create a new Level and add it to the map - - - + + Create a new Level and add it to the map + + the string to display for the Level + the level value to give to the Level + + + Create a new Level and add it to the map + + + - - Create a new Level and add it to the map - - the string to display for the Level - the level value to give to the Level - the display name to give to the Level - - - Create a new Level and add it to the map - - + + Create a new Level and add it to the map + + the string to display for the Level + the level value to give to the Level + the display name to give to the Level + + + Create a new Level and add it to the map + + - - Add a Level to the map - - the Level to add - - - Add a Level to the map - - + + Add a Level to the map + + the Level to add + + + Add a Level to the map + + @@ -11040,70 +11667,70 @@ + + Return all possible levels as a list of Level objects. + + all possible levels as a list of Level objects + + + Return all possible levels as a list of Level objects. + + + + + + The internal representation of caller location information. + + + + This class uses the System.Diagnostics.StackTrace class to generate + a call stack. The caller's information is then extracted from this stack. + + + The System.Diagnostics.StackTrace class is not supported on the + .NET Compact Framework 1.0 therefore caller location information is not + available on that framework. + + + The System.Diagnostics.StackTrace class has this to say about Release builds: + + + "StackTrace information will be most informative with Debug build configurations. + By default, Debug builds include debug symbols, while Release builds do not. The + debug symbols contain most of the file, method name, line number, and column + information used in constructing StackFrame and StackTrace objects. StackTrace + might not report as many method calls as expected, due to code transformations + that occur during optimization." + + + This means that in a Release build the caller information may be incomplete or may + not exist at all! Therefore caller location information cannot be relied upon in a Release build. + + + Nicko Cadell + Gert Driesen + + + + When location information is not available the constant + NA is returned. Current value of this string + constant is ?. + + + - Return all possible levels as a list of Level objects. + Constructor - all possible levels as a list of Level objects + The declaring type of the method that is + the stack boundary into the logging system for this call. - Return all possible levels as a list of Level objects. + Initializes a new instance of the + class based on the current thread. - - - The internal representation of caller location information. - - - - This class uses the System.Diagnostics.StackTrace class to generate - a call stack. The caller's information is then extracted from this stack. - - - The System.Diagnostics.StackTrace class is not supported on the - .NET Compact Framework 1.0 therefore caller location information is not - available on that framework. - - - The System.Diagnostics.StackTrace class has this to say about Release builds: - - - "StackTrace information will be most informative with Debug build configurations. - By default, Debug builds include debug symbols, while Release builds do not. The - debug symbols contain most of the file, method name, line number, and column - information used in constructing StackFrame and StackTrace objects. StackTrace - might not report as many method calls as expected, due to code transformations - that occur during optimization." - - - This means that in a Release build the caller information may be incomplete or may - not exist at all! Therefore caller location information cannot be relied upon in a Release build. - - - Nicko Cadell - Gert Driesen - - - - When location information is not available the constant - NA is returned. Current value of this string - constant is ?. - - - - - Constructor - - The declaring type of the method that is - the stack boundary into the logging system for this call. - - - Initializes a new instance of the - class based on the current thread. - - - - + Constructor @@ -11118,75 +11745,89 @@ + + + The fully qualified type of the LocationInfo class. + + + Used by the internal logger to record the Type of the + log message. + + - - Gets the fully qualified class name of the caller making the logging - request. - - - The fully qualified class name of the caller making the logging - request. - - - - Gets the fully qualified class name of the caller making the logging - request. - - + + Gets the fully qualified class name of the caller making the logging + request. + + + The fully qualified class name of the caller making the logging + request. + + + + Gets the fully qualified class name of the caller making the logging + request. + + - - Gets the file name of the caller. - - - The file name of the caller. - - - - Gets the file name of the caller. - - + + Gets the file name of the caller. + + + The file name of the caller. + + + + Gets the file name of the caller. + + - - Gets the line number of the caller. - - - The line number of the caller. - - - - Gets the line number of the caller. - - + + Gets the line number of the caller. + + + The line number of the caller. + + + + Gets the line number of the caller. + + - - Gets the method name of the caller. - - - The method name of the caller. - - - - Gets the method name of the caller. - - + + Gets the method name of the caller. + + + The method name of the caller. + + + + Gets the method name of the caller. + + - - Gets all available caller information - - - All available caller information, in the format - fully.qualified.classname.of.caller.methodName(Filename:line) - - - - Gets all available caller information, in the format - fully.qualified.classname.of.caller.methodName(Filename:line) - - + + Gets all available caller information + + + All available caller information, in the format + fully.qualified.classname.of.caller.methodName(Filename:line) + + + + Gets all available caller information, in the format + fully.qualified.classname.of.caller.methodName(Filename:line) + + + + + + Gets the stack frames from the stack trace of the caller making the log request + @@ -11212,40 +11853,40 @@ Gert Driesen - - Private constructor to prevent instances. Only static methods should be used. - - - - Private constructor to prevent instances. Only static methods should be used. - - + + Private constructor to prevent instances. Only static methods should be used. + + + + Private constructor to prevent instances. Only static methods should be used. + + - - Hook the shutdown event - - - - On the full .NET runtime, the static constructor hooks up the - AppDomain.ProcessExit and AppDomain.DomainUnload> events. - These are used to shutdown the log4net system as the application exits. - - + + Hook the shutdown event + + + + On the full .NET runtime, the static constructor hooks up the + AppDomain.ProcessExit and AppDomain.DomainUnload> events. + These are used to shutdown the log4net system as the application exits. + + - - Register for ProcessExit and DomainUnload events on the AppDomain - - - - This needs to be in a separate method because the events make - a LinkDemand for the ControlAppDomain SecurityPermission. Because - this is a LinkDemand it is demanded at JIT time. Therefore we cannot - catch the exception in the method itself, we have to catch it in the - caller. - - + + Register for ProcessExit and DomainUnload events on the AppDomain + + + + This needs to be in a separate method because the events make + a LinkDemand for the ControlAppDomain SecurityPermission. Because + this is a LinkDemand it is demanded at JIT time. Therefore we cannot + catch the exception in the method itself, we have to catch it in the + caller. + + @@ -11293,201 +11934,201 @@ - - Returns the named logger if it exists. - - The repository to lookup in. - The fully qualified logger name to look for. - - The logger found, or null if the named logger does not exist in the - specified repository. - - - - If the named logger exists (in the specified repository) then it - returns a reference to the logger, otherwise it returns - null. - - + + Returns the named logger if it exists. + + The repository to lookup in. + The fully qualified logger name to look for. + + The logger found, or null if the named logger does not exist in the + specified repository. + + + + If the named logger exists (in the specified repository) then it + returns a reference to the logger, otherwise it returns + null. + + - - Returns the named logger if it exists. - - The assembly to use to lookup the repository. - The fully qualified logger name to look for. - - The logger found, or null if the named logger does not exist in the - specified assembly's repository. - - - - If the named logger exists (in the specified assembly's repository) then it - returns a reference to the logger, otherwise it returns - null. - - + + Returns the named logger if it exists. + + The assembly to use to lookup the repository. + The fully qualified logger name to look for. + + The logger found, or null if the named logger does not exist in the + specified assembly's repository. + + + + If the named logger exists (in the specified assembly's repository) then it + returns a reference to the logger, otherwise it returns + null. + + - - Returns all the currently defined loggers in the specified repository. - - The repository to lookup in. - All the defined loggers. - - - The root logger is not included in the returned array. - - + + Returns all the currently defined loggers in the specified repository. + + The repository to lookup in. + All the defined loggers. + + + The root logger is not included in the returned array. + + - - Returns all the currently defined loggers in the specified assembly's repository. - - The assembly to use to lookup the repository. - All the defined loggers. - - - The root logger is not included in the returned array. - - + + Returns all the currently defined loggers in the specified assembly's repository. + + The assembly to use to lookup the repository. + All the defined loggers. + + + The root logger is not included in the returned array. + + - - Retrieves or creates a named logger. - - The repository to lookup in. - The name of the logger to retrieve. - The logger with the name specified. - - - Retrieves a logger named as the - parameter. If the named logger already exists, then the - existing instance will be returned. Otherwise, a new instance is - created. - - - By default, loggers do not have a set level but inherit - it from the hierarchy. This is one of the central features of - log4net. - - + + Retrieves or creates a named logger. + + The repository to lookup in. + The name of the logger to retrieve. + The logger with the name specified. + + + Retrieves a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + - - Retrieves or creates a named logger. - - The assembly to use to lookup the repository. - The name of the logger to retrieve. - The logger with the name specified. - - - Retrieves a logger named as the - parameter. If the named logger already exists, then the - existing instance will be returned. Otherwise, a new instance is - created. - - - By default, loggers do not have a set level but inherit - it from the hierarchy. This is one of the central features of - log4net. - - + + Retrieves or creates a named logger. + + The assembly to use to lookup the repository. + The name of the logger to retrieve. + The logger with the name specified. + + + Retrieves a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + - - Shorthand for . - - The repository to lookup in. - The of which the fullname will be used as the name of the logger to retrieve. - The logger with the name specified. - - - Gets the logger for the fully qualified name of the type specified. - - + + Shorthand for . + + The repository to lookup in. + The of which the fullname will be used as the name of the logger to retrieve. + The logger with the name specified. + + + Gets the logger for the fully qualified name of the type specified. + + - - Shorthand for . - - the assembly to use to lookup the repository - The of which the fullname will be used as the name of the logger to retrieve. - The logger with the name specified. - - - Gets the logger for the fully qualified name of the type specified. - - + + Shorthand for . + + the assembly to use to lookup the repository + The of which the fullname will be used as the name of the logger to retrieve. + The logger with the name specified. + + + Gets the logger for the fully qualified name of the type specified. + + - - Shuts down the log4net system. - - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in all the - default repositories. - - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - - The shutdown method is careful to close nested - appenders before closing regular appenders. This is allows - configurations where a regular appender is attached to a logger - and again to a nested appender. - - + + Shuts down the log4net system. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in all the + default repositories. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + - - Shuts down the repository for the repository specified. - - The repository to shutdown. - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in the - repository for the specified. - - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - - The shutdown method is careful to close nested - appenders before closing regular appenders. This is allows - configurations where a regular appender is attached to a logger - and again to a nested appender. - - + + Shuts down the repository for the repository specified. + + The repository to shutdown. + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + repository for the specified. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + - - Shuts down the repository for the repository specified. - - The assembly to use to lookup the repository. - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in the - repository for the repository. The repository is looked up using - the specified. - - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - - The shutdown method is careful to close nested - appenders before closing regular appenders. This is allows - configurations where a regular appender is attached to a logger - and again to a nested appender. - - + + Shuts down the repository for the repository specified. + + The assembly to use to lookup the repository. + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + repository for the repository. The repository is looked up using + the specified. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + @@ -11612,7 +12253,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -11629,7 +12270,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -11646,10 +12287,10 @@ - - Internal method to get pertinent version info. - - A string of version info. + + Internal method to get pertinent version info. + + A string of version info. @@ -11662,7 +12303,7 @@ Called when the event fires. - When the event is triggered the log4net system is . + When the event is triggered the log4net system is . @@ -11677,14 +12318,23 @@ Called when the event fires. - When the event is triggered the log4net system is . + When the event is triggered the log4net system is . + + + The fully qualified type of the LoggerManager class. + + + Used by the internal logger to record the Type of the + log message. + + - - Initialize the default repository selector - + + Initialize the default repository selector + @@ -11702,7 +12352,7 @@ The caller to supplies either a string name or an assembly (if not supplied the assembly is inferred using - ). + ). This context is used by the selector to lookup a specific repository. @@ -11727,20 +12377,20 @@ Gert Driesen - - Constructs a new wrapper for the specified logger. - - The logger to wrap. - - - Constructs a new wrapper for the specified logger. - - + + Constructs a new wrapper for the specified logger. + + The logger to wrap. + + + Constructs a new wrapper for the specified logger. + + - - The logger that this object is wrapping - + + The logger that this object is wrapping + @@ -11772,119 +12422,119 @@ Nicko Cadell - - The logger name. - - - - The logger name. - - + + The logger name. + + + + The logger name. + + - - Level of logging event. - - - - Level of logging event. Level cannot be Serializable - because it is a flyweight. Due to its special serialization it - cannot be declared final either. - - + + Level of logging event. + + + + Level of logging event. Level cannot be Serializable + because it is a flyweight. Due to its special serialization it + cannot be declared final either. + + - - The application supplied message. - - - - The application supplied message of logging event. - - + + The application supplied message. + + + + The application supplied message of logging event. + + - - The name of thread - - - - The name of thread in which this logging event was generated - - + + The name of thread + + + + The name of thread in which this logging event was generated + + - - The time the event was logged - - - - The TimeStamp is stored in the local time zone for this computer. - - + + The time the event was logged + + + + The TimeStamp is stored in the local time zone for this computer. + + - - Location information for the caller. - - - - Location information for the caller. - - + + Location information for the caller. + + + + Location information for the caller. + + - - String representation of the user - - - - String representation of the user's windows name, - like DOMAIN\username - - + + String representation of the user + + + + String representation of the user's windows name, + like DOMAIN\username + + - - String representation of the identity. - - - - String representation of the current thread's principal identity. - - + + String representation of the identity. + + + + String representation of the current thread's principal identity. + + - - The string representation of the exception - - - - The string representation of the exception - - + + The string representation of the exception + + + + The string representation of the exception + + - - String representation of the AppDomain. - - - - String representation of the AppDomain. - - + + String representation of the AppDomain. + + + + String representation of the AppDomain. + + - - Additional event specific properties - - - - A logger or an appender may attach additional - properties to specific events. These properties - have a string key and an object value. - - + + Additional event specific properties + + + + A logger or an appender may attach additional + properties to specific events. These properties + have a string key and an object value. + + @@ -11898,73 +12548,73 @@ Nicko Cadell - - Fix the MDC - + + Fix the MDC + - - Fix the NDC - + + Fix the NDC + - - Fix the rendered message - + + Fix the rendered message + - - Fix the thread name - + + Fix the thread name + - - Fix the callers location information - - - CAUTION: Very slow to generate - + + Fix the callers location information + + + CAUTION: Very slow to generate + - - Fix the callers windows user name - - - CAUTION: Slow to generate - + + Fix the callers windows user name + + + CAUTION: Slow to generate + - - Fix the domain friendly name - + + Fix the domain friendly name + - - Fix the callers principal name - - - CAUTION: May be slow to generate - + + Fix the callers principal name + + + CAUTION: May be slow to generate + - - Fix the exception text - + + Fix the exception text + - Fix the event properties + Fix the event properties. Active properties must implement in order to be eligible for fixing. - - No fields fixed - + + No fields fixed + - - All fields fixed - + + All fields fixed + @@ -12002,8 +12652,8 @@ time the event is delivered to appenders, but will not be consistent at any time afterwards. If an event is to be stored and then processed at a later time these volatile values must be fixed by calling - . There is a performance penalty - for incurred by calling but it + . There is a performance penalty + for incurred by calling but it is essential to maintaining data consistency. @@ -12013,19 +12663,19 @@ Daniel Cazzulino - - The key into the Properties map for the host name value. - + + The key into the Properties map for the host name value. + - - The key into the Properties map for the thread identity value. - + + The key into the Properties map for the thread identity value. + - - The key into the Properties map for the user name value. - + + The key into the Properties map for the user name value. + @@ -12043,7 +12693,7 @@ Except , and , all fields of LoggingEvent are filled when actually needed. Call - to cache all data locally + to cache all data locally to prevent inconsistencies. This method is called by the log4net framework @@ -12068,7 +12718,7 @@ be useful if you require a custom serialization scheme. - Use the method to obtain an + Use the method to obtain an instance of the class. @@ -12094,7 +12744,7 @@ be useful if you require a custom serialization scheme. - Use the method to obtain an + Use the method to obtain an instance of the class. @@ -12117,7 +12767,7 @@ be useful if you require a custom serialization scheme. - Use the method to obtain an + Use the method to obtain an instance of the class. @@ -12141,10 +12791,10 @@ - - Ensure that the repository is set. - - the value for the repository + + Ensure that the repository is set. + + the value for the repository @@ -12172,7 +12822,7 @@ The data in this event must be fixed before it can be serialized. - The method must be called during the + The method must be called during the method call if this event is to be used outside that method. @@ -12247,17 +12897,17 @@ time the event is delivered to appenders, but will not be consistent at any time afterwards. If an event is to be stored and then processed at a later time these volatile values must be fixed by calling - . There is a performance penalty - incurred by calling but it + . There is a performance penalty + incurred by calling but it is essential to maintaining data consistency. - Calling is equivalent to - calling passing the parameter + Calling is equivalent to + calling passing the parameter false. - See for more + See for more information. @@ -12274,8 +12924,8 @@ time the event is delivered to appenders, but will not be consistent at any time afterwards. If an event is to be stored and then processed at a later time these volatile values must be fixed by calling - . There is a performance penalty - for incurred by calling but it + . There is a performance penalty + for incurred by calling but it is essential to maintaining data consistency. @@ -12358,88 +13008,88 @@ - - The internal logging event data. - + + The internal logging event data. + - - The internal logging event data. - + + The internal logging event data. + - - The internal logging event data. - + + The internal logging event data. + - - The fully qualified Type of the calling - logger class in the stack frame (i.e. the declaring type of the method). - + + The fully qualified Type of the calling + logger class in the stack frame (i.e. the declaring type of the method). + - - The application supplied message of logging event. - + + The application supplied message of logging event. + - - The exception that was thrown. - - - This is not serialized. The string representation - is serialized instead. - + + The exception that was thrown. + + + This is not serialized. The string representation + is serialized instead. + - - The repository that generated the logging event - - - This is not serialized. - + + The repository that generated the logging event + + + This is not serialized. + - - The fix state for this event - - - These flags indicate which fields have been fixed. - Not serialized. - + + The fix state for this event + + + These flags indicate which fields have been fixed. + Not serialized. + - - Indicated that the internal cache is updateable (ie not fixed) - - - This is a seperate flag to m_fixFlags as it allows incrementel fixing and simpler - changes in the caching strategy. - + + Indicated that the internal cache is updateable (ie not fixed) + + + This is a seperate flag to m_fixFlags as it allows incrementel fixing and simpler + changes in the caching strategy. + - - Gets the time when the current process started. - - - This is the time when this process started. - - - - The TimeStamp is stored in the local time zone for this computer. - - - Tries to get the start time for the current process. - Failing that it returns the time of the first call to - this property. - - - Note that AppDomains may be loaded and unloaded within the - same process without the process terminating and therefore - without the process start time being reset. - - + + Gets the time when the current process started. + + + This is the time when this process started. + + + + The TimeStamp is stored in the local time zone for this computer. + + + Tries to get the start time for the current process. + Failing that it returns the time of the first call to + this property. + + + Note that AppDomains may be loaded and unloaded within the + same process without the process terminating and therefore + without the process start time being reset. + + @@ -12455,30 +13105,30 @@ - - Gets the time of the logging event. - - - The time of the logging event. - - - - The TimeStamp is stored in the local time zone for this computer. - - + + Gets the time of the logging event. + + + The time of the logging event. + + + + The TimeStamp is stored in the local time zone for this computer. + + - - Gets the name of the logger that logged the event. - - - The name of the logger that logged the event. - - - - Gets the name of the logger that logged the event. - - + + Gets the name of the logger that logged the event. + + + The name of the logger that logged the event. + + + + Gets the name of the logger that logged the event. + + @@ -12566,94 +13216,94 @@ - - Gets the name of the current thread. - - - The name of the current thread, or the thread ID when - the name is not available. - - - - The collected information is cached for future use. - - + + Gets the name of the current thread. + + + The name of the current thread, or the thread ID when + the name is not available. + + + + The collected information is cached for future use. + + - - Gets the name of the current user. - - - The name of the current user, or NOT AVAILABLE when the - underlying runtime has no support for retrieving the name of the - current user. - - - - Calls WindowsIdentity.GetCurrent().Name to get the name of - the current windows user. - - - To improve performance, we could cache the string representation of - the name, and reuse that as long as the identity stayed constant. - Once the identity changed, we would need to re-assign and re-render - the string. - - - However, the WindowsIdentity.GetCurrent() call seems to - return different objects every time, so the current implementation - doesn't do this type of caching. - - - Timing for these operations: - - - - Method - Results - - - WindowsIdentity.GetCurrent() - 10000 loops, 00:00:00.2031250 seconds - - - WindowsIdentity.GetCurrent().Name - 10000 loops, 00:00:08.0468750 seconds - - - - This means we could speed things up almost 40 times by caching the - value of the WindowsIdentity.GetCurrent().Name property, since - this takes (8.04-0.20) = 7.84375 seconds. - - + + Gets the name of the current user. + + + The name of the current user, or NOT AVAILABLE when the + underlying runtime has no support for retrieving the name of the + current user. + + + + Calls WindowsIdentity.GetCurrent().Name to get the name of + the current windows user. + + + To improve performance, we could cache the string representation of + the name, and reuse that as long as the identity stayed constant. + Once the identity changed, we would need to re-assign and re-render + the string. + + + However, the WindowsIdentity.GetCurrent() call seems to + return different objects every time, so the current implementation + doesn't do this type of caching. + + + Timing for these operations: + + + + Method + Results + + + WindowsIdentity.GetCurrent() + 10000 loops, 00:00:00.2031250 seconds + + + WindowsIdentity.GetCurrent().Name + 10000 loops, 00:00:08.0468750 seconds + + + + This means we could speed things up almost 40 times by caching the + value of the WindowsIdentity.GetCurrent().Name property, since + this takes (8.04-0.20) = 7.84375 seconds. + + - - Gets the identity of the current thread principal. - - - The string name of the identity of the current thread principal. - - - - Calls System.Threading.Thread.CurrentPrincipal.Identity.Name to get - the name of the current thread principal. - - + + Gets the identity of the current thread principal. + + + The string name of the identity of the current thread principal. + + + + Calls System.Threading.Thread.CurrentPrincipal.Identity.Name to get + the name of the current thread principal. + + - - Gets the AppDomain friendly name. - - - The AppDomain friendly name. - - - - Gets the AppDomain friendly name. - - + + Gets the AppDomain friendly name. + + + The AppDomain friendly name. + + + + Gets the AppDomain friendly name. + + @@ -12684,18 +13334,18 @@ - - The fixed fields in this event - - - The set of fields that are fixed in this event - - - - Fields will not be fixed if they have previously been fixed. - It is not possible to 'unfix' a field. - - + + The fixed fields in this event + + + The set of fields that are fixed in this event + + + + Fields will not be fixed if they have previously been fixed. + It is not possible to 'unfix' a field. + + @@ -12714,7 +13364,7 @@ DEBUG - The and methods log messages + The and methods log messages at the DEBUG level. That is the level with that name defined in the repositories . The default value for this level is . The @@ -12724,7 +13374,7 @@ INFO - The and methods log messages + The and methods log messages at the INFO level. That is the level with that name defined in the repositories . The default value for this level is . The @@ -12734,7 +13384,7 @@ WARN - The and methods log messages + The and methods log messages at the WARN level. That is the level with that name defined in the repositories . The default value for this level is . The @@ -12744,7 +13394,7 @@ ERROR - The and methods log messages + The and methods log messages at the ERROR level. That is the level with that name defined in the repositories . The default value for this level is . The @@ -12754,7 +13404,7 @@ FATAL - The and methods log messages + The and methods log messages at the FATAL level. That is the level with that name defined in the repositories . The default value for this level is . The @@ -12778,7 +13428,7 @@ Use the to obtain logger instances - that implement this interface. The + that implement this interface. The static method is used to get logger instances. @@ -12807,7 +13457,7 @@ - + Nicko Cadell Gert Driesen @@ -12832,10 +13482,10 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. - + @@ -12848,10 +13498,10 @@ The exception to log, including its stack trace. - See the form for more detailed information. + See the form for more detailed information. - + @@ -12864,16 +13514,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -12885,16 +13535,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -12907,16 +13557,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -12930,16 +13580,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -12952,16 +13602,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -12984,11 +13634,11 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. The message object to log. - + @@ -13001,10 +13651,10 @@ The exception to log, including its stack trace. - See the form for more detailed information. + See the form for more detailed information. - + @@ -13017,16 +13667,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13038,16 +13688,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13060,16 +13710,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13083,16 +13733,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13105,16 +13755,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13137,11 +13787,11 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. The message object to log. - + @@ -13154,10 +13804,10 @@ The exception to log, including its stack trace. - See the form for more detailed information. + See the form for more detailed information. - + @@ -13170,16 +13820,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13191,16 +13841,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13213,16 +13863,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13236,16 +13886,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13258,16 +13908,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13291,10 +13941,10 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. - + @@ -13307,10 +13957,10 @@ The exception to log, including its stack trace. - See the form for more detailed information. + See the form for more detailed information. - + @@ -13323,16 +13973,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13344,16 +13994,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13366,16 +14016,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13389,16 +14039,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13411,16 +14061,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13443,11 +14093,11 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. The message object to log. - + @@ -13460,10 +14110,10 @@ The exception to log, including its stack trace. - See the form for more detailed information. + See the form for more detailed information. - + @@ -13476,16 +14126,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13497,16 +14147,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13519,16 +14169,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13542,16 +14192,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13564,16 +14214,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13611,7 +14261,7 @@ the other hand, if the log is debug enabled, you will incur the cost of evaluating whether the logger is debug enabled twice. Once in and once in - the . This is an insignificant overhead + the . This is an insignificant overhead since evaluating a logger takes about 1% of the time it takes to actually log. This is the preferred style of logging. @@ -13644,8 +14294,8 @@ speed or runtime flexibility. - - + + @@ -13657,8 +14307,8 @@ For more information see . - - + + @@ -13671,8 +14321,8 @@ For more information see . - - + + @@ -13685,8 +14335,8 @@ For more information see . - - + + @@ -13699,31 +14349,31 @@ For more information see . - - + + - - Construct a new wrapper for the specified logger. - - The logger to wrap. - - - Construct a new wrapper for the specified logger. - - + + Construct a new wrapper for the specified logger. + + The logger to wrap. + + + Construct a new wrapper for the specified logger. + + - - Virtual method called when the configuration of the repository changes - - the repository holding the levels - - - Virtual method called when the configuration of the repository changes - - + + Virtual method called when the configuration of the repository changes + + the repository holding the levels + + + Virtual method called when the configuration of the repository changes + + @@ -13746,7 +14396,7 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. @@ -13763,10 +14413,10 @@ as a parameter. - See the form for more detailed information. + See the form for more detailed information. - + @@ -13776,18 +14426,18 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13800,18 +14450,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13825,18 +14475,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13851,18 +14501,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13876,13 +14526,13 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13908,7 +14558,7 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. @@ -13925,10 +14575,10 @@ passed as a parameter. - See the form for more detailed information. + See the form for more detailed information. - + @@ -13938,18 +14588,18 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13962,18 +14612,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13987,18 +14637,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14013,18 +14663,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14038,13 +14688,13 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14070,7 +14720,7 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. @@ -14087,10 +14737,10 @@ passed as a parameter. - See the form for more detailed information. + See the form for more detailed information. - + @@ -14100,18 +14750,18 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14124,18 +14774,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14149,18 +14799,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14175,18 +14825,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14200,13 +14850,13 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14232,7 +14882,7 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. @@ -14249,10 +14899,10 @@ passed as a parameter. - See the form for more detailed information. + See the form for more detailed information. - + @@ -14262,18 +14912,18 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14286,18 +14936,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14311,18 +14961,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14337,18 +14987,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14362,13 +15012,13 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14394,7 +15044,7 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. @@ -14411,10 +15061,10 @@ passed as a parameter. - See the form for more detailed information. + See the form for more detailed information. - + @@ -14424,18 +15074,18 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14448,18 +15098,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14473,18 +15123,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14499,18 +15149,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14524,13 +15174,13 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14543,54 +15193,54 @@ Empty - - The fully qualified name of this declaring type not the type of any subclass. - + + The fully qualified name of this declaring type not the type of any subclass. + - - Checks if this logger is enabled for the DEBUG - level. - - - true if this logger is enabled for DEBUG events, - false otherwise. - - - - This function is intended to lessen the computational cost of - disabled log debug statements. - - - For some log Logger object, when you write: - - - log.Debug("This is entry number: " + i ); - - - You incur the cost constructing the message, concatenation in - this case, regardless of whether the message is logged or not. - - - If you are worried about speed, then you should write: - - - if (log.IsDebugEnabled()) - { - log.Debug("This is entry number: " + i ); - } - - - This way you will not incur the cost of parameter - construction if debugging is disabled for log. On - the other hand, if the log is debug enabled, you - will incur the cost of evaluating whether the logger is debug - enabled twice. Once in IsDebugEnabled and once in - the Debug. This is an insignificant overhead - since evaluating a logger takes about 1% of the time it - takes to actually log. - - + + Checks if this logger is enabled for the DEBUG + level. + + + true if this logger is enabled for DEBUG events, + false otherwise. + + + + This function is intended to lessen the computational cost of + disabled log debug statements. + + + For some log Logger object, when you write: + + + log.Debug("This is entry number: " + i ); + + + You incur the cost constructing the message, concatenation in + this case, regardless of whether the message is logged or not. + + + If you are worried about speed, then you should write: + + + if (log.IsDebugEnabled()) + { + log.Debug("This is entry number: " + i ); + } + + + This way you will not incur the cost of parameter + construction if debugging is disabled for log. On + the other hand, if the log is debug enabled, you + will incur the cost of evaluating whether the logger is debug + enabled twice. Once in IsDebugEnabled and once in + the Debug. This is an insignificant overhead + since evaluating a logger takes about 1% of the time it + takes to actually log. + + @@ -14654,20 +15304,99 @@ - + - A SecurityContext used by log4net when interacting with protected resources + provides method information without actually referencing a System.Reflection.MethodBase + as that would require that the containing assembly is loaded. - - - A SecurityContext used by log4net when interacting with protected resources - for example with operating system services. This can be used to impersonate - a principal that has been granted privileges on the system resources. - - - Nicko Cadell + - + + + When location information is not available the constant + NA is returned. Current value of this string + constant is ?. + + + + + constructs a method item for an unknown method. + + + + + constructs a method item from the name of the method. + + + + + + constructs a method item from the name of the method and its parameters. + + + + + + + constructs a method item from a method base by determining the method name and its parameters. + + + + + + The fully qualified type of the StackFrameItem class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets the method name of the caller making the logging + request. + + + The method name of the caller making the logging + request. + + + + Gets the method name of the caller making the logging + request. + + + + + + Gets the method parameters of the caller making + the logging request. + + + The method parameters of the caller making + the logging request + + + + Gets the method parameters of the caller making + the logging request. + + + + + + A SecurityContext used by log4net when interacting with protected resources + + + + A SecurityContext used by log4net when interacting with protected resources + for example with operating system services. This can be used to impersonate + a principal that has been granted privileges on the system resources. + + + Nicko Cadell + + Impersonate this SecurityContext @@ -14720,19 +15449,19 @@ Nicko Cadell - - The default provider - + + The default provider + - - Protected default constructor to allow subclassing - - - - Protected default constructor to allow subclassing - - + + Protected default constructor to allow subclassing + + + + Protected default constructor to allow subclassing + + @@ -14774,6 +15503,195 @@ + + + provides stack frame information without actually referencing a System.Diagnostics.StackFrame + as that would require that the containing assembly is loaded. + + + + + + When location information is not available the constant + NA is returned. Current value of this string + constant is ?. + + + + + returns a stack frame item from a stack frame. This + + + + + + + The fully qualified type of the StackFrameItem class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets the fully qualified class name of the caller making the logging + request. + + + The fully qualified class name of the caller making the logging + request. + + + + Gets the fully qualified class name of the caller making the logging + request. + + + + + + Gets the file name of the caller. + + + The file name of the caller. + + + + Gets the file name of the caller. + + + + + + Gets the line number of the caller. + + + The line number of the caller. + + + + Gets the line number of the caller. + + + + + + Gets the method name of the caller. + + + The method name of the caller. + + + + Gets the method name of the caller. + + + + + + Gets all available caller information + + + All available caller information, in the format + fully.qualified.classname.of.caller.methodName(Filename:line) + + + + Gets all available caller information, in the format + fully.qualified.classname.of.caller.methodName(Filename:line) + + + + + + An evaluator that triggers after specified number of seconds. + + + + This evaluator will trigger if the specified time period + has passed since last check. + + + Robert Sevcik + + + + The default time threshold for triggering in seconds. Zero means it won't trigger at all. + + + + + The time threshold for triggering in seconds. Zero means it won't trigger at all. + + + + + The time of last check. This gets updated when the object is created and when the evaluator triggers. + + + + + Create a new evaluator using the time threshold in seconds. + + + + Create a new evaluator using the time threshold in seconds. + + + This evaluator will trigger if the specified time period + has passed since last check. + + + + + + Create a new evaluator using the specified time threshold in seconds. + + + The time threshold in seconds to trigger after. + Zero means it won't trigger at all. + + + + Create a new evaluator using the specified time threshold in seconds. + + + This evaluator will trigger if the specified time period + has passed since last check. + + + + + + Is this the triggering event? + + The event to check + This method returns true, if the specified time period + has passed since last check.. + Otherwise it returns false + + + This evaluator will trigger if the specified time period + has passed since last check. + + + + + + The time threshold in seconds to trigger after + + + The time threshold in seconds to trigger after. + Zero means it won't trigger at all. + + + + This evaluator will trigger if the specified time period + has passed since last check. + + + Delegate used to handle creation of new wrappers. @@ -14871,26 +15789,26 @@ - - Event handler for repository shutdown event. - - The sender of the event. - The event args. + + Event handler for repository shutdown event. + + The sender of the event. + The event args. - - Map of logger repositories to hashtables of ILogger to ILoggerWrapper mappings - + + Map of logger repositories to hashtables of ILogger to ILoggerWrapper mappings + - - The handler to use to create the extension wrapper objects. - + + The handler to use to create the extension wrapper objects. + - - Internal reference to the delegate used to register for repository shutdown events. - + + Internal reference to the delegate used to register for repository shutdown events. + @@ -14950,34 +15868,34 @@ - - String constant used to specify AbsoluteTimeDateFormat in layouts. Current value is ABSOLUTE. - + + String constant used to specify AbsoluteTimeDateFormat in layouts. Current value is ABSOLUTE. + - - String constant used to specify DateTimeDateFormat in layouts. Current value is DATE. - + + String constant used to specify DateTimeDateFormat in layouts. Current value is DATE. + - - String constant used to specify ISO8601DateFormat in layouts. Current value is ISO8601. - + + String constant used to specify ISO8601DateFormat in layouts. Current value is ISO8601. + - - Renders the date into a string. Format is "HH:mm:ss". - - The date to render into a string. - The string builder to write to. - - - Subclasses should override this method to render the date - into a string using a precision up to the second. This method - will be called at most once per second and the result will be - reused if it is needed again during the same second. - - + + Renders the date into a string. Format is "HH:mm:ss". + + The date to render into a string. + The string builder to write to. + + + Subclasses should override this method to render the date + into a string using a precision up to the second. This method + will be called at most once per second and the result will be + reused if it is needed again during the same second. + + @@ -15000,21 +15918,21 @@ - - Last stored time with precision up to the second. - + + Last stored time with precision up to the second. + - - Last stored time with precision up to the second, formatted - as a string. - + + Last stored time with precision up to the second, formatted + as a string. + - - - Last stored time with precision up to the second, formatted - as a string. - + + + Last stored time with precision up to the second, formatted + as a string. + @@ -15042,26 +15960,26 @@ - - Formats the date without the milliseconds part - - The date to format. - The string builder to write to. - - - Formats a DateTime in the format "dd MMM yyyy HH:mm:ss" - for example, "06 Nov 1994 15:49:37". - - - The base class will append the ",fff" milliseconds section. - This method will only be called at most once per second. - - + + Formats the date without the milliseconds part + + The date to format. + The string builder to write to. + + + Formats a DateTime in the format "dd MMM yyyy HH:mm:ss" + for example, "06 Nov 1994 15:49:37". + + + The base class will append the ",fff" milliseconds section. + This method will only be called at most once per second. + + - - The format info for the invariant culture. - + + The format info for the invariant culture. + @@ -15086,28 +16004,28 @@ - - Formats the date without the milliseconds part - - The date to format. - The string builder to write to. - - - Formats the date specified as a string: "yyyy-MM-dd HH:mm:ss". - - - The base class will append the ",fff" milliseconds section. - This method will only be called at most once per second. - - + + Formats the date without the milliseconds part + + The date to format. + The string builder to write to. + + + Formats the date specified as a string: "yyyy-MM-dd HH:mm:ss". + + + The base class will append the ",fff" milliseconds section. + This method will only be called at most once per second. + + - Formats the using the method. + Formats the using the method. - Formats the using the method. + Formats the using the method. Nicko Cadell @@ -15125,22 +16043,22 @@ The format string must be compatible with the options - that can be supplied to . + that can be supplied to . - - Formats the date using . - - The date to convert to a string. - The writer to write to. - - - Uses the date format string supplied to the constructor to call - the method to format the date. - - + + Formats the date using . + + The date to convert to a string. + The writer to write to. + + + Uses the date format string supplied to the constructor to call + the method to format the date. + + @@ -15149,7 +16067,7 @@ The format string must be compatible with the options - that can be supplied to . + that can be supplied to . @@ -15277,18 +16195,18 @@ - - Property to get and set the next filter - - - The next filter in the chain - - - - Filters are typically composed into chains. This property allows the next filter in - the chain to be accessed. - - + + Property to get and set the next filter + + + The next filter in the chain + + + + Filters are typically composed into chains. This property allows the next filter in + the chain to be accessed. + + @@ -15343,27 +16261,27 @@ + + Property to get and set the next filter + + + The next filter in the chain + + + + Filters are typically composed into chains. This property allows the next filter in + the chain to be accessed. + + + + + + Default constructor + + + - Property to get and set the next filter - - - The next filter in the chain - - - - Filters are typically composed into chains. This property allows the next filter in - the chain to be accessed. - - - - - - Default constructor - - - - - Always returns the integer constant + Always returns the integer constant the LoggingEvent to filter Always returns @@ -15388,22 +16306,22 @@ - - The log event must be dropped immediately without - consulting with the remaining filters, if any, in the chain. - + + The log event must be dropped immediately without + consulting with the remaining filters, if any, in the chain. + - - This filter is neutral with respect to the log event. - The remaining filters, if any, should be consulted for a final decision. - + + This filter is neutral with respect to the log event. + The remaining filters, if any, should be consulted for a final decision. + - - The log event must be logged immediately without - consulting with the remaining filters, if any, in the chain. - + + The log event must be logged immediately without + consulting with the remaining filters, if any, in the chain. + @@ -15435,9 +16353,9 @@ - - Default constructor - + + Default constructor + @@ -15518,9 +16436,9 @@ - - Default constructor - + + Default constructor + @@ -15597,19 +16515,19 @@ Daniel Cazzulino - - Flag to indicate the behavior when we have a match - + + Flag to indicate the behavior when we have a match + - - The logger name string to substring match against the event - + + The logger name string to substring match against the event + - - Default constructor - + + Default constructor + @@ -15621,7 +16539,7 @@ The rendered message is matched against the . If the equals the beginning of - the incoming () + the incoming () then a match will have occurred. If no match occurs this function will return allowing other filters to check the event. If a match occurs then @@ -15655,7 +16573,7 @@ This filter will attempt to match this value against logger name in the following way. The match will be done against the beginning of the - logger name (using ). The match is + logger name (using ). The match is case sensitive. If a match is found then the result depends on the value of . @@ -15678,53 +16596,53 @@ Gert Driesen - - Simple filter to match a string an event property - - - - Simple filter to match a string in the value for a - specific event property - - - Nicko Cadell + + Simple filter to match a string an event property + + + + Simple filter to match a string in the value for a + specific event property + + + Nicko Cadell - - Simple filter to match a string in the rendered message - - - - Simple filter to match a string in the rendered message - - - Nicko Cadell - Gert Driesen + + Simple filter to match a string in the rendered message + + + + Simple filter to match a string in the rendered message + + + Nicko Cadell + Gert Driesen - - Flag to indicate the behavior when we have a match - + + Flag to indicate the behavior when we have a match + - - The string to substring match against the message - + + The string to substring match against the message + - - A string regex to match - + + A string regex to match + - - A regex object to match (generated from m_stringRegexToMatch) - + + A regex object to match (generated from m_stringRegexToMatch) + - - Default constructor - + + Default constructor + @@ -15814,14 +16732,14 @@ - - The key to use to lookup the string from the event properties - + + The key to use to lookup the string from the event properties + - - Default constructor - + + Default constructor + @@ -15895,41 +16813,41 @@ Nicko Cadell - - Abstract class that provides the formatting functionality that - derived classes need. - - - Conversion specifiers in a conversion patterns are parsed to - individual PatternConverters. Each of which is responsible for - converting a logging event in a converter specific manner. - - Nicko Cadell + + Abstract class that provides the formatting functionality that + derived classes need. + + + Conversion specifiers in a conversion patterns are parsed to + individual PatternConverters. Each of which is responsible for + converting a logging event in a converter specific manner. + + Nicko Cadell - - Abstract class that provides the formatting functionality that - derived classes need. - - - - Conversion specifiers in a conversion patterns are parsed to - individual PatternConverters. Each of which is responsible for - converting a logging event in a converter specific manner. - - - Nicko Cadell - Gert Driesen + + Abstract class that provides the formatting functionality that + derived classes need. + + + + Conversion specifiers in a conversion patterns are parsed to + individual PatternConverters. Each of which is responsible for + converting a logging event in a converter specific manner. + + + Nicko Cadell + Gert Driesen - - Initial buffer size - + + Initial buffer size + - - Maximum buffer size before it is recycled - + + Maximum buffer size before it is recycled + @@ -15955,17 +16873,17 @@ - - Set the next pattern converter in the chains - - the pattern converter that should follow this converter in the chain - the next converter - - - The PatternConverter can merge with its neighbor during this method (or a sub class). - Therefore the return value may or may not be the value of the argument passed in. - - + + Set the next pattern converter in the chains + + the pattern converter that should follow this converter in the chain + the next converter + + + The PatternConverter can merge with its neighbor during this method (or a sub class). + Therefore the return value may or may not be the value of the argument passed in. + + @@ -15995,9 +16913,9 @@ - - The option string to the converter - + + The option string to the converter + @@ -16020,59 +16938,85 @@ - + - Write an object to a + Write an dictionary to a the writer to write to a to use for object conversion the value to write to the writer - Writes the Object to a writer. If the specified - is not null then it is used to render the object to text, otherwise + Writes the to a writer in the form: + + + {key1=value1, key2=value2, key3=value3} + + + If the specified + is not null then it is used to render the key and value to text, otherwise the object's ToString method is called. - + - Get the next pattern converter in the chain + Write an object to a - - the next pattern converter in the chain - + the writer to write to + a to use for object conversion + the value to write to the writer - Get the next pattern converter in the chain + Writes the Object to a writer. If the specified + is not null then it is used to render the object to text, otherwise + the object's ToString method is called. + + + Get the next pattern converter in the chain + + + the next pattern converter in the chain + + + + Get the next pattern converter in the chain + + + - - Gets or sets the formatting info for this converter - - - The formatting info for this converter - - - - Gets or sets the formatting info for this converter - - + + Gets or sets the formatting info for this converter + + + The formatting info for this converter + + + + Gets or sets the formatting info for this converter + + - - Gets or sets the option value for this converter - - - The option for this converter - - - - Gets or sets the option value for this converter - - + + Gets or sets the option value for this converter + + + The option for this converter + + + + Gets or sets the option value for this converter + + + + + + + @@ -16096,12 +17040,12 @@ The state object on which the pattern converter should be executed. - - Flag indicating if this converter handles exceptions - - - false if this converter handles exceptions - + + Flag indicating if this converter handles exceptions + + + false if this converter handles exceptions + @@ -16133,6 +17077,132 @@ + + + Converter for items in the ASP.Net Cache. + + + + Outputs an item from the . + + + Ron Grabowski + + + + Abstract class that provides access to the current HttpContext () that + derived classes need. + + + This class handles the case when HttpContext.Current is null by writing + to the writer. + + Ron Grabowski + + + + Derived pattern converters must override this method in order to + convert conversion specifiers in the correct way. + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + + Write the ASP.Net Cache item to the output + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + Writes out the value of a named property. The property name + should be set in the + property. If no property has been set, all key value pairs from the Cache will + be written to the output. + + + + + + Converter for items in the . + + + + Outputs an item from the . + + + Ron Grabowski + + + + Write the ASP.Net HttpContext item to the output + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + Writes out the value of a named property. The property name + should be set in the + property. + + + + + + Converter for items in the ASP.Net Cache. + + + + Outputs an item from the . + + + Ron Grabowski + + + + Write the ASP.Net Cache item to the output + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + Writes out the value of a named property. The property name + should be set in the + property. + + + + + + Converter for items in the ASP.Net Cache. + + + + Outputs an item from the . + + + Ron Grabowski + + + + Write the ASP.Net Cache item to the output + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + Writes out the value of a named property. The property name + should be set in the + property. If no property has been set, all key value pairs from the Session will + be written to the output. + + + Date pattern converter, uses a to format @@ -16176,7 +17246,7 @@ Any other pattern string uses the formatter. This formatter passes the pattern string to the - method. + method. For details on valid patterns see DateTimeFormatInfo Class. @@ -16234,29 +17304,38 @@ + + + The fully qualified type of the DatePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + - - Write the exception text to the output - - - - If an exception object is stored in the logging event - it will be rendered into the pattern output with a - trailing newline. - - - If there is no exception then nothing will be output - and no trailing newline will be appended. - It is typical to put a newline before the exception - and to have the exception as the last data in the pattern. - - - Nicko Cadell + + Write the exception text to the output + + + + If an exception object is stored in the logging event + it will be rendered into the pattern output with a + trailing newline. + + + If there is no exception then nothing will be output + and no trailing newline will be appended. + It is typical to put a newline before the exception + and to have the exception as the last data in the pattern. + + + Nicko Cadell - - Default constructor - + + Default constructor + @@ -16271,26 +17350,47 @@ trailing newline. - If there is no exception then nothing will be output + If there is no exception or the exception property specified + by the Option value does not exist then nothing will be output and no trailing newline will be appended. It is typical to put a newline before the exception and to have the exception as the last data in the pattern. - - - - - Writes the caller location file name to the output - - - Writes the value of the for - the event to the output writer. + Recognized values for the Option parameter are: - - Nicko Cadell - - + + + Message + + + Source + + + StackTrace + + + TargetSite + + + HelpLink + + + + + + + Writes the caller location file name to the output + + + + Writes the value of the for + the event to the output writer. + + + Nicko Cadell + + Write the caller location file name to the output @@ -16450,20 +17550,20 @@ - - Get the fully qualified string data - - the event being logged - the fully qualified name - - - Overridden by subclasses to get the fully qualified name before the - precision is applied to it. - - - Return the fully qualified '.' (dot/period) separated string. - - + + Get the fully qualified string data + + the event being logged + the fully qualified name + + + Overridden by subclasses to get the fully qualified name before the + precision is applied to it. + + + Return the fully qualified '.' (dot/period) separated string. + + @@ -16476,6 +17576,15 @@ specified by the property. + + + The fully qualified type of the NamedPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + Gets the fully qualified name of the logger @@ -16604,15 +17713,15 @@ - - Converter to output the relative time of the event - - - - Converter to output the time of the event relative to the start of the program. - - - Nicko Cadell + + Converter to output the relative time of the event + + + + Converter to output the time of the event relative to the start of the program. + + + Nicko Cadell @@ -16629,12 +17738,92 @@ + + Helper method to get the time difference between two DateTime objects + + start time (in the current local time zone) + end time (in the current local time zone) + the time difference in milliseconds + + + + Write the caller stack frames to the output + + + + Writes the to the output writer, using format: + type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...) + + + Adam Davies + + + + Write the caller stack frames to the output + + + + Writes the to the output writer, using format: + type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1 + + + Michael Cromwell + + + + Initialize the converter + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + - Helper method to get the time difference between two DateTime objects + Write the strack frames to the output - start time (in the current local time zone) - end time (in the current local time zone) - the time difference in milliseconds + that will receive the formatted result. + the event being logged + + + Writes the to the output writer. + + + + + + Returns the Name of the method + + + This method was created, so this class could be used as a base class for StackTraceDetailPatternConverter + string + + + + The fully qualified type of the StackTracePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + The fully qualified type of the StackTraceDetailPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + @@ -16683,11 +17872,11 @@ - - Converter to include event user name - - Douglas de la Torre - Nicko Cadell + + Converter to include event user name + + Douglas de la Torre + Nicko Cadell @@ -16734,439 +17923,92 @@ - - - A Layout that renders only the Exception text from the logging event - - - - A Layout that renders only the Exception text from the logging event. - - - This Layout should only be used with appenders that utilize multiple - layouts (e.g. ). - + + + The fully qualified type of the UtcDatePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + A flexible layout configurable with pattern string that re-evaluates on each call. + + + This class is built on and provides all the + features and capabilities of PatternLayout. PatternLayout is a 'static' class + in that its layout is done once at configuration time. This class will recreate + the layout on each reference. + One important difference between PatternLayout and DynamicPatternLayout is the + treatment of the Header and Footer parameters in the configuration. The Header and Footer + parameters for DynamicPatternLayout must be syntactically in the form of a PatternString, + but should not be marked as type log4net.Util.PatternString. Doing so causes the + pattern to be statically converted at configuration time and causes DynamicPatternLayout + to perform the same as PatternLayout. + Please see for complete documentation. + + <layout type="log4net.Layout.DynamicPatternLayout"> + <param name="Header" value="%newline**** Trace Opened Local: %date{yyyy-MM-dd HH:mm:ss.fff} UTC: %utcdate{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /> + <param name="Footer" value="**** Trace Closed %date{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /> + </layout> + - Nicko Cadell - Gert Driesen - + - Extend this abstract class to create your own log layout format. + A flexible layout configurable with pattern string. - This is the base implementation of the - interface. Most layout objects should extend this class. - - - - - - Subclasses must implement the - method. - - - Subclasses should set the in their default - constructor. + The goal of this class is to a + as a string. The results + depend on the conversion pattern. - - - Nicko Cadell - Gert Driesen - - - - Interface implemented by layout objects - - - An object is used to format a - as text. The method is called by an - appender to transform the into a string. + The conversion pattern is closely related to the conversion + pattern of the printf function in C. A conversion pattern is + composed of literal text and format control expressions called + conversion specifiers. - The layout can also supply and - text that is appender before any events and after all the events respectively. + You are free to insert any literal text within the conversion + pattern. - - Nicko Cadell - Gert Driesen - - - - Implement this method to create your own layout format. - - The TextWriter to write the formatted event to - The event to format - - This method is called by an appender to format - the as text and output to a writer. + Each conversion specifier starts with a percent sign (%) and is + followed by optional format modifiers and a conversion + pattern name. The conversion pattern name specifies the type of + data, e.g. logger, level, date, thread name. The format + modifiers control such things as field width, padding, left and + right justification. The following is a simple example. - If the caller does not have a and prefers the - event to be formatted as a then the following - code can be used to format the event into a . + Let the conversion pattern be "%-5level [%thread]: %message%newline" and assume + that the log4net environment was set to use a PatternLayout. Then the + statements - StringWriter writer = new StringWriter(); - Layout.Format(writer, loggingEvent); - string formattedEvent = writer.ToString(); + ILog log = LogManager.GetLogger(typeof(TestApp)); + log.Debug("Message 1"); + log.Warn("Message 2"); + + would yield the output + + DEBUG [main]: Message 1 + WARN [main]: Message 2 - - - - - The content type output by this layout. - - The content type - - - The content type output by this layout. - - - This is a MIME type e.g. "text/plain". - - - - - - The header for the layout format. - - the layout header - - - The Header text will be appended before any logging events - are formatted and appended. - - - - - - The footer for the layout format. - - the layout footer - - - The Footer text will be appended after all the logging events - have been formatted and appended. - - - - - - Flag indicating if this layout handle exceptions - - false if this layout handles exceptions - - - If this layout handles the exception object contained within - , then the layout should return - false. Otherwise, if the layout ignores the exception - object, then the layout should return true. - - - - - - The header text - - - - See for more information. - - - - - - The footer text - - - - See for more information. - - - - - - Flag indicating if this layout handles exceptions - - - false if this layout handles exceptions + Note that there is no explicit separator between text and + conversion specifiers. The pattern parser knows when it has reached + the end of a conversion specifier when it reads a conversion + character. In the example above the conversion specifier + %-5level means the level of the logging event should be left + justified to a width of five characters. - - - - - Empty default constructor - - - Empty default constructor - - - - - - Activate component options - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - This method must be implemented by the subclass. - - - - - - Implement this method to create your own layout format. - - The TextWriter to write the formatted event to - The event to format - - - This method is called by an appender to format - the as text. - - - - - - The content type output by this layout. - - The content type is "text/plain" - - - The content type output by this layout. - - - This base class uses the value "text/plain". - To change this value a subclass must override this - property. - - - - - - The header for the layout format. - - the layout header - - - The Header text will be appended before any logging events - are formatted and appended. - - - - - - The footer for the layout format. - - the layout footer - - - The Footer text will be appended after all the logging events - have been formatted and appended. - - - - - - Flag indicating if this layout handles exceptions - - false if this layout handles exceptions - - - If this layout handles the exception object contained within - , then the layout should return - false. Otherwise, if the layout ignores the exception - object, then the layout should return true. - - - Set this value to override a this default setting. The default - value is true, this layout does not handle the exception. - - - - - - Default constructor - - - - Constructs a ExceptionLayout - - - - - - Activate component options - - - - Part of the component activation - framework. - - - This method does nothing as options become effective immediately. - - - - - - Gets the exception text from the logging event - - The TextWriter to write the formatted event to - the event being logged - - - Write the exception string to the . - The exception string is retrieved from . - - - - - - Interface for raw layout objects - - - - Interface used to format a - to an object. - - - This interface should not be confused with the - interface. This interface is used in - only certain specialized situations where a raw object is - required rather than a formatted string. The - is not generally useful than this interface. - - - Nicko Cadell - Gert Driesen - - - - Implement this method to create your own layout format. - - The event to format - returns the formatted event - - - Implement this method to create your own layout format. - - - - - - Adapts any to a - - - - Where an is required this adapter - allows a to be specified. - - - Nicko Cadell - Gert Driesen - - - - The layout to adapt - - - - - Construct a new adapter - - the layout to adapt - - - Create the adapter for the specified . - - - - - - Format the logging event as an object. - - The event to format - returns the formatted event - - - Format the logging event as an object. - - - Uses the object supplied to - the constructor to perform the formatting. - - - - - - A flexible layout configurable with pattern string. - - - - The goal of this class is to a - as a string. The results - depend on the conversion pattern. - - - The conversion pattern is closely related to the conversion - pattern of the printf function in C. A conversion pattern is - composed of literal text and format control expressions called - conversion specifiers. - - - You are free to insert any literal text within the conversion - pattern. - - - Each conversion specifier starts with a percent sign (%) and is - followed by optional format modifiers and a conversion - pattern name. The conversion pattern name specifies the type of - data, e.g. logger, level, date, thread name. The format - modifiers control such things as field width, padding, left and - right justification. The following is a simple example. - - - Let the conversion pattern be "%-5level [%thread]: %message%newline" and assume - that the log4net environment was set to use a PatternLayout. Then the - statements - - - ILog log = LogManager.GetLogger(typeof(TestApp)); - log.Debug("Message 1"); - log.Warn("Message 2"); - - would yield the output - - DEBUG [main]: Message 1 - WARN [main]: Message 2 - - - Note that there is no explicit separator between text and - conversion specifiers. The pattern parser knows when it has reached - the end of a conversion specifier when it reads a conversion - character. In the example above the conversion specifier - %-5level means the level of the logging event should be left - justified to a width of five characters. - - - The recognized conversion pattern names are: + The recognized conversion pattern names are: @@ -17184,6 +18026,50 @@ logging event was generated. + + aspnet-cache + + + Used to output all cache items in the case of %aspnet-cache or just one named item if used as %aspnet-cache{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + + + aspnet-context + + + Used to output all context items in the case of %aspnet-context or just one named item if used as %aspnet-context{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + + + aspnet-request + + + Used to output all request parameters in the case of %aspnet-request or just one named param if used as %aspnet-request{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + + + aspnet-session + + + Used to output all session items in the case of %aspnet-session or just one named item if used as %aspnet-session{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + c Equivalent to logger @@ -17215,7 +18101,7 @@ The date format specifier admits the same syntax as the - time pattern string of the . + time pattern string of the . For better results it is recommended to use the log4net date @@ -17228,7 +18114,7 @@ These dedicated date formatters perform significantly - better than . + better than . @@ -17494,6 +18380,42 @@ r Equivalent to timestamp + + stacktrace + + + Used to output the stack trace of the logging event + The stack trace level specifier may be enclosed + between braces. For example, %stacktrace{level}. + If no stack trace level specifier is given then 1 is assumed + + + Output uses the format: + type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1 + + + This pattern is not available for Compact Framework assemblies. + + + + + stacktracedetail + + + Used to output the stack trace of the logging event + The stack trace level specifier may be enclosed + between braces. For example, %stacktracedetail{level}. + If no stack trace level specifier is given then 1 is assumed + + + Output uses the format: + type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...) + + + This pattern is not available for Compact Framework assemblies. + + + t Equivalent to thread @@ -17576,7 +18498,7 @@ The date format specifier admits the same syntax as the - time pattern string of the . + time pattern string of the . For better results it is recommended to use the log4net date @@ -17589,7 +18511,7 @@ These dedicated date formatters perform significantly - better than . + better than . @@ -17761,7 +18683,7 @@ Additional pattern converters may be registered with a specific - instance using the method. + instance using the method. @@ -17781,63 +18703,322 @@ Douglas de la Torre Daniel Cazzulino - + + + Extend this abstract class to create your own log layout format. + + + + This is the base implementation of the + interface. Most layout objects should extend this class. + + + + + + Subclasses must implement the + method. + + + Subclasses should set the in their default + constructor. + + + + Nicko Cadell + Gert Driesen + + + + Interface implemented by layout objects + + + + An object is used to format a + as text. The method is called by an + appender to transform the into a string. + + + The layout can also supply and + text that is appender before any events and after all the events respectively. + + + Nicko Cadell + Gert Driesen + + + + Implement this method to create your own layout format. + + The TextWriter to write the formatted event to + The event to format + + + This method is called by an appender to format + the as text and output to a writer. + + + If the caller does not have a and prefers the + event to be formatted as a then the following + code can be used to format the event into a . + + + StringWriter writer = new StringWriter(); + Layout.Format(writer, loggingEvent); + string formattedEvent = writer.ToString(); + + + + + + The content type output by this layout. + + The content type + + + The content type output by this layout. + + + This is a MIME type e.g. "text/plain". + + + + + + The header for the layout format. + + the layout header + + + The Header text will be appended before any logging events + are formatted and appended. + + + + + + The footer for the layout format. + + the layout footer + + + The Footer text will be appended after all the logging events + have been formatted and appended. + + + + + + Flag indicating if this layout handle exceptions + + false if this layout handles exceptions + + + If this layout handles the exception object contained within + , then the layout should return + false. Otherwise, if the layout ignores the exception + object, then the layout should return true. + + + + + + The header text + + + + See for more information. + + + + + + The footer text + + + + See for more information. + + + + + + Flag indicating if this layout handles exceptions + + + + false if this layout handles exceptions + + + + + + Empty default constructor + + + + Empty default constructor + + + + + + Activate component options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + This method must be implemented by the subclass. + + + + + + Implement this method to create your own layout format. + + The TextWriter to write the formatted event to + The event to format + + + This method is called by an appender to format + the as text. + + + + + + Convenience method for easily formatting the logging event into a string variable. + + + + Creates a new StringWriter instance to store the formatted logging event. + + + + + The content type output by this layout. + + The content type is "text/plain" + + + The content type output by this layout. + + + This base class uses the value "text/plain". + To change this value a subclass must override this + property. + + + + + + The header for the layout format. + + the layout header + + + The Header text will be appended before any logging events + are formatted and appended. + + + + + + The footer for the layout format. + + the layout footer + + + The Footer text will be appended after all the logging events + have been formatted and appended. + + + + - Default pattern string for log output. + Flag indicating if this layout handles exceptions + false if this layout handles exceptions - Default pattern string for log output. - Currently set to the string "%message%newline" - which just prints the application supplied message. + If this layout handles the exception object contained within + , then the layout should return + false. Otherwise, if the layout ignores the exception + object, then the layout should return true. - - - - - A detailed conversion pattern - - - A conversion pattern which includes Time, Thread, Logger, and Nested Context. - Current value is %timestamp [%thread] %level %logger %ndc - %message%newline. + Set this value to override a this default setting. The default + value is true, this layout does not handle the exception. + + + Default pattern string for log output. + + + + Default pattern string for log output. + Currently set to the string "%message%newline" + which just prints the application supplied message. + + + + + + A detailed conversion pattern + + + + A conversion pattern which includes Time, Thread, Logger, and Nested Context. + Current value is %timestamp [%thread] %level %logger %ndc - %message%newline. + + + - - Internal map of converter identifiers to converter types. - - - - This static map is overridden by the m_converterRegistry instance map - - + + Internal map of converter identifiers to converter types. + + + + This static map is overridden by the m_converterRegistry instance map + + - - the pattern - + + the pattern + - - the head of the pattern converter chain - + + the head of the pattern converter chain + - - patterns defined on this PatternLayout only - + + patterns defined on this PatternLayout only + - - Initialize the global registry - - - - Defines the builtin global rules. - - + + Initialize the global registry + + + + Defines the builtin global rules. + + @@ -17920,17 +19101,17 @@ - - - Add a converter to this PatternLayout - - the converter info - - - This version of the method is used by the configurator. - Programmatic users should use the alternative method. - - + + + Add a converter to this PatternLayout + + the converter info + + + This version of the method is used by the configurator. + Programmatic users should use the alternative method. + + @@ -17951,52 +19132,198 @@ + + The pattern formatting string + + + + The ConversionPattern option. This is the string which + controls formatting and consists of a mix of literal content and + conversion specifiers. + + + + + + The header PatternString + + + + + The footer PatternString + + + + + Constructs a DynamicPatternLayout using the DefaultConversionPattern + + + + The default pattern just produces the application supplied message. + + + + + + Constructs a DynamicPatternLayout using the supplied conversion pattern + + the pattern to use + + + + + + The header for the layout format. + + the layout header + + + The Header text will be appended before any logging events + are formatted and appended. + + The pattern will be formatted on each get operation. + + + + + The footer for the layout format. + + the layout footer + + + The Footer text will be appended after all the logging events + have been formatted and appended. + + The pattern will be formatted on each get operation. + + + - The pattern formatting string + A Layout that renders only the Exception text from the logging event - The ConversionPattern option. This is the string which - controls formatting and consists of a mix of literal content and - conversion specifiers. + A Layout that renders only the Exception text from the logging event. + + + This Layout should only be used with appenders that utilize multiple + layouts (e.g. ). + Nicko Cadell + Gert Driesen + + + + Default constructor + + + + Constructs a ExceptionLayout + + - + - Wrapper class used to map converter names to converter types + Activate component options - Pattern converter info class used during configuration to - pass to the - method. + Part of the component activation + framework. + + + This method does nothing as options become effective immediately. - + - default constructor + Gets the exception text from the logging event + The TextWriter to write the formatted event to + the event being logged + + + Write the exception string to the . + The exception string is retrieved from . + + - + - Gets or sets the name of the conversion pattern + Interface for raw layout objects - The name of the pattern in the format string + Interface used to format a + to an object. + + + This interface should not be confused with the + interface. This interface is used in + only certain specialized situations where a raw object is + required rather than a formatted string. The + is not generally useful than this interface. + Nicko Cadell + Gert Driesen + + + + Implement this method to create your own layout format. + + The event to format + returns the formatted event + + + Implement this method to create your own layout format. + + - + - Gets or sets the type of the converter + Adapts any to a - The value specified must extend the - type. + Where an is required this adapter + allows a to be specified. + + + Nicko Cadell + Gert Driesen + + + + The layout to adapt + + + + + Construct a new adapter + + the layout to adapt + + + Create the adapter for the specified . + + + + + + Format the logging event as an object. + + The event to format + returns the formatted event + + + Format the logging event as an object. + + + Uses the object supplied to + the constructor to perform the formatting. @@ -18028,30 +19355,30 @@ Gert Driesen - - Can the source type be converted to the type supported by this object - - the type to convert - true if the conversion is possible - - - Test if the can be converted to the - type supported by this converter. - - + + Can the source type be converted to the type supported by this object + + the type to convert + true if the conversion is possible + + + Test if the can be converted to the + type supported by this converter. + + - - Convert the source object to the type supported by this object - - the object to convert - the converted object - - - Converts the to the type supported - by this converter. - - + + Convert the source object to the type supported by this object + + the object to convert + the converted object + + + Converts the to the type supported + by this converter. + + @@ -18095,9 +19422,9 @@ Nicko Cadell - - Constructs a RawPropertyLayout - + + Constructs a RawPropertyLayout + @@ -18139,9 +19466,9 @@ Gert Driesen - - Constructs a RawTimeStampLayout - + + Constructs a RawTimeStampLayout + @@ -18172,9 +19499,9 @@ Gert Driesen - - Constructs a RawUtcTimeStampLayout - + + Constructs a RawUtcTimeStampLayout + @@ -18193,25 +19520,25 @@ - - A very simple layout - - - - SimpleLayout consists of the level of the log statement, - followed by " - " and then the log message itself. For example, - - DEBUG - Hello world - - - - Nicko Cadell - Gert Driesen + + A very simple layout + + + + SimpleLayout consists of the level of the log statement, + followed by " - " and then the log message itself. For example, + + DEBUG - Hello world + + + + Nicko Cadell + Gert Driesen - - Constructs a SimpleLayout - + + Constructs a SimpleLayout + @@ -18232,18 +19559,18 @@ - - Produces a simple formatted output. - - the event being logged - The TextWriter to write the formatted event to - - - Formats the event as the level of the even, - followed by " - " and then the log message itself. The - output is terminated by a newline. - - + + Produces a simple formatted output. + + the event being logged + The TextWriter to write the formatted event to + + + Formats the event as the level of the even, + followed by " - " and then the log message itself. The + output is terminated by a newline. + + @@ -18265,8 +19592,7 @@ <?xml version="1.0" ?> <!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [<!ENTITY data SYSTEM "abc">]> - - <log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2> + <log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2> &data; </log4net:events> @@ -18318,23 +19644,23 @@ - - Protected constructor to support subclasses - - - - The parameter determines whether - location information will be output by the layout. If - is set to true, then the - file name and line number of the statement at the origin of the log - statement will be output. - - - If you are embedding this layout within an SMTPAppender - then make sure to set the LocationInfo option of that - appender as well. - - + + Protected constructor to support subclasses + + + + The parameter determines whether + location information will be output by the layout. If + is set to true, then the + file name and line number of the statement at the origin of the log + statement will be output. + + + If you are embedding this layout within an SMTPAppender + then make sure to set the LocationInfo option of that + appender as well. + + @@ -18386,20 +19712,15 @@ - - Flag to indicate if location information should be included in - the XML events. - - - - - Writer adapter that ignores Close - + + Flag to indicate if location information should be included in + the XML events. + - - The string to replace invalid chars with - + + The string to replace invalid chars with + @@ -18424,56 +19745,56 @@ - - The string to replace characters that can not be expressed in XML with. - - - Not all characters may be expressed in XML. This property contains the - string to replace those that can not with. This defaults to a ?. Set it - to the empty string to simply remove offending characters. For more - details on the allowed character ranges see http://www.w3.org/TR/REC-xml/#charsets - Character replacement will occur in the log message, the property names - and the property values. - - - + + The string to replace characters that can not be expressed in XML with. + + + Not all characters may be expressed in XML. This property contains the + string to replace those that can not with. This defaults to a ?. Set it + to the empty string to simply remove offending characters. For more + details on the allowed character ranges see http://www.w3.org/TR/REC-xml/#charsets + Character replacement will occur in the log message, the property names + and the property values. + + + - - Gets the content type output by this layout. - - - As this is the XML layout, the value is always "text/xml". - - - - As this is the XML layout, the value is always "text/xml". - - + + Gets the content type output by this layout. + + + As this is the XML layout, the value is always "text/xml". + + + + As this is the XML layout, the value is always "text/xml". + + - - Constructs an XmlLayout - + + Constructs an XmlLayout + - - Constructs an XmlLayout. - - - - The LocationInfo 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. - - - If you are embedding this layout within an SmtpAppender - then make sure to set the LocationInfo option of that - appender as well. - - + + Constructs an XmlLayout. + + + + The LocationInfo 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. + + + If you are embedding this layout within an SmtpAppender + then make sure to set the LocationInfo option of that + appender as well. + + @@ -18510,21 +19831,21 @@ - - The prefix to use for all generated element names - + + The prefix to use for all generated element names + - - The prefix to use for all element names - - - - The default prefix is log4net. Set this property - to change the prefix. If the prefix is set to an empty string - then no prefix will be written. - - + + The prefix to use for all element names + + + + The default prefix is log4net. Set this property + to change the prefix. If the prefix is set to an empty string + then no prefix will be written. + + @@ -18556,67 +19877,67 @@ - - - Layout that formats the log events as XML elements compatible with the log4j schema - - - - Formats the log events according to the http://logging.apache.org/log4j schema. - - - Nicko Cadell - - - - The 1st of January 1970 in UTC - - - - - Constructs an XMLLayoutSchemaLog4j - - - - - Constructs an XMLLayoutSchemaLog4j. - - - - The LocationInfo 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. - - - If you are embedding this layout within an SMTPAppender - then make sure to set the LocationInfo option of that - appender as well. - - - - - - Actually do the writing of the xml - - the writer to use - the event to write - - - Generate XML that is compatible with the log4j schema. - - - + + + Layout that formats the log events as XML elements compatible with the log4j schema + + + + Formats the log events according to the http://logging.apache.org/log4j schema. + + + Nicko Cadell + + + + The 1st of January 1970 in UTC + + + + + Constructs an XMLLayoutSchemaLog4j + + + + + Constructs an XMLLayoutSchemaLog4j. + + + + The LocationInfo 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. + + + If you are embedding this layout within an SMTPAppender + then make sure to set the LocationInfo option of that + appender as well. + + + + + + Actually do the writing of the xml + + the writer to use + the event to write + + + Generate XML that is compatible with the log4j schema. + + + - - The version of the log4j schema to use. - - - - Only version 1.2 of the log4j schema is supported. - - + + The version of the log4j schema to use. + + + + Only version 1.2 of the log4j schema is supported. + + @@ -18649,35 +19970,35 @@ Gert Driesen - - Render the object to a string - - The map used to lookup renderers - The object to render - The writer to render to - - - Render the object to a - string. - - - The parameter is - provided to lookup and render other objects. This is - very useful where contains - nested objects of unknown type. The - method can be used to render these objects. - - + + Render the object to a string + + The map used to lookup renderers + The object to render + The writer to render to + + + Render the object to a + string. + + + The parameter is + provided to lookup and render other objects. This is + very useful where contains + nested objects of unknown type. The + method can be used to render these objects. + + - - Default constructor - - - - Default constructor - - + + Default constructor + + + + Default constructor + + @@ -18694,7 +20015,7 @@ The parameter is provided to lookup and render other objects. This is very useful where contains - nested objects of unknown type. The + nested objects of unknown type. The method can be used to render these objects. @@ -18768,55 +20089,55 @@ - - Render the array argument into a string - - The map used to lookup renderers - the array to render - The writer to render to - - - For a one dimensional array this is the - array type name, an open brace, followed by a comma - separated list of the elements (using the appropriate - renderer), followed by a close brace. For example: - int[] {1, 2, 3}. - - - If the array is not one dimensional the - Array.ToString() is returned. - - + + Render the array argument into a string + + The map used to lookup renderers + the array to render + The writer to render to + + + For a one dimensional array this is the + array type name, an open brace, followed by a comma + separated list of the elements (using the appropriate + renderer), followed by a close brace. For example: + int[] {1, 2, 3}. + + + If the array is not one dimensional the + Array.ToString() is returned. + + - - Render the enumerator argument into a string - - The map used to lookup renderers - the enumerator to render - The writer to render to - - - Rendered as an open brace, followed by a comma - separated list of the elements (using the appropriate - renderer), followed by a close brace. For example: - {a, b, c}. - - + + Render the enumerator argument into a string + + The map used to lookup renderers + the enumerator to render + The writer to render to + + + Rendered as an open brace, followed by a comma + separated list of the elements (using the appropriate + renderer), followed by a close brace. For example: + {a, b, c}. + + - - Render the DictionaryEntry argument into a string - - The map used to lookup renderers - the DictionaryEntry to render - The writer to render to - - - Render the key, an equals sign ('='), and the value (using the appropriate - renderer). For example: key=value. - - + + Render the DictionaryEntry argument into a string + + The map used to lookup renderers + the DictionaryEntry to render + The writer to render to + + + Render the key, an equals sign ('='), and the value (using the appropriate + renderer). For example: key=value. + + @@ -18829,7 +20150,7 @@ is used to render them. - The method is used to render an + The method is used to render an object using the appropriate renderers defined in this map. @@ -18837,14 +20158,14 @@ Gert Driesen - - Default Constructor - - - - Default constructor. - - + + Default Constructor + + + + Default constructor. + + @@ -18855,7 +20176,7 @@ This is a convenience method used to render an object to a string. - The alternative method + The alternative method should be used when streaming output to a . @@ -18870,27 +20191,27 @@ Find the appropriate renderer for the type of the parameter. This is accomplished by calling the - method. Once a renderer is found, it is + method. Once a renderer is found, it is applied on the object and the result is returned as a . - - Gets the renderer for the specified object type - - the object to lookup the renderer for - the renderer for - - - Gets the renderer for the specified object type. - - - Syntactic sugar method that calls - with the type of the object parameter. - - + + Gets the renderer for the specified object type + + the object to lookup the renderer for + the renderer for + + + Gets the renderer for the specified object type. + + + Syntactic sugar method that calls + with the type of the object parameter. + + @@ -18907,11 +20228,11 @@ - - Internal function to recursively search interfaces - - the type to lookup the renderer for - the renderer for the specified type + + Internal function to recursively search interfaces + + the type to lookup the renderer for + the renderer for the specified type @@ -18934,21 +20255,21 @@ Register an object renderer for a specific source type. - This renderer will be returned from a call to + This renderer will be returned from a call to specifying the same as an argument. - - Get the default renderer instance - - the default renderer - - - Get the default renderer - - + + Get the default renderer instance + + the default renderer + + + Get the default renderer + + @@ -18985,16 +20306,16 @@ - - Is called when the plugin is to shutdown. - - - - This method is called to notify the plugin that - it should stop operating and should detach from - the repository. - - + + Is called when the plugin is to shutdown. + + + + This method is called to notify the plugin that + it should stop operating and should detach from + the repository. + + @@ -19018,35 +20339,35 @@ Nicko Cadell - - Creates a read-only wrapper for a PluginCollection instance. - - list to create a readonly wrapper arround - - A PluginCollection wrapper that is read-only. - + + Creates a read-only wrapper for a PluginCollection instance. + + list to create a readonly wrapper arround + + A PluginCollection wrapper that is read-only. + - - Initializes a new instance of the PluginCollection class - that is empty and has the default initial capacity. - + + Initializes a new instance of the PluginCollection class + that is empty and has the default initial capacity. + - - Initializes a new instance of the PluginCollection class - that has the specified initial capacity. - - - The number of elements that the new PluginCollection is initially capable of storing. - + + Initializes a new instance of the PluginCollection class + that has the specified initial capacity. + + + The number of elements that the new PluginCollection is initially capable of storing. + - - Initializes a new instance of the PluginCollection class - that contains elements copied from the specified PluginCollection. - - The PluginCollection whose elements are copied to the new collection. + + Initializes a new instance of the PluginCollection class + that contains elements copied from the specified PluginCollection. + + The PluginCollection whose elements are copied to the new collection. @@ -19063,11 +20384,11 @@ The collection whose elements are copied to the new list. - - Allow subclasses to avoid our default constructors - - - + + Allow subclasses to avoid our default constructors + + + @@ -19092,9 +20413,9 @@ The index at which the value has been added. - - Removes all elements from the PluginCollection. - + + Removes all elements from the PluginCollection. + @@ -19180,42 +20501,42 @@ The new of the PluginCollection. - - Sets the capacity to the actual number of elements. - + + Sets the capacity to the actual number of elements. + - is less than zero. + is less than zero. -or- - is equal to or greater than . + is equal to or greater than . - is less than zero. + is less than zero. -or- - is equal to or greater than . + is equal to or greater than . - - Gets the number of elements actually contained in the PluginCollection. - + + Gets the number of elements actually contained in the PluginCollection. + - - Gets a value indicating whether access to the collection is synchronized (thread-safe). - - true if access to the ICollection is synchronized (thread-safe); otherwise, false. + + Gets a value indicating whether access to the collection is synchronized (thread-safe). + + true if access to the ICollection is synchronized (thread-safe); otherwise, false. - - Gets an object that can be used to synchronize access to the collection. - - - An object that can be used to synchronize access to the collection. - + + Gets an object that can be used to synchronize access to the collection. + + + An object that can be used to synchronize access to the collection. + @@ -19232,24 +20553,24 @@ - - Gets a value indicating whether the collection has a fixed size. - - true if the collection has a fixed size; otherwise, false. The default is false. + + Gets a value indicating whether the collection has a fixed size. + + true if the collection has a fixed size; otherwise, false. The default is false. - - Gets a value indicating whether the IList is read-only. - - true if the collection is read-only; otherwise, false. The default is false. + + Gets a value indicating whether the IList is read-only. + + true if the collection is read-only; otherwise, false. The default is false. - - Gets or sets the number of elements the PluginCollection can contain. - - - The number of elements the PluginCollection can contain. - + + Gets or sets the number of elements the PluginCollection can contain. + + + The number of elements the PluginCollection can contain. + @@ -19270,26 +20591,26 @@ - - Sets the enumerator to its initial position, before the first element in the collection. - + + Sets the enumerator to its initial position, before the first element in the collection. + - - Gets the current element in the collection. - + + Gets the current element in the collection. + - - Type visible only to our subclasses - Used to access protected constructor - - + + Type visible only to our subclasses + Used to access protected constructor + + - - A value - + + A value + @@ -19298,10 +20619,10 @@ - - Initializes a new instance of the Enumerator class. - - + + Initializes a new instance of the Enumerator class. + + @@ -19316,33 +20637,33 @@ - - Sets the enumerator to its initial position, before the first element in the collection. - + + Sets the enumerator to its initial position, before the first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - + - - Map of repository plugins. - - - - This class is a name keyed map of the plugins that are - attached to a repository. - - - Nicko Cadell - Gert Driesen + + Map of repository plugins. + + + + This class is a name keyed map of the plugins that are + attached to a repository. + + + Nicko Cadell + Gert Driesen @@ -19426,13 +20747,13 @@ Gert Driesen - - Constructor - - the name of the plugin - - Initializes a new Plugin with the specified name. - + + Constructor + + the name of the plugin + + Initializes a new Plugin with the specified name. + @@ -19449,26 +20770,26 @@ - - Is called when the plugin is to shutdown. - - - - This method is called to notify the plugin that - it should stop operating and should detach from - the repository. - - + + Is called when the plugin is to shutdown. + + + + This method is called to notify the plugin that + it should stop operating and should detach from + the repository. + + - - The name of this plugin. - + + The name of this plugin. + - - The repository this plugin is attached to. - + + The repository this plugin is attached to. + @@ -19562,29 +20883,38 @@ - - Is called when the plugin is to shutdown. - - - - When the plugin is shutdown the remote logging - sink is disconnected. - - + + Is called when the plugin is to shutdown. + + + + When the plugin is shutdown the remote logging + sink is disconnected. + + + + + + The fully qualified type of the RemoteLoggingServerPlugin class. + + + Used by the internal logger to record the Type of the + log message. + - - Gets or sets the URI of this sink. - - - The URI of this sink. - - - - This is the name under which the object is marshaled. - - - + + Gets or sets the URI of this sink. + + + The URI of this sink. + + + + This is the name under which the object is marshaled. + + + @@ -19621,18 +20951,18 @@ - - Obtains a lifetime service object to control the lifetime - policy for this instance. - - null to indicate that this instance should live forever. - - - Obtains a lifetime service object to control the lifetime - policy for this instance. This object should live forever - therefore this implementation returns null. - - + + Obtains a lifetime service object to control the lifetime + policy for this instance. + + null to indicate that this instance should live forever. + + + Obtains a lifetime service object to control the lifetime + policy for this instance. This object should live forever + therefore this implementation returns null. + + @@ -19664,7 +20994,7 @@ create new objects. - The method is called + The method is called to create a named . @@ -19674,10 +21004,11 @@ Nicko Cadell Gert Driesen - + Create a new instance + The that will own the . The name of the . The instance for the specified name. @@ -19705,10 +21036,11 @@ - + Create a new instance + The that will own the . The name of the . The instance for the specified name. @@ -19784,46 +21116,46 @@ - - Add to the list of appenders of this - Logger instance. - - An appender to add to this logger - - - Add to the list of appenders of this - Logger instance. - - - If is already in the list of - appenders, then it won't be added again. - - + + Add to the list of appenders of this + Logger instance. + + An appender to add to this logger + + + Add to the list of appenders of this + Logger instance. + + + If is already in the list of + appenders, then it won't be added again. + + - - Look for the appender named as name - - The name of the appender to lookup - The appender with the name specified, or null. - - - Returns the named appender, or null if the appender is not found. - - + + Look for the appender named as name + + The name of the appender to lookup + The appender with the name specified, or null. + + + Returns the named appender, or null if the appender is not found. + + - - Remove all previously added appenders from this Logger instance. - - - - Remove all previously added appenders from this Logger instance. - - - This is useful when re-reading configuration information. - - + + Remove all previously added appenders from this Logger instance. + + + + Remove all previously added appenders from this Logger instance. + + + This is useful when re-reading configuration information. + + @@ -19834,61 +21166,61 @@ Remove the appender passed as parameter form the list of appenders. - The appender removed is not closed. - If you are discarding the appender you must call - on the appender removed. - - - - - - Remove the appender passed as parameter form the list of appenders. - - The name of the appender to remove - The appender removed from the list - - - Remove the named appender passed as parameter form the list of appenders. - The appender removed is not closed. - If you are discarding the appender you must call - on the appender removed. - - - - - - This generic form is intended to be used by wrappers. - - The declaring type of the method that is - the stack boundary into the logging system for this call. - The level of the message to be logged. - The message object to log. - The exception to log, including its stack trace. - - - Generate a logging event for the specified using - the and . - - - This method must not throw any exception to the caller. + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. - + - This is the most generic printing method that is intended to be used - by wrappers. + Remove the appender passed as parameter form the list of appenders. - The event being logged. + The name of the appender to remove + The appender removed from the list - Logs the specified logging event through this logger. - - - This method must not throw any exception to the caller. + Remove the named appender passed as parameter form the list of appenders. + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + This generic form is intended to be used by wrappers. + + The declaring type of the method that is + the stack boundary into the logging system for this call. + The level of the message to be logged. + The message object to log. + The exception to log, including its stack trace. + + + Generate a logging event for the specified using + the and . + + + This method must not throw any exception to the caller. + + + + + + This is the most generic printing method that is intended to be used + by wrappers. + + The event being logged. + + + Logs the specified logging event through this logger. + + + This method must not throw any exception to the caller. + + + Checks if this logger is enabled for a given passed as parameter. @@ -19935,90 +21267,90 @@ - - This is the most generic printing method. This generic form is intended to be used by wrappers - - The level of the message to be logged. - The message object to log. - The exception to log, including its stack trace. - - - Generate a logging event for the specified using - the . - - + + This is the most generic printing method. This generic form is intended to be used by wrappers + + The level of the message to be logged. + The message object to log. + The exception to log, including its stack trace. + + + Generate a logging event for the specified using + the . + + - - Creates a new logging event and logs the event without further checks. - - The declaring type of the method that is - the stack boundary into the logging system for this call. - The level of the message to be logged. - The message object to log. - The exception to log, including its stack trace. - - - Generates a logging event and delivers it to the attached - appenders. - - + + Creates a new logging event and logs the event without further checks. + + The declaring type of the method that is + the stack boundary into the logging system for this call. + The level of the message to be logged. + The message object to log. + The exception to log, including its stack trace. + + + Generates a logging event and delivers it to the attached + appenders. + + - - Creates a new logging event and logs the event without further checks. - - The event being logged. - - - Delivers the logging event to the attached appenders. - - - - - - The fully qualified type of the Logger class. - + + Creates a new logging event and logs the event without further checks. + + The event being logged. + + + Delivers the logging event to the attached appenders. + + + + + + The fully qualified type of the Logger class. + - - The name of this logger. - + + The name of this logger. + - - The assigned level of this logger. - - - - The level variable need not be - assigned a value in which case it is inherited - form the hierarchy. - - + + The assigned level of this logger. + + + + The level variable need not be + assigned a value in which case it is inherited + form the hierarchy. + + - - The parent of this logger. - - - - The parent of this logger. - All loggers have at least one ancestor which is the root logger. - - + + The parent of this logger. + + + + The parent of this logger. + All loggers have at least one ancestor which is the root logger. + + - - Loggers need to know what Hierarchy they are in. - - - - Loggers need to know what Hierarchy they are in. - The hierarchy that this logger is a member of is stored - here. - - + + Loggers need to know what Hierarchy they are in. + + + + Loggers need to know what Hierarchy they are in. + The hierarchy that this logger is a member of is stored + here. + + @@ -20026,73 +21358,73 @@ - - Flag indicating if child loggers inherit their parents appenders - - - - Additivity is set to true by default, that is children inherit - the appenders of their ancestors by default. If this variable is - set to false then the appenders found in the - ancestors of this logger are not used. However, the children - of this logger will inherit its appenders, unless the children - have their additivity flag set to false too. See - the user manual for more details. - - + + Flag indicating if child loggers inherit their parents appenders + + + + Additivity is set to true by default, that is children inherit + the appenders of their ancestors by default. If this variable is + set to false then the appenders found in the + ancestors of this logger are not used. However, the children + of this logger will inherit its appenders, unless the children + have their additivity flag set to false too. See + the user manual for more details. + + - - Lock to protect AppenderAttachedImpl variable m_appenderAttachedImpl - + + Lock to protect AppenderAttachedImpl variable m_appenderAttachedImpl + - - Gets or sets the parent logger in the hierarchy. - - - The parent logger in the hierarchy. - - - - Part of the Composite pattern that makes the hierarchy. - The hierarchy is parent linked rather than child linked. - - + + Gets or sets the parent logger in the hierarchy. + + + The parent logger in the hierarchy. + + + + Part of the Composite pattern that makes the hierarchy. + The hierarchy is parent linked rather than child linked. + + - - Gets or sets a value indicating if child loggers inherit their parent's appenders. - - - true if child loggers inherit their parent's appenders. - - - - Additivity is set to true by default, that is children inherit - the appenders of their ancestors by default. If this variable is - set to false then the appenders found in the - ancestors of this logger are not used. However, the children - of this logger will inherit its appenders, unless the children - have their additivity flag set to false too. See - the user manual for more details. - - + + Gets or sets a value indicating if child loggers inherit their parent's appenders. + + + true if child loggers inherit their parent's appenders. + + + + Additivity is set to true by default, that is children inherit + the appenders of their ancestors by default. If this variable is + set to false then the appenders found in the + ancestors of this logger are not used. However, the children + of this logger will inherit its appenders, unless the children + have their additivity flag set to false too. See + the user manual for more details. + + - - Gets the effective level for this logger. - - The nearest level in the logger hierarchy. - - - Starting from this logger, searches the logger hierarchy for a - non-null level and returns it. Otherwise, returns the level of the - root logger. - - The Logger class is designed so that this method executes as - quickly as possible. - + + Gets the effective level for this logger. + + The nearest level in the logger hierarchy. + + + Starting from this logger, searches the logger hierarchy for a + non-null level and returns it. Otherwise, returns the level of the + root logger. + + The Logger class is designed so that this method executes as + quickly as possible. + @@ -20134,17 +21466,17 @@ - - Gets the logger name. - - - The name of the logger. - - - - The name of this logger - - + + Gets the logger name. + + + The name of the logger. + + + + The name of this logger + + @@ -20242,7 +21574,7 @@ The structure of the logger hierarchy is maintained by the - method. The hierarchy is such that children + method. The hierarchy is such that children link to their parent but parents do not have any references to their children. Moreover, loggers can be instantiated in any order, in particular descendant before ancestor. @@ -20280,7 +21612,7 @@ This interface is implemented by logger repositories. e.g. - . + . This interface is used by the @@ -20291,84 +21623,84 @@ Gert Driesen - - Check if the named logger exists in the repository. If so return - its reference, otherwise returns null. - - The name of the logger to lookup - The Logger object with the name specified - - - If the names logger exists it is returned, otherwise - null is returned. - - + + Check if the named logger exists in the repository. If so return + its reference, otherwise returns null. + + The name of the logger to lookup + The Logger object with the name specified + + + If the names logger exists it is returned, otherwise + null is returned. + + - - Returns all the currently defined loggers as an Array. - - All the defined loggers - - - Returns all the currently defined loggers as an Array. - - + + Returns all the currently defined loggers as an Array. + + All the defined loggers + + + Returns all the currently defined loggers as an Array. + + - - Returns a named logger instance - - The name of the logger to retrieve - The logger object with the name specified - - - Returns a named logger instance. - - - If a logger of that name already exists, then it will be - returned. Otherwise, a new logger will be instantiated and - then linked with its existing ancestors as well as children. - - + + Returns a named logger instance + + The name of the logger to retrieve + The logger object with the name specified + + + Returns a named logger instance. + + + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated and + then linked with its existing ancestors as well as children. + + - Shutdown the repository - - - Shutting down a repository will safely close and remove - all appenders in all loggers including the root logger. - - - Some appenders need to be closed before the - application exists. Otherwise, pending logging events might be - lost. - - - The method is careful to close nested - appenders before closing regular appenders. This is allows - configurations where a regular appender is attached to a logger - and again to a nested appender. - - + Shutdown the repository + + + Shutting down a repository will safely close and remove + all appenders in all loggers including the root logger. + + + Some appenders need to be closed before the + application exists. Otherwise, pending logging events might be + lost. + + + The method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + - - Reset the repositories configuration to a default state - - - - Reset all values contained in this instance to their - default state. - - - Existing loggers are not removed. They are just reset. - - - This method should be used sparingly and with care as it will - block all logging until it is completed. - - + + Reset the repositories configuration to a default state + + + + Reset all values contained in this instance to their + default state. + + + Existing loggers are not removed. They are just reset. + + + This method should be used sparingly and with care as it will + block all logging until it is completed. + + @@ -20380,7 +21712,7 @@ This method should not normally be used to log. The interface should be used for routine logging. This interface can be obtained - using the method. + using the method. The logEvent is delivered to the appropriate logger and @@ -20389,28 +21721,28 @@ - - Returns all the Appenders that are configured as an Array. - - All the Appenders - - - Returns all the Appenders that are configured as an Array. - - + + Returns all the Appenders that are configured as an Array. + + All the Appenders + + + Returns all the Appenders that are configured as an Array. + + - - The name of the repository - - - The name of the repository - - - - The name of the repository. - - + + The name of the repository + + + The name of the repository + + + + The name of the repository. + + @@ -20459,145 +21791,151 @@ - - The threshold for all events in this repository - - - The threshold for all events in this repository - - - - The threshold for all events in this repository. - - + + The threshold for all events in this repository + + + The threshold for all events in this repository + + + + The threshold for all events in this repository. + + - - Flag indicates if this repository has been configured. - - - Flag indicates if this repository has been configured. - - - - Flag indicates if this repository has been configured. - - + + Flag indicates if this repository has been configured. + + + Flag indicates if this repository has been configured. + + + + Flag indicates if this repository has been configured. + + + + + + Collection of internal messages captured during the most + recent configuration process. + - - Event to notify that the repository has been shutdown. - - - Event to notify that the repository has been shutdown. - - - - Event raised when the repository has been shutdown. - - + + Event to notify that the repository has been shutdown. + + + Event to notify that the repository has been shutdown. + + + + Event raised when the repository has been shutdown. + + - - Event to notify that the repository has had its configuration reset. - - - Event to notify that the repository has had its configuration reset. - - - - Event raised when the repository's configuration has been - reset to default. - - + + Event to notify that the repository has had its configuration reset. + + + Event to notify that the repository has had its configuration reset. + + + + Event raised when the repository's configuration has been + reset to default. + + - - Event to notify that the repository has had its configuration changed. - - - Event to notify that the repository has had its configuration changed. - - - - Event raised when the repository's configuration has been changed. - - + + Event to notify that the repository has had its configuration changed. + + + Event to notify that the repository has had its configuration changed. + + + + Event raised when the repository's configuration has been changed. + + - - Repository specific properties - - - Repository specific properties - - - - These properties can be specified on a repository specific basis. - - + + Repository specific properties + + + Repository specific properties + + + + These properties can be specified on a repository specific basis. + + - - Default Constructor - - - - Initializes the repository with default (empty) properties. - - + + Default Constructor + + + + Initializes the repository with default (empty) properties. + + - - Construct the repository using specific properties - - the properties to set for this repository - - - Initializes the repository with specified properties. - - + + Construct the repository using specific properties + + the properties to set for this repository + + + Initializes the repository with specified properties. + + - - Test if logger exists - - The name of the logger to lookup - The Logger object with the name specified - - - Check if the named logger exists in the repository. If so return - its reference, otherwise returns null. - - + + Test if logger exists + + The name of the logger to lookup + The Logger object with the name specified + + + Check if the named logger exists in the repository. If so return + its reference, otherwise returns null. + + - - Returns all the currently defined loggers in the repository - - All the defined loggers - - - Returns all the currently defined loggers in the repository as an Array. - - + + Returns all the currently defined loggers in the repository + + All the defined loggers + + + Returns all the currently defined loggers in the repository as an Array. + + - - Return a new logger instance - - The name of the logger to retrieve - The logger object with the name specified - - - Return a new logger instance. - - - If a logger of that name already exists, then it will be - returned. Otherwise, a new logger will be instantiated and - then linked with its existing ancestors as well as children. - - + + Return a new logger instance + + The name of the logger to retrieve + The logger object with the name specified + + + Return a new logger instance. + + + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated and + then linked with its existing ancestors as well as children. + + @@ -20605,30 +21943,30 @@ - Shutdown the repository. Can be overridden in a subclass. - This base class implementation notifies the - listeners and all attached plugins of the shutdown event. - - - - - - Reset the repositories configuration to a default state - - - - Reset all values contained in this instance to their - default state. - - - Existing loggers are not removed. They are just reset. - - - This method should be used sparingly and with care as it will - block all logging until it is completed. + Shutdown the repository. Can be overridden in a subclass. + This base class implementation notifies the + listeners and all attached plugins of the shutdown event. + + + Reset the repositories configuration to a default state + + + + Reset all values contained in this instance to their + default state. + + + Existing loggers are not removed. They are just reset. + + + This method should be used sparingly and with care as it will + block all logging until it is completed. + + + Log the logEvent through this repository. @@ -20639,7 +21977,7 @@ This method should not normally be used to log. The interface should be used for routine logging. This interface can be obtained - using the method. + using the method. The logEvent is delivered to the appropriate logger and @@ -20648,72 +21986,81 @@ - - Returns all the Appenders that are configured as an Array. - - All the Appenders - - - Returns all the Appenders that are configured as an Array. - - + + Returns all the Appenders that are configured as an Array. + + All the Appenders + + + Returns all the Appenders that are configured as an Array. + + + + + + The fully qualified type of the LoggerRepositorySkeleton class. + + + Used by the internal logger to record the Type of the + log message. + - - Adds an object renderer for a specific class. - - The type that will be rendered by the renderer supplied. - The object renderer used to render the object. - - - Adds an object renderer for a specific class. - - + + Adds an object renderer for a specific class. + + The type that will be rendered by the renderer supplied. + The object renderer used to render the object. + + + Adds an object renderer for a specific class. + + - - Notify the registered listeners that the repository is shutting down - - Empty EventArgs - - - Notify any listeners that this repository is shutting down. - - + + Notify the registered listeners that the repository is shutting down + + Empty EventArgs + + + Notify any listeners that this repository is shutting down. + + - - Notify the registered listeners that the repository has had its configuration reset - - Empty EventArgs - - - Notify any listeners that this repository's configuration has been reset. - - + + Notify the registered listeners that the repository has had its configuration reset + + Empty EventArgs + + + Notify any listeners that this repository's configuration has been reset. + + - - Notify the registered listeners that the repository has had its configuration changed - - Empty EventArgs - - - Notify any listeners that this repository's configuration has changed. - - + + Notify the registered listeners that the repository has had its configuration changed + + Empty EventArgs + + + Notify any listeners that this repository's configuration has changed. + + - - Raise a configuration changed event on this repository - - EventArgs.Empty - - - Applications that programmatically change the configuration of the repository should - raise this event notification to notify listeners. - - + + Raise a configuration changed event on this repository + + EventArgs.Empty + + + Applications that programmatically change the configuration of the repository should + raise this event notification to notify listeners. + + @@ -20731,17 +22078,17 @@ - - The threshold for all events in this repository - - - The threshold for all events in this repository - - - - The threshold for all events in this repository - - + + The threshold for all events in this repository + + + The threshold for all events in this repository + + + + The threshold for all events in this repository + + @@ -20790,68 +22137,74 @@ - - Flag indicates if this repository has been configured. - - - Flag indicates if this repository has been configured. - - - - Flag indicates if this repository has been configured. - - + + Flag indicates if this repository has been configured. + + + Flag indicates if this repository has been configured. + + + + Flag indicates if this repository has been configured. + + + + + + Contains a list of internal messages captures during the + last configuration. + - - Event to notify that the repository has been shutdown. - - - Event to notify that the repository has been shutdown. - - - - Event raised when the repository has been shutdown. - - + + Event to notify that the repository has been shutdown. + + + Event to notify that the repository has been shutdown. + + + + Event raised when the repository has been shutdown. + + - - Event to notify that the repository has had its configuration reset. - - - Event to notify that the repository has had its configuration reset. - - - - Event raised when the repository's configuration has been - reset to default. - - + + Event to notify that the repository has had its configuration reset. + + + Event to notify that the repository has had its configuration reset. + + + + Event raised when the repository's configuration has been + reset to default. + + - - Event to notify that the repository has had its configuration changed. - - - Event to notify that the repository has had its configuration changed. - - - - Event raised when the repository's configuration has been changed. - - + + Event to notify that the repository has had its configuration changed. + + + Event to notify that the repository has had its configuration changed. + + + + Event raised when the repository's configuration has been changed. + + - - Repository specific properties - - - Repository specific properties - - - These properties can be specified on a repository specific basis - + + Repository specific properties + + + Repository specific properties + + + These properties can be specified on a repository specific basis + @@ -20871,16 +22224,28 @@ Gert Driesen - - Initialize the repository using the specified appender - - the appender to use to log all logging events - - - Configure the repository to route all logging events to the - specified appender. - - + + Initialize the repository using the specified appender + + the appender to use to log all logging events + + + Configure the repository to route all logging events to the + specified appender. + + + + + + Initialize the repository using the specified appenders + + the appenders to use to log all logging events + + + Configure the repository to route all logging events to the + specified appenders. + + @@ -20899,16 +22264,16 @@ Gert Driesen - - Initialize the repository using the specified config - - the element containing the root of the config - - - The schema for the XML configuration data is defined by - the implementation. - - + + Initialize the repository using the specified config + + the element containing the root of the config + + + The schema for the XML configuration data is defined by + the implementation. + + @@ -20957,72 +22322,72 @@ - - Test if a logger exists - - The name of the logger to lookup - The Logger object with the name specified - - - Check if the named logger exists in the hierarchy. If so return - its reference, otherwise returns null. - - + + Test if a logger exists + + The name of the logger to lookup + The Logger object with the name specified + + + Check if the named logger exists in the hierarchy. If so return + its reference, otherwise returns null. + + - - Returns all the currently defined loggers in the hierarchy as an Array - - All the defined loggers - - - Returns all the currently defined loggers in the hierarchy as an Array. - The root logger is not included in the returned - enumeration. - - + + Returns all the currently defined loggers in the hierarchy as an Array + + All the defined loggers + + + Returns all the currently defined loggers in the hierarchy as an Array. + The root logger is not included in the returned + enumeration. + + - - Return a new logger instance named as the first parameter using - the default factory. - - - - Return a new logger instance named as the first parameter using - the default factory. - - - If a logger of that name already exists, then it will be - returned. Otherwise, a new logger will be instantiated and - then linked with its existing ancestors as well as children. - - - The name of the logger to retrieve - The logger object with the name specified + + Return a new logger instance named as the first parameter using + the default factory. + + + + Return a new logger instance named as the first parameter using + the default factory. + + + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated and + then linked with its existing ancestors as well as children. + + + The name of the logger to retrieve + The logger object with the name specified - - Shutting down a hierarchy will safely close and remove - all appenders in all loggers including the root logger. - - - - Shutting down a hierarchy will safely close and remove - all appenders in all loggers including the root logger. - - - Some appenders need to be closed before the - application exists. Otherwise, pending logging events might be - lost. - - - The Shutdown method is careful to close nested - appenders before closing regular appenders. This is allows - configurations where a regular appender is attached to a logger - and again to a nested appender. - - + + Shutting down a hierarchy will safely close and remove + all appenders in all loggers including the root logger. + + + + Shutting down a hierarchy will safely close and remove + all appenders in all loggers including the root logger. + + + Some appenders need to be closed before the + application exists. Otherwise, pending logging events might be + lost. + + + The Shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + @@ -21056,7 +22421,7 @@ This method should not normally be used to log. The interface should be used for routine logging. This interface can be obtained - using the method. + using the method. The logEvent is delivered to the appropriate logger and @@ -21096,42 +22461,48 @@ - - Initialize the log4net system using the specified appender - - the appender to use to log all logging events - - - - Initialize the log4net system using the specified appender - - the appender to use to log all logging events - - - This method provides the same functionality as the - method implemented - on this object, but it is protected and therefore can be called by subclasses. - - + + Initialize the log4net system using the specified appender + + the appender to use to log all logging events + + + + Initialize the log4net system using the specified appenders + + the appenders to use to log all logging events + + + + Initialize the log4net system using the specified appenders + + the appenders to use to log all logging events + + + This method provides the same functionality as the + method implemented + on this object, but it is protected and therefore can be called by subclasses. + + - - Initialize the log4net system using the specified config - - the element containing the root of the config + + Initialize the log4net system using the specified config + + the element containing the root of the config - - Initialize the log4net system using the specified config - - the element containing the root of the config - - - This method provides the same functionality as the - method implemented - on this object, but it is protected and therefore can be called by subclasses. - - + + Initialize the log4net system using the specified config + + the element containing the root of the config + + + This method provides the same functionality as the + method implemented + on this object, but it is protected and therefore can be called by subclasses. + + @@ -21157,83 +22528,83 @@ - - Clear all logger definitions from the internal hashtable - - - - This call will clear all logger definitions from the internal - hashtable. Invoking this method will irrevocably mess up the - logger hierarchy. - - - You should really know what you are doing before - invoking this method. - - + + Clear all logger definitions from the internal hashtable + + + + This call will clear all logger definitions from the internal + hashtable. Invoking this method will irrevocably mess up the + logger hierarchy. + + + You should really know what you are doing before + invoking this method. + + - - Return a new logger instance named as the first parameter using - . - - The name of the logger to retrieve - The factory that will make the new logger instance - The logger object with the name specified - - - If a logger of that name already exists, then it will be - returned. Otherwise, a new logger will be instantiated by the - parameter and linked with its existing - ancestors as well as children. - - + + Return a new logger instance named as the first parameter using + . + + The name of the logger to retrieve + The factory that will make the new logger instance + The logger object with the name specified + + + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated by the + parameter and linked with its existing + ancestors as well as children. + + - - Sends a logger creation event to all registered listeners - - The newly created logger - - Raises the logger creation event. - + + Sends a logger creation event to all registered listeners + + The newly created logger + + Raises the logger creation event. + - - Updates all the parents of the specified logger - - The logger to update the parents for - - - This method loops through all the potential parents of - . There 3 possible cases: - - - - No entry for the potential parent of exists - - We create a ProvisionNode for this potential - parent and insert in that provision node. - - - - The entry is of type Logger for the potential parent. - - The entry is 's nearest existing parent. We - update 's parent field with this entry. We also break from - he loop because updating our parent's parent is our parent's - responsibility. - - - - The entry is of type ProvisionNode for this potential parent. - - We add to the list of children for this - potential parent. - - - - + + Updates all the parents of the specified logger + + The logger to update the parents for + + + This method loops through all the potential parents of + . There 3 possible cases: + + + + No entry for the potential parent of exists + + We create a ProvisionNode for this potential + parent and insert in that provision node. + + + + The entry is of type Logger for the potential parent. + + The entry is 's nearest existing parent. We + update 's parent field with this entry. We also break from + he loop because updating our parent's parent is our parent's + responsibility. + + + + The entry is of type ProvisionNode for this potential parent. + + We add to the list of children for this + potential parent. + + + + @@ -21256,176 +22627,143 @@ 'log' then there is no need to update 'c'. - Otherwise, we set log's parent field to c's parent and set - c's parent field to log. - - - - - - Define or redefine a Level using the values in the argument - - the level values - - - Define or redefine a Level using the values in the argument - - - Supports setting levels via the configuration file. - - - - - - Set a Property using the values in the argument - - the property value - - - Set a Property using the values in the argument. - - - Supports setting property values via the configuration file. - - - - - - Event used to notify that a logger has been created. - - - - Event raised when a logger is created. - - - - - - Has no appender warning been emitted - - - - Flag to indicate if we have already issued a warning - about not having an appender warning. - - - - - - Get the root of this hierarchy - - - - Get the root of this hierarchy. - - - - - - Gets or sets the default instance. - - The default - - - The logger factory is used to create logger instances. - - - - - - A class to hold the value, name and display name for a level - - - - A class to hold the value, name and display name for a level + Otherwise, we set log's parent field to c's parent and set + c's parent field to log. - - - Override Object.ToString to return sensible debug info - - string info about this object - - + - Value of the level + Define or redefine a Level using the values in the argument + the level values - If the value is not set (defaults to -1) the value will be looked - up for the current level with the same name. + Define or redefine a Level using the values in the argument - - - - - Name of the level - - - The name of the level - - - The name of the level. + Supports setting levels via the configuration file. - + - Display name for the level + Set a Property using the values in the argument - - The display name of the level - + the property value - The display name of the level. + Set a Property using the values in the argument. - - - - - A class to hold the key and data for a property set in the config file - - - A class to hold the key and data for a property set in the config file + Supports setting property values via the configuration file. - - - Override Object.ToString to return sensible debug info - - string info about this object + + + The fully qualified type of the Hierarchy class. + + + Used by the internal logger to record the Type of the + log message. + - - - Property Key - - - Property Key - - - - Property Key. - - + + + Event used to notify that a logger has been created. + + + + Event raised when a logger is created. + + + + + + Has no appender warning been emitted + + + + Flag to indicate if we have already issued a warning + about not having an appender warning. + + + + + + Get the root of this hierarchy + + + + Get the root of this hierarchy. + + - + - Property Value + Gets or sets the default instance. - - Property Value - + The default - Property Value. + The logger factory is used to create logger instances. + + + A class to hold the value, name and display name for a level + + + + A class to hold the value, name and display name for a level + + + + + + Override Object.ToString to return sensible debug info + + string info about this object + + + + Value of the level + + + + If the value is not set (defaults to -1) the value will be looked + up for the current level with the same name. + + + + + + Name of the level + + + The name of the level + + + + The name of the level. + + + + + + Display name for the level + + + The display name of the level + + + + The display name of the level. + + + Used internally to accelerate hash table searches. @@ -21468,15 +22806,15 @@ The name of the logger. - - Returns a hash code for the current instance. - - A hash code for the current instance. - - - Returns the cached hashcode. - - + + Returns a hash code for the current instance. + + A hash code for the current instance. + + + Returns the cached hashcode. + + @@ -21558,6 +22896,15 @@ + + + The fully qualified type of the RootLogger class. + + + Used by the internal logger to record the Type of the + log message. + + Gets the assigned level value without walking the logger hierarchy. @@ -21610,125 +22957,125 @@ - - Configure the hierarchy by parsing a DOM tree of XML elements. - - The root element to parse. - - - Configure the hierarchy by parsing a DOM tree of XML elements. - - + + Configure the hierarchy by parsing a DOM tree of XML elements. + + The root element to parse. + + + Configure the hierarchy by parsing a DOM tree of XML elements. + + - - Parse appenders by IDREF. - - The appender ref element. - The instance of the appender that the ref refers to. - - - Parse an XML element that represents an appender and return - the appender. - - + + Parse appenders by IDREF. + + The appender ref element. + The instance of the appender that the ref refers to. + + + Parse an XML element that represents an appender and return + the appender. + + - - Parses an appender element. - - The appender element. - The appender instance or null when parsing failed. - - - Parse an XML element that represents an appender and return - the appender instance. - - + + Parses an appender element. + + The appender element. + The appender instance or null when parsing failed. + + + Parse an XML element that represents an appender and return + the appender instance. + + - - Parses a logger element. - - The logger element. - - - Parse an XML element that represents a logger. - - + + Parses a logger element. + + The logger element. + + + Parse an XML element that represents a logger. + + - - Parses the root logger element. - - The root element. - - - Parse an XML element that represents the root logger. - - + + Parses the root logger element. + + The root element. + + + Parse an XML element that represents the root logger. + + - - Parses the children of a logger element. - - The category element. - The logger instance. - Flag to indicate if the logger is the root logger. - - - Parse the child elements of a <logger> element. - - + + Parses the children of a logger element. + + The category element. + The logger instance. + Flag to indicate if the logger is the root logger. + + + Parse the child elements of a <logger> element. + + - - Parses an object renderer. - - The renderer element. - - - Parse an XML element that represents a renderer. - - + + Parses an object renderer. + + The renderer element. + + + Parse an XML element that represents a renderer. + + - - Parses a level element. - - The level element. - The logger object to set the level on. - Flag to indicate if the logger is the root logger. - - - Parse an XML element that represents a level. - - + + Parses a level element. + + The level element. + The logger object to set the level on. + Flag to indicate if the logger is the root logger. + + + Parse an XML element that represents a level. + + - - Sets a parameter on an object. - - The parameter element. - The object to set the parameter on. - - The parameter name must correspond to a writable property - on the object. The value of the parameter is a string, - therefore this function will attempt to set a string - property first. If unable to set a string property it - will inspect the property and its argument type. It will - attempt to call a static method called Parse on the - type of the property. This method will take a single - string argument and return a value that can be used to - set the property. - + + Sets a parameter on an object. + + The parameter element. + The object to set the parameter on. + + The parameter name must correspond to a writable property + on the object. The value of the parameter is a string, + therefore this function will attempt to set a string + property first. If unable to set a string property it + will inspect the property and its argument type. It will + attempt to call a static method called Parse on the + type of the property. This method will take a single + string argument and return a value that can be used to + set the property. + - - Test if an element has no attributes or child elements - - the element to inspect - true if the element has any attributes or child elements, false otherwise + + Test if an element has no attributes or child elements + + the element to inspect + true if the element has any attributes or child elements, false otherwise @@ -21738,63 +23085,88 @@ true if the type is creatable using a default constructor, false otherwise - - Look for a method on the that matches the supplied - - the type that has the method - the name of the method - the method info found - - - The method must be a public instance method on the . - The method must be named or "Add" followed by . - The method must take a single parameter. - - + + Look for a method on the that matches the supplied + + the type that has the method + the name of the method + the method info found + + + The method must be a public instance method on the . + The method must be named or "Add" followed by . + The method must take a single parameter. + + - - Converts a string value to a target type. - - The type of object to convert the string to. - The string value to use as the value of the object. - - - An object of type with value or - null when the conversion could not be performed. - - + + Converts a string value to a target type. + + The type of object to convert the string to. + The string value to use as the value of the object. + + + An object of type with value or + null when the conversion could not be performed. + + - - Creates an object as specified in XML. - - The XML element that contains the definition of the object. - The object type to use if not explicitly specified. - The type that the returned object must be or must inherit from. - The object or null - - - Parse an XML element and create an object instance based on the configuration - data. - - - The type of the instance may be specified in the XML. If not - specified then the is used - as the type. However the type is specified it must support the - type. - - + + Creates an object as specified in XML. + + The XML element that contains the definition of the object. + The object type to use if not explicitly specified. + The type that the returned object must be or must inherit from. + The object or null + + + Parse an XML element and create an object instance based on the configuration + data. + + + The type of the instance may be specified in the XML. If not + specified then the is used + as the type. However the type is specified it must support the + type. + + - - key: appenderName, value: appender. - + + key: appenderName, value: appender. + - - The Hierarchy being configured. - + + The Hierarchy being configured. + + + + + The fully qualified type of the XmlHierarchyConfigurator class. + + + Used by the internal logger to record the Type of the + log message. + + + + + + + + + + + + + + + + + @@ -21833,27 +23205,27 @@ - - Write the name of the current AppDomain to the output - - - - Write the name of the current AppDomain to the output writer - - - Nicko Cadell + + Write the name of the current AppDomain to the output + + + + Write the name of the current AppDomain to the output writer + + + Nicko Cadell - - Write the name of the current AppDomain to the output - - the writer to write to - null, state is not set - - - Writes name of the current AppDomain to the output . - - + + Write the name of the current AppDomain to the output + + the writer to write to + null, state is not set + + + Writes name of the current AppDomain to the output . + + @@ -21898,7 +23270,7 @@ Any other pattern string uses the formatter. This formatter passes the pattern string to the - method. + method. For details on valid patterns see DateTimeFormatInfo Class. @@ -21956,57 +23328,122 @@ - + + + The fully qualified type of the DatePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + - Write an environment variable to the output + Write an folder path to the output - Write an environment variable to the output writer. + Write an special path environment folder path to the output writer. The value of the determines - the name of the variable to output. + the name of the variable to output. + should be a value in the enumeration. - Nicko Cadell + Ron Grabowski - + - Write an environment variable to the output + Write an special path environment folder path to the output the writer to write to null, state is not set - Writes the environment variable to the output . - The name of the environment variable to output must be set + Writes the special path environment folder path to the output . + The name of the special path environment folder path to output must be set using the property. - + + + The fully qualified type of the EnvironmentFolderPathPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + - Write the current thread identity to the output + Write an environment variable to the output - Write the current thread identity to the output writer + Write an environment variable to the output writer. + The value of the determines + the name of the variable to output. Nicko Cadell - + - Write the current thread identity to the output + Write an environment variable to the output the writer to write to null, state is not set - Writes the current thread identity to the output . + Writes the environment variable to the output . + The name of the environment variable to output must be set + using the + property. + + + The fully qualified type of the EnvironmentPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write the current thread identity to the output + + + + Write the current thread identity to the output writer + + + Nicko Cadell + + + + Write the current thread identity to the output + + the writer to write to + null, state is not set + + + Writes the current thread identity to the output . + + + + + + The fully qualified type of the IdentityPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + Pattern converter for literal string instances in the pattern @@ -22112,27 +23549,36 @@ - - Write the current process ID to the output - - - - Write the current process ID to the output writer - - - Nicko Cadell + + Write the current process ID to the output + + + + Write the current process ID to the output writer + + + Nicko Cadell - - Write the current process ID to the output - - the writer to write to - null, state is not set - - - Write the current process ID to the output . - - + + Write the current process ID to the output + + the writer to write to + null, state is not set + + + Write the current process ID to the output . + + + + + + The fully qualified type of the ProcessIdPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + @@ -22193,68 +23639,86 @@ Nicko Cadell - - Shared random number generator - - - - - Length of random string to generate. Default length 4. - - - - - Initialize the converter options - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - Write a randoim string to the output - - the writer to write to - null, state is not set - - - Write a randoim string to the output . - - - - - - Write the current threads username to the output - - - - Write the current threads username to the output writer - - - Nicko Cadell + + Shared random number generator + - + + + Length of random string to generate. Default length 4. + + + - Write the current threads username to the output + Initialize the converter options - the writer to write to - null, state is not set - Write the current threads username to the output . + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + Write a randoim string to the output + + the writer to write to + null, state is not set + + + Write a randoim string to the output . + + + + + + The fully qualified type of the RandomStringPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write the current threads username to the output + + + + Write the current threads username to the output writer + + + Nicko Cadell + + + + Write the current threads username to the output + + the writer to write to + null, state is not set + + + Write the current threads username to the output . + + + + + + The fully qualified type of the UserNamePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + Write the UTC date time to the output @@ -22288,6 +23752,15 @@ + + + The fully qualified type of the UtcDatePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + Type converter for Boolean. @@ -22433,8 +23906,8 @@ types. - Use the and - methods to register new converters. + Use the and + methods to register new converters. The and methods lookup appropriate converters to use. @@ -22453,26 +23926,26 @@ - - Static constructor. - - - - This constructor defines the intrinsic type converters. - - + + Static constructor. + + + + This constructor defines the intrinsic type converters. + + - - Adds a converter for a specific type. - - The type being converted to. - The type converter to use to convert to the destination type. - - - Adds a converter instance for a specific type. - - + + Adds a converter for a specific type. + + The type being converted to. + The type converter to use to convert to the destination type. + + + Adds a converter instance for a specific type. + + @@ -22487,46 +23960,46 @@ - - Gets the type converter to use to convert values to the destination type. - - The type being converted from. - The type being converted to. - - The type converter instance to use for type conversions or null - if no type converter is found. - - - - Gets the type converter to use to convert values to the destination type. - - + + Gets the type converter to use to convert values to the destination type. + + The type being converted from. + The type being converted to. + + The type converter instance to use for type conversions or null + if no type converter is found. + + + + Gets the type converter to use to convert values to the destination type. + + - - Gets the type converter to use to convert values to the destination type. - - The type being converted to. - - The type converter instance to use for type conversions or null - if no type converter is found. - - - - Gets the type converter to use to convert values to the destination type. - - + + Gets the type converter to use to convert values to the destination type. + + The type being converted to. + + The type converter instance to use for type conversions or null + if no type converter is found. + + + + Gets the type converter to use to convert values to the destination type. + + - - Lookups the type converter to use as specified by the attributes on the - destination type. - - The type being converted to. - - The type converter instance to use for type conversions or null - if no type converter is found. - + + Lookups the type converter to use as specified by the attributes on the + destination type. + + The type being converted to. + + The type converter instance to use for type conversions or null + if no type converter is found. + @@ -22545,6 +24018,15 @@ + + + The fully qualified type of the ConverterRegistry class. + + + Used by the internal logger to record the Type of the + log message. + + Mapping from to type converter. @@ -22586,7 +24068,7 @@ the encoding - Uses the method to + Uses the method to convert the argument to an . @@ -22609,31 +24091,31 @@ Nicko Cadell - - Returns whether this converter can convert the object to the specified type - - A Type that represents the type you want to convert to - true if the conversion is possible - - - Test if the type supported by this converter can be converted to the - . - - + + Returns whether this converter can convert the object to the specified type + + A Type that represents the type you want to convert to + true if the conversion is possible + + + Test if the type supported by this converter can be converted to the + . + + - - Converts the given value object to the specified type, using the arguments - - the object to convert - The Type to convert the value parameter to - the converted object - - - Converts the (which must be of the type supported - by this converter) to the specified.. - - + + Converts the given value object to the specified type, using the arguments + + the object to convert + The Type to convert the value parameter to + the converted object + + + Converts the (which must be of the type supported + by this converter) to the specified.. + + @@ -22681,9 +24163,9 @@ - - Valid characters in an IPv4 or IPv6 address string. (Does not support subnets) - + + Valid characters in an IPv4 or IPv6 address string. (Does not support subnets) + @@ -22776,7 +24258,7 @@ the converted object - Uses the method to convert the + Uses the method to convert the argument to a . @@ -22853,7 +24335,7 @@ the Type - Uses the method to convert the + Uses the method to convert the argument to a . Additional effort is made to locate partially specified types by searching the loaded assemblies. @@ -22866,37 +24348,37 @@ - - Attribute used to associate a type converter - - - - Class and Interface level attribute that specifies a type converter - to use with the associated type. - - - To associate a type converter with a target type apply a - TypeConverterAttribute to the target type. Specify the - type of the type converter on the attribute. - - - Nicko Cadell - Gert Driesen + + Attribute used to associate a type converter + + + + Class and Interface level attribute that specifies a type converter + to use with the associated type. + + + To associate a type converter with a target type apply a + TypeConverterAttribute to the target type. Specify the + type of the type converter on the attribute. + + + Nicko Cadell + Gert Driesen - - The string type name of the type converter - + + The string type name of the type converter + - - Default constructor - - - - Default constructor - - + + Default constructor + + + + Default constructor + + @@ -23003,40 +24485,40 @@ - - Attaches an appender. - - The appender to add. - - - If the appender is already in the list it won't be added again. - - + + Attaches an appender. + + The appender to add. + + + If the appender is already in the list it won't be added again. + + - - Gets an attached appender with the specified name. - - The name of the appender to get. - - The appender with the name specified, or null if no appender with the - specified name is found. - - - - Lookup an attached appender by name. - - + + Gets an attached appender with the specified name. + + The name of the appender to get. + + The appender with the name specified, or null if no appender with the + specified name is found. + + + + Lookup an attached appender by name. + + - - Removes all attached appenders. - - - - Removes and closes all attached appenders - - + + Removes all attached appenders. + + + + Removes and closes all attached appenders + + @@ -23067,28 +24549,37 @@ - - List of appenders - + + List of appenders + - - Array of appenders, used to cache the m_appenderList - + + Array of appenders, used to cache the m_appenderList + + + + + The fully qualified type of the AppenderAttachedImpl class. + + + Used by the internal logger to record the Type of the + log message. + - - Gets all attached appenders. - - - A collection of attached appenders, or null if there - are no attached appenders. - - - - The read only collection of all currently attached appenders. - - + + Gets all attached appenders. + + + A collection of attached appenders, or null if there + are no attached appenders. + + + + The read only collection of all currently attached appenders. + + @@ -23113,28 +24604,28 @@ - - Add a Properties Dictionary to this composite collection - - the properties to add - - - Properties dictionaries added first take precedence over dictionaries added - later. - - + + Add a Properties Dictionary to this composite collection + + the properties to add + + + Properties dictionaries added first take precedence over dictionaries added + later. + + - - Flatten this composite collection into a single properties dictionary - - the flattened dictionary - - - Reduces the collection of ordered dictionaries to a single dictionary - containing the resultant values for the keys. - - + + Flatten this composite collection into a single properties dictionary + + the flattened dictionary + + + Reduces the collection of ordered dictionaries to a single dictionary + containing the resultant values for the keys. + + @@ -23158,29 +24649,77 @@ - - Base class for Context Properties implementations - - - - This class defines a basic property get set accessor - - - Nicko Cadell + + Base class for Context Properties implementations + + + + This class defines a basic property get set accessor + + + Nicko Cadell + + Gets or sets the value of a property + + + The value for the property with the specified key + + + + Gets or sets the value of a property + + + + + + Wrapper class used to map converter names to converter types + + + + Pattern converter info class used during configuration by custom + PatternString and PatternLayer converters. + + + + + + default constructor + + + + + + + + + + + Gets or sets the name of the conversion pattern + + + + The name of the pattern in the format string + + + + - Gets or sets the value of a property + Gets or sets the type of the converter - - The value for the property with the specified key - - Gets or sets the value of a property + The value specified must extend the + type. + + + + + Subclass of that maintains a count of @@ -23221,9 +24760,9 @@ Nicko Cadell - - The writer to forward messages to - + + The writer to forward messages to + @@ -23239,70 +24778,70 @@ - - Closes the writer and releases any system resources associated with the writer - - - - - + + Closes the writer and releases any system resources associated with the writer + + + + + - - Dispose this writer - - flag indicating if we are being disposed - - - Dispose this writer - - + + Dispose this writer + + flag indicating if we are being disposed + + + Dispose this writer + + - - Flushes any buffered output - - - - Clears all buffers for the writer and causes any buffered data to be written - to the underlying device - - + + Flushes any buffered output + + + + Clears all buffers for the writer and causes any buffered data to be written + to the underlying device + + - - Writes a character to the wrapped TextWriter - - the value to write to the TextWriter - - - Writes a character to the wrapped TextWriter - - + + Writes a character to the wrapped TextWriter + + the value to write to the TextWriter + + + Writes a character to the wrapped TextWriter + + - - Writes a character buffer to the wrapped TextWriter - - the data buffer - the start index - the number of characters to write - - - Writes a character buffer to the wrapped TextWriter - - + + Writes a character buffer to the wrapped TextWriter + + the data buffer + the start index + the number of characters to write + + + Writes a character buffer to the wrapped TextWriter + + - - Writes a string to the wrapped TextWriter - - the value to write to the TextWriter - - - Writes a string to the wrapped TextWriter - - + + Writes a string to the wrapped TextWriter + + the value to write to the TextWriter + + + Writes a string to the wrapped TextWriter + + @@ -23331,123 +24870,123 @@ - - Gets an object that controls formatting - - - The format provider - - - - Gets an object that controls formatting - - + + Gets an object that controls formatting + + + The format provider + + + + Gets an object that controls formatting + + - - Gets or sets the line terminator string used by the TextWriter - - - The line terminator to use - - - - Gets or sets the line terminator string used by the TextWriter - - + + Gets or sets the line terminator string used by the TextWriter + + + The line terminator to use + + + + Gets or sets the line terminator string used by the TextWriter + + - - Constructor - - the writer to actually write to - the error handler to report error to - - - Create a new QuietTextWriter using a writer and error handler - - + + Constructor + + the writer to actually write to + the error handler to report error to + + + Create a new QuietTextWriter using a writer and error handler + + - - Writes a character to the underlying writer - - the char to write - - - Writes a character to the underlying writer - - + + Writes a character to the underlying writer + + the char to write + + + Writes a character to the underlying writer + + - - Writes a buffer to the underlying writer - - the buffer to write - the start index to write from - the number of characters to write - - - Writes a buffer to the underlying writer - - + + Writes a buffer to the underlying writer + + the buffer to write + the start index to write from + the number of characters to write + + + Writes a buffer to the underlying writer + + - - Writes a string to the output. - - The string data to write to the output. - - - Writes a string to the output. - - + + Writes a string to the output. + + The string data to write to the output. + + + Writes a string to the output. + + - - Closes the underlying output writer. - - - - Closes the underlying output writer. - - + + Closes the underlying output writer. + + + + Closes the underlying output writer. + + - - The error handler instance to pass all errors to - + + The error handler instance to pass all errors to + - - Flag to indicate if this writer is closed - + + Flag to indicate if this writer is closed + - - Gets or sets the error handler that all errors are passed to. - - - The error handler that all errors are passed to. - - - - Gets or sets the error handler that all errors are passed to. - - + + Gets or sets the error handler that all errors are passed to. + + + The error handler that all errors are passed to. + + + + Gets or sets the error handler that all errors are passed to. + + - - Gets a value indicating whether this writer is closed. - - - true if this writer is closed, otherwise false. - - - - Gets a value indicating whether this writer is closed. - - + + Gets a value indicating whether this writer is closed. + + + true if this writer is closed, otherwise false. + + + + Gets a value indicating whether this writer is closed. + + @@ -23501,34 +25040,34 @@ - - Total number of bytes written. - + + Total number of bytes written. + - - Gets or sets the total number of bytes written. - - - The total number of bytes written. - - - - Gets or sets the total number of bytes written. - - + + Gets or sets the total number of bytes written. + + + The total number of bytes written. + + + + Gets or sets the total number of bytes written. + + - - A fixed size rolling buffer of logging events. - - - - An array backed fixed size leaky bucket. - - - Nicko Cadell - Gert Driesen + + A fixed size rolling buffer of logging events. + + + + An array backed fixed size leaky bucket. + + + Nicko Cadell + Gert Driesen @@ -23544,74 +25083,74 @@ The argument is not a positive integer. - - Appends a to the buffer. - - The event to append to the buffer. - The event discarded from the buffer, if the buffer is full, otherwise null. - - - Append an event to the buffer. If the buffer still contains free space then - null is returned. If the buffer is full then an event will be dropped - to make space for the new event, the event dropped is returned. - - + + Appends a to the buffer. + + The event to append to the buffer. + The event discarded from the buffer, if the buffer is full, otherwise null. + + + Append an event to the buffer. If the buffer still contains free space then + null is returned. If the buffer is full then an event will be dropped + to make space for the new event, the event dropped is returned. + + - - Get and remove the oldest event in the buffer. - - The oldest logging event in the buffer - - - Gets the oldest (first) logging event in the buffer and removes it - from the buffer. - - + + Get and remove the oldest event in the buffer. + + The oldest logging event in the buffer + + + Gets the oldest (first) logging event in the buffer and removes it + from the buffer. + + - - Pops all the logging events from the buffer into an array. - - An array of all the logging events in the buffer. - - - Get all the events in the buffer and clear the buffer. - - + + Pops all the logging events from the buffer into an array. + + An array of all the logging events in the buffer. + + + Get all the events in the buffer and clear the buffer. + + - - Clear the buffer - - - - Clear the buffer of all events. The events in the buffer are lost. - - + + Clear the buffer + + + + Clear the buffer of all events. The events in the buffer are lost. + + - - Gets the th oldest event currently in the buffer. - - The th oldest event currently in the buffer. - - - If is outside the range 0 to the number of events - currently in the buffer, then null is returned. - - + + Gets the th oldest event currently in the buffer. + + The th oldest event currently in the buffer. + + + If is outside the range 0 to the number of events + currently in the buffer, then null is returned. + + - - Gets the maximum size of the buffer. - - The maximum size of the buffer. - - - Gets the maximum size of the buffer - - + + Gets the maximum size of the buffer. + + The maximum size of the buffer. + + + Gets the maximum size of the buffer + + @@ -23680,20 +25219,20 @@ - - The singleton instance of the empty collection. - + + The singleton instance of the empty collection. + - - Gets the singleton instance of the empty collection. - - The singleton instance of the empty collection. - - - Gets the singleton instance of the empty collection. - - + + Gets the singleton instance of the empty collection. + + The singleton instance of the empty collection. + + + Gets the singleton instance of the empty collection. + + @@ -23857,9 +25396,9 @@ This dictionary is always empty and cannot be modified. - - The singleton instance of the empty dictionary. - + + The singleton instance of the empty dictionary. + @@ -24008,44 +25547,44 @@ - - Gets or sets the minimum value. - - - The minimum value. - - - - Gets or sets the minimum value. - - + + Gets or sets the minimum value. + + + The minimum value. + + + + Gets or sets the minimum value. + + - - Gets or sets the maximum value. - - - The maximum value. - - - - Gets or sets the maximum value. - - + + Gets or sets the maximum value. + + + The maximum value. + + + + Gets or sets the maximum value. + + - - Gets or sets a flag indicating whether left align is enabled - or not. - - - A flag indicating whether left align is enabled or not. - - - - Gets or sets a flag indicating whether left align is enabled or not. - - + + Gets or sets a flag indicating whether left align is enabled + or not. + + + A flag indicating whether left align is enabled or not. + + + + Gets or sets a flag indicating whether left align is enabled or not. + + @@ -24064,20 +25603,20 @@ Nicko Cadell - - The read only copy of the properties. - - - - This variable is declared volatile to prevent the compiler and JIT from - reordering reads and writes of this thread performed on different threads. - - + + The read only copy of the properties. + + + + This variable is declared volatile to prevent the compiler and JIT from + reordering reads and writes of this thread performed on different threads. + + - - Lock object used to synchronize updates within this instance - + + Lock object used to synchronize updates within this instance + @@ -24090,48 +25629,48 @@ - - Remove a property from the global context - - the key for the entry to remove - - - Removing an entry from the global context properties is relatively expensive compared - with reading a value. - - + + Remove a property from the global context + + the key for the entry to remove + + + Removing an entry from the global context properties is relatively expensive compared + with reading a value. + + - - Clear the global context properties - + + Clear the global context properties + - - Get a readonly immutable copy of the properties - - the current global context properties - - - This implementation is fast because the GlobalContextProperties class - stores a readonly copy of the properties. - - + + Get a readonly immutable copy of the properties + + the current global context properties + + + This implementation is fast because the GlobalContextProperties class + stores a readonly copy of the properties. + + - - Gets or sets the value of a property - - - The value for the property with the specified key - - - - Reading the value for a key is faster than setting the value. - When the value is written a new read only copy of - the properties is created. - - + + Gets or sets the value of a property + + + The value for the property with the specified key + + + + Reading the value for a key is faster than setting the value. + When the value is written a new read only copy of + the properties is created. + + @@ -24191,292 +25730,405 @@ - Caches the sorted list of in an array - - - - - - Implementation of Properties collection for the - - - - Class implements a collection of properties that is specific to each thread. - The class is not synchronized as each thread has its own . - - - Nicko Cadell - - - - Constructor - - - - Initializes a new instance of the class. - - - - - - Remove a property - - the key for the entry to remove - - - Remove the value for the specified from the context. - - - - - - Clear all the context properties - - - - Clear all the context properties - - - - - - Get the PropertiesDictionary stored in the LocalDataStoreSlot for this thread. - - create the dictionary if it does not exist, otherwise return null if is does not exist - the properties for this thread - - - The collection returned is only to be used on the calling thread. If the - caller needs to share the collection between different threads then the - caller must clone the collection before doings so. - - - - - - Gets or sets the value of a property - - - The value for the property with the specified key - - - - Get or set the property value for the specified. - - - - - - Outputs log statements from within the log4net assembly. - - - - Log4net components cannot make log4net logging calls. However, it is - sometimes useful for the user to learn about what log4net is - doing. - - - All log4net internal debug calls go to the standard output stream - whereas internal error messages are sent to the standard error output - stream. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - - Uses a private access modifier to prevent instantiation of this class. - - - - - - Static constructor that initializes logging by reading - settings from the application configuration file. - - - - The log4net.Internal.Debug application setting - controls internal debugging. This setting should be set - to true to enable debugging. - - - The log4net.Internal.Quiet application setting - suppresses all internal logging including error messages. - This setting should be set to true to enable message - suppression. - - - - - - Writes log4net internal debug messages to the - standard output stream. - - The message to log. - - - All internal debug messages are prepended with - the string "log4net: ". - - - - - - Writes log4net internal debug messages to the - standard output stream. - - The message to log. - An exception to log. - - - All internal debug messages are prepended with - the string "log4net: ". - - - - - - Writes log4net internal warning messages to the - standard error stream. - - The message to log. - - - All internal warning messages are prepended with - the string "log4net:WARN ". - - - - - - Writes log4net internal warning messages to the - standard error stream. - - The message to log. - An exception to log. - - - All internal warning messages are prepended with - the string "log4net:WARN ". + Caches the sorted list of in an array - + - Writes log4net internal error messages to the - standard error stream. + Implementation of Properties collection for the - The message to log. - All internal error messages are prepended with - the string "log4net:ERROR ". + Class implements a collection of properties that is specific to each thread. + The class is not synchronized as each thread has its own . + + + This class stores its properties in a slot on the named + log4net.Util.LogicalThreadContextProperties. + + + The requires a link time + for the + . + If the calling code does not have this permission then this context will be disabled. + It will not store any property values set on it. + Nicko Cadell - + + + Flag used to disable this context if we don't have permission to access the CallContext. + + + - Writes log4net internal error messages to the - standard error stream. + Constructor - The message to log. - An exception to log. - All internal debug messages are prepended with - the string "log4net:ERROR ". + Initializes a new instance of the class. - + + + Remove a property + + the key for the entry to remove + + + Remove the value for the specified from the context. + + + + + + Clear all the context properties + + + + Clear all the context properties + + + + + + Get the PropertiesDictionary stored in the LocalDataStoreSlot for this thread. + + create the dictionary if it does not exist, otherwise return null if is does not exist + the properties for this thread + + + The collection returned is only to be used on the calling thread. If the + caller needs to share the collection between different threads then the + caller must clone the collection before doings so. + + + + - Writes output to the standard output stream. + Gets the call context get data. - The message to log. + The peroperties dictionary stored in the call context - - Writes to both Console.Out and System.Diagnostics.Trace. - Note that the System.Diagnostics.Trace is not supported - on the Compact Framework. - - - If the AppDomain is not configured with a config file then - the call to System.Diagnostics.Trace may fail. This is only - an issue if you are programmatically creating your own AppDomains. - + The method has a + security link demand, therfore we must put the method call in a seperate method + that we can wrap in an exception handler. - + - Writes output to the standard error stream. + Sets the call context data. - The message to log. + The properties. - - Writes to both Console.Error and System.Diagnostics.Trace. - Note that the System.Diagnostics.Trace is not supported - on the Compact Framework. - - - If the AppDomain is not configured with a config file then - the call to System.Diagnostics.Trace may fail. This is only - an issue if you are programmatically creating your own AppDomains. - + The method has a + security link demand, therfore we must put the method call in a seperate method + that we can wrap in an exception handler. - + + + The fully qualified type of the LogicalThreadContextProperties class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets or sets the value of a property + + + The value for the property with the specified key + + + + Get or set the property value for the specified. + + + + + + + + + + + + + Outputs log statements from within the log4net assembly. + + + + Log4net components cannot make log4net logging calls. However, it is + sometimes useful for the user to learn about what log4net is + doing. + + + All log4net internal debug calls go to the standard output stream + whereas internal error messages are sent to the standard error output + stream. + + + Nicko Cadell + Gert Driesen + + + + Formats Prefix, Source, and Message in the same format as the value + sent to Console.Out and Trace.Write. + + + + - Default debug level + Initializes a new instance of the class. + + + + + + + + Static constructor that initializes logging by reading + settings from the application configuration file. + + + + The log4net.Internal.Debug application setting + controls internal debugging. This setting should be set + to true to enable debugging. + + + The log4net.Internal.Quiet application setting + suppresses all internal logging including error messages. + This setting should be set to true to enable message + suppression. + + + + + + Raises the LogReceived event when an internal messages is received. + + + + + + + + + Writes log4net internal debug messages to the + standard output stream. + + + The message to log. + + + All internal debug messages are prepended with + the string "log4net: ". + + + + + + Writes log4net internal debug messages to the + standard output stream. + + The Type that generated this message. + The message to log. + An exception to log. + + + All internal debug messages are prepended with + the string "log4net: ". + + + + + + Writes log4net internal warning messages to the + standard error stream. + + The Type that generated this message. + The message to log. + + + All internal warning messages are prepended with + the string "log4net:WARN ". + + + + + + Writes log4net internal warning messages to the + standard error stream. + + The Type that generated this message. + The message to log. + An exception to log. + + + All internal warning messages are prepended with + the string "log4net:WARN ". + + + + + + Writes log4net internal error messages to the + standard error stream. + + The Type that generated this message. + The message to log. + + + All internal error messages are prepended with + the string "log4net:ERROR ". + + + + + + Writes log4net internal error messages to the + standard error stream. + + The Type that generated this message. + The message to log. + An exception to log. + + + All internal debug messages are prepended with + the string "log4net:ERROR ". + + + + + + Writes output to the standard output stream. + + The message to log. + + + Writes to both Console.Out and System.Diagnostics.Trace. + Note that the System.Diagnostics.Trace is not supported + on the Compact Framework. + + + If the AppDomain is not configured with a config file then + the call to System.Diagnostics.Trace may fail. This is only + an issue if you are programmatically creating your own AppDomains. + + + + + + Writes output to the standard error stream. + + The message to log. + + + Writes to both Console.Error and System.Diagnostics.Trace. + Note that the System.Diagnostics.Trace is not supported + on the Compact Framework. + + + If the AppDomain is not configured with a config file then + the call to System.Diagnostics.Trace may fail. This is only + an issue if you are programmatically creating your own AppDomains. + + + + + + Default debug level + - - In quietMode not even errors generate any output. - + + In quietMode not even errors generate any output. + + + + + The event raised when an internal message has been received. + + + + + The Type that generated the internal message. + + + + + The DateTime stamp of when the internal message was received. + + + + + A string indicating the severity of the internal message. + + + "log4net: ", + "log4net:ERROR ", + "log4net:WARN " + + + + + The internal log message. + + + + + The Exception related to the message. + + + Optional. Will be null if no Exception was passed. + - - Gets or sets a value indicating whether log4net internal logging - is enabled or disabled. - - - true if log4net internal logging is enabled, otherwise - false. - - - - When set to true, internal debug level logging will be - displayed. - - - This value can be set by setting the application setting - log4net.Internal.Debug in the application configuration - file. - - - The default value is false, i.e. debugging is - disabled. - - - - - The following example enables internal debugging using the - application configuration file : - - - - - - - - - + + Gets or sets a value indicating whether log4net internal logging + is enabled or disabled. + + + true if log4net internal logging is enabled, otherwise + false. + + + + When set to true, internal debug level logging will be + displayed. + + + This value can be set by setting the application setting + log4net.Internal.Debug in the application configuration + file. + + + The default value is false, i.e. debugging is + disabled. + + + + + The following example enables internal debugging using the + application configuration file : + + + + + + + + + @@ -24514,56 +26166,99 @@ + + + + + - - Test if LogLog.Debug is enabled for output. - - - true if Debug is enabled - - - - Test if LogLog.Debug is enabled for output. - - + + Test if LogLog.Debug is enabled for output. + + + true if Debug is enabled + + + + Test if LogLog.Debug is enabled for output. + + - - Test if LogLog.Warn is enabled for output. - - - true if Warn is enabled - - - - Test if LogLog.Warn is enabled for output. - - + + Test if LogLog.Warn is enabled for output. + + + true if Warn is enabled + + + + Test if LogLog.Warn is enabled for output. + + - - Test if LogLog.Error is enabled for output. - - - true if Error is enabled - - - - Test if LogLog.Error is enabled for output. - - + + Test if LogLog.Error is enabled for output. + + + true if Error is enabled + + + + Test if LogLog.Error is enabled for output. + + + + + + Subscribes to the LogLog.LogReceived event and stores messages + to the supplied IList instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - Represents a native error code and message. - - - - Represents a Win32 platform native error. - - - Nicko Cadell - Gert Driesen + + Represents a native error code and message. + + + + Represents a Win32 platform native error. + + + Nicko Cadell + Gert Driesen @@ -24610,92 +26305,92 @@ - - Retrieves the message corresponding with a Win32 message identifier. - - Message identifier for the requested message. - - The message corresponding with the specified message identifier. - - - - The message will be searched for in system message-table resource(s) - using the native FormatMessage function. - - + + Retrieves the message corresponding with a Win32 message identifier. + + Message identifier for the requested message. + + The message corresponding with the specified message identifier. + + + + The message will be searched for in system message-table resource(s) + using the native FormatMessage function. + + - - Return error information string - - error information string - - - Return error information string - - + + Return error information string + + error information string + + + Return error information string + + - - Formats a message string. - - Formatting options, and how to interpret the parameter. - Location of the message definition. - Message identifier for the requested message. - Language identifier for the requested message. - If includes FORMAT_MESSAGE_ALLOCATE_BUFFER, the function allocates a buffer using the LocalAlloc function, and places the pointer to the buffer at the address specified in . - If the FORMAT_MESSAGE_ALLOCATE_BUFFER flag is not set, this parameter specifies the maximum number of TCHARs that can be stored in the output buffer. If FORMAT_MESSAGE_ALLOCATE_BUFFER is set, this parameter specifies the minimum number of TCHARs to allocate for an output buffer. - Pointer to an array of values that are used as insert values in the formatted message. - - - The function requires a message definition as input. The message definition can come from a - buffer passed into the function. It can come from a message table resource in an - already-loaded module. Or the caller can ask the function to search the system's message - table resource(s) for the message definition. The function finds the message definition - in a message table resource based on a message identifier and a language identifier. - The function copies the formatted message text to an output buffer, processing any embedded - insert sequences if requested. - - - To prevent the usage of unsafe code, this stub does not support inserting values in the formatted message. - - - - - If the function succeeds, the return value is the number of TCHARs stored in the output - buffer, excluding the terminating null character. - - - If the function fails, the return value is zero. To get extended error information, - call . - - + + Formats a message string. + + Formatting options, and how to interpret the parameter. + Location of the message definition. + Message identifier for the requested message. + Language identifier for the requested message. + If includes FORMAT_MESSAGE_ALLOCATE_BUFFER, the function allocates a buffer using the LocalAlloc function, and places the pointer to the buffer at the address specified in . + If the FORMAT_MESSAGE_ALLOCATE_BUFFER flag is not set, this parameter specifies the maximum number of TCHARs that can be stored in the output buffer. If FORMAT_MESSAGE_ALLOCATE_BUFFER is set, this parameter specifies the minimum number of TCHARs to allocate for an output buffer. + Pointer to an array of values that are used as insert values in the formatted message. + + + The function requires a message definition as input. The message definition can come from a + buffer passed into the function. It can come from a message table resource in an + already-loaded module. Or the caller can ask the function to search the system's message + table resource(s) for the message definition. The function finds the message definition + in a message table resource based on a message identifier and a language identifier. + The function copies the formatted message text to an output buffer, processing any embedded + insert sequences if requested. + + + To prevent the usage of unsafe code, this stub does not support inserting values in the formatted message. + + + + + If the function succeeds, the return value is the number of TCHARs stored in the output + buffer, excluding the terminating null character. + + + If the function fails, the return value is zero. To get extended error information, + call . + + - - Gets the number of the native error. - - - The number of the native error. - - - - Gets the number of the native error. - - + + Gets the number of the native error. + + + The number of the native error. + + + + Gets the number of the native error. + + - - Gets the message of the native error. - - - The message of the native error. - - - - - Gets the message of the native error. - + + Gets the message of the native error. + + + The message of the native error. + + + + + Gets the message of the native error. + @@ -24936,44 +26631,45 @@ - - Private constructor - - - - Private constructor for singleton pattern. - - + + Private constructor + + + + Private constructor for singleton pattern. + + - - Impersonate this SecurityContext - - State supplied by the caller - null - - - No impersonation is done and null is always returned. - - + + Impersonate this SecurityContext + + State supplied by the caller + null + + + No impersonation is done and null is always returned. + + - - Implements log4net's default error handling policy which consists - of emitting a message for the first error in an appender and - ignoring all subsequent errors. - - - - The error message is printed on the standard error output stream. - - - This policy aims at protecting an otherwise working application - from being flooded with error messages when logging fails. - - - Nicko Cadell - Gert Driesen + + Implements log4net's default error handling policy which consists + of emitting a message for the first error in an appender and + ignoring all subsequent errors. + + + + The error message is processed using the LogLog sub-system by default. + + + This policy aims at protecting an otherwise working application + from being flooded with error messages when logging fails. + + + Nicko Cadell + Gert Driesen + Ron Grabowski @@ -24997,6 +26693,11 @@ + + + Reset the error handler back to its initial disabled state. + + Log an Error @@ -25006,8 +26707,20 @@ The internal error code. - Prints the message and the stack trace of the exception on the standard - error output stream. + Invokes if and only if this is the first error or the first error after has been called. + + + + + + Log the very first error + + The error message. + The exception. + The internal error code. + + + Sends the error information to 's Error method. @@ -25019,8 +26732,7 @@ The exception. - Prints the message and the stack trace of the exception on the standard - error output stream. + Invokes if and only if this is the first error or the first error after has been called. @@ -25031,20 +26743,48 @@ The error message. - Print a the error message passed as parameter on the standard - error output stream. + Invokes if and only if this is the first error or the first error after has been called. + + + The date the error was recorded. + + - - Flag to indicate if it is the first error - + + Flag to indicate if it is the first error + + + + + The message recorded during the first error. + + + + + The exception recorded during the first error. + + + + + The error code recorded during the first error. + - - String to prefix each message with - + + String to prefix each message with + + + + + The fully qualified type of the OnlyOnceErrorHandler class. + + + Used by the internal logger to record the Type of the + log message. + @@ -25057,177 +26797,212 @@ - - - A convenience class to convert property values to specific types. - - - - Utility functions for converting types and parsing values. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - - Uses a private access modifier to prevent instantiation of this class. - - + + + The date the first error that trigged this error handler occured. + - - - Converts a string to a value. - - String to convert. - The default value. - The value of . - - - If is "true", then true is returned. - If is "false", then false is returned. - Otherwise, is returned. - - + + + The message from the first error that trigged this error handler. + - - - Parses a file size into a number. - - String to parse. - The default value. - The value of . - - - Parses a file size of the form: number[KB|MB|GB] into a - long value. It is scaled with the appropriate multiplier. - - - is returned when - cannot be converted to a value. - - + + + The exception from the first error that trigged this error handler. + + + May be . + - + - Converts a string to an object. + The error code from the first error that trigged this error handler. - The target type to convert to. - The string to convert to an object. - - The object converted from a string or null when the - conversion failed. - - - Converts a string to an object. Uses the converter registry to try - to convert the string value into the specified target type. - + Defaults to - - - Checks if there is an appropriate type conversion from the source type to the target type. - - The type to convert from. - The type to convert to. - true if there is a conversion from the source type to the target type. - - Checks if there is an appropriate type conversion from the source type to the target type. - - - + + + A convenience class to convert property values to specific types. + + + + Utility functions for converting types and parsing values. + + + Nicko Cadell + Gert Driesen - + - Converts an object to the target type. + Initializes a new instance of the class. - The object to convert to the target type. - The type to convert to. - The converted object. - Converts an object to the target type. + Uses a private access modifier to prevent instantiation of this class. - + - Instantiates an object given a class name. + Converts a string to a value. - The fully qualified class name of the object to instantiate. - The class to which the new object should belong. - The object to return in case of non-fulfillment. - - An instance of the or - if the object could not be instantiated. - + String to convert. + The default value. + The value of . - Checks that the is a subclass of - . If that test fails or the object could - not be instantiated, then is returned. + If is "true", then true is returned. + If is "false", then false is returned. + Otherwise, is returned. - + - Performs variable substitution in string from the - values of keys found in . + Parses a file size into a number. - The string on which variable substitution is performed. - The dictionary to use to lookup variables. - The result of the substitutions. + String to parse. + The default value. + The value of . - The variable substitution delimiters are ${ and }. - - - For example, if props contains key=value, then the call - - - - string s = OptionConverter.SubstituteVariables("Value of key is ${key}."); - - - - will set the variable s to "Value of key is value.". - - - If no value could be found for the specified key, then substitution - defaults to an empty string. - - - For example, if system properties contains no value for the key - "nonExistentKey", then the call - - - - string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]"); - - - - will set s to "Value of nonExistentKey is []". + Parses a file size of the form: number[KB|MB|GB] into a + long value. It is scaled with the appropriate multiplier. - An Exception is thrown if contains a start - delimiter "${" which is not balanced by a stop delimiter "}". + is returned when + cannot be converted to a value. + + + Converts a string to an object. + + The target type to convert to. + The string to convert to an object. + + The object converted from a string or null when the + conversion failed. + + + + Converts a string to an object. Uses the converter registry to try + to convert the string value into the specified target type. + + + + + + Checks if there is an appropriate type conversion from the source type to the target type. + + The type to convert from. + The type to convert to. + true if there is a conversion from the source type to the target type. + + Checks if there is an appropriate type conversion from the source type to the target type. + + + + + + + Converts an object to the target type. + + The object to convert to the target type. + The type to convert to. + The converted object. + + + Converts an object to the target type. + + + + + + Instantiates an object given a class name. + + The fully qualified class name of the object to instantiate. + The class to which the new object should belong. + The object to return in case of non-fulfillment. + + An instance of the or + if the object could not be instantiated. + + + + Checks that the is a subclass of + . If that test fails or the object could + not be instantiated, then is returned. + + + + + + Performs variable substitution in string from the + values of keys found in . + + The string on which variable substitution is performed. + The dictionary to use to lookup variables. + The result of the substitutions. + + + The variable substitution delimiters are ${ and }. + + + For example, if props contains key=value, then the call + + + + string s = OptionConverter.SubstituteVariables("Value of key is ${key}."); + + + + will set the variable s to "Value of key is value.". + + + If no value could be found for the specified key, then substitution + defaults to an empty string. + + + For example, if system properties contains no value for the key + "nonExistentKey", then the call + + + + string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]"); + + + + will set s to "Value of nonExistentKey is []". + + + An Exception is thrown if contains a start + delimiter "${" which is not balanced by a stop delimiter "}". + + + - - Converts the string representation of the name or numeric value of one or - more enumerated constants to an equivalent enumerated object. - - The type to convert to. - The enum string value. - If true, ignore case; otherwise, regard case. - An object of type whose value is represented by . + + Converts the string representation of the name or numeric value of one or + more enumerated constants to an equivalent enumerated object. + + The type to convert to. + The enum string value. + If true, ignore case; otherwise, regard case. + An object of type whose value is represented by . + + + + The fully qualified type of the OptionConverter class. + + + Used by the internal logger to record the Type of the + log message. + @@ -25256,97 +27031,106 @@ - - Parses the pattern into a chain of pattern converters. - - The head of a chain of pattern converters. - - - Parses the pattern into a chain of pattern converters. - - + + Parses the pattern into a chain of pattern converters. + + The head of a chain of pattern converters. + + + Parses the pattern into a chain of pattern converters. + + - - Build the unified cache of converters from the static and instance maps - - the list of all the converter names - - - Build the unified cache of converters from the static and instance maps - - + + Build the unified cache of converters from the static and instance maps + + the list of all the converter names + + + Build the unified cache of converters from the static and instance maps + + - - Internal method to parse the specified pattern to find specified matches - - the pattern to parse - the converter names to match in the pattern - - - The matches param must be sorted such that longer strings come before shorter ones. - - + + Internal method to parse the specified pattern to find specified matches + + the pattern to parse + the converter names to match in the pattern + + + The matches param must be sorted such that longer strings come before shorter ones. + + - - Process a parsed literal - - the literal text + + Process a parsed literal + + the literal text - - Process a parsed converter pattern - - the name of the converter - the optional option for the converter - the formatting info for the converter + + Process a parsed converter pattern + + the name of the converter + the optional option for the converter + the formatting info for the converter - - Resets the internal state of the parser and adds the specified pattern converter - to the chain. - - The pattern converter to add. + + Resets the internal state of the parser and adds the specified pattern converter + to the chain. + + The pattern converter to add. - - The first pattern converter in the chain - + + The first pattern converter in the chain + - - the last pattern converter in the chain - + + the last pattern converter in the chain + - - The pattern - + + The pattern + - - Internal map of converter identifiers to converter types - - - - This map overrides the static s_globalRulesRegistry map. - - + + Internal map of converter identifiers to converter types + + + + This map overrides the static s_globalRulesRegistry map. + + + + + + The fully qualified type of the PatternParser class. + + + Used by the internal logger to record the Type of the + log message. + - - Get the converter registry used by this parser - - - The converter registry used by this parser - - - - Get the converter registry used by this parser - - + + Get the converter registry used by this parser + + + The converter registry used by this parser + + + + Get the converter registry used by this parser + + @@ -25395,7 +27179,7 @@ date - Used to output the date of the logging event in the local time zone. + Used to output the current date and time in the local time zone. To output the date in universal time use the %utcdate pattern. The date conversion specifier may be followed by a date format specifier enclosed @@ -25406,7 +27190,7 @@ The date format specifier admits the same syntax as the - time pattern string of the . + time pattern string of the . For better results it is recommended to use the log4net date @@ -25419,7 +27203,7 @@ These dedicated date formatters perform significantly - better than . + better than . @@ -25541,7 +27325,7 @@ The date format specifier admits the same syntax as the - time pattern string of the . + time pattern string of the . For better results it is recommended to use the log4net date @@ -25554,7 +27338,7 @@ These dedicated date formatters perform significantly - better than . + better than . @@ -25569,8 +27353,8 @@ Additional pattern converters may be registered with a specific - instance using or - . + instance using or + . See the for details on the @@ -25580,29 +27364,29 @@ Nicko Cadell - - Internal map of converter identifiers to converter types. - + + Internal map of converter identifiers to converter types. + - - the pattern - + + the pattern + - - the head of the pattern converter chain - + + the head of the pattern converter chain + - - patterns defined on this PatternString only - + + patterns defined on this PatternString only + - - Initialize the global registry - + + Initialize the global registry + @@ -25658,142 +27442,101 @@ - - Produces a formatted string as specified by the conversion pattern. - - The TextWriter to write the formatted event to - - - Format the pattern to the . - - + + Produces a formatted string as specified by the conversion pattern. + + The TextWriter to write the formatted event to + + + Format the pattern to the . + + - - Format the pattern as a string - - the pattern formatted as a string - - - Format the pattern to a string. - - - - - - Add a converter to this PatternString - - the converter info - - - This version of the method is used by the configurator. - Programmatic users should use the alternative method. - - + + Format the pattern as a string + + the pattern formatted as a string + + + Format the pattern to a string. + + + + + + Add a converter to this PatternString + + the converter info + + + This version of the method is used by the configurator. + Programmatic users should use the alternative method. + + - - Add a converter to this PatternString - - the name of the conversion pattern for this converter - the type of the converter - - - Add a converter to this PatternString - - + + Add a converter to this PatternString + + the name of the conversion pattern for this converter + the type of the converter + + + Add a converter to this PatternString + + - - Gets or sets the pattern formatting string - - - The pattern formatting string - - - - The ConversionPattern option. This is the string which - controls formatting and consists of a mix of literal content and - conversion specifiers. - - - - - - Wrapper class used to map converter names to converter types - - - - Wrapper class used to map converter names to converter types - - - - - - default constructor - - - - - Gets or sets the name of the conversion pattern - - - The name of the conversion pattern - - - - Gets or sets the name of the conversion pattern - - - - - - Gets or sets the type of the converter - - - The type of the converter - - - - Gets or sets the type of the converter - - + + Gets or sets the pattern formatting string + + + The pattern formatting string + + + + The ConversionPattern option. This is the string which + controls formatting and consists of a mix of literal content and + conversion specifiers. + + - - String keyed object map. - - - - While this collection is serializable only member - objects that are serializable will - be serialized along with this collection. - - - Nicko Cadell - Gert Driesen + + String keyed object map. + + + + While this collection is serializable only member + objects that are serializable will + be serialized along with this collection. + + + Nicko Cadell + Gert Driesen - - String keyed object map that is read only. - - - - This collection is readonly and cannot be modified. - - - While this collection is serializable only member - objects that are serializable will - be serialized along with this collection. - - - Nicko Cadell - Gert Driesen + + String keyed object map that is read only. + + + + This collection is readonly and cannot be modified. + + + While this collection is serializable only member + objects that are serializable will + be serialized along with this collection. + + + Nicko Cadell + Gert Driesen - - The Hashtable used to store the properties data - + + The Hashtable used to store the properties data + @@ -25830,27 +27573,27 @@ - - Gets the key names. - - An array of all the keys. - - - Gets the key names. - - + + Gets the key names. + + An array of all the keys. + + + Gets the key names. + + - - Test if the dictionary contains a specified key - - the key to look for - true if the dictionary contains the specified key - - - Test if the dictionary contains a specified key - - + + Test if the dictionary contains a specified key + + the key to look for + true if the dictionary contains the specified key + + + Test if the dictionary contains a specified key + + @@ -25883,9 +27626,9 @@ - - Remove all properties from the properties collection - + + Remove all properties from the properties collection + @@ -25907,33 +27650,33 @@ - - Gets or sets the value of the property with the specified key. - - - The value of the property with the specified key. - - The key of the property to get or set. - - - The property value will only be serialized if it is serializable. - If it cannot be serialized it will be silently ignored if - a serialization operation is performed. - - + + Gets or sets the value of the property with the specified key. + + + The value of the property with the specified key. + + The key of the property to get or set. + + + The property value will only be serialized if it is serializable. + If it cannot be serialized it will be silently ignored if + a serialization operation is performed. + + - - The hashtable used to store the properties - - - The internal collection used to store the properties - - - - The hashtable used to store the properties - - + + The hashtable used to store the properties + + + The internal collection used to store the properties + + + + The hashtable used to store the properties + + @@ -25966,9 +27709,9 @@ - - The number of properties in this collection - + + The number of properties in this collection + @@ -26010,15 +27753,15 @@ - - Remove the entry with the specified key from this dictionary - - the key for the entry to remove - - - Remove the entry with the specified key from this dictionary - - + + Remove the entry with the specified key from this dictionary + + the key for the entry to remove + + + Remove the entry with the specified key from this dictionary + + @@ -26055,14 +27798,14 @@ - - Remove all properties from the properties collection - - - - Remove all properties from the properties collection - - + + Remove all properties from the properties collection + + + + Remove all properties from the properties collection + + @@ -26086,24 +27829,24 @@ - See - - - - - Gets or sets the value of the property with the specified key. - - - The value of the property with the specified key. - - The key of the property to get or set. - - - The property value will only be serialized if it is serializable. - If it cannot be serialized it will be silently ignored if - a serialization operation is performed. - - + See + + + + + Gets or sets the value of the property with the specified key. + + + The value of the property with the specified key. + + The key of the property to get or set. + + + The property value will only be serialized if it is serializable. + If it cannot be serialized it will be silently ignored if + a serialization operation is performed. + + @@ -26158,6 +27901,48 @@ See + + + A class to hold the key and data for a property set in the config file + + + + A class to hold the key and data for a property set in the config file + + + + + + Override Object.ToString to return sensible debug info + + string info about this object + + + + Property Key + + + Property Key + + + + Property Key. + + + + + + Property Value + + + Property Value + + + + Property Value. + + + A that ignores the message @@ -26171,15 +27956,15 @@ Nicko Cadell - - Constructor - - the writer to actually write to - - - Create a new ProtectCloseTextWriter using a writer - - + + Constructor + + the writer to actually write to + + + Create a new ProtectCloseTextWriter using a writer + + @@ -26193,15 +27978,15 @@ - - Does not close the underlying output writer. - - - - Does not close the underlying output writer. - This method does nothing. - - + + Does not close the underlying output writer. + + + + Does not close the underlying output writer. + This method does nothing. + + @@ -26257,25 +28042,25 @@ - - Acquires the writer lock - - - - This method blocks if another thread has a reader lock or writer lock. - - + + Acquires the writer lock + + + + This method blocks if another thread has a reader lock or writer lock. + + - - Decrements the lock count on the writer lock - - - - ReleaseWriterLock decrements the writer lock count. - When the count reaches zero, the writer lock is released. - - + + Decrements the lock count on the writer lock + + + + ReleaseWriterLock decrements the writer lock count. + When the count reaches zero, the writer lock is released. + + @@ -26301,75 +28086,75 @@ - - Override Dispose to prevent closing of writer - - flag - - - Override Dispose to prevent closing of writer - - + + Override Dispose to prevent closing of writer + + flag + + + Override Dispose to prevent closing of writer + + - - Reset this string writer so that it can be reused. - - the maximum buffer capacity before it is trimmed - the default size to make the buffer - - - Reset this string writer so that it can be reused. - The internal buffers are cleared and reset. - - + + Reset this string writer so that it can be reused. + + the maximum buffer capacity before it is trimmed + the default size to make the buffer + + + Reset this string writer so that it can be reused. + The internal buffers are cleared and reset. + + - - Utility class for system specific information. - - - - Utility class of static methods for system specific information. - - - Nicko Cadell - Gert Driesen - Alexey Solofnenko + + Utility class for system specific information. + + + + Utility class of static methods for system specific information. + + + Nicko Cadell + Gert Driesen + Alexey Solofnenko - - Private constructor to prevent instances. - - - - Only static methods are exposed from this type. - - + + Private constructor to prevent instances. + + + + Only static methods are exposed from this type. + + - - Initialize default values for private static fields. - - - - Only static methods are exposed from this type. - - + + Initialize default values for private static fields. + + + + Only static methods are exposed from this type. + + - - Gets the assembly location path for the specified assembly. - - The assembly to get the location for. - The location of the assembly. - - - This method does not guarantee to return the correct path - to the assembly. If only tries to give an indication as to - where the assembly was loaded from. - - + + Gets the assembly location path for the specified assembly. + + The assembly to get the location for. + The location of the assembly. + + + This method does not guarantee to return the correct path + to the assembly. If only tries to give an indication as to + where the assembly was loaded from. + + @@ -26424,80 +28209,80 @@ - - Loads the type specified in the type string. - - A sibling type to use to load the type. - The name of the type to load. - Flag set to true to throw an exception if the type cannot be loaded. - true to ignore the case of the type name; otherwise, false - The type loaded or null if it could not be loaded. - - - If the type name is fully qualified, i.e. if contains an assembly name in - the type name, the type will be loaded from the system using - . - - - If the type name is not fully qualified, it will be loaded from the assembly - containing the specified relative type. If the type is not found in the assembly - then all the loaded assemblies will be searched for the type. - - + + Loads the type specified in the type string. + + A sibling type to use to load the type. + The name of the type to load. + Flag set to true to throw an exception if the type cannot be loaded. + true to ignore the case of the type name; otherwise, false + The type loaded or null if it could not be loaded. + + + If the type name is fully qualified, i.e. if contains an assembly name in + the type name, the type will be loaded from the system using + . + + + If the type name is not fully qualified, it will be loaded from the assembly + containing the specified relative type. If the type is not found in the assembly + then all the loaded assemblies will be searched for the type. + + - - Loads the type specified in the type string. - - The name of the type to load. - Flag set to true to throw an exception if the type cannot be loaded. - true to ignore the case of the type name; otherwise, false - The type loaded or null if it could not be loaded. - - - If the type name is fully qualified, i.e. if contains an assembly name in - the type name, the type will be loaded from the system using - . - - - If the type name is not fully qualified it will be loaded from the - assembly that is directly calling this method. If the type is not found - in the assembly then all the loaded assemblies will be searched for the type. - - + + Loads the type specified in the type string. + + The name of the type to load. + Flag set to true to throw an exception if the type cannot be loaded. + true to ignore the case of the type name; otherwise, false + The type loaded or null if it could not be loaded. + + + If the type name is fully qualified, i.e. if contains an assembly name in + the type name, the type will be loaded from the system using + . + + + If the type name is not fully qualified it will be loaded from the + assembly that is directly calling this method. If the type is not found + in the assembly then all the loaded assemblies will be searched for the type. + + - - Loads the type specified in the type string. - - An assembly to load the type from. - The name of the type to load. - Flag set to true to throw an exception if the type cannot be loaded. - true to ignore the case of the type name; otherwise, false - The type loaded or null if it could not be loaded. - - - If the type name is fully qualified, i.e. if contains an assembly name in - the type name, the type will be loaded from the system using - . - - - If the type name is not fully qualified it will be loaded from the specified - assembly. If the type is not found in the assembly then all the loaded assemblies - will be searched for the type. - - + + Loads the type specified in the type string. + + An assembly to load the type from. + The name of the type to load. + Flag set to true to throw an exception if the type cannot be loaded. + true to ignore the case of the type name; otherwise, false + The type loaded or null if it could not be loaded. + + + If the type name is fully qualified, i.e. if contains an assembly name in + the type name, the type will be loaded from the system using + . + + + If the type name is not fully qualified it will be loaded from the specified + assembly. If the type is not found in the assembly then all the loaded assemblies + will be searched for the type. + + - - Generate a new guid - - A new Guid - - - Generate a new guid - - + + Generate a new guid + + A new Guid + + + Generate a new guid + + @@ -26548,35 +28333,49 @@ - + - Lookup an application setting + Parse a string into an value - the application settings key to lookup - the value for the key, or null + the string to parse + out param where the parsed value is placed + true if the string was able to be parsed into an integer - Configuration APIs are not supported under the Compact Framework + Attempts to parse the string into an integer. If the string cannot + be parsed then this method returns false. The method does not throw an exception. + + + Lookup an application setting + + the application settings key to lookup + the value for the key, or null + + + Configuration APIs are not supported under the Compact Framework + + + - - Convert a path into a fully qualified local file path. - - The path to convert. - The fully qualified path. - - - Converts the path specified to a fully - qualified path. If the path is relative it is - taken as relative from the application base - directory. - - - The path specified must be a local file path, a URI is not supported. - - + + Convert a path into a fully qualified local file path. + + The path to convert. + The fully qualified path. + + + Converts the path specified to a fully + qualified path. If the path is relative it is + taken as relative from the application base + directory. + + + The path specified must be a local file path, a URI is not supported. + + @@ -26590,53 +28389,62 @@ - - Gets an empty array of types. - - - - The Type.EmptyTypes field is not available on - the .NET Compact Framework 1.0. - - + + Gets an empty array of types. + + + + The Type.EmptyTypes field is not available on + the .NET Compact Framework 1.0. + + + + + + The fully qualified type of the SystemInfo class. + + + Used by the internal logger to record the Type of the + log message. + - - Cache the host name for the current machine - + + Cache the host name for the current machine + - - Cache the application friendly name - + + Cache the application friendly name + - - Text to output when a null is encountered. - + + Text to output when a null is encountered. + - - Text to output when an unsupported feature is requested. - + + Text to output when an unsupported feature is requested. + - - Start time for the current process. - + + Start time for the current process. + - - Gets the system dependent line terminator. - - - The system dependent line terminator. - - - - Gets the system dependent line terminator. - - + + Gets the system dependent line terminator. + + + The system dependent line terminator. + + + + Gets the system dependent line terminator. + + @@ -26680,28 +28488,28 @@ - - Gets the ID of the current thread. - - The ID of the current thread. - - - On the .NET framework, the AppDomain.GetCurrentThreadId method - is used to obtain the thread ID for the current thread. This is the - operating system ID for the thread. - - - On the .NET Compact Framework 1.0 it is not possible to get the - operating system thread ID for the current thread. The native method - GetCurrentThreadId is implemented inline in a header file - and cannot be called. - - - On the .NET Framework 2.0 the Thread.ManagedThreadId is used as this - gives a stable id unrelated to the operating system thread ID which may - change if the runtime is using fibers. - - + + Gets the ID of the current thread. + + The ID of the current thread. + + + On the .NET framework, the AppDomain.GetCurrentThreadId method + is used to obtain the thread ID for the current thread. This is the + operating system ID for the thread. + + + On the .NET Compact Framework 1.0 it is not possible to get the + operating system thread ID for the current thread. The native method + GetCurrentThreadId is implemented inline in a header file + and cannot be called. + + + On the .NET Framework 2.0 the Thread.ManagedThreadId is used as this + gives a stable id unrelated to the operating system thread ID which may + change if the runtime is using fibers. + + @@ -26723,85 +28531,85 @@ - - Get this application's friendly name - - - The friendly name of this application as a string - - - - If available the name of the application is retrieved from - the AppDomain using AppDomain.CurrentDomain.FriendlyName. - - - Otherwise the file name of the entry assembly is used. - - + + Get this application's friendly name + + + The friendly name of this application as a string + + + + If available the name of the application is retrieved from + the AppDomain using AppDomain.CurrentDomain.FriendlyName. + + + Otherwise the file name of the entry assembly is used. + + - - Get the start time for the current process. - - - - This is the time at which the log4net library was loaded into the - AppDomain. Due to reports of a hang in the call to System.Diagnostics.Process.StartTime - this is not the start time for the current process. - - - The log4net library should be loaded by an application early during its - startup, therefore this start time should be a good approximation for - the actual start time. - - - Note that AppDomains may be loaded and unloaded within the - same process without the process terminating, however this start time - will be set per AppDomain. - - + + Get the start time for the current process. + + + + This is the time at which the log4net library was loaded into the + AppDomain. Due to reports of a hang in the call to System.Diagnostics.Process.StartTime + this is not the start time for the current process. + + + The log4net library should be loaded by an application early during its + startup, therefore this start time should be a good approximation for + the actual start time. + + + Note that AppDomains may be loaded and unloaded within the + same process without the process terminating, however this start time + will be set per AppDomain. + + - - Text to output when a null is encountered. - - - - Use this value to indicate a null has been encountered while - outputting a string representation of an item. - - - The default value is (null). This value can be overridden by specifying - a value for the log4net.NullText appSetting in the application's - .config file. - - + + Text to output when a null is encountered. + + + + Use this value to indicate a null has been encountered while + outputting a string representation of an item. + + + The default value is (null). This value can be overridden by specifying + a value for the log4net.NullText appSetting in the application's + .config file. + + - - Text to output when an unsupported feature is requested. - - - - Use this value when an unsupported feature is requested. - - - The default value is NOT AVAILABLE. This value can be overridden by specifying - a value for the log4net.NotAvailableText appSetting in the application's - .config file. - - + + Text to output when an unsupported feature is requested. + + + + Use this value when an unsupported feature is requested. + + + The default value is NOT AVAILABLE. This value can be overridden by specifying + a value for the log4net.NotAvailableText appSetting in the application's + .config file. + + - - Utility class that represents a format string. - - - - Utility class that represents a format string. - - - Nicko Cadell + + Utility class that represents a format string. + + + + Utility class that represents a format string. + + + Nicko Cadell @@ -26812,10 +28620,10 @@ An array containing zero or more objects to format. - - Format the string and arguments - - the formatted string + + Format the string and arguments + + the formatted string @@ -26838,19 +28646,28 @@ - - Process an error during StringFormat - + + Process an error during StringFormat + - - Dump the contents of an array into a string builder - + + Dump the contents of an array into a string builder + - - Dump an object to a string - + + Dump an object to a string + + + + + The fully qualified type of the SystemStringFormat class. + + + Used by the internal logger to record the Type of the + log message. + @@ -26864,10 +28681,10 @@ Nicko Cadell - - - The thread local data slot to use to store a PropertiesDictionary. - + + + Each thread will automatically have its instance. + @@ -26880,52 +28697,61 @@ - - Remove a property - - the key for the entry to remove - - - Remove a property - - + + Remove a property + + the key for the entry to remove + + + Remove a property + + + + + + Get the keys stored in the properties. + + + Gets the keys stored in the properties. + + a set of the defined keys - - Clear all properties - - - - Clear all properties - - + + Clear all properties + + + + Clear all properties + + - - Get the PropertiesDictionary for this thread. - - create the dictionary if it does not exist, otherwise return null if is does not exist - the properties for this thread - - - The collection returned is only to be used on the calling thread. If the - caller needs to share the collection between different threads then the - caller must clone the collection before doing so. - - + + Get the PropertiesDictionary for this thread. + + create the dictionary if it does not exist, otherwise return null if does not exist + the properties for this thread + + + The collection returned is only to be used on the calling thread. If the + caller needs to share the collection between different threads then the + caller must clone the collection before doing so. + + - - Gets or sets the value of a property - - - The value for the property with the specified key - - - - Gets or sets the value of a property - - + + Gets or sets the value of a property + + + The value for the property with the specified key + + + + Gets or sets the value of a property + + @@ -26939,9 +28765,9 @@ Nicko Cadell - - The stack store. - + + The stack store. + @@ -26971,17 +28797,17 @@ - - Removes the top context from this stack. - - The message in the context that was removed from the top of this stack. - - - Remove the top context from this stack, and return - it to the caller. If this stack is empty then an - empty string (not ) is returned. - - + + Removes the top context from this stack. + + The message in the context that was removed from the top of this stack. + + + Remove the top context from this stack, and return + it to the caller. If this stack is empty then an + empty string (not ) is returned. + + @@ -27009,32 +28835,32 @@ - - Gets the current context information for this stack. - - The current context information. + + Gets the current context information for this stack. + + The current context information. - - Gets the current context information for this stack. - - Gets the current context information - - - Gets the current context information for this stack. - - + + Gets the current context information for this stack. + + Gets the current context information + + + Gets the current context information for this stack. + + - - Get a portable version of this object - - the portable instance of this object - - - Get a cross thread portable version of this object - - + + Get a portable version of this object + + the portable instance of this object + + + Get a cross thread portable version of this object + + @@ -27065,14 +28891,14 @@ - - Inner class used to represent a single context frame in the stack. - - - - Inner class used to represent a single context frame in the stack. - - + + Inner class used to represent a single context frame in the stack. + + + + Inner class used to represent a single context frame in the stack. + + @@ -27088,28 +28914,28 @@ - - Get the message. - - The message. - - - Get the message. - - + + Get the message. + + The message. + + + Get the message. + + - - Gets the full text of the context down to the root level. - - - The full text of the context down to the root level. - - - - Gets the full text of the context down to the root level. - - + + Gets the full text of the context down to the root level. + + + The full text of the context down to the root level. + + + + Gets the full text of the context down to the root level. + + @@ -27123,14 +28949,14 @@ - - The ThreadContextStack internal stack - + + The ThreadContextStack internal stack + - - The depth to trim the stack to when this instance is disposed - + + The depth to trim the stack to when this instance is disposed + @@ -27146,14 +28972,14 @@ - - Returns the stack to the correct depth. - - - - Returns the stack to the correct depth. - - + + Returns the stack to the correct depth. + + + + Returns the stack to the correct depth. + + @@ -27176,30 +29002,39 @@ + + + The fully qualified type of the ThreadContextStacks class. + + + Used by the internal logger to record the Type of the + log message. + + - - Gets the named thread context stack - - - The named stack - - - - Gets the named thread context stack - - + + Gets the named thread context stack + + + The named stack + + + + Gets the named thread context stack + + - - Utility class for transforming strings. - - - - Utility class for transforming strings. - - - Nicko Cadell - Gert Driesen + + Utility class for transforming strings. + + + + Utility class for transforming strings. + + + Nicko Cadell + Gert Driesen @@ -27226,35 +29061,40 @@ - - Replace invalid XML characters in text string - - the XML text input string - the string to use in place of invalid characters - A string that does not contain invalid XML characters. - - - Certain Unicode code points are not allowed in the XML InfoSet, for - details see: http://www.w3.org/TR/REC-xml/#charsets. - - - This method replaces any illegal characters in the input string - with the mask string specified. - - + + Replace invalid XML characters in text string + + the XML text input string + the string to use in place of invalid characters + A string that does not contain invalid XML characters. + + + Certain Unicode code points are not allowed in the XML InfoSet, for + details see: http://www.w3.org/TR/REC-xml/#charsets. + + + This method replaces any illegal characters in the input string + with the mask string specified. + + - - Count the number of times that the substring occurs in the text - - the text to search - the substring to find - the number of times the substring occurs in the text - - - The substring is assumed to be non repeating within itself. - - + + Count the number of times that the substring occurs in the text + + the text to search + the substring to find + the number of times the substring occurs in the text + + + The substring is assumed to be non repeating within itself. + + + + + + Characters illegal in XML 1.0 + @@ -27272,14 +29112,14 @@ - - Default constructor - - - - Default constructor - - + + Default constructor + + + + Default constructor + + @@ -27424,14 +29264,14 @@ - - Impersonate a user using the credentials supplied - + + Impersonate a user using the credentials supplied + - - Revert this the thread to the credentials of the process - + + Revert this the thread to the credentials of the process + @@ -27445,25 +29285,25 @@ - - Constructor - - the impersonation context being wrapped - - - Constructor - - + + Constructor + + the impersonation context being wrapped + + + Constructor + + - - Revert the impersonation - - - - Revert the impersonation - - + + Revert the impersonation + + + + Revert the impersonation + + @@ -27493,30 +29333,53 @@ Nicko Cadell - - Private Constructor. - - - Uses a private access modifier to prevent instantiation of this class. - + + Private Constructor. + + + Uses a private access modifier to prevent instantiation of this class. + - - The global context properties instance - + + The global context properties instance + - - The global properties map. - - - The global properties map. - - - - The global properties map. - - + + The global properties map. + + + The global properties map. + + + + The global properties map. + + + + + + Provides information about the environment the assembly has + been built for. + + + + Version of the assembly + + + Version of the framework targeted + + + Type of framework targeted + + + Does it target a client profile? + + + + Identifies the version and target for this assembly. + @@ -27544,6 +29407,13 @@ The Logical Thread Context is managed on a per basis. + + The requires a link time + for the + . + If the calling code does not have this permission then this context will be disabled. + It will not store any property values set on it. + Example of using the thread context properties to store a username. @@ -27564,24 +29434,24 @@ Nicko Cadell - - Private Constructor. - - - - Uses a private access modifier to prevent instantiation of this class. - - + + Private Constructor. + + + + Uses a private access modifier to prevent instantiation of this class. + + - - The thread context properties instance - + + The thread context properties instance + - - The thread context stacks instance - + + The thread context stacks instance + @@ -27598,17 +29468,17 @@ - - The thread stacks - - - stack map - - - - The logical thread stacks. - - + + The thread stacks + + + stack map + + + + The logical thread stacks. + + @@ -27617,7 +29487,7 @@ This class has static methods that are used by a client to request - a logger instance. The method is + a logger instance. The method is used to retrieve a logger. @@ -27651,266 +29521,266 @@ - Returns the named logger if it exists. - - Returns the named logger if it exists. - - - - If the named logger exists (in the default repository) then it - returns a reference to the logger, otherwise it returns null. - - - The fully qualified logger name to look for. - The logger found, or null if no logger could be found. + Returns the named logger if it exists. + + Returns the named logger if it exists. + + + + If the named logger exists (in the default repository) then it + returns a reference to the logger, otherwise it returns null. + + + The fully qualified logger name to look for. + The logger found, or null if no logger could be found. - - Returns the named logger if it exists. - - - - If the named logger exists (in the specified repository) then it - returns a reference to the logger, otherwise it returns - null. - - - The repository to lookup in. - The fully qualified logger name to look for. - - The logger found, or null if the logger doesn't exist in the specified - repository. - + + Returns the named logger if it exists. + + + + If the named logger exists (in the specified repository) then it + returns a reference to the logger, otherwise it returns + null. + + + The repository to lookup in. + The fully qualified logger name to look for. + + The logger found, or null if the logger doesn't exist in the specified + repository. + - - Returns the named logger if it exists. - - - - If the named logger exists (in the repository for the specified assembly) then it - returns a reference to the logger, otherwise it returns - null. - - - The assembly to use to lookup the repository. - The fully qualified logger name to look for. - - The logger, or null if the logger doesn't exist in the specified - assembly's repository. - + + Returns the named logger if it exists. + + + + If the named logger exists (in the repository for the specified assembly) then it + returns a reference to the logger, otherwise it returns + null. + + + The assembly to use to lookup the repository. + The fully qualified logger name to look for. + + The logger, or null if the logger doesn't exist in the specified + assembly's repository. + - Get the currently defined loggers. - - Returns all the currently defined loggers in the default repository. - - - The root logger is not included in the returned array. - - All the defined loggers. + Get the currently defined loggers. + + Returns all the currently defined loggers in the default repository. + + + The root logger is not included in the returned array. + + All the defined loggers. - - Returns all the currently defined loggers in the specified repository. - - The repository to lookup in. - - The root logger is not included in the returned array. - - All the defined loggers. + + Returns all the currently defined loggers in the specified repository. + + The repository to lookup in. + + The root logger is not included in the returned array. + + All the defined loggers. - - Returns all the currently defined loggers in the specified assembly's repository. - - The assembly to use to lookup the repository. - - The root logger is not included in the returned array. - - All the defined loggers. + + Returns all the currently defined loggers in the specified assembly's repository. + + The assembly to use to lookup the repository. + + The root logger is not included in the returned array. + + All the defined loggers. - Get or create a logger. - - Retrieves or creates a named logger. - - - - Retrieves a logger named as the - parameter. If the named logger already exists, then the - existing instance will be returned. Otherwise, a new instance is - created. - - By default, loggers do not have a set level but inherit - it from the hierarchy. This is one of the central features of - log4net. - - - The name of the logger to retrieve. - The logger with the name specified. + Get or create a logger. + + Retrieves or creates a named logger. + + + + Retrieves a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + + The name of the logger to retrieve. + The logger with the name specified. - - Retrieves or creates a named logger. - - - - Retrieve a logger named as the - parameter. If the named logger already exists, then the - existing instance will be returned. Otherwise, a new instance is - created. - - - By default, loggers do not have a set level but inherit - it from the hierarchy. This is one of the central features of - log4net. - - - The repository to lookup in. - The name of the logger to retrieve. - The logger with the name specified. + + Retrieves or creates a named logger. + + + + Retrieve a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + + The repository to lookup in. + The name of the logger to retrieve. + The logger with the name specified. - - Retrieves or creates a named logger. - - - - Retrieve a logger named as the - parameter. If the named logger already exists, then the - existing instance will be returned. Otherwise, a new instance is - created. - - - By default, loggers do not have a set level but inherit - it from the hierarchy. This is one of the central features of - log4net. - - - The assembly to use to lookup the repository. - The name of the logger to retrieve. - The logger with the name specified. + + Retrieves or creates a named logger. + + + + Retrieve a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + + The assembly to use to lookup the repository. + The name of the logger to retrieve. + The logger with the name specified. - - Shorthand for . - - - Get the logger for the fully qualified name of the type specified. - - The full name of will be used as the name of the logger to retrieve. - The logger with the name specified. + + Shorthand for . + + + Get the logger for the fully qualified name of the type specified. + + The full name of will be used as the name of the logger to retrieve. + The logger with the name specified. - - Shorthand for . - - - Gets the logger for the fully qualified name of the type specified. - - The repository to lookup in. - The full name of will be used as the name of the logger to retrieve. - The logger with the name specified. + + Shorthand for . + + + Gets the logger for the fully qualified name of the type specified. + + The repository to lookup in. + The full name of will be used as the name of the logger to retrieve. + The logger with the name specified. - - Shorthand for . - - - Gets the logger for the fully qualified name of the type specified. - - The assembly to use to lookup the repository. - The full name of will be used as the name of the logger to retrieve. - The logger with the name specified. + + Shorthand for . + + + Gets the logger for the fully qualified name of the type specified. + + The assembly to use to lookup the repository. + The full name of will be used as the name of the logger to retrieve. + The logger with the name specified. - - Shuts down the log4net system. - - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in all the - default repositories. - - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - The shutdown method is careful to close nested - appenders before closing regular appenders. This is allows - configurations where a regular appender is attached to a logger - and again to a nested appender. - - + + Shuts down the log4net system. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in all the + default repositories. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + - Shutdown a logger repository. - - Shuts down the default repository. - - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in the - default repository. - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - The shutdown method is careful to close nested - appenders before closing regular appenders. This is allows - configurations where a regular appender is attached to a logger - and again to a nested appender. - - + Shutdown a logger repository. + + Shuts down the default repository. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + default repository. + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + - - Shuts down the repository for the repository specified. - - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in the - specified. - - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - The shutdown method is careful to close nested - appenders before closing regular appenders. This is allows - configurations where a regular appender is attached to a logger - and again to a nested appender. - - - The repository to shutdown. + + Shuts down the repository for the repository specified. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + specified. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + The repository to shutdown. - - Shuts down the repository specified. - - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in the - repository. The repository is looked up using - the specified. - - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - - The shutdown method is careful to close nested - appenders before closing regular appenders. This is allows - configurations where a regular appender is attached to a logger - and again to a nested appender. - - - The assembly to use to lookup the repository. + + Shuts down the repository specified. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + repository. The repository is looked up using + the specified. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + The assembly to use to lookup the repository. Reset the configuration of a repository @@ -27968,7 +29838,7 @@ Gets the for the repository specified - by the callers assembly (). + by the callers assembly (). The instance for the default repository. @@ -28007,7 +29877,7 @@ Gets the for the repository specified - by the callers assembly (). + by the callers assembly (). The instance for the default repository. @@ -28049,7 +29919,7 @@ The created will be associated with the repository - specified such that a call to will return + specified such that a call to will return the same repository instance. @@ -28070,7 +29940,7 @@ The created will be associated with the repository - specified such that a call to will return + specified such that a call to will return the same repository instance. @@ -28161,7 +30031,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -28178,7 +30048,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -28200,18 +30070,18 @@ An array of all the known objects. - - Looks up the wrapper object for the logger specified. - - The logger to get the wrapper for. - The wrapper for the logger specified. + + Looks up the wrapper object for the logger specified. + + The logger to get the wrapper for. + The wrapper for the logger specified. - - Looks up the wrapper objects for the loggers specified. - - The loggers to get the wrappers for. - The wrapper objects for the loggers specified. + + Looks up the wrapper objects for the loggers specified. + + The loggers to get the wrappers for. + The wrapper objects for the loggers specified. @@ -28294,13 +30164,13 @@ - Puts a context value (the parameter) as identified + Puts a context value (the parameter) as identified with the parameter into the current thread's context map. If a value is already defined for the - specified then the value will be replaced. If the + specified then the value will be replaced. If the is specified as null then the key value mapping will be removed. @@ -28605,24 +30475,24 @@ Nicko Cadell - - Private Constructor. - - - - Uses a private access modifier to prevent instantiation of this class. - - + + Private Constructor. + + + + Uses a private access modifier to prevent instantiation of this class. + + - - The thread context properties instance - + + The thread context properties instance + - - The thread context stacks instance - + + The thread context stacks instance + @@ -28639,17 +30509,17 @@ - - The thread stacks - - - stack map - - - - The thread local stacks. - - + + The thread stacks + + + stack map + + + + The thread local stacks. + + diff --git a/packages/log4net.1.2.10/lib/1.1/log4net.xml b/packages/log4net.2.0.3/lib/net11-full/log4net.xml similarity index 89% rename from packages/log4net.1.2.10/lib/1.1/log4net.xml rename to packages/log4net.2.0.3/lib/net11-full/log4net.xml index f20322f..eb86366 100644 --- a/packages/log4net.1.2.10/lib/1.1/log4net.xml +++ b/packages/log4net.2.0.3/lib/net11-full/log4net.xml @@ -109,7 +109,7 @@ the underlying database in one go. - Subclasses should override the + Subclasses should override the method to deliver the buffered events. The BufferingAppenderSkeleton maintains a fixed size cyclic @@ -119,14 +119,14 @@ A is used to inspect each event as it arrives in the appender. If the triggers, then the current buffer is sent immediately - (see ). Otherwise the event + (see ). Otherwise the event is stored in the buffer. For example, an evaluator can be used to deliver the events immediately when an ERROR event arrives. The buffering appender can be configured in a mode. By default the appender is NOT lossy. When the buffer is full all - the buffered events are sent with . + the buffered events are sent with . If the property is set to true then the buffer will not be sent when it is full, and new events arriving in the appender will overwrite the oldest event in the buffer. @@ -152,7 +152,7 @@ Appenders can also implement the interface. Therefore - they would require that the method + they would require that the method be called after the appenders properties have been configured. @@ -170,7 +170,7 @@ Appenders can also implement the interface. Therefore - they would require that the method + they would require that the method be called after the appenders properties have been configured. @@ -178,38 +178,38 @@ Gert Driesen - - Closes the appender and releases resources. - - - - Releases any resources allocated within the appender such as file handles, - network connections, etc. - - - It is a programming error to append to a closed appender. - - + + Closes the appender and releases resources. + + + + Releases any resources allocated within the appender such as file handles, + network connections, etc. + + + It is a programming error to append to a closed appender. + + - - Log the logging event in Appender specific way. - - The event to log - - - This method is called to log a message into this appender. - - + + Log the logging event in Appender specific way. + + The event to log + + + This method is called to log a message into this appender. + + - - Gets or sets the name of this appender. - - The name of the appender. - - The name uniquely identifies the appender. - + + Gets or sets the name of this appender. + + The name of the appender. + + The name uniquely identifies the appender. + @@ -225,15 +225,15 @@ Nicko Cadell - - Log the array of logging events in Appender specific way. - - The events to log - - - This method is called to log an array of events into this appender. - - + + Log the array of logging events in Appender specific way. + + The events to log + + + This method is called to log an array of events into this appender. + + @@ -254,38 +254,38 @@ Nicko Cadell - - Activate the options that were previously set with calls to properties. - - - - This allows an object to defer activation of its options until all - options have been set. This is required for components which have - related options that remain ambiguous until all are set. - - - If a component implements this interface then this method must be called - after its properties have been set before the component can be used. - - + + Activate the options that were previously set with calls to properties. + + + + This allows an object to defer activation of its options until all + options have been set. This is required for components which have + related options that remain ambiguous until all are set. + + + If a component implements this interface then this method must be called + after its properties have been set before the component can be used. + + - - Initial buffer size - + + Initial buffer size + - - Maximum buffer size before it is recycled - + + Maximum buffer size before it is recycled + - - Default constructor - - - Empty default constructor - + + Default constructor + + + Empty default constructor + @@ -340,13 +340,13 @@ Performs threshold checks and invokes filters before delegating actual logging to the subclasses specific - method. + method. The event to log. This method cannot be overridden by derived classes. A - derived class should override the method + derived class should override the method which is called by this method. @@ -368,14 +368,14 @@ - Calls and checks that + Calls and checks that it returns true. If all of the above steps succeed then the - will be passed to the abstract method. + will be passed to the abstract method. @@ -383,13 +383,13 @@ Performs threshold checks and invokes filters before delegating actual logging to the subclasses specific - method. + method. The array of events to log. This method cannot be overridden by derived classes. A - derived class should override the method + derived class should override the method which is called by this method. @@ -399,26 +399,26 @@ - Checks that the severity of the + Checks that the severity of the is greater than or equal to the of this appender. Checks that the chain accepts the - . + . - Calls and checks that + Calls and checks that it returns true. If all of the above steps succeed then the - will be passed to the method. + will be passed to the method. @@ -456,29 +456,29 @@ - - Adds a filter to the end of the filter chain. - - the filter to add to this appender - - - The Filters are organized in a linked list. - - - Setting this property causes the new filter to be pushed onto the - back of the filter chain. - - + + Adds a filter to the end of the filter chain. + + the filter to add to this appender + + + The Filters are organized in a linked list. + + + Setting this property causes the new filter to be pushed onto the + back of the filter chain. + + - - Clears the filter list for this appender. - - - - Clears the filter list for this appender. - - + + Clears the filter list for this appender. + + + + Clears the filter list for this appender. + + @@ -496,19 +496,19 @@ - - Is called when the appender is closed. Derived classes should override - this method if resources need to be released. - - - - Releases any resources allocated within the appender such as file handles, - network connections, etc. - - - It is a programming error to append to a closed appender. - - + + Is called when the appender is closed. Derived classes should override + this method if resources need to be released. + + + + Releases any resources allocated within the appender such as file handles, + network connections, etc. + + + It is a programming error to append to a closed appender. + + @@ -521,50 +521,50 @@ A subclass must implement this method to perform logging of the . - This method will be called by + This method will be called by if all the conditions listed for that method are met. To restrict the logging of events in the appender - override the method. + override the method. - - Append a bulk array of logging events. - - the array of logging events - - - This base class implementation calls the - method for each element in the bulk array. - - - A sub class that can better process a bulk array of events should - override this method in addition to . - - + + Append a bulk array of logging events. + + the array of logging events + + + This base class implementation calls the + method for each element in the bulk array. + + + A sub class that can better process a bulk array of events should + override this method in addition to . + + - - Called before as a precondition. - - - - This method is called by - before the call to the abstract method. - - - This method can be overridden in a subclass to extend the checks - made before the event is passed to the method. - - - A subclass should ensure that they delegate this call to - this base class if it is overridden. - - - true if the call to should proceed. + + Called before as a precondition. + + + + This method is called by + before the call to the abstract method. + + + This method can be overridden in a subclass to extend the checks + made before the event is passed to the method. + + + A subclass should ensure that they delegate this call to + this base class if it is overridden. + + + true if the call to should proceed. @@ -585,7 +585,7 @@ Where possible use the alternative version of this method - . + . That method streams the rendering onto an existing Writer which can give better performance if the caller already has a open and ready for writing. @@ -610,9 +610,9 @@ will append the exception text to the rendered string. - Use this method in preference to + Use this method in preference to where possible. If, however, the caller needs to render the event - to a string then does + to a string then does provide an efficient mechanism for doing so. @@ -689,14 +689,23 @@ - - The guard prevents an appender from repeatedly calling its own DoAppend method - + + The guard prevents an appender from repeatedly calling its own DoAppend method + - - StringWriter used to render events - + + StringWriter used to render events + + + + + The fully qualified type of the AppenderSkeleton class. + + + Used by the internal logger to record the Type of the + log message. + @@ -730,16 +739,16 @@ - - The filter chain. - - The head of the filter chain filter chain. - - - Returns the head Filter. The Filters are organized in a linked list - and so all Filters on this Appender are available through the result. - - + + The filter chain. + + The head of the filter chain filter chain. + + + Returns the head Filter. The Filters are organized in a linked list + and so all Filters on this Appender are available through the result. + + @@ -754,15 +763,15 @@ - - Gets or sets the name of this appender. - - The name of the appender. - - - The name uniquely identifies the appender. - - + + Gets or sets the name of this appender. + + The name of the appender. + + + The name uniquely identifies the appender. + + @@ -775,7 +784,7 @@ then the appender should return true. - This default implementation always returns true. + This default implementation always returns false. @@ -783,13 +792,13 @@ - - The default buffer size. - - - The default size of the cyclic buffer used to store events. - This is set to 512 by default. - + + The default buffer size. + + + The default size of the cyclic buffer used to store events. + This is set to 512 by default. + @@ -887,7 +896,7 @@ - This method is called by the method. + This method is called by the method. the event to log @@ -911,34 +920,34 @@ Before the event is stored in the buffer it is fixed - (see ) to ensure that + (see ) to ensure that any data referenced by the event will be valid when the buffer is processed. - - Sends the contents of the buffer. - - The first logging event. - The buffer containing the events that need to be send. - - - The subclass must override . - - + + Sends the contents of the buffer. + + The first logging event. + The buffer containing the events that need to be send. + + + The subclass must override . + + - - Sends the events. - - The events that need to be send. - - - The subclass must override this method to process the buffered events. - - + + Sends the events. + + The events that need to be send. + + + The subclass must override this method to process the buffered events. + + @@ -949,9 +958,9 @@ - - The cyclic buffer used to store the logging events. - + + The cyclic buffer used to store the logging events. + @@ -978,28 +987,28 @@ - - The triggering event evaluator filters discarded events. - - - The object that is used to determine if an event that is discarded should - really be discarded or if it should be sent to the appenders. - This field can be null, which indicates that all discarded events will - be discarded. - + + The triggering event evaluator filters discarded events. + + + The object that is used to determine if an event that is discarded should + really be discarded or if it should be sent to the appenders. + This field can be null, which indicates that all discarded events will + be discarded. + - - Value indicating which fields in the event should be fixed - - - By default all fields are fixed - + + Value indicating which fields in the event should be fixed + + + By default all fields are fixed + - - The events delivered to the subclass must be fixed. - + + The events delivered to the subclass must be fixed. + @@ -1059,7 +1068,7 @@ The evaluator will be called for each event that is appended to this appender. If the evaluator triggers then the current buffer will - immediately be sent (see ). + immediately be sent (see ). If is set to true then an must be specified. @@ -1076,28 +1085,28 @@ The evaluator will be called for each event that is discarded from this appender. If the evaluator triggers then the current buffer will immediately - be sent (see ). + be sent (see ). - - Gets or sets a value indicating if only part of the logging event data - should be fixed. - - - true if the appender should only fix part of the logging event - data, otherwise false. The default is false. - - - - Setting this property to true will cause only part of the - event data to be fixed and serialized. This will improve performance. - - - See for more information. - - + + Gets or sets a value indicating if only part of the logging event data + should be fixed. + + + true if the appender should only fix part of the logging event + data, otherwise false. The default is false. + + + + Setting this property to true will cause only part of the + event data to be fixed and serialized. This will improve performance. + + + See for more information. + + @@ -1142,37 +1151,37 @@ - - Override the parent method to close the database - - - - Closes the database command and database connection. - - + + Override the parent method to close the database + + + + Closes the database command and database connection. + + - - Inserts the events into the database. - - The events to insert into the database. - - - Insert all the events specified in the - array into the database. - - + + Inserts the events into the database. + + The events to insert into the database. + + + Insert all the events specified in the + array into the database. + + - - Adds a parameter to the command. - - The parameter to add to the command. - - - Adds a parameter to the ordered list of command parameters. - - + + Adds a parameter to the command. + + The parameter to add to the command. + + + Adds a parameter to the ordered list of command parameters. + + @@ -1201,10 +1210,27 @@ Text that can be passed to a . - + - Connects to the database. - + Creates an instance used to connect to the database. + + + This method is called whenever a new IDbConnection is needed (i.e. when a reconnect is necessary). + + The of the object. + The connectionString output from the ResolveConnectionString method. + An instance with a valid connection string. + + + + Resolves the connection string from the ConnectionString, ConnectionStringName, or AppSettingsKey + property. + + + ConnectiongStringName is only supported on .NET 2.0 and higher. + + Additional information describing the connection string. + A connection string used to connect to the database. @@ -1224,21 +1250,42 @@ The of the ADO.NET provider - - Prepares the database command and initialize the parameters. - + + Prepares the database command and initialize the parameters. + - + + + Connects to the database. + + + + + Cleanup the existing command. + + + If true, a message will be written using LogLog.Warn if an exception is encountered when calling Dispose. + + + - Flag to indicate if we are using a command object + Cleanup the existing connection. - - Set to true when the appender is to use a prepared - statement or stored procedure to insert into the database. - + Calls the IDbConnection's method. + + + Flag to indicate if we are using a command object + + + + Set to true when the appender is to use a prepared + statement or stored procedure to insert into the database. + + + The list of objects. @@ -1250,9 +1297,9 @@ - - The security context to use for privileged calls - + + The security context to use for privileged calls + @@ -1261,14 +1308,19 @@ - - The database command. - + + The database command. + - - Database connection string. - + + Database connection string. + + + + + The appSettings key from App.Config that contains the connection string. + @@ -1276,24 +1328,33 @@ - - The text of the command. - + + The text of the command. + - - The command type. - + + The command type. + - - Indicates whether to use transactions when writing to the database. - + + Indicates whether to use transactions when writing to the database. + - - Indicates whether to use transactions when writing to the database. - + + Indicates whether to use transactions when writing to the database. + + + + + The fully qualified type of the AdoNetAppender class. + + + Used by the internal logger to record the Type of the + log message. + @@ -1319,6 +1380,11 @@ "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;" + + + The appSettings key from App.Config that contains the connection string. + + Gets or sets the type name of the connection @@ -1395,24 +1461,24 @@ - - Should transactions be used to insert logging events in the database. - - - true if transactions should be used to insert logging events in - the database, otherwise false. The default value is true. - - - - Gets or sets a value that indicates whether transactions should be used - to insert logging events in the database. - - - When set a single transaction will be used to insert the buffered events - into the database. Otherwise each event will be inserted without using - an explicit transaction. - - + + Should transactions be used to insert logging events in the database. + + + true if transactions should be used to insert logging events in + the database, otherwise false. The default value is true. + + + + Gets or sets a value that indicates whether transactions should be used + to insert logging events in the database. + + + When set a single transaction will be used to insert the buffered events + into the database. Otherwise each event will be inserted without using + an explicit transaction. + + @@ -1431,30 +1497,30 @@ - - Should this appender try to reconnect to the database on error. - - - true if the appender should try to reconnect to the database after an - error has occurred, otherwise false. The default value is false, - i.e. not to try to reconnect. - - - - The default behaviour is for the appender not to try to reconnect to the - database if an error occurs. Subsequent logging events are discarded. - - - To force the appender to attempt to reconnect to the database set this - property to true. - - - When the appender attempts to connect to the database there may be a - delay of up to the connection timeout specified in the connection string. - This delay will block the calling application's thread. - Until the connection can be reestablished this potential delay may occur multiple times. - - + + Should this appender try to reconnect to the database on error. + + + true if the appender should try to reconnect to the database after an + error has occurred, otherwise false. The default value is false, + i.e. not to try to reconnect. + + + + The default behaviour is for the appender not to try to reconnect to the + database if an error occurs. Subsequent logging events are discarded. + + + To force the appender to attempt to reconnect to the database set this + property to true. + + + When the appender attempts to connect to the database there may be a + delay of up to the connection timeout specified in the connection string. + This delay will block the calling application's thread. + Until the connection can be reestablished this potential delay may occur multiple times. + + @@ -1495,59 +1561,59 @@ - - Prepare the specified database command object. - - The command to prepare. - - - Prepares the database command object by adding - this parameter to its collection of parameters. - - + + Prepare the specified database command object. + + The command to prepare. + + + Prepares the database command object by adding + this parameter to its collection of parameters. + + - - Renders the logging event and set the parameter value in the command. - - The command containing the parameter. - The event to be rendered. - - - Renders the logging event using this parameters layout - object. Sets the value of the parameter on the command object. - - + + Renders the logging event and set the parameter value in the command. + + The command containing the parameter. + The event to be rendered. + + + Renders the logging event using this parameters layout + object. Sets the value of the parameter on the command object. + + - - The name of this parameter. - + + The name of this parameter. + - - The database type for this parameter. - + + The database type for this parameter. + - - Flag to infer type rather than use the DbType - + + Flag to infer type rather than use the DbType + - - The precision for this parameter. - + + The precision for this parameter. + - - The scale for this parameter. - + + The scale for this parameter. + - - The size for this parameter. - + + The size for this parameter. + @@ -1556,19 +1622,19 @@ - - Gets or sets the name of this parameter. - - - The name of this parameter. - - - - The name of this parameter. The parameter name - must match up to a named parameter to the SQL stored procedure - or prepared statement. - - + + Gets or sets the name of this parameter. + + + The name of this parameter. + + + + The name of this parameter. The parameter name + must match up to a named parameter to the SQL stored procedure + or prepared statement. + + @@ -1641,6 +1707,9 @@ This property is optional. If not specified the ADO.NET provider will attempt to infer the size from the value. + + For BLOB data types like VARCHAR(max) it may be impossible to infer the value automatically, use -1 as the size in this case. + @@ -1767,9 +1836,9 @@ - - Ansi code to reset terminal - + + Ansi code to reset terminal + @@ -1794,53 +1863,53 @@ - - This method is called by the method. - - The event to log. - - - Writes the event to the console. - - - The format of the output will depend on the appender's layout. - - + + This method is called by the method. + + The event to log. + + + Writes the event to the console. + + + The format of the output will depend on the appender's layout. + + - - Initialize the options for this appender - - - - Initialize the level to color mappings set on this appender. - - + + Initialize the options for this appender + + + + Initialize the level to color mappings set on this appender. + + - - Flag to write output to the error stream rather than the standard output stream - + + Flag to write output to the error stream rather than the standard output stream + - - Mapping from level object to color value - + + Mapping from level object to color value + - - Target is the value of the console output stream. - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - + + Target is the value of the console output stream. + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + @@ -1866,42 +1935,47 @@ - - text is bright - + + text is bright + - - text is dim - + + text is dim + - - text is underlined - + + text is underlined + - - text is blinking - - - Not all terminals support this attribute - + + text is blinking + + + Not all terminals support this attribute + - - text and background colors are reversed - + + text and background colors are reversed + - - text is hidden - + + text is hidden + - - text is displayed with a strikethrough - + + text is displayed with a strikethrough + + + + + text color is light + @@ -1916,55 +1990,55 @@ - - color is black - + + color is black + - - color is red - + + color is red + - - color is green - + + color is green + - - color is yellow - + + color is yellow + - - color is blue - + + color is blue + - - color is magenta - + + color is magenta + - - color is cyan - + + color is cyan + - - color is white - + + color is white + - - A class to act as a mapping between the level that a logging call is made at and - the color it should be displayed as. - - - - Defines the mapping between a level and the color it should be displayed in. - - + + A class to act as a mapping between the level that a logging call is made at and + the color it should be displayed as. + + + + Defines the mapping between a level and the color it should be displayed in. + + @@ -1979,24 +2053,24 @@ Nicko Cadell - - Default protected constructor - - - - Default protected constructor - - + + Default protected constructor + + + + Default protected constructor + + - - Initialize any options defined on this entry - - - - Should be overridden by any classes that need to initialise based on their options - - + + Initialize any options defined on this entry + + + + Should be overridden by any classes that need to initialise based on their options + + @@ -2024,37 +2098,37 @@ - - The mapped foreground color for the specified level - - - - Required property. - The mapped foreground color for the specified level - - + + The mapped foreground color for the specified level + + + + Required property. + The mapped foreground color for the specified level + + - - The mapped background color for the specified level - - - - Required property. - The mapped background color for the specified level - - + + The mapped background color for the specified level + + + + Required property. + The mapped background color for the specified level + + - - The color attributes for the specified level - - - - Required property. - The color attributes for the specified level - - + + The color attributes for the specified level + + + + Required property. + The color attributes for the specified level + + @@ -2069,40 +2143,40 @@ Nicko Cadell - - Creates a read-only wrapper for a AppenderCollection instance. - - list to create a readonly wrapper arround - - An AppenderCollection wrapper that is read-only. - + + Creates a read-only wrapper for a AppenderCollection instance. + + list to create a readonly wrapper arround + + An AppenderCollection wrapper that is read-only. + - - An empty readonly static AppenderCollection - + + An empty readonly static AppenderCollection + - - Initializes a new instance of the AppenderCollection class - that is empty and has the default initial capacity. - + + Initializes a new instance of the AppenderCollection class + that is empty and has the default initial capacity. + - - Initializes a new instance of the AppenderCollection class - that has the specified initial capacity. - - - The number of elements that the new AppenderCollection is initially capable of storing. - + + Initializes a new instance of the AppenderCollection class + that has the specified initial capacity. + + + The number of elements that the new AppenderCollection is initially capable of storing. + - - Initializes a new instance of the AppenderCollection class - that contains elements copied from the specified AppenderCollection. - - The AppenderCollection whose elements are copied to the new collection. + + Initializes a new instance of the AppenderCollection class + that contains elements copied from the specified AppenderCollection. + + The AppenderCollection whose elements are copied to the new collection. @@ -2119,11 +2193,11 @@ The collection whose elements are copied to the new list. - - Allow subclasses to avoid our default constructors - - - + + Allow subclasses to avoid our default constructors + + + @@ -2148,9 +2222,9 @@ The index at which the value has been added. - - Removes all elements from the AppenderCollection. - + + Removes all elements from the AppenderCollection. + @@ -2236,45 +2310,45 @@ The new of the AppenderCollection. - - Sets the capacity to the actual number of elements. - + + Sets the capacity to the actual number of elements. + - - Return the collection elements as an array - - the array + + Return the collection elements as an array + + the array - is less than zero + is less than zero -or- - is equal to or greater than . + is equal to or greater than . - is less than zero + is less than zero -or- - is equal to or greater than . + is equal to or greater than . - - Gets the number of elements actually contained in the AppenderCollection. - + + Gets the number of elements actually contained in the AppenderCollection. + - - Gets a value indicating whether access to the collection is synchronized (thread-safe). - - true if access to the ICollection is synchronized (thread-safe); otherwise, false. + + Gets a value indicating whether access to the collection is synchronized (thread-safe). + + true if access to the ICollection is synchronized (thread-safe); otherwise, false. - - Gets an object that can be used to synchronize access to the collection. - + + Gets an object that can be used to synchronize access to the collection. + @@ -2288,21 +2362,21 @@ - - Gets a value indicating whether the collection has a fixed size. - - true if the collection has a fixed size; otherwise, false. The default is false + + Gets a value indicating whether the collection has a fixed size. + + true if the collection has a fixed size; otherwise, false. The default is false - - Gets a value indicating whether the IList is read-only. - - true if the collection is read-only; otherwise, false. The default is false + + Gets a value indicating whether the IList is read-only. + + true if the collection is read-only; otherwise, false. The default is false - - Gets or sets the number of elements the AppenderCollection can contain. - + + Gets or sets the number of elements the AppenderCollection can contain. + @@ -2323,26 +2397,26 @@ - - Sets the enumerator to its initial position, before the first element in the collection. - + + Sets the enumerator to its initial position, before the first element in the collection. + - - Gets the current element in the collection. - + + Gets the current element in the collection. + - - Type visible only to our subclasses - Used to access protected constructor - - + + Type visible only to our subclasses + Used to access protected constructor + + - - A value - + + A value + @@ -2351,10 +2425,10 @@ - - Initializes a new instance of the Enumerator class. - - + + Initializes a new instance of the Enumerator class. + + @@ -2369,17 +2443,17 @@ - - Sets the enumerator to its initial position, before the first element in the collection. - + + Sets the enumerator to its initial position, before the first element in the collection. + - - Gets the current element in the collection. - + + Gets the current element in the collection. + - + @@ -2399,12 +2473,14 @@ whether tracing is displayed to a page, to the trace viewer, or both. - The logging event is passed to the or - method depending on the level of the logging event. + The logging event is passed to the or + method depending on the level of the logging event. + The event's logger name is the default value for the category parameter of the Write/Warn method. Nicko Cadell Gert Driesen + Ron Grabowski @@ -2429,6 +2505,11 @@ + + + Defaults to %logger + + This appender requires a to be set. @@ -2440,6 +2521,19 @@ + + + The category parameter sent to the Trace method. + + + + Defaults to %logger which will use the logger name of the current + as the category parameter. + + + + + Buffers events and then forwards them to attached appenders. @@ -2460,55 +2554,55 @@ Gert Driesen - - Interface for attaching appenders to objects. - - - - Interface for attaching, removing and retrieving appenders. - - - Nicko Cadell - Gert Driesen + + Interface for attaching appenders to objects. + + + + Interface for attaching, removing and retrieving appenders. + + + Nicko Cadell + Gert Driesen - - Attaches an appender. - - The appender to add. - - - Add the specified appender. The implementation may - choose to allow or deny duplicate appenders. - - + + Attaches an appender. + + The appender to add. + + + Add the specified appender. The implementation may + choose to allow or deny duplicate appenders. + + - - Gets an attached appender with the specified name. - - The name of the appender to get. - - The appender with the name specified, or null if no appender with the - specified name is found. - - - - Returns an attached appender with the specified. - If no appender with the specified name is found null will be - returned. - - + + Gets an attached appender with the specified name. + + The name of the appender to get. + + The appender with the name specified, or null if no appender with the + specified name is found. + + + + Returns an attached appender with the specified. + If no appender with the specified name is found null will be + returned. + + - - Removes all attached appenders. - - - - Removes and closes all attached appenders - - + + Removes all attached appenders. + + + + Removes and closes all attached appenders + + @@ -2539,20 +2633,20 @@ - - Gets all attached appenders. - - - A collection of attached appenders. - - - - Gets a collection of attached appenders. - If there are no attached appenders the - implementation should return an empty - collection rather than null. - - + + Gets all attached appenders. + + + A collection of attached appenders. + + + + Gets a collection of attached appenders. + If there are no attached appenders the + implementation should return an empty + collection rather than null. + + @@ -2565,29 +2659,29 @@ - - Closes the appender and releases resources. - - - - Releases any resources allocated within the appender such as file handles, - network connections, etc. - - - It is a programming error to append to a closed appender. - - + + Closes the appender and releases resources. + + + + Releases any resources allocated within the appender such as file handles, + network connections, etc. + + + It is a programming error to append to a closed appender. + + - - Send the events. - - The events that need to be send. - - - Forwards the events to the attached appenders. - - + + Send the events. + + The events that need to be send. + + + Forwards the events to the attached appenders. + + @@ -2603,28 +2697,28 @@ - - Looks for the appender with the specified name. - - The name of the appender to lookup. - - The appender with the specified name, or null. - - - - Get the named appender attached to this buffering appender. - - + + Looks for the appender with the specified name. + + The name of the appender to lookup. + + The appender with the specified name, or null. + + + + Get the named appender attached to this buffering appender. + + - - Removes all previously added appenders from this appender. - - - - This is useful when re-reading configuration information. - - + + Removes all previously added appenders from this appender. + + + + This is useful when re-reading configuration information. + + @@ -2796,73 +2890,73 @@ - - This method is called by the method. - - The event to log. - - - Writes the event to the console. - - - The format of the output will depend on the appender's layout. - - + + This method is called by the method. + + The event to log. + + + Writes the event to the console. + + + The format of the output will depend on the appender's layout. + + - - Initialize the options for this appender - - - - Initialize the level to color mappings set on this appender. - - + + Initialize the options for this appender + + + + Initialize the level to color mappings set on this appender. + + - - Flag to write output to the error stream rather than the standard output stream - + + Flag to write output to the error stream rather than the standard output stream + - - Mapping from level object to color value - + + Mapping from level object to color value + + + The console output stream writer to write to + + + + This writer is not thread safe. + + + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + - The console output stream writer to write to + This appender requires a to be set. + true - This writer is not thread safe. - - - - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - - - - This appender requires a to be set. - - true - - - This appender requires a to be set. + This appender requires a to be set. @@ -2879,55 +2973,55 @@ - - color is blue - + + color is blue + - - color is green - + + color is green + - - color is red - + + color is red + - - color is white - + + color is white + - - color is yellow - + + color is yellow + - - color is purple - + + color is purple + - - color is cyan - + + color is cyan + - - color is intensified - + + color is intensified + - - A class to act as a mapping between the level that a logging call is made at and - the color it should be displayed as. - - - - Defines the mapping between a level and the color it should be displayed in. - - + + A class to act as a mapping between the level that a logging call is made at and + the color it should be displayed as. + + + + Defines the mapping between a level and the color it should be displayed in. + + @@ -2940,26 +3034,26 @@ - - The mapped foreground color for the specified level - - - - Required property. - The mapped foreground color for the specified level. - - + + The mapped foreground color for the specified level + + + + Required property. + The mapped foreground color for the specified level. + + - - The mapped background color for the specified level - - - - Required property. - The mapped background color for the specified level. - - + + The mapped background color for the specified level + + + + Required property. + The mapped background color for the specified level. + + @@ -3051,34 +3145,34 @@ - - This method is called by the method. - - The event to log. - - - Writes the event to the console. - - - The format of the output will depend on the appender's layout. - - + + This method is called by the method. + + The event to log. + + + Writes the event to the console. + + + The format of the output will depend on the appender's layout. + + - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + @@ -3103,7 +3197,7 @@ debug system. - Events are written using the + Events are written using the method. The event's logger name is passed as the value for the category name to the Write method. @@ -3162,24 +3256,24 @@ - - Gets or sets a value that indicates whether the appender will - flush at the end of each write. - - - The default behavior is to flush at the end of each - write. If the option is set tofalse, then the underlying - stream can defer writing to physical medium to a later time. - - - Avoiding the flush operation at the end of each append results - in a performance gain of 10 to 20 percent. However, there is safety - trade-off involved in skipping flushing. Indeed, when flushing is - skipped, then it is likely that the last few log events will not - be recorded on disk when the application exits. This is a high - price to pay even for a 20% performance gain. - - + + Gets or sets a value that indicates whether the appender will + flush at the end of each write. + + + The default behavior is to flush at the end of each + write. If the option is set tofalse, then the underlying + stream can defer writing to physical medium to a later time. + + + Avoiding the flush operation at the end of each append results + in a performance gain of 10 to 20 percent. However, there is safety + trade-off involved in skipping flushing. Indeed, when flushing is + skipped, then it is likely that the last few log events will not + be recorded on disk when the application exits. This is a high + price to pay even for a 20% performance gain. + + @@ -3198,8 +3292,17 @@ + The appender will fail if you try to write using an event source that doesn't exist unless it is running with local administrator privileges. + See also http://logging.apache.org/log4net/release/faq.html#trouble-EventLog + + The EventID of the event log entry can be - set using the EventLogEventID property () + set using the EventID property () + on the . + + + The Category of the event log entry can be + set using the Category property () on the . @@ -3288,16 +3391,16 @@ - - Create an event log source - - - Uses different API calls under NET_2_0 - + + Create an event log source + + + Uses different API calls under NET_2_0 + - This method is called by the + This method is called by the method. the event to log @@ -3315,10 +3418,10 @@ - Get the equivalent for a + Get the equivalent for a the Level to convert to an EventLogEntryType - The equivalent for a + The equivalent for a Because there are fewer applicable values to use in logging levels than there are in the @@ -3327,10 +3430,10 @@ - - The log name is the section in the event logs where the messages - are stored. - + + The log name is the section in the event logs where the messages + are stored. + @@ -3339,20 +3442,102 @@ - - The name of the machine which holds the event log. This is - currently only allowed to be '.' i.e. the current machine. - + + The name of the machine which holds the event log. This is + currently only allowed to be '.' i.e. the current machine. + - - Mapping from level object to EventLogEntryType - + + Mapping from level object to EventLogEntryType + - - The security context to use for privileged calls - + + The security context to use for privileged calls + + + + + The event ID to use unless one is explicitly specified via the LoggingEvent's properties. + + + + + The event category to use unless one is explicitly specified via the LoggingEvent's properties. + + + + + The fully qualified type of the EventLogAppender class. + + + Used by the internal logger to record the Type of the + log message. + + + + + The maximum size supported by default. + + + http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx + The 32766 documented max size is two bytes shy of 32K (I'm assuming 32766 + may leave space for a two byte null terminator of #0#0). The 32766 max + length is what the .NET 4.0 source code checks for, but this is WRONG! + Strings with a length > 31839 on Windows Vista or higher can CORRUPT + the event log! See: System.Diagnostics.EventLogInternal.InternalWriteEvent() + for the use of the 32766 max size. + + + + + The maximum size supported by a windows operating system that is vista + or newer. + + + See ReportEvent API: + http://msdn.microsoft.com/en-us/library/aa363679(VS.85).aspx + ReportEvent's lpStrings parameter: + "A pointer to a buffer containing an array of + null-terminated strings that are merged into the message before Event Viewer + displays the string to the user. This parameter must be a valid pointer + (or NULL), even if wNumStrings is zero. Each string is limited to 31,839 characters." + + Going beyond the size of 31839 will (at some point) corrupt the event log on Windows + Vista or higher! It may succeed for a while...but you will eventually run into the + error: "System.ComponentModel.Win32Exception : A device attached to the system is + not functioning", and the event log will then be corrupt (I was able to corrupt + an event log using a length of 31877 on Windows 7). + + The max size for Windows Vista or higher is documented here: + http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx. + Going over this size may succeed a few times but the buffer will overrun and + eventually corrupt the log (based on testing). + + The maxEventMsgSize size is based on the max buffer size of the lpStrings parameter of the ReportEvent API. + The documented max size for EventLog.WriteEntry for Windows Vista and higher is 31839, but I'm leaving room for a + terminator of #0#0, as we cannot see the source of ReportEvent (though we could use an API monitor to examine the + buffer, given enough time). + + + + + The maximum size that the operating system supports for + a event log message. + + + Used to determine the maximum string length that can be written + to the operating system event log and eventually truncate a string + that exceeds the limits. + + + + + This method determines the maximum event log message size allowed for + the current environment. + + @@ -3375,31 +3560,31 @@ - - Property used to set the Application name. This appears in the - event logs when logging. - - - The string used to distinguish events from different sources. - - - Sets the event log source property. - + + Property used to set the Application name. This appears in the + event logs when logging. + + + The string used to distinguish events from different sources. + + + Sets the event log source property. + - - This property is used to return the name of the computer to use - when accessing the event logs. Currently, this is the current - computer, denoted by a dot "." - - - The string name of the machine holding the event log that - will be logged into. - - - This property cannot be changed. It is currently set to '.' - i.e. the local machine. This may be changed in future. - + + This property is used to return the name of the computer to use + when accessing the event logs. Currently, this is the current + computer, denoted by a dot "." + + + The string name of the machine holding the event log that + will be logged into. + + + This property cannot be changed. It is currently set to '.' + i.e. the local machine. This may be changed in future. + @@ -3420,28 +3605,54 @@ - + - This appender requires a to be set. + Gets or sets the EventId to use unless one is explicitly specified via the LoggingEvent's properties. - true - This appender requires a to be set. + The EventID of the event log entry will normally be + set using the EventID property () + on the . + This property provides the fallback value which defaults to 0. - + + + Gets or sets the Category to use unless one is explicitly specified via the LoggingEvent's properties. + + + + The Category of the event log entry will normally be + set using the Category property () + on the . + This property provides the fallback value which defaults to 0. + + + + - A class to act as a mapping between the level that a logging call is made at and - the color it should be displayed as. + This appender requires a to be set. + true - Defines the mapping between a level and its event log entry type. + This appender requires a to be set. + + + A class to act as a mapping between the level that a logging call is made at and + the color it should be displayed as. + + + + Defines the mapping between a level and its event log entry type. + + + The for this entry @@ -3488,8 +3699,13 @@ the property. The default behavior, implemented by is to obtain an exclusive write lock on the file until this appender is closed. - The alternative model, , only holds a - write lock while the appender is writing a logging event. + The alternative models only hold a + write lock while the appender is writing a logging event () + or synchronize by using a named system wide Mutex (). + + + All locking strategies have issues and you should seriously consider using a different strategy that + avoids having multiple processes logging to the same file. Nicko Cadell @@ -3557,53 +3773,53 @@ - - This method determines if there is a sense in attempting to append. - - - - This method checked if an output target has been set and if a - layout has been set. - - - false if any of the preconditions fail. + + This method determines if there is a sense in attempting to append. + + + + This method checks if an output target has been set and if a + layout has been set. + + + false if any of the preconditions fail. - - This method is called by the - method. - - The event to log. - - - Writes a log statement to the output stream if the output stream exists - and is writable. - - - The format of the output will depend on the appender's layout. - - + + This method is called by the + method. + + The event to log. + + + Writes a log statement to the output stream if the output stream exists + and is writable. + + + The format of the output will depend on the appender's layout. + + - - This method is called by the - method. - - The array of events to log. - - - This method writes all the bulk logged events to the output writer - before flushing the stream. - - + + This method is called by the + method. + + The array of events to log. + + + This method writes all the bulk logged events to the output writer + before flushing the stream. + + - - Close this appender instance. The underlying stream or writer is also closed. - - - Closed appenders cannot be reused. - + + Close this appender instance. The underlying stream or writer is also closed. + + + Closed appenders cannot be reused. + @@ -3692,30 +3908,39 @@ + + + The fully qualified type of the TextWriterAppender class. + + + Used by the internal logger to record the Type of the + log message. + + - - Gets or set whether the appender will flush at the end - of each append operation. - - - - The default behavior is to flush at the end of each - append operation. - - - If this option is set to false, then the underlying - stream can defer persisting the logging event to a later - time. - - - - Avoiding the flush operation at the end of each append results in - a performance gain of 10 to 20 percent. However, there is safety - trade-off involved in skipping flushing. Indeed, when flushing is - skipped, then it is likely that the last few log events will not - be recorded on disk when the application exits. This is a high - price to pay even for a 20% performance gain. - + + Gets or set whether the appender will flush at the end + of each append operation. + + + + The default behavior is to flush at the end of each + append operation. + + + If this option is set to false, then the underlying + stream can defer persisting the logging event to a later + time. + + + + Avoiding the flush operation at the end of each append results in + a performance gain of 10 to 20 percent. However, there is safety + trade-off involved in skipping flushing. Indeed, when flushing is + skipped, then it is likely that the last few log events will not + be recorded on disk when the application exits. This is a high + price to pay even for a 20% performance gain. + @@ -3770,40 +3995,40 @@ - - Default constructor - - - - Default constructor - - + + Default constructor + + + + Default constructor + + - - Construct a new appender using the layout, file and append mode. - - the layout to use with this appender - the full path to the file to write to - flag to indicate if the file should be appended to - - - Obsolete constructor. - - + + Construct a new appender using the layout, file and append mode. + + the layout to use with this appender + the full path to the file to write to + flag to indicate if the file should be appended to + + + Obsolete constructor. + + - - Construct a new appender using the layout and file specified. - The file will be appended to. - - the layout to use with this appender - the full path to the file to write to - - - Obsolete constructor. - - + + Construct a new appender using the layout and file specified. + The file will be appended to. + + the layout to use with this appender + the full path to the file to write to + + + Obsolete constructor. + + @@ -3837,44 +4062,44 @@ - - Called to initialize the file writer - - - - Will be called for each logged message until the file is - successfully opened. - - + + Called to initialize the file writer + + + + Will be called for each logged message until the file is + successfully opened. + + - - This method is called by the - method. - - The event to log. - - - Writes a log statement to the output stream if the output stream exists - and is writable. - - - The format of the output will depend on the appender's layout. - - + + This method is called by the + method. + + The event to log. + + + Writes a log statement to the output stream if the output stream exists + and is writable. + + + The format of the output will depend on the appender's layout. + + - - This method is called by the - method. - - The array of events to log. - - - Acquires the output file locks once before writing all the events to - the stream. - - + + This method is called by the + method. + + The array of events to log. + + + Acquires the output file locks once before writing all the events to + the stream. + + @@ -3931,21 +4156,21 @@ - - Sets and opens the file where the log output will go. The specified file must be writable. - - The path to the log file. Must be a fully qualified path. - If true will append to fileName. Otherwise will truncate fileName - - - If there was already an opened file, then the previous file - is closed first. - - - This method will ensure that the directory structure - for the specified exists. - - + + Sets and opens the file where the log output will go. The specified file must be writable. + + The path to the log file. Must be a fully qualified path. + If true will append to fileName. Otherwise will truncate fileName + + + If there was already an opened file, then the previous file + is closed first. + + + This method will ensure that the directory structure + for the specified exists. + + @@ -3954,9 +4179,9 @@ the file stream that has been opened for writing - This implementation of creates a + This implementation of creates a over the and passes it to the - method. + method. This method can be overridden by sub classes that want to wrap the @@ -3978,96 +4203,105 @@ - - Convert a path into a fully qualified path. - - The path to convert. - The fully qualified path. - - - Converts the path specified to a fully - qualified path. If the path is relative it is - taken as relative from the application base - directory. - - + + Convert a path into a fully qualified path. + + The path to convert. + The fully qualified path. + + + Converts the path specified to a fully + qualified path. If the path is relative it is + taken as relative from the application base + directory. + + - - Flag to indicate if we should append to the file - or overwrite the file. The default is to append. - + + Flag to indicate if we should append to the file + or overwrite the file. The default is to append. + - - The name of the log file. - + + The name of the log file. + - - The encoding to use for the file stream. - + + The encoding to use for the file stream. + - - The security context to use for privileged calls - + + The security context to use for privileged calls + - - The stream to log to. Has added locking semantics - + + The stream to log to. Has added locking semantics + - - The locking model to use - + + The locking model to use + + + + + The fully qualified type of the FileAppender class. + + + Used by the internal logger to record the Type of the + log message. + + + Gets or sets the path to the file that logging will be written to. + + + The path to the file that logging will be written to. + + + + If the path is relative it is taken as relative from + the application base directory. + + + + + + Gets or sets a flag that indicates whether the file should be + appended to or overwritten. + + + Indicates whether the file should be appended to or overwritten. + + + + If the value is set to false then the file will be overwritten, if + it is set to true then the file will be appended to. + + The default value is true. + + + - Gets or sets the path to the file that logging will be written to. + Gets or sets used to write to the file. - The path to the file that logging will be written to. + The used to write to the file. - If the path is relative it is taken as relative from - the application base directory. + The default encoding set is + which is the encoding for the system's current ANSI code page. - - - Gets or sets a flag that indicates whether the file should be - appended to or overwritten. - - - Indicates whether the file should be appended to or overwritten. - - - - If the value is set to false then the file will be overwritten, if - it is set to true then the file will be appended to. - - The default value is true. - - - - - Gets or sets used to write to the file. - - - The used to write to the file. - - - - The default encoding set is - which is the encoding for the system's current ANSI code page. - - - - + Gets or sets the used to write to the file. @@ -4095,9 +4329,10 @@ Gets or sets the used to handle locking of the file. - There are two built in locking models, and . - The former locks the file from the start of logging to the end and the - later lock only for the minimal amount of time when logging each message. + There are three built in locking models, , and . + The first locks the file from the start of logging to the end, the + second locks only for the minimal amount of time when logging each message + and the last synchronizes processes using a named system wide Mutex. The default locking model is the . @@ -4111,9 +4346,9 @@ - - True asynchronous writes are not supported, the implementation forces a synchronous write. - + + True asynchronous writes are not supported, the implementation forces a synchronous write. + @@ -4204,14 +4439,14 @@ - - Close the file - - - - Close the file. No further writes will be made. - - + + Close the file + + + + Close the file. No further writes will be made. + + @@ -4237,6 +4472,33 @@ + + + Helper method that creates a FileStream under CurrentAppender's SecurityContext. + + + + Typically called during OpenFile or AcquireLock. + + + If the directory portion of the does not exist, it is created + via Directory.CreateDirecctory. + + + + + + + + + + Helper method to close under CurrentAppender's SecurityContext. + + + Does not set to null. + + + Gets or sets the for this LockingModel @@ -4286,35 +4548,35 @@ - - Close the file - - - - Close the file. No further writes will be made. - - + + Close the file + + + + Close the file. No further writes will be made. + + - - Acquire the lock on the file - - A stream that is ready to be written to. - - - Does nothing. The lock is already taken - - + + Acquire the lock on the file + + A stream that is ready to be written to. + + + Does nothing. The lock is already taken + + - - Release the lock on the file - - - - Does nothing. The lock will be released when the file is closed. - - + + Release the lock on the file + + + + Does nothing. The lock will be released when the file is closed. + + @@ -4346,14 +4608,14 @@ - - Close the file - - - - Close the file. No further writes will be made. - - + + Close the file + + + + Close the file. No further writes will be made. + + @@ -4379,18 +4641,67 @@ - + + + Provides cross-process file locking. + + Ron Grabowski + Steve Wranovsky + + - This appender forwards logging events to attached appenders. + Open the file specified and prepare for logging. + The filename to use + Whether to append to the file, or overwrite + The encoding to use - The forwarding appender can be used to specify different thresholds - and filters for the same appender at different locations within the hierarchy. - - - Nicko Cadell - Gert Driesen + Open the file specified and prepare for logging. + No writes will be made until is called. + Must be called before any calls to , + - and . + + + + + + Close the file + + + + Close the file. No further writes will be made. + + + + + + Acquire the lock on the file + + A stream that is ready to be written to. + + + Does nothing. The lock is already taken + + + + + + + + + + + This appender forwards logging events to attached appenders. + + + + The forwarding appender can be used to specify different thresholds + and filters for the same appender at different locations within the hierarchy. + + + Nicko Cadell + Gert Driesen @@ -4403,40 +4714,40 @@ - - Closes the appender and releases resources. - - - - Releases any resources allocated within the appender such as file handles, - network connections, etc. - - - It is a programming error to append to a closed appender. - - + + Closes the appender and releases resources. + + + + Releases any resources allocated within the appender such as file handles, + network connections, etc. + + + It is a programming error to append to a closed appender. + + - - Forward the logging event to the attached appenders - - The event to log. - - - Delivers the logging event to all the attached appenders. - - + + Forward the logging event to the attached appenders + + The event to log. + + + Delivers the logging event to all the attached appenders. + + - - Forward the logging events to the attached appenders - - The array of events to log. - - - Delivers the logging events to all the attached appenders. - - + + Forward the logging events to the attached appenders + + The array of events to log. + + + Delivers the logging events to all the attached appenders. + + @@ -4452,28 +4763,28 @@ - - Looks for the appender with the specified name. - - The name of the appender to lookup. - - The appender with the specified name, or null. - - - - Get the named appender attached to this appender. - - + + Looks for the appender with the specified name. + + The name of the appender to lookup. + + The appender with the specified name, or null. + + + + Get the named appender attached to this appender. + + - - Removes all previously added appenders from this appender. - - - - This is useful when re-reading configuration information. - - + + Removes all previously added appenders from this appender. + + + + This is useful when re-reading configuration information. + + @@ -4591,48 +4902,48 @@ - - This method is called by the method. - - The event to log. - - - Writes the event to a remote syslog daemon. - - - The format of the output will depend on the appender's layout. - - + + This method is called by the method. + + The event to log. + + + Writes the event to a remote syslog daemon. + + + The format of the output will depend on the appender's layout. + + - - Close the syslog when the appender is closed - - - - Close the syslog when the appender is closed - - + + Close the syslog when the appender is closed + + + + Close the syslog when the appender is closed + + - - Translates a log4net level to a syslog severity. - - A log4net level. - A syslog severity. - - - Translates a log4net level to a syslog severity. - - + + Translates a log4net level to a syslog severity. + + A log4net level. + A syslog severity. + + + Translates a log4net level to a syslog severity. + + - - Generate a syslog priority. - - The syslog facility. - The syslog severity. - A syslog priority. + + Generate a syslog priority. + + The syslog facility. + The syslog severity. + A syslog priority. @@ -4640,45 +4951,45 @@ - - The message identity - + + The message identity + - - Marshaled handle to the identity string. We have to hold on to the - string as the openlog and syslog APIs just hold the - pointer to the ident and dereference it for each log message. - + + Marshaled handle to the identity string. We have to hold on to the + string as the openlog and syslog APIs just hold the + pointer to the ident and dereference it for each log message. + - - Mapping from level object to syslog severity - + + Mapping from level object to syslog severity + - - Open connection to system logger. - + + Open connection to system logger. + - - Generate a log message. - - - - The libc syslog method takes a format string and a variable argument list similar - to the classic printf function. As this type of vararg list is not supported - by C# we need to specify the arguments explicitly. Here we have specified the - format string with a single message argument. The caller must set the format - string to "%s". - - + + Generate a log message. + + + + The libc syslog method takes a format string and a variable argument list similar + to the classic printf function. As this type of vararg list is not supported + by C# we need to specify the arguments explicitly. Here we have specified the + format string with a single message argument. The caller must set the format + string to "%s". + + - - Close descriptor used to write to system logger. - + + Close descriptor used to write to system logger. + @@ -4727,44 +5038,44 @@ - - system is unusable - + + system is unusable + - - action must be taken immediately - + + action must be taken immediately + - - critical conditions - + + critical conditions + - - error conditions - + + error conditions + - - warning conditions - + + warning conditions + - - normal but significant condition - + + normal but significant condition + - - informational - + + informational + - - debug-level messages - + + debug-level messages + @@ -4778,147 +5089,147 @@ - - kernel messages - + + kernel messages + - - random user-level messages - + + random user-level messages + - - mail system - + + mail system + - - system daemons - + + system daemons + - - security/authorization messages - + + security/authorization messages + - - messages generated internally by syslogd - + + messages generated internally by syslogd + - - line printer subsystem - + + line printer subsystem + - - network news subsystem - + + network news subsystem + - - UUCP subsystem - + + UUCP subsystem + - - clock (cron/at) daemon - + + clock (cron/at) daemon + - - security/authorization messages (private) - + + security/authorization messages (private) + - - ftp daemon - + + ftp daemon + - - NTP subsystem - + + NTP subsystem + - - log audit - + + log audit + - - log alert - + + log alert + - - clock daemon - + + clock daemon + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - A class to act as a mapping between the level that a logging call is made at and - the syslog severity that is should be logged at. - - - - A class to act as a mapping between the level that a logging call is made at and - the syslog severity that is should be logged at. - - + + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + + + + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + + - - The mapped syslog severity for the specified level - - - - Required property. - The mapped syslog severity for the specified level - - + + The mapped syslog severity for the specified level + + + + Required property. + The mapped syslog severity for the specified level + + @@ -4934,7 +5245,7 @@ the current list of events that have been appended. - Use the method to clear the + Use the method to clear the current list of events. @@ -4953,74 +5264,74 @@ - - Gets the events that have been logged. - - The events that have been logged - - - Gets the events that have been logged. - - + + Gets the events that have been logged. + + The events that have been logged + + + Gets the events that have been logged. + + - - This method is called by the method. - - the event to log - - Stores the in the events list. - + + This method is called by the method. + + the event to log + + Stores the in the events list. + - - Clear the list of events - - - Clear the list of events - + + Clear the list of events + + + Clear the list of events + - - The list of events that have been appended. - + + The list of events that have been appended. + - - Value indicating which fields in the event should be fixed - - - By default all fields are fixed - + + Value indicating which fields in the event should be fixed + + + By default all fields are fixed + + + Gets or sets a value indicating whether only part of the logging event + data should be fixed. + + + true if the appender should only fix part of the logging event + data, otherwise false. The default is false. + + + + Setting this property to true will cause only part of the event + data to be fixed and stored in the appender, hereby improving performance. + + + See for more information. + + + + - Gets or sets a value indicating whether only part of the logging event - data should be fixed. + Gets or sets the fields that will be fixed in the event - - true if the appender should only fix part of the logging event - data, otherwise false. The default is false. - - Setting this property to true will cause only part of the event - data to be fixed and stored in the appender, hereby improving performance. - - - See for more information. - - - - - - Gets or sets the fields that will be fixed in the event - - - - The logging event needs to have certain thread specific values - captured before it can be buffered. See - for details. + The logging event needs to have certain thread specific values + captured before it can be buffered. See + for details. @@ -5054,10 +5365,10 @@ Send a message to a user account on the local machine - = <name of the local machine> + = <name of the local machine> - = <user name> + = <user name> @@ -5065,10 +5376,10 @@ Send a message to a user account on a remote machine - = <name of the remote machine> + = <name of the remote machine> - = <user name> + = <user name> @@ -5076,10 +5387,10 @@ Send a message to a domain user account - = <name of a domain controller | uninitialized> + = <name of a domain controller | uninitialized> - = <user name> + = <user name> @@ -5087,7 +5398,7 @@ Send a message to all the names in a workgroup or domain - = <workgroup name | domain name>* + = <workgroup name | domain name>* @@ -5095,10 +5406,10 @@ Send a message from the local machine to a remote machine - = <name of the local machine | uninitialized> + = <name of the local machine | uninitialized> - = <name of the remote machine> + = <name of the remote machine> @@ -5128,32 +5439,32 @@ Gert Driesen - - The DNS or NetBIOS name of the server on which the function is to execute. - + + The DNS or NetBIOS name of the server on which the function is to execute. + - - The sender of the network message. - + + The sender of the network message. + - - The message alias to which the message should be sent. - + + The message alias to which the message should be sent. + - - The security context to use for privileged calls - + + The security context to use for privileged calls + - - Initializes the appender. - - - The default constructor initializes all fields to their default values. - + + Initializes the appender. + + + The default constructor initializes all fields to their default values. + @@ -5178,109 +5489,109 @@ The required property was not specified. - - This method is called by the method. - - The event to log. - - - Sends the event using a network message. - - + + This method is called by the method. + + The event to log. + + + Sends the event using a network message. + + - - Sends a buffer of information to a registered message alias. - - The DNS or NetBIOS name of the server on which the function is to execute. - The message alias to which the message buffer should be sent - The originator of the message. - The message text. - The length, in bytes, of the message text. - - - The following restrictions apply for sending network messages: - - - - - Platform - Requirements - - - Windows NT - - - No special group membership is required to send a network message. - - - Admin, Accounts, Print, or Server Operator group membership is required to - successfully send a network message on a remote server. - - - - - Windows 2000 or later - - - If you send a message on a domain controller that is running Active Directory, - access is allowed or denied based on the access control list (ACL) for the securable - object. The default ACL permits only Domain Admins and Account Operators to send a network message. - - - On a member server or workstation, only Administrators and Server Operators can send a network message. - - - - - - - For more information see Security Requirements for the Network Management Functions. - - - - - If the function succeeds, the return value is zero. - - + + Sends a buffer of information to a registered message alias. + + The DNS or NetBIOS name of the server on which the function is to execute. + The message alias to which the message buffer should be sent + The originator of the message. + The message text. + The length, in bytes, of the message text. + + + The following restrictions apply for sending network messages: + + + + + Platform + Requirements + + + Windows NT + + + No special group membership is required to send a network message. + + + Admin, Accounts, Print, or Server Operator group membership is required to + successfully send a network message on a remote server. + + + + + Windows 2000 or later + + + If you send a message on a domain controller that is running Active Directory, + access is allowed or denied based on the access control list (ACL) for the securable + object. The default ACL permits only Domain Admins and Account Operators to send a network message. + + + On a member server or workstation, only Administrators and Server Operators can send a network message. + + + + + + + For more information see Security Requirements for the Network Management Functions. + + + + + If the function succeeds, the return value is zero. + + - - Gets or sets the sender of the message. - - - The sender of the message. - - - If this property is not specified, the message is sent from the local computer. - + + Gets or sets the sender of the message. + + + The sender of the message. + + + If this property is not specified, the message is sent from the local computer. + - - Gets or sets the message alias to which the message should be sent. - - - The recipient of the message. - - - This property should always be specified in order to send a message. - + + Gets or sets the message alias to which the message should be sent. + + + The recipient of the message. + + + This property should always be specified in order to send a message. + - - Gets or sets the DNS or NetBIOS name of the remote server on which the function is to execute. - - - DNS or NetBIOS name of the remote server on which the function is to execute. - - - - For Windows NT 4.0 and earlier, the string should begin with \\. - - - If this property is not specified, the local computer is used. - - + + Gets or sets the DNS or NetBIOS name of the remote server on which the function is to execute. + + + DNS or NetBIOS name of the remote server on which the function is to execute. + + + + For Windows NT 4.0 and earlier, the string should begin with \\. + + + If this property is not specified, the local computer is used. + + @@ -5310,21 +5621,21 @@ - - Appends log events to the OutputDebugString system. - - - - OutputDebugStringAppender appends log events to the - OutputDebugString system. - - - The string is passed to the native OutputDebugString - function. - - - Nicko Cadell - Gert Driesen + + Appends log events to the OutputDebugString system. + + + + OutputDebugStringAppender appends log events to the + OutputDebugString system. + + + The string is passed to the native OutputDebugString + function. + + + Nicko Cadell + Gert Driesen @@ -5337,26 +5648,26 @@ - - Write the logging event to the output debug string API - - the event to log - - - Write the logging event to the output debug string API - - + + Write the logging event to the output debug string API + + the event to log + + + Write the logging event to the output debug string API + + - - Stub for OutputDebugString native method - - the string to output - - - Stub for OutputDebugString native method - - + + Stub for OutputDebugString native method + + the string to output + + + Stub for OutputDebugString native method + + @@ -5465,8 +5776,7 @@ Try remoteEndPoint = new IPEndPoint(IPAddress.Any, 0) udpClient = new UdpClient(8080) - - While True + While True buffer = udpClient.Receive(ByRef remoteEndPoint) loggingEvent = System.Text.Encoding.Unicode.GetString(buffer) Console.WriteLine(loggingEvent) @@ -5524,7 +5834,7 @@ - This method is called by the method. + This method is called by the method. The event to log. @@ -5563,21 +5873,21 @@ - - The IP address of the remote host or multicast group to which - the logging event will be sent. - + + The IP address of the remote host or multicast group to which + the logging event will be sent. + - - The TCP port number of the remote host or multicast group to - which the logging event will be sent. - + + The TCP port number of the remote host or multicast group to + which the logging event will be sent. + - - The cached remote endpoint to which the logging events will be sent. - + + The cached remote endpoint to which the logging events will be sent. + @@ -5591,9 +5901,9 @@ - - The encoding to use for the packet. - + + The encoding to use for the packet. + @@ -5752,9 +6062,19 @@ - - Syslog port 514 - + + Syslog port 514 + + + + + Initial buffer size + + + + + Maximum buffer size before it is recycled + @@ -5777,53 +6097,53 @@ - - This method is called by the method. - - The event to log. - - - Writes the event to a remote syslog daemon. - - - The format of the output will depend on the appender's layout. - - + + This method is called by the method. + + The event to log. + + + Writes the event to a remote syslog daemon. + + + The format of the output will depend on the appender's layout. + + - - Initialize the options for this appender - - - - Initialize the level to syslog severity mappings set on this appender. - - + + Initialize the options for this appender + + + + Initialize the level to syslog severity mappings set on this appender. + + - - Translates a log4net level to a syslog severity. - - A log4net level. - A syslog severity. - - - Translates a log4net level to a syslog severity. - - + + Translates a log4net level to a syslog severity. + + A log4net level. + A syslog severity. + + + Translates a log4net level to a syslog severity. + + - - Generate a syslog priority. - - The syslog facility. - The syslog severity. - A syslog priority. - - - Generate a syslog priority. - - + + Generate a syslog priority. + + The syslog facility. + The syslog severity. + A syslog priority. + + + Generate a syslog priority. + + @@ -5831,14 +6151,14 @@ - - The message identity - + + The message identity + - - Mapping from level object to syslog severity - + + Mapping from level object to syslog severity + @@ -5864,207 +6184,207 @@ - - syslog severities - - - - The syslog severities. - - + + syslog severities + + + + The syslog severities. + + - - system is unusable - + + system is unusable + - - action must be taken immediately - + + action must be taken immediately + - - critical conditions - + + critical conditions + - - error conditions - + + error conditions + - - warning conditions - + + warning conditions + - - normal but significant condition - + + normal but significant condition + - - informational - + + informational + - - debug-level messages - + + debug-level messages + - - syslog facilities - - - - The syslog facilities - - + + syslog facilities + + + + The syslog facilities + + - - kernel messages - + + kernel messages + - - random user-level messages - + + random user-level messages + - - mail system - + + mail system + - - system daemons - + + system daemons + - - security/authorization messages - + + security/authorization messages + - - messages generated internally by syslogd - + + messages generated internally by syslogd + - - line printer subsystem - + + line printer subsystem + - - network news subsystem - + + network news subsystem + - - UUCP subsystem - + + UUCP subsystem + - - clock (cron/at) daemon - + + clock (cron/at) daemon + - - security/authorization messages (private) - + + security/authorization messages (private) + - - ftp daemon - + + ftp daemon + - - NTP subsystem - + + NTP subsystem + - - log audit - + + log audit + - - log alert - + + log alert + - - clock daemon - + + clock daemon + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - reserved for local use - + + reserved for local use + - - A class to act as a mapping between the level that a logging call is made at and - the syslog severity that is should be logged at. - - - - A class to act as a mapping between the level that a logging call is made at and - the syslog severity that is should be logged at. - - + + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + + + + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + + - - The mapped syslog severity for the specified level - - - - Required property. - The mapped syslog severity for the specified level - - + + The mapped syslog severity for the specified level + + + + Required property. + The mapped syslog severity for the specified level + + @@ -6184,14 +6504,14 @@ - - A work item is being queued into the thread pool - + + A work item is being queued into the thread pool + - - A work item from the thread pool has completed - + + A work item from the thread pool has completed + @@ -6205,28 +6525,28 @@ the logging events to send - - The URL of the remote sink. - + + The URL of the remote sink. + - - The local proxy (.NET remoting) for the remote logging sink. - + + The local proxy (.NET remoting) for the remote logging sink. + - - The number of queued callbacks currently waiting or executing - + + The number of queued callbacks currently waiting or executing + - - Event used to signal when there are no queued work items - - - This event is set when there are no queued work items. In this - state it is safe to close the appender. - + + Event used to signal when there are no queued work items + + + This event is set when there are no queued work items. In this + state it is safe to close the appender. + @@ -6255,15 +6575,15 @@ - - Delivers logging events to the remote sink - - Array of events to log. - - - Delivers logging events to the remote sink - - + + Delivers logging events to the remote sink + + Array of events to log. + + + Delivers logging events to the remote sink + + @@ -6359,52 +6679,61 @@ + + + The fully qualified type of the RollingFileAppender class. + + + Used by the internal logger to record the Type of the + log message. + + - - Sets the quiet writer being used. - - - This method can be overridden by sub classes. - - the writer to set + + Sets the quiet writer being used. + + + This method can be overridden by sub classes. + + the writer to set - - Write out a logging event. - - the event to write to file. - - - Handles append time behavior for RollingFileAppender. This checks - if a roll over either by date (checked first) or time (checked second) - is need and then appends to the file last. - - + + Write out a logging event. + + the event to write to file. + + + Handles append time behavior for RollingFileAppender. This checks + if a roll over either by date (checked first) or time (checked second) + is need and then appends to the file last. + + - - Write out an array of logging events. - - the events to write to file. - - - Handles append time behavior for RollingFileAppender. This checks - if a roll over either by date (checked first) or time (checked second) - is need and then appends to the file last. - - + + Write out an array of logging events. + + the events to write to file. + + + Handles append time behavior for RollingFileAppender. This checks + if a roll over either by date (checked first) or time (checked second) + is need and then appends to the file last. + + - - Performs any required rolling before outputting the next event - - - - Handles append time behavior for RollingFileAppender. This checks - if a roll over either by date (checked first) or time (checked second) - is need and then appends to the file last. - - + + Performs any required rolling before outputting the next event + + + + Handles append time behavior for RollingFileAppender. This checks + if a roll over either by date (checked first) or time (checked second) + is need and then appends to the file last. + + @@ -6433,30 +6762,30 @@ - - Determines curSizeRollBackups (only within the current roll point) - + + Determines curSizeRollBackups (only within the current roll point) + - - Generates a wildcard pattern that can be used to find all files - that are similar to the base file name. - - - + + Generates a wildcard pattern that can be used to find all files + that are similar to the base file name. + + + - - Builds a list of filenames for all files matching the base filename plus a file - pattern. - - - + + Builds a list of filenames for all files matching the base filename plus a file + pattern. + + + - - Initiates a roll over if needed for crossing a date boundary since the last run. - + + Initiates a roll over if needed for crossing a date boundary since the last run. + @@ -6474,39 +6803,50 @@ - - Does the work of bumping the 'current' file counter higher - to the highest count when an incremental file name is seen. - The highest count is either the first file (when count direction - is greater than 0) or the last file (when count direction less than 0). - In either case, we want to know the highest count that is present. - - - + + Does the work of bumping the 'current' file counter higher + to the highest count when an incremental file name is seen. + The highest count is either the first file (when count direction + is greater than 0) or the last file (when count direction less than 0). + In either case, we want to know the highest count that is present. + + + + + + + Attempts to extract a number from the end of the file name that indicates + the number of the times the file has been rolled over. + + + Certain date pattern extensions like yyyyMMdd will be parsed as valid backup indexes. + + + - - Takes a list of files and a base file name, and looks for - 'incremented' versions of the base file. Bumps the max - count up to the highest count seen. - - - + + Takes a list of files and a base file name, and looks for + 'incremented' versions of the base file. Bumps the max + count up to the highest count seen. + + + - - Calculates the RollPoint for the datePattern supplied. - - the date pattern to calculate the check period for - The RollPoint that is most accurate for the date pattern supplied - - Essentially the date pattern is examined to determine what the - most suitable roll point is. The roll point chosen is the roll point - with the smallest period that can be detected using the date pattern - supplied. i.e. if the date pattern only outputs the year, month, day - and hour then the smallest roll point that can be detected would be - and hourly roll point as minutes could not be detected. - + + Calculates the RollPoint for the datePattern supplied. + + the date pattern to calculate the check period for + The RollPoint that is most accurate for the date pattern supplied + + Essentially the date pattern is examined to determine what the + most suitable roll point is. The roll point chosen is the roll point + with the smallest period that can be detected using the date pattern + supplied. i.e. if the date pattern only outputs the year, month, day + and hour then the smallest roll point that can be detected would be + and hourly roll point as minutes could not be detected. + @@ -6531,85 +6871,93 @@ + + + + + + .1, .2, .3, etc. + + - - Rollover the file(s) to date/time tagged file(s). - - set to true if the file to be rolled is currently open - - - Rollover the file(s) to date/time tagged file(s). - Resets curSizeRollBackups. - If fileIsOpen is set then the new file is opened (through SafeOpenFile). - - + + Rollover the file(s) to date/time tagged file(s). + + set to true if the file to be rolled is currently open + + + Rollover the file(s) to date/time tagged file(s). + Resets curSizeRollBackups. + If fileIsOpen is set then the new file is opened (through SafeOpenFile). + + - - Renames file to file . - - Name of existing file to roll. - New name for file. - - - Renames file to file . It - also checks for existence of target file and deletes if it does. - - + + Renames file to file . + + Name of existing file to roll. + New name for file. + + + Renames file to file . It + also checks for existence of target file and deletes if it does. + + - - Test if a file exists at a specified path - - the path to the file - true if the file exists - - - Test if a file exists at a specified path - - + + Test if a file exists at a specified path + + the path to the file + true if the file exists + + + Test if a file exists at a specified path + + - - Deletes the specified file if it exists. - - The file to delete. - - - Delete a file if is exists. - The file is first moved to a new filename then deleted. - This allows the file to be removed even when it cannot - be deleted, but it still can be moved. - - + + Deletes the specified file if it exists. + + The file to delete. + + + Delete a file if is exists. + The file is first moved to a new filename then deleted. + This allows the file to be removed even when it cannot + be deleted, but it still can be moved. + + - - Implements file roll base on file size. - - - - If the maximum number of size based backups is reached - (curSizeRollBackups == maxSizeRollBackups) then the oldest - file is deleted -- its index determined by the sign of countDirection. - If countDirection < 0, then files - {File.1, ..., File.curSizeRollBackups -1} - are renamed to {File.2, ..., - File.curSizeRollBackups}. Moreover, File is - renamed File.1 and closed. - - - A new file is created to receive further log output. - - - If maxSizeRollBackups is equal to zero, then the - File is truncated with no backup files created. - - - If maxSizeRollBackups < 0, then File is - renamed if needed and no files are deleted. - - + + Implements file roll base on file size. + + + + If the maximum number of size based backups is reached + (curSizeRollBackups == maxSizeRollBackups) then the oldest + file is deleted -- its index determined by the sign of countDirection. + If countDirection < 0, then files + {File.1, ..., File.curSizeRollBackups -1} + are renamed to {File.2, ..., + File.curSizeRollBackups}. Moreover, File is + renamed File.1 and closed. + + + A new file is created to receive further log output. + + + If maxSizeRollBackups is equal to zero, then the + File is truncated with no backup files created. + + + If maxSizeRollBackups < 0, then File is + renamed if needed and no files are deleted. + + @@ -6640,107 +6988,137 @@ - - Get the start time of the next window for the current rollpoint - - the current date - the type of roll point we are working with - the start time for the next roll point an interval after the currentDateTime date - - - Returns the date of the next roll point after the currentDateTime date passed to the method. - - - The basic strategy is to subtract the time parts that are less significant - than the rollpoint from the current time. This should roll the time back to - the start of the time window for the current rollpoint. Then we add 1 window - worth of time and get the start time of the next window for the rollpoint. - - + + Get the start time of the next window for the current rollpoint + + the current date + the type of roll point we are working with + the start time for the next roll point an interval after the currentDateTime date + + + Returns the date of the next roll point after the currentDateTime date passed to the method. + + + The basic strategy is to subtract the time parts that are less significant + than the rollpoint from the current time. This should roll the time back to + the start of the time window for the current rollpoint. Then we add 1 window + worth of time and get the start time of the next window for the rollpoint. + + - - This object supplies the current date/time. Allows test code to plug in - a method to control this class when testing date/time based rolling. - + + This object supplies the current date/time. Allows test code to plug in + a method to control this class when testing date/time based rolling. The default + implementation uses the underlying value of DateTime.Now. + - - The date pattern. By default, the pattern is set to ".yyyy-MM-dd" - meaning daily rollover. - + + The date pattern. By default, the pattern is set to ".yyyy-MM-dd" + meaning daily rollover. + - - The actual formatted filename that is currently being written to - or will be the file transferred to on roll over - (based on staticLogFileName). - + + The actual formatted filename that is currently being written to + or will be the file transferred to on roll over + (based on staticLogFileName). + - - The timestamp when we shall next recompute the filename. - + + The timestamp when we shall next recompute the filename. + - - Holds date of last roll over - + + Holds date of last roll over + - - The type of rolling done - + + The type of rolling done + - - The default maximum file size is 10MB - + + The default maximum file size is 10MB + - - There is zero backup files by default - + + There is zero backup files by default + - - How many sized based backups have been made so far - + + How many sized based backups have been made so far + - - The rolling file count direction. - + + The rolling file count direction. + - - The rolling mode used in this appender. - + + The rolling mode used in this appender. + - - Cache flag set if we are rolling by date. - + + Cache flag set if we are rolling by date. + - - Cache flag set if we are rolling by size. - + + Cache flag set if we are rolling by size. + - - Value indicating whether to always log to the same file. - + + Value indicating whether to always log to the same file. + + + + + Value indicating whether to preserve the file name extension when rolling. + - - FileName provided in configuration. Used for rolling properly - + + FileName provided in configuration. Used for rolling properly + + + The 1st of January 1970 in UTC + + + - The 1st of January 1970 in UTC + Gets or sets the strategy for determining the current date and time. The default + implementation is to use LocalDateTime which internally calls through to DateTime.Now. + DateTime.UtcNow may be used on frameworks newer than .NET 1.0 by specifying + . + + An implementation of the interface which returns the current date and time. + + + + Gets or sets the used to return the current date and time. + + + There are two built strategies for determining the current date and time, + + and . + + + The default strategy is . + + @@ -6878,113 +7256,129 @@ + + + Gets or sets a value indicating whether to preserve the file name extension when rolling. + + + true if the file name extension should be preserved. + + + + By default file.log is rolled to file.log.yyyy-MM-dd or file.log.curSizeRollBackup. + However, under Windows the new file name will loose any program associations as the + extension is changed. Optionally file.log can be renamed to file.yyyy-MM-dd.log or + file.curSizeRollBackup.log to maintain any program associations. + + + - - Gets or sets a value indicating whether to always log to - the same file. - - - true if always should be logged to the same file, otherwise false. - - - - By default file.log is always the current file. Optionally - file.log.yyyy-mm-dd for current formatted datePattern can by the currently - logging file (or file.log.curSizeRollBackup or even - file.log.yyyy-mm-dd.curSizeRollBackup). - - - This will make time based rollovers with a large number of backups - much faster as the appender it won't have to rename all the backups! - - + + Gets or sets a value indicating whether to always log to + the same file. + + + true if always should be logged to the same file, otherwise false. + + + + By default file.log is always the current file. Optionally + file.log.yyyy-mm-dd for current formatted datePattern can by the currently + logging file (or file.log.curSizeRollBackup or even + file.log.yyyy-mm-dd.curSizeRollBackup). + + + This will make time based rollovers with a large number of backups + much faster as the appender it won't have to rename all the backups! + + - - Style of rolling to use - - - - Style of rolling to use - - + + Style of rolling to use + + + + Style of rolling to use + + - - Roll files once per program execution - - - - Roll files once per program execution. - Well really once each time this appender is - configured. - - - Setting this option also sets AppendToFile to - false on the RollingFileAppender, otherwise - this appender would just be a normal file appender. - - + + Roll files once per program execution + + + + Roll files once per program execution. + Well really once each time this appender is + configured. + + + Setting this option also sets AppendToFile to + false on the RollingFileAppender, otherwise + this appender would just be a normal file appender. + + - - Roll files based only on the size of the file - + + Roll files based only on the size of the file + - - Roll files based only on the date - + + Roll files based only on the date + - - Roll files based on both the size and date of the file - + + Roll files based on both the size and date of the file + - - The code assumes that the following 'time' constants are in a increasing sequence. - - - - The code assumes that the following 'time' constants are in a increasing sequence. - - + + The code assumes that the following 'time' constants are in a increasing sequence. + + + + The code assumes that the following 'time' constants are in a increasing sequence. + + - - Roll the log not based on the date - + + Roll the log not based on the date + - - Roll the log for each minute - + + Roll the log for each minute + - - Roll the log for each hour - + + Roll the log for each hour + - - Roll the log twice a day (midday and midnight) - + + Roll the log twice a day (midday and midnight) + - - Roll the log each day (midnight) - + + Roll the log each day (midnight) + - - Roll the log each week - + + Roll the log each week + - - Roll the log each month - + + Roll the log each month + @@ -6997,31 +7391,47 @@ - - Gets the current time. - - The current time. - - - Gets the current time. - - - - + + Gets the current time. + + The current time. + + + Gets the current time. + + + + Default implementation of that returns the current time. - + + + Gets the current time. + + The current time. + + + Gets the current time. + + + + - Gets the current time. + Implementation of that returns the current time as the coordinated universal time (UTC). - The current time. - - - Gets the current time. - - + + + + Gets the current time. + + The current time. + + + Gets the current time. + + @@ -7058,118 +7468,162 @@ Gert Driesen - - Default constructor - - - - Default constructor - - + + Default constructor + + + + Default constructor + + - - Sends the contents of the cyclic buffer as an e-mail message. - - The logging events to send. + + Sends the contents of the cyclic buffer as an e-mail message. + + The logging events to send. - - Send the email message - - the body text to include in the mail + + Send the email message + + the body text to include in the mail + + Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses (use semicolon on .NET 1.1 and comma for later versions). + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + + Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses + that will be carbon copied (use semicolon on .NET 1.1 and comma for later versions). + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + + Gets or sets a semicolon-delimited list of recipient e-mail addresses + that will be blind carbon copied. + + + A semicolon-delimited list of e-mail addresses. + + + + A semicolon-delimited list of recipient e-mail addresses. + + + + + + Gets or sets the e-mail address of the sender. + + + The e-mail address of the sender. + + + + The e-mail address of the sender. + + + + + + Gets or sets the subject line of the e-mail message. + + + The subject line of the e-mail message. + + + + The subject line of the e-mail message. + + + + + + Gets or sets the name of the SMTP relay mail server to use to send + the e-mail messages. + + + The name of the e-mail relay server. If SmtpServer is not set, the + name of the local SMTP server is used. + + + + The name of the e-mail relay server. If SmtpServer is not set, the + name of the local SMTP server is used. + + + + + + Obsolete + + + Use the BufferingAppenderSkeleton Fix methods instead + + + + Obsolete property. + + + + - Gets or sets a semicolon-delimited list of recipient e-mail addresses. + The mode to use to authentication with the SMTP server - - A semicolon-delimited list of e-mail addresses. - + Authentication is only available on the MS .NET 1.1 runtime. - A semicolon-delimited list of recipient e-mail addresses. + Valid Authentication mode values are: , + , and . + The default value is . When using + you must specify the + and to use to authenticate. + When using the Windows credentials for the current + thread, if impersonating, or the process will be used to authenticate. - + - Gets or sets the e-mail address of the sender. + The username to use to authenticate with the SMTP server - - The e-mail address of the sender. - - - The e-mail address of the sender. - - - - - - Gets or sets the subject line of the e-mail message. - - - The subject line of the e-mail message. - - - - The subject line of the e-mail message. - - - - - - Gets or sets the name of the SMTP relay mail server to use to send - the e-mail messages. - - - The name of the e-mail relay server. If SmtpServer is not set, the - name of the local SMTP server is used. - - - - The name of the e-mail relay server. If SmtpServer is not set, the - name of the local SMTP server is used. - - - - - - Obsolete - - - Use the BufferingAppenderSkeleton Fix methods instead - - - - Obsolete property. - - - - - - The mode to use to authentication with the SMTP server - - - Authentication is only available on the MS .NET 1.1 runtime. - - Valid Authentication mode values are: , - , and . - The default value is . When using - you must specify the - and to use to authenticate. - When using the Windows credentials for the current - thread, if impersonating, or the process will be used to authenticate. - - - - - - The username to use to authenticate with the SMTP server - - - Authentication is only available on the MS .NET 1.1 runtime. + Authentication is only available on the MS .NET 1.1 runtime. A and must be specified when is set to , @@ -7191,17 +7645,17 @@ - - The port on which the SMTP server is listening - - - Server Port is only available on the MS .NET 1.1 runtime. - - The port on which the SMTP server is listening. The default - port is 25. The Port can only be changed when running on - the MS .NET 1.1 runtime. - - + + The port on which the SMTP server is listening + + + Server Port is only available on the MS .NET 1.1 runtime. + + The port on which the SMTP server is listening. The default + port is 25. The Port can only be changed when running on + the MS .NET 1.1 runtime. + + @@ -7221,6 +7675,22 @@ + + + Gets or sets the subject encoding to be used. + + + The default encoding is the operating system's current ANSI codepage. + + + + + Gets or sets the body encoding to be used. + + + The default encoding is the operating system's current ANSI codepage. + + This appender requires a to be set. @@ -7243,25 +7713,25 @@ - - No authentication - + + No authentication + - - Basic authentication. - - - Requires a username and password to be supplied - + + Basic authentication. + + + Requires a username and password to be supplied + - - Integrated authentication - - - Uses the Windows credentials from the current thread or process to authenticate. - + + Integrated authentication + + + Uses the Windows credentials from the current thread or process to authenticate. + @@ -7289,25 +7759,25 @@ Nicko Cadell - - Default constructor - - - - Default constructor - - + + Default constructor + + + + Default constructor + + - - Sends the contents of the cyclic buffer as an e-mail message. - - The logging events to send. - - - Sends the contents of the cyclic buffer as an e-mail message. - - + + Sends the contents of the cyclic buffer as an e-mail message. + + The logging events to send. + + + Sends the contents of the cyclic buffer as an e-mail message. + + @@ -7328,74 +7798,74 @@ - - Convert a path into a fully qualified path. - - The path to convert. - The fully qualified path. - - - Converts the path specified to a fully - qualified path. If the path is relative it is - taken as relative from the application base - directory. - - + + Convert a path into a fully qualified path. + + The path to convert. + The fully qualified path. + + + Converts the path specified to a fully + qualified path. If the path is relative it is + taken as relative from the application base + directory. + + - - The security context to use for privileged calls - + + The security context to use for privileged calls + - - Gets or sets a semicolon-delimited list of recipient e-mail addresses. - - - A semicolon-delimited list of e-mail addresses. - - - - A semicolon-delimited list of e-mail addresses. - - + + Gets or sets a semicolon-delimited list of recipient e-mail addresses. + + + A semicolon-delimited list of e-mail addresses. + + + + A semicolon-delimited list of e-mail addresses. + + - - Gets or sets the e-mail address of the sender. - - - The e-mail address of the sender. - - - - The e-mail address of the sender. - - + + Gets or sets the e-mail address of the sender. + + + The e-mail address of the sender. + + + + The e-mail address of the sender. + + - - Gets or sets the subject line of the e-mail message. - - - The subject line of the e-mail message. - - - - The subject line of the e-mail message. - - + + Gets or sets the subject line of the e-mail message. + + + The subject line of the e-mail message. + + + + The subject line of the e-mail message. + + - - Gets or sets the path to write the messages to. - - - - Gets or sets the path to write the messages to. This should be the same - as that used by the agent sending the messages. - - + + Gets or sets the path to write the messages to. + + + + Gets or sets the path to write the messages to. This should be the same + as that used by the agent sending the messages. + + @@ -7444,24 +7914,33 @@ Nicko Cadell - - Default constructor - - - - Default constructor - - + + Default constructor + + + + Default constructor + + + + + + The fully qualified type of the TelnetAppender class. + + + Used by the internal logger to record the Type of the + log message. + - - Overrides the parent method to close the socket handler - - - - Closes all the outstanding connections. - - + + Overrides the parent method to close the socket handler + + + + Closes all the outstanding connections. + + @@ -7485,15 +7964,15 @@ - - Writes the logging event to each connected client. - - The event to log. - - - Writes the logging event to each connected client. - - + + Writes the logging event to each connected client. + + The event to log. + + + Writes the logging event to each connected client. + + @@ -7523,97 +8002,97 @@ - - Helper class to manage connected clients - - - - The SocketHandler class is used to accept connections from - clients. It is threaded so that clients can connect/disconnect - asynchronously. - - + + Helper class to manage connected clients + + + + The SocketHandler class is used to accept connections from + clients. It is threaded so that clients can connect/disconnect + asynchronously. + + - - Opens a new server port on - - the local port to listen on for connections - - - Creates a socket handler on the specified local server port. - - + + Opens a new server port on + + the local port to listen on for connections + + + Creates a socket handler on the specified local server port. + + - - Sends a string message to each of the connected clients - - the text to send - - - Sends a string message to each of the connected clients - - + + Sends a string message to each of the connected clients + + the text to send + + + Sends a string message to each of the connected clients + + - - Add a client to the internal clients list - - client to add + + Add a client to the internal clients list + + client to add - - Remove a client from the internal clients list - - client to remove + + Remove a client from the internal clients list + + client to remove - - Callback used to accept a connection on the server socket - - The result of the asynchronous operation - - - On connection adds to the list of connections - if there are two many open connections you will be disconnected - - + + Callback used to accept a connection on the server socket + + The result of the asynchronous operation + + + On connection adds to the list of connections + if there are two many open connections you will be disconnected + + - - Close all network connections - - - - Make sure we close all network connections - - + + Close all network connections + + + + Make sure we close all network connections + + - - Test if this handler has active connections - - - true if this handler has active connections - - - - This property will be true while this handler has - active connections, that is at least one connection that - the handler will attempt to send a message to. - - + + Test if this handler has active connections + + + true if this handler has active connections + + + + This property will be true while this handler has + active connections, that is at least one connection that + the handler will attempt to send a message to. + + - - Class that represents a client connected to this handler - - - - Class that represents a client connected to this handler - - + + Class that represents a client connected to this handler + + + + Class that represents a client connected to this handler + + @@ -7627,25 +8106,25 @@ - - Write a string to the client - - string to send - - - Write a string to the client - - + + Write a string to the client + + string to send + + + Write a string to the client + + - - Cleanup the clients connection - - - - Close the socket connection. - - + + Cleanup the clients connection + + + + Close the socket connection. + + @@ -7660,7 +8139,8 @@ Events are written using the System.Diagnostics.Trace.Write(string,string) - method. The event's logger name is passed as the value for the category name to the Write method. + method. The event's logger name is the default value for the category parameter + of the Write method. Compact Framework
@@ -7673,6 +8153,7 @@ Douglas de la Torre Nicko Cadell Gert Driesen + Ron Grabowski @@ -7724,24 +8205,42 @@ The default value is true. + + + Defaults to %logger + + + + Gets or sets a value that indicates whether the appender will + flush at the end of each write. + + + The default behavior is to flush at the end of each + write. If the option is set tofalse, then the underlying + stream can defer writing to physical medium to a later time. + + + Avoiding the flush operation at the end of each append results + in a performance gain of 10 to 20 percent. However, there is safety + trade-off involved in skipping flushing. Indeed, when flushing is + skipped, then it is likely that the last few log events will not + be recorded on disk when the application exits. This is a high + price to pay even for a 20% performance gain. + + + + - Gets or sets a value that indicates whether the appender will - flush at the end of each write. + The category parameter sent to the Trace method. - The default behavior is to flush at the end of each - write. If the option is set tofalse, then the underlying - stream can defer writing to physical medium to a later time. - - Avoiding the flush operation at the end of each append results - in a performance gain of 10 to 20 percent. However, there is safety - trade-off involved in skipping flushing. Indeed, when flushing is - skipped, then it is likely that the last few log events will not - be recorded on disk when the application exits. This is a high - price to pay even for a 20% performance gain. + Defaults to %logger which will use the logger name of the current + as the category parameter. + + @@ -7814,17 +8313,17 @@ - - Gets or sets the repository to alias to this assemby's repository. - - - The repository to alias to this assemby's repository. - - - - The name of the repository to alias to this assemby's repository. - - + + Gets or sets the repository to alias to this assemby's repository. + + + The repository to alias to this assemby's repository. + + + + The name of the repository to alias to this assemby's repository. + + @@ -7853,13 +8352,22 @@ Appenders can also implement the interface. Therefore - they would require that the method + they would require that the method be called after the appenders properties have been configured. Nicko Cadell Gert Driesen + + + The fully qualified type of the BasicConfigurator class. + + + Used by the internal logger to record the Type of the + log message. + + Initializes a new instance of the class. @@ -7885,15 +8393,26 @@ - - Initializes the log4net system using the specified appender. - - The appender to use to log all logging events. - - - Initializes the log4net system using the specified appender. - - + + Initializes the log4net system using the specified appender. + + The appender to use to log all logging events. + + + Initializes the log4net system using the specified appender. + + + + + + Initializes the log4net system using the specified appenders. + + The appenders to use to log all logging events. + + + Initializes the log4net system using the specified appenders. + + @@ -7922,32 +8441,44 @@ - - - Base class for all log4net configuration attributes. - - - This is an abstract class that must be extended by - specific configurators. This attribute allows the - configurator to be parameterized by an assembly level - attribute. - - Nicko Cadell - Gert Driesen - - + - Constructor used by subclasses. + Initializes the using the specified appenders. - the ordering priority for this configurator + The repository to configure. + The appenders to use to log all logging events. - The is used to order the configurator - attributes before they are invoked. Higher priority configurators are executed - before lower priority ones. + Initializes the using the specified appender. + + + Base class for all log4net configuration attributes. + + + This is an abstract class that must be extended by + specific configurators. This attribute allows the + configurator to be parameterized by an assembly level + attribute. + + Nicko Cadell + Gert Driesen + + + + Constructor used by subclasses. + + the ordering priority for this configurator + + + The is used to order the configurator + attributes before they are invoked. Higher priority configurators are executed + before lower priority ones. + + + Configures the for the specified assembly. @@ -8045,19 +8576,19 @@ - - Gets or sets the name of the logging repository. - - - The string name to use as the name of the repository associated with this - assembly. - - - - This value does not have to be unique. Several assemblies can share the - same repository. They will share the logging configuration of the repository. - - + + Gets or sets the name of the logging repository. + + + The string name to use as the name of the repository associated with this + assembly. + + + + This value does not have to be unique. Several assemblies can share the + same repository. They will share the logging configuration of the repository. + + @@ -8119,25 +8650,25 @@ Gert Driesen - - Private constructor - + + Private constructor + - - Automatically configures the log4net system based on the - application's configuration settings. - - - - DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. - - Each application has a configuration file. This has the - same name as the application with '.config' appended. - This file is XML and calling this function prompts the - configurator to look in that file for a section called - log4net that contains the configuration data. - + + Automatically configures the log4net system based on the + application's configuration settings. + + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + Each application has a configuration file. This has the + same name as the application with '.config' appended. + This file is XML and calling this function prompts the + configurator to look in that file for a section called + log4net that contains the configuration data. + @@ -8157,17 +8688,17 @@ The repository to configure. - - Configures log4net using a log4net element - - - - DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. - - Loads the log4net configuration from the XML element - supplied as . - - The element to parse. + + Configures log4net using a log4net element + + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + Loads the log4net configuration from the XML element + supplied as . + + The element to parse. @@ -8185,67 +8716,67 @@ The element to parse. - - Configures log4net using the specified configuration file. - - The XML file to load the configuration from. - - - DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. - - - The configuration file must be valid XML. It must contain - at least one element called log4net that holds - the log4net configuration data. - - - The log4net configuration file can possible be specified in the application's - configuration file (either MyAppName.exe.config for a - normal application on Web.config for an ASP.NET application). - - - The following example configures log4net using a configuration file, of which the - location is stored in the application's configuration file : - - - using log4net.Config; - using System.IO; - using System.Configuration; - - ... - - DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); - - - In the .config file, the path to the log4net can be specified like this : - - - - - - - - - + + Configures log4net using the specified configuration file. + + The XML file to load the configuration from. + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + + The configuration file must be valid XML. It must contain + at least one element called log4net that holds + the log4net configuration data. + + + The log4net configuration file can possible be specified in the application's + configuration file (either MyAppName.exe.config for a + normal application on Web.config for an ASP.NET application). + + + The following example configures log4net using a configuration file, of which the + location is stored in the application's configuration file : + + + using log4net.Config; + using System.IO; + using System.Configuration; + + ... + + DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); + + + In the .config file, the path to the log4net can be specified like this : + + + + + + + + + - - Configures log4net using the specified configuration file. - - A stream to load the XML configuration from. - - - DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. - - - The configuration data must be valid XML. It must contain - at least one element called log4net that holds - the log4net configuration data. - - - Note that this method will NOT close the stream parameter. - - + + Configures log4net using the specified configuration file. + + A stream to load the XML configuration from. + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + + The configuration data must be valid XML. It must contain + at least one element called log4net that holds + the log4net configuration data. + + + Note that this method will NOT close the stream parameter. + + @@ -8335,10 +8866,10 @@ For more information on how to configure log4net using - a separate configuration file, see . + a separate configuration file, see . - + @@ -8363,10 +8894,10 @@ For more information on how to configure log4net using - a separate configuration file, see . + a separate configuration file, see . - + @@ -8382,7 +8913,7 @@ Use this attribute to configure the - without calling one of the + without calling one of the methods. @@ -8400,7 +8931,7 @@ Use this attribute to configure the - without calling one of the + without calling one of the methods. @@ -8431,7 +8962,7 @@ If you cannot guarantee the order in which log4net calls will be made from different assemblies you must use programmatic configuration instead, i.e. - call the method directly. + call the method directly. @@ -8439,14 +8970,14 @@ Gert Driesen - - Default constructor - - - - Default constructor - - + + Default constructor + + + + Default constructor + + @@ -8462,14 +8993,14 @@ configure it. - The does not extend . + The does not extend . - - Attempt to load configuration from the local file system - - The assembly that this attribute was defined on. - The repository to configure. + + Attempt to load configuration from the local file system + + The assembly that this attribute was defined on. + The repository to configure. @@ -8479,11 +9010,20 @@ the FileInfo pointing to the config file - - Attempt to load configuration from a URI - - The assembly that this attribute was defined on. - The repository to configure. + + Attempt to load configuration from a URI + + The assembly that this attribute was defined on. + The repository to configure. + + + + The fully qualified type of the XmlConfiguratorAttribute class. + + + Used by the internal logger to record the Type of the + log message. + @@ -8528,53 +9068,53 @@ - - Gets or sets a value indicating whether to watch the configuration file. - - - true if the configuration should be watched, false otherwise. - - - - If this flag is specified and set to true then the framework - will watch the configuration file and will reload the config each time - the file is modified. - - - The config file can only be watched if it is loaded from local disk. - In a No-Touch (Smart Client) deployment where the application is downloaded - from a web server the config file may not reside on the local disk - and therefore it may not be able to watch it. - - - Watching configuration is not supported on the SSCLI. - - + + Gets or sets a value indicating whether to watch the configuration file. + + + true if the configuration should be watched, false otherwise. + + + + If this flag is specified and set to true then the framework + will watch the configuration file and will reload the config each time + the file is modified. + + + The config file can only be watched if it is loaded from local disk. + In a No-Touch (Smart Client) deployment where the application is downloaded + from a web server the config file may not reside on the local disk + and therefore it may not be able to watch it. + + + Watching configuration is not supported on the SSCLI. + + - - Class to register for the log4net section of the configuration file - - - The log4net section of the configuration file needs to have a section - handler registered. This is the section handler used. It simply returns - the XML element that is the root of the section. - - - Example of registering the log4net section handler : - - - -
- - - log4net configuration XML goes here - - - - - Nicko Cadell - Gert Driesen + + Class to register for the log4net section of the configuration file + + + The log4net section of the configuration file needs to have a section + handler registered. This is the section handler used. It simply returns + the XML element that is the root of the section. + + + Example of registering the log4net section handler : + + + +
+ + + log4net configuration XML goes here + + + + + Nicko Cadell + Gert Driesen @@ -8616,27 +9156,27 @@ Gert Driesen - - Interface used to create plugins. - - - - Interface used to create a plugin. - - - Nicko Cadell - Gert Driesen + + Interface used to create plugins. + + + + Interface used to create a plugin. + + + Nicko Cadell + Gert Driesen - - Creates the plugin object. - - the new plugin instance - - - Create and return a new plugin instance. - - + + Creates the plugin object. + + the new plugin instance + + + Create and return a new plugin instance. + + @@ -8678,29 +9218,29 @@ The plugin object. - - Returns a representation of the properties of this object. - - - - Overrides base class method to - return a representation of the properties of this object. - - - A representation of the properties of this object + + Returns a representation of the properties of this object. + + + + Overrides base class method to + return a representation of the properties of this object. + + + A representation of the properties of this object - - Gets or sets the type for the plugin. - - - The type for the plugin. - - - - The type for the plugin. - - + + Gets or sets the type for the plugin. + + + The type for the plugin. + + + + The type for the plugin. + + @@ -8729,7 +9269,7 @@ Use this attribute to configure the - without calling one of the + without calling one of the methods. @@ -8760,6 +9300,15 @@ + + + The fully qualified type of the SecurityContextProviderAttribute class. + + + Used by the internal logger to record the Type of the + log message. + + Gets or sets the type of the provider to use. @@ -8787,9 +9336,9 @@ Gert Driesen - - Private constructor - + + Private constructor + @@ -8836,16 +9385,16 @@ The repository to configure. - - Configures log4net using a log4net element - - - - Loads the log4net configuration from the XML element - supplied as . - - - The element to parse. + + Configures log4net using a log4net element + + + + Loads the log4net configuration from the XML element + supplied as . + + + The element to parse. @@ -8928,20 +9477,20 @@ - - Configures log4net using the specified configuration data stream. - - A stream to load the XML configuration from. - - - The configuration data must be valid XML. It must contain - at least one element called log4net that holds - the log4net configuration data. - - - Note that this method will NOT close the stream parameter. - - + + Configures log4net using the specified configuration data stream. + + A stream to load the XML configuration from. + + + The configuration data must be valid XML. It must contain + at least one element called log4net that holds + the log4net configuration data. + + + Note that this method will NOT close the stream parameter. + + @@ -9051,10 +9600,10 @@ For more information on how to configure log4net using - a separate configuration file, see . + a separate configuration file, see . - + @@ -9076,12 +9625,12 @@ For more information on how to configure log4net using - a separate configuration file, see . + a separate configuration file, see . - + - + Configures the specified repository using a log4net element. @@ -9098,6 +9647,22 @@ + + + Maps repository names to ConfigAndWatchHandler instances to allow a particular + ConfigAndWatchHandler to dispose of its FileSystemWatcher when a repository is + reconfigured. + + + + + The fully qualified type of the XmlConfigurator class. + + + Used by the internal logger to record the Type of the + log message. + + Class used to watch config files. @@ -9117,41 +9682,36 @@ - - The default amount of time to wait after receiving notification - before reloading the config file. - - - - - Watch a specified config file used to configure a repository - - The repository to configure. - The configuration file to watch. - - - Watch a specified config file used to configure a repository - - + + The default amount of time to wait after receiving notification + before reloading the config file. + - - Holds the FileInfo used to configure the XmlConfigurator - + + Holds the FileInfo used to configure the XmlConfigurator + - - Holds the repository being configured. - + + Holds the repository being configured. + - - The timer used to compress the notification events. - + + The timer used to compress the notification events. + + + + + Watches file for changes. This object should be disposed when no longer + needed to free system handles on the watched resources. + - Initializes a new instance of the class. + Initializes a new instance of the class to + watch a specified config file used to configure a repository. The repository to configure. The configuration file to watch. @@ -9186,10 +9746,15 @@ - - Called by the timer when the configuration has been updated. - - null + + Called by the timer when the configuration has been updated. + + null + + + + Release the handles held by the watcher and timer. + @@ -9251,7 +9816,7 @@ The named Lookup a named . This is the repository created by - calling . + calling . @@ -9264,7 +9829,7 @@ The created will be associated with the domain - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -9284,24 +9849,24 @@ The created will be associated with the name - specified such that a call to with the + specified such that a call to with the same name will return the same repository instance. - - Test if a named repository exists - - the named repository to check - true if the repository exists - - - Test if a named repository exists. Use - to create a new repository and to retrieve - a repository. - - + + Test if a named repository exists + + the named repository to check + true if the repository exists + + + Test if a named repository exists. Use + to create a new repository and to retrieve + a repository. + + @@ -9374,7 +9939,7 @@ Get the named . The default repository is log4net-default-repository. Other repositories - must be created using the . + must be created using the . If the named repository does not exist an exception is thrown. @@ -9414,7 +9979,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same repository specified will return the same repository instance. @@ -9429,18 +9994,18 @@ throw if the already exists - - Test if a named repository exists - - the named repository to check - true if the repository exists - - - Test if a named repository exists. Use - to create a new repository and to retrieve - a repository. - - + + Test if a named repository exists + + the named repository to check + true if the repository exists + + + Test if a named repository exists. Use + to create a new repository and to retrieve + a repository. + + @@ -9453,6 +10018,15 @@ + + + The fully qualified type of the CompactRepositorySelector class. + + + Used by the internal logger to record the Type of the + log message. + + Notify the registered listeners that the repository has been created @@ -9547,7 +10121,7 @@ does not exist a is thrown. - Use to create a repository. + Use to create a repository. is . @@ -9563,7 +10137,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -9603,7 +10177,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -9642,7 +10216,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same repository specified will return the same repository instance. @@ -9650,18 +10224,18 @@ already exists. - - Test if a named repository exists - - the named repository to check - true if the repository exists - - - Test if a named repository exists. Use - to create a new repository and to retrieve - a repository. - - + + Test if a named repository exists + + the named repository to check + true if the repository exists + + + Test if a named repository exists. Use + to create a new repository and to retrieve + a repository. + + @@ -9753,6 +10327,15 @@ is . + + + The fully qualified type of the DefaultRepositorySelector class. + + + Used by the internal logger to record the Type of the + log message. + + Event to notify that a logger repository has been created. @@ -9770,102 +10353,190 @@ - - Defined error codes that can be passed to the method. - - - - Values passed to the method. - - - Nicko Cadell + + Defined error codes that can be passed to the method. + + + + Values passed to the method. + + + Nicko Cadell - - A general error - + + A general error + - - Error while writing output - + + Error while writing output + - - Failed to flush file - + + Failed to flush file + - - Failed to close file - + + Failed to close file + - - Unable to open output file - + + Unable to open output file + - - No layout specified - + + No layout specified + - - Failed to parse address - + + Failed to parse address + - + - Appenders may delegate their error handling to an . + An evaluator that triggers on an Exception type - Error handling is a particularly tedious to get right because by - definition errors are hard to predict and to reproduce. + This evaluator will trigger if the type of the Exception + passed to + is equal to a Type in . /// - Nicko Cadell - Gert Driesen + Drew Schaeffer - + - Handles the error and information about the error condition is passed as - a parameter. + Test if an triggers an action - The message associated with the error. - The that was thrown when the error occurred. - The error code associated with the error. - Handles the error and information about the error condition is passed as - a parameter. - + Implementations of this interface allow certain appenders to decide + when to perform an appender specific action. + + + The action or behavior triggered is defined by the implementation. + + Nicko Cadell - + + + Test if this event triggers the action + + The event to check + true if this event triggers the action, otherwise false + + + Return true if this event triggers the action + + + + + + The type that causes the trigger to fire. + + + - Prints the error message passed as a parameter. + Causes subclasses of to cause the trigger to fire. + + + + + Default ctor to allow dynamic creation through a configurator. + + + + + Constructs an evaluator and initializes to trigger on + + the type that triggers this evaluator. + If true, this evaluator will trigger on subclasses of . + + + + Is this the triggering event? + + The event to check + This method returns true, if the logging event Exception + Type is . + Otherwise it returns false + + + This evaluator will trigger if the Exception Type of the event + passed to + is . + + + + + + The type that triggers this evaluator. + + + + + If true, this evaluator will trigger on subclasses of . + + + + + Appenders may delegate their error handling to an . + + + + Error handling is a particularly tedious to get right because by + definition errors are hard to predict and to reproduce. + + + Nicko Cadell + Gert Driesen + + + + Handles the error and information about the error condition is passed as + a parameter. The message associated with the error. The that was thrown when the error occurred. + The error code associated with the error. - See . + Handles the error and information about the error condition is passed as + a parameter. - + Prints the error message passed as a parameter. The message associated with the error. + The that was thrown when the error occurred. - See . + See . + + + Prints the error message passed as a parameter. + + The message associated with the error. + + + See . + + + Interface for objects that require fixing. @@ -9888,63 +10559,63 @@ Nicko Cadell - - Get a portable version of this object - - the portable instance of this object - - - Get a portable instance object that represents the current - state of this object. The portable object can be stored - and logged from any thread with identical results. - - + + Get a portable version of this object + + the portable instance of this object + + + Get a portable instance object that represents the current + state of this object. The portable object can be stored + and logged from any thread with identical results. + + - - Interface that all loggers implement - - - - This interface supports logging events and testing if a level - is enabled for logging. - - - These methods will not throw exceptions. Note to implementor, ensure - that the implementation of these methods cannot allow an exception - to be thrown to the caller. - - - Nicko Cadell - Gert Driesen + + Interface that all loggers implement + + + + This interface supports logging events and testing if a level + is enabled for logging. + + + These methods will not throw exceptions. Note to implementor, ensure + that the implementation of these methods cannot allow an exception + to be thrown to the caller. + + + Nicko Cadell + Gert Driesen - - This generic form is intended to be used by wrappers. - - The declaring type of the method that is - the stack boundary into the logging system for this call. - The level of the message to be logged. - The message object to log. - the exception to log, including its stack trace. Pass null to not log an exception. - - - Generates a logging event for the specified using - the and . - - + + This generic form is intended to be used by wrappers. + + The declaring type of the method that is + the stack boundary into the logging system for this call. + The level of the message to be logged. + The message object to log. + the exception to log, including its stack trace. Pass null to not log an exception. + + + Generates a logging event for the specified using + the and . + + - - This is the most generic printing method that is intended to be used - by wrappers. - - The event being logged. - - - Logs the specified logging event through this logger. - - + + This is the most generic printing method that is intended to be used + by wrappers. + + The event being logged. + + + Logs the specified logging event through this logger. + + @@ -9961,17 +10632,17 @@ - - Gets the name of the logger. - - - The name of the logger. - - - - The name of this logger - - + + Gets the name of the logger. + + + The name of the logger. + + + + The name of this logger + + @@ -9989,18 +10660,18 @@ - - Base interface for all wrappers - - - - Base interface for all wrappers. - - - All wrappers must implement this interface. - - - Nicko Cadell + + Base interface for all wrappers + + + + Base interface for all wrappers. + + + All wrappers must implement this interface. + + + Nicko Cadell @@ -10072,33 +10743,6 @@ - - - Test if an triggers an action - - - - Implementations of this interface allow certain appenders to decide - when to perform an appender specific action. - - - The action or behavior triggered is defined by the implementation. - - - Nicko Cadell - - - - Test if this event triggers the action - - The event to check - true if this event triggers the action, otherwise false - - - Return true if this event triggers the action - - - Defines the default set of levels recognized by the system. @@ -10410,6 +11054,12 @@ The level designates a higher level than all the rest. + + + The level designates very severe error events. + System unusable, emergencies. + + The level designates very severe error events. @@ -10505,43 +11155,43 @@ - - Gets the name of this level. - - - The name of this level. - - - - Gets the name of this level. - - + + Gets the name of this level. + + + The name of this level. + + + + Gets the name of this level. + + - - Gets the value of this level. - - - The value of this level. - - - - Gets the value of this level. - - + + Gets the value of this level. + + + The value of this level. + + + + Gets the value of this level. + + - - Gets the display name of this level. - - - The display name of this level. - - - - Gets the display name of this level. - - + + Gets the display name of this level. + + + The display name of this level. + + + + Gets the display name of this level. + + @@ -10550,35 +11200,35 @@ Nicko Cadell - - Creates a read-only wrapper for a LevelCollection instance. - - list to create a readonly wrapper arround - - A LevelCollection wrapper that is read-only. - + + Creates a read-only wrapper for a LevelCollection instance. + + list to create a readonly wrapper arround + + A LevelCollection wrapper that is read-only. + - - Initializes a new instance of the LevelCollection class - that is empty and has the default initial capacity. - + + Initializes a new instance of the LevelCollection class + that is empty and has the default initial capacity. + - - Initializes a new instance of the LevelCollection class - that has the specified initial capacity. - - - The number of elements that the new LevelCollection is initially capable of storing. - + + Initializes a new instance of the LevelCollection class + that has the specified initial capacity. + + + The number of elements that the new LevelCollection is initially capable of storing. + - - Initializes a new instance of the LevelCollection class - that contains elements copied from the specified LevelCollection. - - The LevelCollection whose elements are copied to the new collection. + + Initializes a new instance of the LevelCollection class + that contains elements copied from the specified LevelCollection. + + The LevelCollection whose elements are copied to the new collection. @@ -10595,10 +11245,10 @@ The collection whose elements are copied to the new list. - - Allow subclasses to avoid our default constructors - - + + Allow subclasses to avoid our default constructors + + @@ -10623,9 +11273,9 @@ The index at which the value has been added. - - Removes all elements from the LevelCollection. - + + Removes all elements from the LevelCollection. + @@ -10711,39 +11361,39 @@ The new of the LevelCollection. - - Sets the capacity to the actual number of elements. - + + Sets the capacity to the actual number of elements. + - is less than zero + is less than zero -or- - is equal to or greater than . + is equal to or greater than . - is less than zero + is less than zero -or- - is equal to or greater than . + is equal to or greater than . - - Gets the number of elements actually contained in the LevelCollection. - + + Gets the number of elements actually contained in the LevelCollection. + - - Gets a value indicating whether access to the collection is synchronized (thread-safe). - - true if access to the ICollection is synchronized (thread-safe); otherwise, false. + + Gets a value indicating whether access to the collection is synchronized (thread-safe). + + true if access to the ICollection is synchronized (thread-safe); otherwise, false. - - Gets an object that can be used to synchronize access to the collection. - + + Gets an object that can be used to synchronize access to the collection. + @@ -10757,21 +11407,21 @@ - - Gets a value indicating whether the collection has a fixed size. - - true if the collection has a fixed size; otherwise, false. The default is false + + Gets a value indicating whether the collection has a fixed size. + + true if the collection has a fixed size; otherwise, false. The default is false - - Gets a value indicating whether the IList is read-only. - - true if the collection is read-only; otherwise, false. The default is false + + Gets a value indicating whether the IList is read-only. + + true if the collection is read-only; otherwise, false. The default is false - - Gets or sets the number of elements the LevelCollection can contain. - + + Gets or sets the number of elements the LevelCollection can contain. + @@ -10791,25 +11441,25 @@ - - Sets the enumerator to its initial position, before the first element in the collection. - + + Sets the enumerator to its initial position, before the first element in the collection. + - - Gets the current element in the collection. - + + Gets the current element in the collection. + - - Type visible only to our subclasses - Used to access protected constructor - + + Type visible only to our subclasses + Used to access protected constructor + - - A value - + + A value + @@ -10817,10 +11467,10 @@ - - Initializes a new instance of the Enumerator class. - - + + Initializes a new instance of the Enumerator class. + + @@ -10835,14 +11485,14 @@ - - Sets the enumerator to its initial position, before the first element in the collection. - + + Sets the enumerator to its initial position, before the first element in the collection. + - - Gets the current element in the collection. - + + Gets the current element in the collection. + @@ -10851,7 +11501,7 @@ This evaluator will trigger if the level of the event - passed to + passed to is equal to or greater than the level. @@ -10859,9 +11509,9 @@ Nicko Cadell - - The threshold for triggering - + + The threshold for triggering + @@ -10873,7 +11523,7 @@ This evaluator will trigger if the level of the event - passed to + passed to is equal to or greater than the level. @@ -10890,7 +11540,7 @@ This evaluator will trigger if the level of the event - passed to + passed to is equal to or greater than the level. @@ -10907,7 +11557,7 @@ This evaluator will trigger if the level of the event - passed to + passed to is equal to or greater than the level. @@ -10923,7 +11573,7 @@ This evaluator will trigger if the level of the event - passed to + passed to is equal to or greater than the level. @@ -10943,67 +11593,67 @@ Nicko Cadell - - Mapping from level name to Level object. The - level name is case insensitive - + + Mapping from level name to Level object. The + level name is case insensitive + - - Construct the level map - - - - Construct the level map. - - + + Construct the level map + + + + Construct the level map. + + - - Clear the internal maps of all levels - - - - Clear the internal maps of all levels - - + + Clear the internal maps of all levels + + + + Clear the internal maps of all levels + + - - Create a new Level and add it to the map - - the string to display for the Level - the level value to give to the Level - - - Create a new Level and add it to the map - - - + + Create a new Level and add it to the map + + the string to display for the Level + the level value to give to the Level + + + Create a new Level and add it to the map + + + - - Create a new Level and add it to the map - - the string to display for the Level - the level value to give to the Level - the display name to give to the Level - - - Create a new Level and add it to the map - - + + Create a new Level and add it to the map + + the string to display for the Level + the level value to give to the Level + the display name to give to the Level + + + Create a new Level and add it to the map + + - - Add a Level to the map - - the Level to add - - - Add a Level to the map - - + + Add a Level to the map + + the Level to add + + + Add a Level to the map + + @@ -11040,70 +11690,70 @@ + + Return all possible levels as a list of Level objects. + + all possible levels as a list of Level objects + + + Return all possible levels as a list of Level objects. + + + + + + The internal representation of caller location information. + + + + This class uses the System.Diagnostics.StackTrace class to generate + a call stack. The caller's information is then extracted from this stack. + + + The System.Diagnostics.StackTrace class is not supported on the + .NET Compact Framework 1.0 therefore caller location information is not + available on that framework. + + + The System.Diagnostics.StackTrace class has this to say about Release builds: + + + "StackTrace information will be most informative with Debug build configurations. + By default, Debug builds include debug symbols, while Release builds do not. The + debug symbols contain most of the file, method name, line number, and column + information used in constructing StackFrame and StackTrace objects. StackTrace + might not report as many method calls as expected, due to code transformations + that occur during optimization." + + + This means that in a Release build the caller information may be incomplete or may + not exist at all! Therefore caller location information cannot be relied upon in a Release build. + + + Nicko Cadell + Gert Driesen + + + + When location information is not available the constant + NA is returned. Current value of this string + constant is ?. + + + - Return all possible levels as a list of Level objects. + Constructor - all possible levels as a list of Level objects + The declaring type of the method that is + the stack boundary into the logging system for this call. - Return all possible levels as a list of Level objects. + Initializes a new instance of the + class based on the current thread. - - - The internal representation of caller location information. - - - - This class uses the System.Diagnostics.StackTrace class to generate - a call stack. The caller's information is then extracted from this stack. - - - The System.Diagnostics.StackTrace class is not supported on the - .NET Compact Framework 1.0 therefore caller location information is not - available on that framework. - - - The System.Diagnostics.StackTrace class has this to say about Release builds: - - - "StackTrace information will be most informative with Debug build configurations. - By default, Debug builds include debug symbols, while Release builds do not. The - debug symbols contain most of the file, method name, line number, and column - information used in constructing StackFrame and StackTrace objects. StackTrace - might not report as many method calls as expected, due to code transformations - that occur during optimization." - - - This means that in a Release build the caller information may be incomplete or may - not exist at all! Therefore caller location information cannot be relied upon in a Release build. - - - Nicko Cadell - Gert Driesen - - - - When location information is not available the constant - NA is returned. Current value of this string - constant is ?. - - - - - Constructor - - The declaring type of the method that is - the stack boundary into the logging system for this call. - - - Initializes a new instance of the - class based on the current thread. - - - - + Constructor @@ -11118,75 +11768,89 @@ + + + The fully qualified type of the LocationInfo class. + + + Used by the internal logger to record the Type of the + log message. + + - - Gets the fully qualified class name of the caller making the logging - request. - - - The fully qualified class name of the caller making the logging - request. - - - - Gets the fully qualified class name of the caller making the logging - request. - - + + Gets the fully qualified class name of the caller making the logging + request. + + + The fully qualified class name of the caller making the logging + request. + + + + Gets the fully qualified class name of the caller making the logging + request. + + - - Gets the file name of the caller. - - - The file name of the caller. - - - - Gets the file name of the caller. - - + + Gets the file name of the caller. + + + The file name of the caller. + + + + Gets the file name of the caller. + + - - Gets the line number of the caller. - - - The line number of the caller. - - - - Gets the line number of the caller. - - + + Gets the line number of the caller. + + + The line number of the caller. + + + + Gets the line number of the caller. + + - - Gets the method name of the caller. - - - The method name of the caller. - - - - Gets the method name of the caller. - - + + Gets the method name of the caller. + + + The method name of the caller. + + + + Gets the method name of the caller. + + - - Gets all available caller information - - - All available caller information, in the format - fully.qualified.classname.of.caller.methodName(Filename:line) - - - - Gets all available caller information, in the format - fully.qualified.classname.of.caller.methodName(Filename:line) - - + + Gets all available caller information + + + All available caller information, in the format + fully.qualified.classname.of.caller.methodName(Filename:line) + + + + Gets all available caller information, in the format + fully.qualified.classname.of.caller.methodName(Filename:line) + + + + + + Gets the stack frames from the stack trace of the caller making the log request + @@ -11212,40 +11876,40 @@ Gert Driesen - - Private constructor to prevent instances. Only static methods should be used. - - - - Private constructor to prevent instances. Only static methods should be used. - - + + Private constructor to prevent instances. Only static methods should be used. + + + + Private constructor to prevent instances. Only static methods should be used. + + - - Hook the shutdown event - - - - On the full .NET runtime, the static constructor hooks up the - AppDomain.ProcessExit and AppDomain.DomainUnload> events. - These are used to shutdown the log4net system as the application exits. - - + + Hook the shutdown event + + + + On the full .NET runtime, the static constructor hooks up the + AppDomain.ProcessExit and AppDomain.DomainUnload> events. + These are used to shutdown the log4net system as the application exits. + + - - Register for ProcessExit and DomainUnload events on the AppDomain - - - - This needs to be in a separate method because the events make - a LinkDemand for the ControlAppDomain SecurityPermission. Because - this is a LinkDemand it is demanded at JIT time. Therefore we cannot - catch the exception in the method itself, we have to catch it in the - caller. - - + + Register for ProcessExit and DomainUnload events on the AppDomain + + + + This needs to be in a separate method because the events make + a LinkDemand for the ControlAppDomain SecurityPermission. Because + this is a LinkDemand it is demanded at JIT time. Therefore we cannot + catch the exception in the method itself, we have to catch it in the + caller. + + @@ -11293,201 +11957,201 @@ - - Returns the named logger if it exists. - - The repository to lookup in. - The fully qualified logger name to look for. - - The logger found, or null if the named logger does not exist in the - specified repository. - - - - If the named logger exists (in the specified repository) then it - returns a reference to the logger, otherwise it returns - null. - - + + Returns the named logger if it exists. + + The repository to lookup in. + The fully qualified logger name to look for. + + The logger found, or null if the named logger does not exist in the + specified repository. + + + + If the named logger exists (in the specified repository) then it + returns a reference to the logger, otherwise it returns + null. + + - - Returns the named logger if it exists. - - The assembly to use to lookup the repository. - The fully qualified logger name to look for. - - The logger found, or null if the named logger does not exist in the - specified assembly's repository. - - - - If the named logger exists (in the specified assembly's repository) then it - returns a reference to the logger, otherwise it returns - null. - - + + Returns the named logger if it exists. + + The assembly to use to lookup the repository. + The fully qualified logger name to look for. + + The logger found, or null if the named logger does not exist in the + specified assembly's repository. + + + + If the named logger exists (in the specified assembly's repository) then it + returns a reference to the logger, otherwise it returns + null. + + - - Returns all the currently defined loggers in the specified repository. - - The repository to lookup in. - All the defined loggers. - - - The root logger is not included in the returned array. - - + + Returns all the currently defined loggers in the specified repository. + + The repository to lookup in. + All the defined loggers. + + + The root logger is not included in the returned array. + + - - Returns all the currently defined loggers in the specified assembly's repository. - - The assembly to use to lookup the repository. - All the defined loggers. - - - The root logger is not included in the returned array. - - + + Returns all the currently defined loggers in the specified assembly's repository. + + The assembly to use to lookup the repository. + All the defined loggers. + + + The root logger is not included in the returned array. + + - - Retrieves or creates a named logger. - - The repository to lookup in. - The name of the logger to retrieve. - The logger with the name specified. - - - Retrieves a logger named as the - parameter. If the named logger already exists, then the - existing instance will be returned. Otherwise, a new instance is - created. - - - By default, loggers do not have a set level but inherit - it from the hierarchy. This is one of the central features of - log4net. - - + + Retrieves or creates a named logger. + + The repository to lookup in. + The name of the logger to retrieve. + The logger with the name specified. + + + Retrieves a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + - - Retrieves or creates a named logger. - - The assembly to use to lookup the repository. - The name of the logger to retrieve. - The logger with the name specified. - - - Retrieves a logger named as the - parameter. If the named logger already exists, then the - existing instance will be returned. Otherwise, a new instance is - created. - - - By default, loggers do not have a set level but inherit - it from the hierarchy. This is one of the central features of - log4net. - - + + Retrieves or creates a named logger. + + The assembly to use to lookup the repository. + The name of the logger to retrieve. + The logger with the name specified. + + + Retrieves a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + - - Shorthand for . - - The repository to lookup in. - The of which the fullname will be used as the name of the logger to retrieve. - The logger with the name specified. - - - Gets the logger for the fully qualified name of the type specified. - - + + Shorthand for . + + The repository to lookup in. + The of which the fullname will be used as the name of the logger to retrieve. + The logger with the name specified. + + + Gets the logger for the fully qualified name of the type specified. + + - - Shorthand for . - - the assembly to use to lookup the repository - The of which the fullname will be used as the name of the logger to retrieve. - The logger with the name specified. - - - Gets the logger for the fully qualified name of the type specified. - - + + Shorthand for . + + the assembly to use to lookup the repository + The of which the fullname will be used as the name of the logger to retrieve. + The logger with the name specified. + + + Gets the logger for the fully qualified name of the type specified. + + - - Shuts down the log4net system. - - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in all the - default repositories. - - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - - The shutdown method is careful to close nested - appenders before closing regular appenders. This is allows - configurations where a regular appender is attached to a logger - and again to a nested appender. - - + + Shuts down the log4net system. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in all the + default repositories. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + - - Shuts down the repository for the repository specified. - - The repository to shutdown. - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in the - repository for the specified. - - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - - The shutdown method is careful to close nested - appenders before closing regular appenders. This is allows - configurations where a regular appender is attached to a logger - and again to a nested appender. - - + + Shuts down the repository for the repository specified. + + The repository to shutdown. + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + repository for the specified. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + - - Shuts down the repository for the repository specified. - - The assembly to use to lookup the repository. - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in the - repository for the repository. The repository is looked up using - the specified. - - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - - The shutdown method is careful to close nested - appenders before closing regular appenders. This is allows - configurations where a regular appender is attached to a logger - and again to a nested appender. - - + + Shuts down the repository for the repository specified. + + The assembly to use to lookup the repository. + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + repository for the repository. The repository is looked up using + the specified. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + @@ -11612,7 +12276,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -11629,7 +12293,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -11646,10 +12310,10 @@ - - Internal method to get pertinent version info. - - A string of version info. + + Internal method to get pertinent version info. + + A string of version info. @@ -11662,7 +12326,7 @@ Called when the event fires. - When the event is triggered the log4net system is . + When the event is triggered the log4net system is . @@ -11677,14 +12341,23 @@ Called when the event fires. - When the event is triggered the log4net system is . + When the event is triggered the log4net system is . + + + The fully qualified type of the LoggerManager class. + + + Used by the internal logger to record the Type of the + log message. + + - - Initialize the default repository selector - + + Initialize the default repository selector + @@ -11702,7 +12375,7 @@ The caller to supplies either a string name or an assembly (if not supplied the assembly is inferred using - ). + ). This context is used by the selector to lookup a specific repository. @@ -11727,20 +12400,20 @@ Gert Driesen - - Constructs a new wrapper for the specified logger. - - The logger to wrap. - - - Constructs a new wrapper for the specified logger. - - + + Constructs a new wrapper for the specified logger. + + The logger to wrap. + + + Constructs a new wrapper for the specified logger. + + - - The logger that this object is wrapping - + + The logger that this object is wrapping + @@ -11772,119 +12445,119 @@ Nicko Cadell - - The logger name. - - - - The logger name. - - + + The logger name. + + + + The logger name. + + - - Level of logging event. - - - - Level of logging event. Level cannot be Serializable - because it is a flyweight. Due to its special serialization it - cannot be declared final either. - - + + Level of logging event. + + + + Level of logging event. Level cannot be Serializable + because it is a flyweight. Due to its special serialization it + cannot be declared final either. + + - - The application supplied message. - - - - The application supplied message of logging event. - - + + The application supplied message. + + + + The application supplied message of logging event. + + - - The name of thread - - - - The name of thread in which this logging event was generated - - + + The name of thread + + + + The name of thread in which this logging event was generated + + - - The time the event was logged - - - - The TimeStamp is stored in the local time zone for this computer. - - + + The time the event was logged + + + + The TimeStamp is stored in the local time zone for this computer. + + - - Location information for the caller. - - - - Location information for the caller. - - + + Location information for the caller. + + + + Location information for the caller. + + - - String representation of the user - - - - String representation of the user's windows name, - like DOMAIN\username - - + + String representation of the user + + + + String representation of the user's windows name, + like DOMAIN\username + + - - String representation of the identity. - - - - String representation of the current thread's principal identity. - - + + String representation of the identity. + + + + String representation of the current thread's principal identity. + + - - The string representation of the exception - - - - The string representation of the exception - - + + The string representation of the exception + + + + The string representation of the exception + + - - String representation of the AppDomain. - - - - String representation of the AppDomain. - - + + String representation of the AppDomain. + + + + String representation of the AppDomain. + + - - Additional event specific properties - - - - A logger or an appender may attach additional - properties to specific events. These properties - have a string key and an object value. - - + + Additional event specific properties + + + + A logger or an appender may attach additional + properties to specific events. These properties + have a string key and an object value. + + @@ -11898,73 +12571,73 @@ Nicko Cadell - - Fix the MDC - + + Fix the MDC + - - Fix the NDC - + + Fix the NDC + - - Fix the rendered message - + + Fix the rendered message + - - Fix the thread name - + + Fix the thread name + - - Fix the callers location information - - - CAUTION: Very slow to generate - + + Fix the callers location information + + + CAUTION: Very slow to generate + - - Fix the callers windows user name - - - CAUTION: Slow to generate - + + Fix the callers windows user name + + + CAUTION: Slow to generate + - - Fix the domain friendly name - + + Fix the domain friendly name + - - Fix the callers principal name - - - CAUTION: May be slow to generate - + + Fix the callers principal name + + + CAUTION: May be slow to generate + - - Fix the exception text - + + Fix the exception text + - Fix the event properties + Fix the event properties. Active properties must implement in order to be eligible for fixing. - - No fields fixed - + + No fields fixed + - - All fields fixed - + + All fields fixed + @@ -12002,8 +12675,8 @@ time the event is delivered to appenders, but will not be consistent at any time afterwards. If an event is to be stored and then processed at a later time these volatile values must be fixed by calling - . There is a performance penalty - for incurred by calling but it + . There is a performance penalty + for incurred by calling but it is essential to maintaining data consistency. @@ -12013,19 +12686,19 @@ Daniel Cazzulino - - The key into the Properties map for the host name value. - + + The key into the Properties map for the host name value. + - - The key into the Properties map for the thread identity value. - + + The key into the Properties map for the thread identity value. + - - The key into the Properties map for the user name value. - + + The key into the Properties map for the user name value. + @@ -12043,7 +12716,7 @@ Except , and , all fields of LoggingEvent are filled when actually needed. Call - to cache all data locally + to cache all data locally to prevent inconsistencies. This method is called by the log4net framework @@ -12068,7 +12741,7 @@ be useful if you require a custom serialization scheme. - Use the method to obtain an + Use the method to obtain an instance of the class. @@ -12094,7 +12767,7 @@ be useful if you require a custom serialization scheme. - Use the method to obtain an + Use the method to obtain an instance of the class. @@ -12117,7 +12790,7 @@ be useful if you require a custom serialization scheme. - Use the method to obtain an + Use the method to obtain an instance of the class. @@ -12141,10 +12814,10 @@ - - Ensure that the repository is set. - - the value for the repository + + Ensure that the repository is set. + + the value for the repository @@ -12172,7 +12845,7 @@ The data in this event must be fixed before it can be serialized. - The method must be called during the + The method must be called during the method call if this event is to be used outside that method. @@ -12247,17 +12920,17 @@ time the event is delivered to appenders, but will not be consistent at any time afterwards. If an event is to be stored and then processed at a later time these volatile values must be fixed by calling - . There is a performance penalty - incurred by calling but it + . There is a performance penalty + incurred by calling but it is essential to maintaining data consistency. - Calling is equivalent to - calling passing the parameter + Calling is equivalent to + calling passing the parameter false. - See for more + See for more information. @@ -12274,8 +12947,8 @@ time the event is delivered to appenders, but will not be consistent at any time afterwards. If an event is to be stored and then processed at a later time these volatile values must be fixed by calling - . There is a performance penalty - for incurred by calling but it + . There is a performance penalty + for incurred by calling but it is essential to maintaining data consistency. @@ -12358,88 +13031,88 @@ - - The internal logging event data. - + + The internal logging event data. + - - The internal logging event data. - + + The internal logging event data. + - - The internal logging event data. - + + The internal logging event data. + - - The fully qualified Type of the calling - logger class in the stack frame (i.e. the declaring type of the method). - + + The fully qualified Type of the calling + logger class in the stack frame (i.e. the declaring type of the method). + - - The application supplied message of logging event. - + + The application supplied message of logging event. + - - The exception that was thrown. - - - This is not serialized. The string representation - is serialized instead. - + + The exception that was thrown. + + + This is not serialized. The string representation + is serialized instead. + - - The repository that generated the logging event - - - This is not serialized. - + + The repository that generated the logging event + + + This is not serialized. + - - The fix state for this event - - - These flags indicate which fields have been fixed. - Not serialized. - + + The fix state for this event + + + These flags indicate which fields have been fixed. + Not serialized. + - - Indicated that the internal cache is updateable (ie not fixed) - - - This is a seperate flag to m_fixFlags as it allows incrementel fixing and simpler - changes in the caching strategy. - + + Indicated that the internal cache is updateable (ie not fixed) + + + This is a seperate flag to m_fixFlags as it allows incrementel fixing and simpler + changes in the caching strategy. + - - Gets the time when the current process started. - - - This is the time when this process started. - - - - The TimeStamp is stored in the local time zone for this computer. - - - Tries to get the start time for the current process. - Failing that it returns the time of the first call to - this property. - - - Note that AppDomains may be loaded and unloaded within the - same process without the process terminating and therefore - without the process start time being reset. - - + + Gets the time when the current process started. + + + This is the time when this process started. + + + + The TimeStamp is stored in the local time zone for this computer. + + + Tries to get the start time for the current process. + Failing that it returns the time of the first call to + this property. + + + Note that AppDomains may be loaded and unloaded within the + same process without the process terminating and therefore + without the process start time being reset. + + @@ -12455,30 +13128,30 @@ - - Gets the time of the logging event. - - - The time of the logging event. - - - - The TimeStamp is stored in the local time zone for this computer. - - + + Gets the time of the logging event. + + + The time of the logging event. + + + + The TimeStamp is stored in the local time zone for this computer. + + - - Gets the name of the logger that logged the event. - - - The name of the logger that logged the event. - - - - Gets the name of the logger that logged the event. - - + + Gets the name of the logger that logged the event. + + + The name of the logger that logged the event. + + + + Gets the name of the logger that logged the event. + + @@ -12566,94 +13239,94 @@ - - Gets the name of the current thread. - - - The name of the current thread, or the thread ID when - the name is not available. - - - - The collected information is cached for future use. - - + + Gets the name of the current thread. + + + The name of the current thread, or the thread ID when + the name is not available. + + + + The collected information is cached for future use. + + - - Gets the name of the current user. - - - The name of the current user, or NOT AVAILABLE when the - underlying runtime has no support for retrieving the name of the - current user. - - - - Calls WindowsIdentity.GetCurrent().Name to get the name of - the current windows user. - - - To improve performance, we could cache the string representation of - the name, and reuse that as long as the identity stayed constant. - Once the identity changed, we would need to re-assign and re-render - the string. - - - However, the WindowsIdentity.GetCurrent() call seems to - return different objects every time, so the current implementation - doesn't do this type of caching. - - - Timing for these operations: - - - - Method - Results - - - WindowsIdentity.GetCurrent() - 10000 loops, 00:00:00.2031250 seconds - - - WindowsIdentity.GetCurrent().Name - 10000 loops, 00:00:08.0468750 seconds - - - - This means we could speed things up almost 40 times by caching the - value of the WindowsIdentity.GetCurrent().Name property, since - this takes (8.04-0.20) = 7.84375 seconds. - - + + Gets the name of the current user. + + + The name of the current user, or NOT AVAILABLE when the + underlying runtime has no support for retrieving the name of the + current user. + + + + Calls WindowsIdentity.GetCurrent().Name to get the name of + the current windows user. + + + To improve performance, we could cache the string representation of + the name, and reuse that as long as the identity stayed constant. + Once the identity changed, we would need to re-assign and re-render + the string. + + + However, the WindowsIdentity.GetCurrent() call seems to + return different objects every time, so the current implementation + doesn't do this type of caching. + + + Timing for these operations: + + + + Method + Results + + + WindowsIdentity.GetCurrent() + 10000 loops, 00:00:00.2031250 seconds + + + WindowsIdentity.GetCurrent().Name + 10000 loops, 00:00:08.0468750 seconds + + + + This means we could speed things up almost 40 times by caching the + value of the WindowsIdentity.GetCurrent().Name property, since + this takes (8.04-0.20) = 7.84375 seconds. + + - - Gets the identity of the current thread principal. - - - The string name of the identity of the current thread principal. - - - - Calls System.Threading.Thread.CurrentPrincipal.Identity.Name to get - the name of the current thread principal. - - + + Gets the identity of the current thread principal. + + + The string name of the identity of the current thread principal. + + + + Calls System.Threading.Thread.CurrentPrincipal.Identity.Name to get + the name of the current thread principal. + + - - Gets the AppDomain friendly name. - - - The AppDomain friendly name. - - - - Gets the AppDomain friendly name. - - + + Gets the AppDomain friendly name. + + + The AppDomain friendly name. + + + + Gets the AppDomain friendly name. + + @@ -12684,18 +13357,18 @@ - - The fixed fields in this event - - - The set of fields that are fixed in this event - - - - Fields will not be fixed if they have previously been fixed. - It is not possible to 'unfix' a field. - - + + The fixed fields in this event + + + The set of fields that are fixed in this event + + + + Fields will not be fixed if they have previously been fixed. + It is not possible to 'unfix' a field. + + @@ -12714,7 +13387,7 @@ DEBUG - The and methods log messages + The and methods log messages at the DEBUG level. That is the level with that name defined in the repositories . The default value for this level is . The @@ -12724,7 +13397,7 @@ INFO - The and methods log messages + The and methods log messages at the INFO level. That is the level with that name defined in the repositories . The default value for this level is . The @@ -12734,7 +13407,7 @@ WARN - The and methods log messages + The and methods log messages at the WARN level. That is the level with that name defined in the repositories . The default value for this level is . The @@ -12744,7 +13417,7 @@ ERROR - The and methods log messages + The and methods log messages at the ERROR level. That is the level with that name defined in the repositories . The default value for this level is . The @@ -12754,7 +13427,7 @@ FATAL - The and methods log messages + The and methods log messages at the FATAL level. That is the level with that name defined in the repositories . The default value for this level is . The @@ -12778,7 +13451,7 @@ Use the to obtain logger instances - that implement this interface. The + that implement this interface. The static method is used to get logger instances. @@ -12807,7 +13480,7 @@ - + Nicko Cadell Gert Driesen @@ -12832,10 +13505,10 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. - + @@ -12848,10 +13521,10 @@ The exception to log, including its stack trace. - See the form for more detailed information. + See the form for more detailed information. - + @@ -12864,16 +13537,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -12885,16 +13558,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -12907,16 +13580,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -12930,16 +13603,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -12952,16 +13625,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -12984,11 +13657,11 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. The message object to log. - + @@ -13001,10 +13674,10 @@ The exception to log, including its stack trace. - See the form for more detailed information. + See the form for more detailed information. - + @@ -13017,16 +13690,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13038,16 +13711,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13060,16 +13733,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13083,16 +13756,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13105,16 +13778,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13137,11 +13810,11 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. The message object to log. - + @@ -13154,10 +13827,10 @@ The exception to log, including its stack trace. - See the form for more detailed information. + See the form for more detailed information. - + @@ -13170,16 +13843,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13191,16 +13864,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13213,16 +13886,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13236,16 +13909,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13258,16 +13931,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13291,10 +13964,10 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. - + @@ -13307,10 +13980,10 @@ The exception to log, including its stack trace. - See the form for more detailed information. + See the form for more detailed information. - + @@ -13323,16 +13996,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13344,16 +14017,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13366,16 +14039,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13389,16 +14062,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13411,16 +14084,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13443,11 +14116,11 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. The message object to log. - + @@ -13460,10 +14133,10 @@ The exception to log, including its stack trace. - See the form for more detailed information. + See the form for more detailed information. - + @@ -13476,16 +14149,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13497,16 +14170,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13519,16 +14192,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13542,16 +14215,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13564,16 +14237,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13611,7 +14284,7 @@ the other hand, if the log is debug enabled, you will incur the cost of evaluating whether the logger is debug enabled twice. Once in and once in - the . This is an insignificant overhead + the . This is an insignificant overhead since evaluating a logger takes about 1% of the time it takes to actually log. This is the preferred style of logging. @@ -13644,8 +14317,8 @@ speed or runtime flexibility. - - + + @@ -13657,8 +14330,8 @@ For more information see . - - + + @@ -13671,8 +14344,8 @@ For more information see . - - + + @@ -13685,8 +14358,8 @@ For more information see . - - + + @@ -13699,31 +14372,31 @@ For more information see . - - + + - - Construct a new wrapper for the specified logger. - - The logger to wrap. - - - Construct a new wrapper for the specified logger. - - + + Construct a new wrapper for the specified logger. + + The logger to wrap. + + + Construct a new wrapper for the specified logger. + + - - Virtual method called when the configuration of the repository changes - - the repository holding the levels - - - Virtual method called when the configuration of the repository changes - - + + Virtual method called when the configuration of the repository changes + + the repository holding the levels + + + Virtual method called when the configuration of the repository changes + + @@ -13746,7 +14419,7 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. @@ -13763,10 +14436,10 @@ as a parameter. - See the form for more detailed information. + See the form for more detailed information. - + @@ -13776,18 +14449,18 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13800,18 +14473,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13825,18 +14498,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13851,18 +14524,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13876,13 +14549,13 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13908,7 +14581,7 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. @@ -13925,10 +14598,10 @@ passed as a parameter. - See the form for more detailed information. + See the form for more detailed information. - + @@ -13938,18 +14611,18 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13962,18 +14635,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13987,18 +14660,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14013,18 +14686,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14038,13 +14711,13 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14070,7 +14743,7 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. @@ -14087,10 +14760,10 @@ passed as a parameter. - See the form for more detailed information. + See the form for more detailed information. - + @@ -14100,18 +14773,18 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14124,18 +14797,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14149,18 +14822,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14175,18 +14848,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14200,13 +14873,13 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14232,7 +14905,7 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. @@ -14249,10 +14922,10 @@ passed as a parameter. - See the form for more detailed information. + See the form for more detailed information. - + @@ -14262,18 +14935,18 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14286,18 +14959,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14311,18 +14984,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14337,18 +15010,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14362,13 +15035,13 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14394,7 +15067,7 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. @@ -14411,10 +15084,10 @@ passed as a parameter. - See the form for more detailed information. + See the form for more detailed information. - + @@ -14424,18 +15097,18 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14448,18 +15121,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14473,18 +15146,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14499,18 +15172,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14524,13 +15197,13 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14543,54 +15216,54 @@ Empty - - The fully qualified name of this declaring type not the type of any subclass. - + + The fully qualified name of this declaring type not the type of any subclass. + - - Checks if this logger is enabled for the DEBUG - level. - - - true if this logger is enabled for DEBUG events, - false otherwise. - - - - This function is intended to lessen the computational cost of - disabled log debug statements. - - - For some log Logger object, when you write: - - - log.Debug("This is entry number: " + i ); - - - You incur the cost constructing the message, concatenation in - this case, regardless of whether the message is logged or not. - - - If you are worried about speed, then you should write: - - - if (log.IsDebugEnabled()) - { - log.Debug("This is entry number: " + i ); - } - - - This way you will not incur the cost of parameter - construction if debugging is disabled for log. On - the other hand, if the log is debug enabled, you - will incur the cost of evaluating whether the logger is debug - enabled twice. Once in IsDebugEnabled and once in - the Debug. This is an insignificant overhead - since evaluating a logger takes about 1% of the time it - takes to actually log. - - + + Checks if this logger is enabled for the DEBUG + level. + + + true if this logger is enabled for DEBUG events, + false otherwise. + + + + This function is intended to lessen the computational cost of + disabled log debug statements. + + + For some log Logger object, when you write: + + + log.Debug("This is entry number: " + i ); + + + You incur the cost constructing the message, concatenation in + this case, regardless of whether the message is logged or not. + + + If you are worried about speed, then you should write: + + + if (log.IsDebugEnabled()) + { + log.Debug("This is entry number: " + i ); + } + + + This way you will not incur the cost of parameter + construction if debugging is disabled for log. On + the other hand, if the log is debug enabled, you + will incur the cost of evaluating whether the logger is debug + enabled twice. Once in IsDebugEnabled and once in + the Debug. This is an insignificant overhead + since evaluating a logger takes about 1% of the time it + takes to actually log. + + @@ -14654,20 +15327,99 @@ - + - A SecurityContext used by log4net when interacting with protected resources + provides method information without actually referencing a System.Reflection.MethodBase + as that would require that the containing assembly is loaded. - - - A SecurityContext used by log4net when interacting with protected resources - for example with operating system services. This can be used to impersonate - a principal that has been granted privileges on the system resources. - - - Nicko Cadell + - + + + When location information is not available the constant + NA is returned. Current value of this string + constant is ?. + + + + + constructs a method item for an unknown method. + + + + + constructs a method item from the name of the method. + + + + + + constructs a method item from the name of the method and its parameters. + + + + + + + constructs a method item from a method base by determining the method name and its parameters. + + + + + + The fully qualified type of the StackFrameItem class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets the method name of the caller making the logging + request. + + + The method name of the caller making the logging + request. + + + + Gets the method name of the caller making the logging + request. + + + + + + Gets the method parameters of the caller making + the logging request. + + + The method parameters of the caller making + the logging request + + + + Gets the method parameters of the caller making + the logging request. + + + + + + A SecurityContext used by log4net when interacting with protected resources + + + + A SecurityContext used by log4net when interacting with protected resources + for example with operating system services. This can be used to impersonate + a principal that has been granted privileges on the system resources. + + + Nicko Cadell + + Impersonate this SecurityContext @@ -14720,19 +15472,19 @@ Nicko Cadell - - The default provider - + + The default provider + - - Protected default constructor to allow subclassing - - - - Protected default constructor to allow subclassing - - + + Protected default constructor to allow subclassing + + + + Protected default constructor to allow subclassing + + @@ -14774,6 +15526,195 @@ + + + provides stack frame information without actually referencing a System.Diagnostics.StackFrame + as that would require that the containing assembly is loaded. + + + + + + When location information is not available the constant + NA is returned. Current value of this string + constant is ?. + + + + + returns a stack frame item from a stack frame. This + + + + + + + The fully qualified type of the StackFrameItem class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets the fully qualified class name of the caller making the logging + request. + + + The fully qualified class name of the caller making the logging + request. + + + + Gets the fully qualified class name of the caller making the logging + request. + + + + + + Gets the file name of the caller. + + + The file name of the caller. + + + + Gets the file name of the caller. + + + + + + Gets the line number of the caller. + + + The line number of the caller. + + + + Gets the line number of the caller. + + + + + + Gets the method name of the caller. + + + The method name of the caller. + + + + Gets the method name of the caller. + + + + + + Gets all available caller information + + + All available caller information, in the format + fully.qualified.classname.of.caller.methodName(Filename:line) + + + + Gets all available caller information, in the format + fully.qualified.classname.of.caller.methodName(Filename:line) + + + + + + An evaluator that triggers after specified number of seconds. + + + + This evaluator will trigger if the specified time period + has passed since last check. + + + Robert Sevcik + + + + The default time threshold for triggering in seconds. Zero means it won't trigger at all. + + + + + The time threshold for triggering in seconds. Zero means it won't trigger at all. + + + + + The time of last check. This gets updated when the object is created and when the evaluator triggers. + + + + + Create a new evaluator using the time threshold in seconds. + + + + Create a new evaluator using the time threshold in seconds. + + + This evaluator will trigger if the specified time period + has passed since last check. + + + + + + Create a new evaluator using the specified time threshold in seconds. + + + The time threshold in seconds to trigger after. + Zero means it won't trigger at all. + + + + Create a new evaluator using the specified time threshold in seconds. + + + This evaluator will trigger if the specified time period + has passed since last check. + + + + + + Is this the triggering event? + + The event to check + This method returns true, if the specified time period + has passed since last check.. + Otherwise it returns false + + + This evaluator will trigger if the specified time period + has passed since last check. + + + + + + The time threshold in seconds to trigger after + + + The time threshold in seconds to trigger after. + Zero means it won't trigger at all. + + + + This evaluator will trigger if the specified time period + has passed since last check. + + + Delegate used to handle creation of new wrappers. @@ -14871,26 +15812,26 @@ - - Event handler for repository shutdown event. - - The sender of the event. - The event args. + + Event handler for repository shutdown event. + + The sender of the event. + The event args. - - Map of logger repositories to hashtables of ILogger to ILoggerWrapper mappings - + + Map of logger repositories to hashtables of ILogger to ILoggerWrapper mappings + - - The handler to use to create the extension wrapper objects. - + + The handler to use to create the extension wrapper objects. + - - Internal reference to the delegate used to register for repository shutdown events. - + + Internal reference to the delegate used to register for repository shutdown events. + @@ -14950,34 +15891,34 @@ - - String constant used to specify AbsoluteTimeDateFormat in layouts. Current value is ABSOLUTE. - + + String constant used to specify AbsoluteTimeDateFormat in layouts. Current value is ABSOLUTE. + - - String constant used to specify DateTimeDateFormat in layouts. Current value is DATE. - + + String constant used to specify DateTimeDateFormat in layouts. Current value is DATE. + - - String constant used to specify ISO8601DateFormat in layouts. Current value is ISO8601. - + + String constant used to specify ISO8601DateFormat in layouts. Current value is ISO8601. + - - Renders the date into a string. Format is "HH:mm:ss". - - The date to render into a string. - The string builder to write to. - - - Subclasses should override this method to render the date - into a string using a precision up to the second. This method - will be called at most once per second and the result will be - reused if it is needed again during the same second. - - + + Renders the date into a string. Format is "HH:mm:ss". + + The date to render into a string. + The string builder to write to. + + + Subclasses should override this method to render the date + into a string using a precision up to the second. This method + will be called at most once per second and the result will be + reused if it is needed again during the same second. + + @@ -15000,21 +15941,21 @@ - - Last stored time with precision up to the second. - + + Last stored time with precision up to the second. + - - Last stored time with precision up to the second, formatted - as a string. - + + Last stored time with precision up to the second, formatted + as a string. + - - - Last stored time with precision up to the second, formatted - as a string. - + + + Last stored time with precision up to the second, formatted + as a string. + @@ -15042,26 +15983,26 @@ - - Formats the date without the milliseconds part - - The date to format. - The string builder to write to. - - - Formats a DateTime in the format "dd MMM yyyy HH:mm:ss" - for example, "06 Nov 1994 15:49:37". - - - The base class will append the ",fff" milliseconds section. - This method will only be called at most once per second. - - + + Formats the date without the milliseconds part + + The date to format. + The string builder to write to. + + + Formats a DateTime in the format "dd MMM yyyy HH:mm:ss" + for example, "06 Nov 1994 15:49:37". + + + The base class will append the ",fff" milliseconds section. + This method will only be called at most once per second. + + - - The format info for the invariant culture. - + + The format info for the invariant culture. + @@ -15086,28 +16027,28 @@ - - Formats the date without the milliseconds part - - The date to format. - The string builder to write to. - - - Formats the date specified as a string: "yyyy-MM-dd HH:mm:ss". - - - The base class will append the ",fff" milliseconds section. - This method will only be called at most once per second. - - + + Formats the date without the milliseconds part + + The date to format. + The string builder to write to. + + + Formats the date specified as a string: "yyyy-MM-dd HH:mm:ss". + + + The base class will append the ",fff" milliseconds section. + This method will only be called at most once per second. + + - Formats the using the method. + Formats the using the method. - Formats the using the method. + Formats the using the method. Nicko Cadell @@ -15125,22 +16066,22 @@ The format string must be compatible with the options - that can be supplied to . + that can be supplied to . - - Formats the date using . - - The date to convert to a string. - The writer to write to. - - - Uses the date format string supplied to the constructor to call - the method to format the date. - - + + Formats the date using . + + The date to convert to a string. + The writer to write to. + + + Uses the date format string supplied to the constructor to call + the method to format the date. + + @@ -15149,7 +16090,7 @@ The format string must be compatible with the options - that can be supplied to . + that can be supplied to . @@ -15277,18 +16218,18 @@ - - Property to get and set the next filter - - - The next filter in the chain - - - - Filters are typically composed into chains. This property allows the next filter in - the chain to be accessed. - - + + Property to get and set the next filter + + + The next filter in the chain + + + + Filters are typically composed into chains. This property allows the next filter in + the chain to be accessed. + + @@ -15343,27 +16284,27 @@ + + Property to get and set the next filter + + + The next filter in the chain + + + + Filters are typically composed into chains. This property allows the next filter in + the chain to be accessed. + + + + + + Default constructor + + + - Property to get and set the next filter - - - The next filter in the chain - - - - Filters are typically composed into chains. This property allows the next filter in - the chain to be accessed. - - - - - - Default constructor - - - - - Always returns the integer constant + Always returns the integer constant the LoggingEvent to filter Always returns @@ -15388,22 +16329,22 @@ - - The log event must be dropped immediately without - consulting with the remaining filters, if any, in the chain. - + + The log event must be dropped immediately without + consulting with the remaining filters, if any, in the chain. + - - This filter is neutral with respect to the log event. - The remaining filters, if any, should be consulted for a final decision. - + + This filter is neutral with respect to the log event. + The remaining filters, if any, should be consulted for a final decision. + - - The log event must be logged immediately without - consulting with the remaining filters, if any, in the chain. - + + The log event must be logged immediately without + consulting with the remaining filters, if any, in the chain. + @@ -15435,9 +16376,9 @@ - - Default constructor - + + Default constructor + @@ -15518,9 +16459,9 @@ - - Default constructor - + + Default constructor + @@ -15597,19 +16538,19 @@ Daniel Cazzulino - - Flag to indicate the behavior when we have a match - + + Flag to indicate the behavior when we have a match + - - The logger name string to substring match against the event - + + The logger name string to substring match against the event + - - Default constructor - + + Default constructor + @@ -15621,7 +16562,7 @@ The rendered message is matched against the . If the equals the beginning of - the incoming () + the incoming () then a match will have occurred. If no match occurs this function will return allowing other filters to check the event. If a match occurs then @@ -15655,7 +16596,7 @@ This filter will attempt to match this value against logger name in the following way. The match will be done against the beginning of the - logger name (using ). The match is + logger name (using ). The match is case sensitive. If a match is found then the result depends on the value of . @@ -15678,53 +16619,53 @@ Gert Driesen - - Simple filter to match a string an event property - - - - Simple filter to match a string in the value for a - specific event property - - - Nicko Cadell + + Simple filter to match a string an event property + + + + Simple filter to match a string in the value for a + specific event property + + + Nicko Cadell - - Simple filter to match a string in the rendered message - - - - Simple filter to match a string in the rendered message - - - Nicko Cadell - Gert Driesen + + Simple filter to match a string in the rendered message + + + + Simple filter to match a string in the rendered message + + + Nicko Cadell + Gert Driesen - - Flag to indicate the behavior when we have a match - + + Flag to indicate the behavior when we have a match + - - The string to substring match against the message - + + The string to substring match against the message + - - A string regex to match - + + A string regex to match + - - A regex object to match (generated from m_stringRegexToMatch) - + + A regex object to match (generated from m_stringRegexToMatch) + - - Default constructor - + + Default constructor + @@ -15814,14 +16755,14 @@ - - The key to use to lookup the string from the event properties - + + The key to use to lookup the string from the event properties + - - Default constructor - + + Default constructor + @@ -15895,41 +16836,41 @@ Nicko Cadell - - Abstract class that provides the formatting functionality that - derived classes need. - - - Conversion specifiers in a conversion patterns are parsed to - individual PatternConverters. Each of which is responsible for - converting a logging event in a converter specific manner. - - Nicko Cadell + + Abstract class that provides the formatting functionality that + derived classes need. + + + Conversion specifiers in a conversion patterns are parsed to + individual PatternConverters. Each of which is responsible for + converting a logging event in a converter specific manner. + + Nicko Cadell - - Abstract class that provides the formatting functionality that - derived classes need. - - - - Conversion specifiers in a conversion patterns are parsed to - individual PatternConverters. Each of which is responsible for - converting a logging event in a converter specific manner. - - - Nicko Cadell - Gert Driesen + + Abstract class that provides the formatting functionality that + derived classes need. + + + + Conversion specifiers in a conversion patterns are parsed to + individual PatternConverters. Each of which is responsible for + converting a logging event in a converter specific manner. + + + Nicko Cadell + Gert Driesen - - Initial buffer size - + + Initial buffer size + - - Maximum buffer size before it is recycled - + + Maximum buffer size before it is recycled + @@ -15955,17 +16896,17 @@ - - Set the next pattern converter in the chains - - the pattern converter that should follow this converter in the chain - the next converter - - - The PatternConverter can merge with its neighbor during this method (or a sub class). - Therefore the return value may or may not be the value of the argument passed in. - - + + Set the next pattern converter in the chains + + the pattern converter that should follow this converter in the chain + the next converter + + + The PatternConverter can merge with its neighbor during this method (or a sub class). + Therefore the return value may or may not be the value of the argument passed in. + + @@ -15995,9 +16936,9 @@ - - The option string to the converter - + + The option string to the converter + @@ -16020,59 +16961,85 @@ - + - Write an object to a + Write an dictionary to a the writer to write to a to use for object conversion the value to write to the writer - Writes the Object to a writer. If the specified - is not null then it is used to render the object to text, otherwise + Writes the to a writer in the form: + + + {key1=value1, key2=value2, key3=value3} + + + If the specified + is not null then it is used to render the key and value to text, otherwise the object's ToString method is called. - + - Get the next pattern converter in the chain + Write an object to a - - the next pattern converter in the chain - + the writer to write to + a to use for object conversion + the value to write to the writer - Get the next pattern converter in the chain + Writes the Object to a writer. If the specified + is not null then it is used to render the object to text, otherwise + the object's ToString method is called. + + + Get the next pattern converter in the chain + + + the next pattern converter in the chain + + + + Get the next pattern converter in the chain + + + - - Gets or sets the formatting info for this converter - - - The formatting info for this converter - - - - Gets or sets the formatting info for this converter - - + + Gets or sets the formatting info for this converter + + + The formatting info for this converter + + + + Gets or sets the formatting info for this converter + + - - Gets or sets the option value for this converter - - - The option for this converter - - - - Gets or sets the option value for this converter - - + + Gets or sets the option value for this converter + + + The option for this converter + + + + Gets or sets the option value for this converter + + + + + + + @@ -16096,12 +17063,12 @@ The state object on which the pattern converter should be executed. - - Flag indicating if this converter handles exceptions - - - false if this converter handles exceptions - + + Flag indicating if this converter handles exceptions + + + false if this converter handles exceptions + @@ -16133,6 +17100,132 @@ + + + Converter for items in the ASP.Net Cache. + + + + Outputs an item from the . + + + Ron Grabowski + + + + Abstract class that provides access to the current HttpContext () that + derived classes need. + + + This class handles the case when HttpContext.Current is null by writing + to the writer. + + Ron Grabowski + + + + Derived pattern converters must override this method in order to + convert conversion specifiers in the correct way. + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + + Write the ASP.Net Cache item to the output + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + Writes out the value of a named property. The property name + should be set in the + property. If no property has been set, all key value pairs from the Cache will + be written to the output. + + + + + + Converter for items in the . + + + + Outputs an item from the . + + + Ron Grabowski + + + + Write the ASP.Net HttpContext item to the output + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + Writes out the value of a named property. The property name + should be set in the + property. + + + + + + Converter for items in the ASP.Net Cache. + + + + Outputs an item from the . + + + Ron Grabowski + + + + Write the ASP.Net Cache item to the output + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + Writes out the value of a named property. The property name + should be set in the + property. + + + + + + Converter for items in the ASP.Net Cache. + + + + Outputs an item from the . + + + Ron Grabowski + + + + Write the ASP.Net Cache item to the output + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + Writes out the value of a named property. The property name + should be set in the + property. If no property has been set, all key value pairs from the Session will + be written to the output. + + + Date pattern converter, uses a to format @@ -16176,7 +17269,7 @@ Any other pattern string uses the formatter. This formatter passes the pattern string to the - method. + method. For details on valid patterns see DateTimeFormatInfo Class. @@ -16234,29 +17327,38 @@ + + + The fully qualified type of the DatePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + - - Write the exception text to the output - - - - If an exception object is stored in the logging event - it will be rendered into the pattern output with a - trailing newline. - - - If there is no exception then nothing will be output - and no trailing newline will be appended. - It is typical to put a newline before the exception - and to have the exception as the last data in the pattern. - - - Nicko Cadell + + Write the exception text to the output + + + + If an exception object is stored in the logging event + it will be rendered into the pattern output with a + trailing newline. + + + If there is no exception then nothing will be output + and no trailing newline will be appended. + It is typical to put a newline before the exception + and to have the exception as the last data in the pattern. + + + Nicko Cadell - - Default constructor - + + Default constructor + @@ -16271,26 +17373,47 @@ trailing newline. - If there is no exception then nothing will be output + If there is no exception or the exception property specified + by the Option value does not exist then nothing will be output and no trailing newline will be appended. It is typical to put a newline before the exception and to have the exception as the last data in the pattern. - - - - - Writes the caller location file name to the output - - - Writes the value of the for - the event to the output writer. + Recognized values for the Option parameter are: - - Nicko Cadell - - + + + Message + + + Source + + + StackTrace + + + TargetSite + + + HelpLink + + + + + + + Writes the caller location file name to the output + + + + Writes the value of the for + the event to the output writer. + + + Nicko Cadell + + Write the caller location file name to the output @@ -16450,20 +17573,20 @@ - - Get the fully qualified string data - - the event being logged - the fully qualified name - - - Overridden by subclasses to get the fully qualified name before the - precision is applied to it. - - - Return the fully qualified '.' (dot/period) separated string. - - + + Get the fully qualified string data + + the event being logged + the fully qualified name + + + Overridden by subclasses to get the fully qualified name before the + precision is applied to it. + + + Return the fully qualified '.' (dot/period) separated string. + + @@ -16476,6 +17599,15 @@ specified by the property. + + + The fully qualified type of the NamedPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + Gets the fully qualified name of the logger @@ -16604,15 +17736,15 @@ - - Converter to output the relative time of the event - - - - Converter to output the time of the event relative to the start of the program. - - - Nicko Cadell + + Converter to output the relative time of the event + + + + Converter to output the time of the event relative to the start of the program. + + + Nicko Cadell @@ -16629,12 +17761,92 @@ + + Helper method to get the time difference between two DateTime objects + + start time (in the current local time zone) + end time (in the current local time zone) + the time difference in milliseconds + + + + Write the caller stack frames to the output + + + + Writes the to the output writer, using format: + type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...) + + + Adam Davies + + + + Write the caller stack frames to the output + + + + Writes the to the output writer, using format: + type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1 + + + Michael Cromwell + + + + Initialize the converter + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + - Helper method to get the time difference between two DateTime objects + Write the strack frames to the output - start time (in the current local time zone) - end time (in the current local time zone) - the time difference in milliseconds + that will receive the formatted result. + the event being logged + + + Writes the to the output writer. + + + + + + Returns the Name of the method + + + This method was created, so this class could be used as a base class for StackTraceDetailPatternConverter + string + + + + The fully qualified type of the StackTracePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + The fully qualified type of the StackTraceDetailPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + @@ -16683,11 +17895,11 @@ - - Converter to include event user name - - Douglas de la Torre - Nicko Cadell + + Converter to include event user name + + Douglas de la Torre + Nicko Cadell @@ -16734,439 +17946,92 @@ - - - A Layout that renders only the Exception text from the logging event - - - - A Layout that renders only the Exception text from the logging event. - - - This Layout should only be used with appenders that utilize multiple - layouts (e.g. ). - + + + The fully qualified type of the UtcDatePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + A flexible layout configurable with pattern string that re-evaluates on each call. + + + This class is built on and provides all the + features and capabilities of PatternLayout. PatternLayout is a 'static' class + in that its layout is done once at configuration time. This class will recreate + the layout on each reference. + One important difference between PatternLayout and DynamicPatternLayout is the + treatment of the Header and Footer parameters in the configuration. The Header and Footer + parameters for DynamicPatternLayout must be syntactically in the form of a PatternString, + but should not be marked as type log4net.Util.PatternString. Doing so causes the + pattern to be statically converted at configuration time and causes DynamicPatternLayout + to perform the same as PatternLayout. + Please see for complete documentation. + + <layout type="log4net.Layout.DynamicPatternLayout"> + <param name="Header" value="%newline**** Trace Opened Local: %date{yyyy-MM-dd HH:mm:ss.fff} UTC: %utcdate{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /> + <param name="Footer" value="**** Trace Closed %date{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /> + </layout> + - Nicko Cadell - Gert Driesen - + - Extend this abstract class to create your own log layout format. + A flexible layout configurable with pattern string. - This is the base implementation of the - interface. Most layout objects should extend this class. - - - - - - Subclasses must implement the - method. - - - Subclasses should set the in their default - constructor. + The goal of this class is to a + as a string. The results + depend on the conversion pattern. - - - Nicko Cadell - Gert Driesen - - - - Interface implemented by layout objects - - - An object is used to format a - as text. The method is called by an - appender to transform the into a string. + The conversion pattern is closely related to the conversion + pattern of the printf function in C. A conversion pattern is + composed of literal text and format control expressions called + conversion specifiers. - The layout can also supply and - text that is appender before any events and after all the events respectively. + You are free to insert any literal text within the conversion + pattern. - - Nicko Cadell - Gert Driesen - - - - Implement this method to create your own layout format. - - The TextWriter to write the formatted event to - The event to format - - This method is called by an appender to format - the as text and output to a writer. + Each conversion specifier starts with a percent sign (%) and is + followed by optional format modifiers and a conversion + pattern name. The conversion pattern name specifies the type of + data, e.g. logger, level, date, thread name. The format + modifiers control such things as field width, padding, left and + right justification. The following is a simple example. - If the caller does not have a and prefers the - event to be formatted as a then the following - code can be used to format the event into a . + Let the conversion pattern be "%-5level [%thread]: %message%newline" and assume + that the log4net environment was set to use a PatternLayout. Then the + statements - StringWriter writer = new StringWriter(); - Layout.Format(writer, loggingEvent); - string formattedEvent = writer.ToString(); + ILog log = LogManager.GetLogger(typeof(TestApp)); + log.Debug("Message 1"); + log.Warn("Message 2"); + + would yield the output + + DEBUG [main]: Message 1 + WARN [main]: Message 2 - - - - - The content type output by this layout. - - The content type - - - The content type output by this layout. - - - This is a MIME type e.g. "text/plain". - - - - - - The header for the layout format. - - the layout header - - - The Header text will be appended before any logging events - are formatted and appended. - - - - - - The footer for the layout format. - - the layout footer - - - The Footer text will be appended after all the logging events - have been formatted and appended. - - - - - - Flag indicating if this layout handle exceptions - - false if this layout handles exceptions - - - If this layout handles the exception object contained within - , then the layout should return - false. Otherwise, if the layout ignores the exception - object, then the layout should return true. - - - - - - The header text - - - - See for more information. - - - - - - The footer text - - - - See for more information. - - - - - - Flag indicating if this layout handles exceptions - - - false if this layout handles exceptions + Note that there is no explicit separator between text and + conversion specifiers. The pattern parser knows when it has reached + the end of a conversion specifier when it reads a conversion + character. In the example above the conversion specifier + %-5level means the level of the logging event should be left + justified to a width of five characters. - - - - - Empty default constructor - - - Empty default constructor - - - - - - Activate component options - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - This method must be implemented by the subclass. - - - - - - Implement this method to create your own layout format. - - The TextWriter to write the formatted event to - The event to format - - - This method is called by an appender to format - the as text. - - - - - - The content type output by this layout. - - The content type is "text/plain" - - - The content type output by this layout. - - - This base class uses the value "text/plain". - To change this value a subclass must override this - property. - - - - - - The header for the layout format. - - the layout header - - - The Header text will be appended before any logging events - are formatted and appended. - - - - - - The footer for the layout format. - - the layout footer - - - The Footer text will be appended after all the logging events - have been formatted and appended. - - - - - - Flag indicating if this layout handles exceptions - - false if this layout handles exceptions - - - If this layout handles the exception object contained within - , then the layout should return - false. Otherwise, if the layout ignores the exception - object, then the layout should return true. - - - Set this value to override a this default setting. The default - value is true, this layout does not handle the exception. - - - - - - Default constructor - - - - Constructs a ExceptionLayout - - - - - - Activate component options - - - - Part of the component activation - framework. - - - This method does nothing as options become effective immediately. - - - - - - Gets the exception text from the logging event - - The TextWriter to write the formatted event to - the event being logged - - - Write the exception string to the . - The exception string is retrieved from . - - - - - - Interface for raw layout objects - - - - Interface used to format a - to an object. - - - This interface should not be confused with the - interface. This interface is used in - only certain specialized situations where a raw object is - required rather than a formatted string. The - is not generally useful than this interface. - - - Nicko Cadell - Gert Driesen - - - - Implement this method to create your own layout format. - - The event to format - returns the formatted event - - - Implement this method to create your own layout format. - - - - - - Adapts any to a - - - - Where an is required this adapter - allows a to be specified. - - - Nicko Cadell - Gert Driesen - - - - The layout to adapt - - - - - Construct a new adapter - - the layout to adapt - - - Create the adapter for the specified . - - - - - - Format the logging event as an object. - - The event to format - returns the formatted event - - - Format the logging event as an object. - - - Uses the object supplied to - the constructor to perform the formatting. - - - - - - A flexible layout configurable with pattern string. - - - - The goal of this class is to a - as a string. The results - depend on the conversion pattern. - - - The conversion pattern is closely related to the conversion - pattern of the printf function in C. A conversion pattern is - composed of literal text and format control expressions called - conversion specifiers. - - - You are free to insert any literal text within the conversion - pattern. - - - Each conversion specifier starts with a percent sign (%) and is - followed by optional format modifiers and a conversion - pattern name. The conversion pattern name specifies the type of - data, e.g. logger, level, date, thread name. The format - modifiers control such things as field width, padding, left and - right justification. The following is a simple example. - - - Let the conversion pattern be "%-5level [%thread]: %message%newline" and assume - that the log4net environment was set to use a PatternLayout. Then the - statements - - - ILog log = LogManager.GetLogger(typeof(TestApp)); - log.Debug("Message 1"); - log.Warn("Message 2"); - - would yield the output - - DEBUG [main]: Message 1 - WARN [main]: Message 2 - - - Note that there is no explicit separator between text and - conversion specifiers. The pattern parser knows when it has reached - the end of a conversion specifier when it reads a conversion - character. In the example above the conversion specifier - %-5level means the level of the logging event should be left - justified to a width of five characters. - - - The recognized conversion pattern names are: + The recognized conversion pattern names are: @@ -17184,6 +18049,50 @@ logging event was generated. + + aspnet-cache + + + Used to output all cache items in the case of %aspnet-cache or just one named item if used as %aspnet-cache{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + + + aspnet-context + + + Used to output all context items in the case of %aspnet-context or just one named item if used as %aspnet-context{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + + + aspnet-request + + + Used to output all request parameters in the case of %aspnet-request or just one named param if used as %aspnet-request{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + + + aspnet-session + + + Used to output all session items in the case of %aspnet-session or just one named item if used as %aspnet-session{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + c Equivalent to logger @@ -17215,7 +18124,7 @@ The date format specifier admits the same syntax as the - time pattern string of the . + time pattern string of the . For better results it is recommended to use the log4net date @@ -17228,7 +18137,7 @@ These dedicated date formatters perform significantly - better than . + better than . @@ -17494,6 +18403,42 @@ r Equivalent to timestamp + + stacktrace + + + Used to output the stack trace of the logging event + The stack trace level specifier may be enclosed + between braces. For example, %stacktrace{level}. + If no stack trace level specifier is given then 1 is assumed + + + Output uses the format: + type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1 + + + This pattern is not available for Compact Framework assemblies. + + + + + stacktracedetail + + + Used to output the stack trace of the logging event + The stack trace level specifier may be enclosed + between braces. For example, %stacktracedetail{level}. + If no stack trace level specifier is given then 1 is assumed + + + Output uses the format: + type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...) + + + This pattern is not available for Compact Framework assemblies. + + + t Equivalent to thread @@ -17576,7 +18521,7 @@ The date format specifier admits the same syntax as the - time pattern string of the . + time pattern string of the . For better results it is recommended to use the log4net date @@ -17589,7 +18534,7 @@ These dedicated date formatters perform significantly - better than . + better than . @@ -17761,7 +18706,7 @@ Additional pattern converters may be registered with a specific - instance using the method. + instance using the method. @@ -17781,63 +18726,322 @@ Douglas de la Torre Daniel Cazzulino - + + + Extend this abstract class to create your own log layout format. + + + + This is the base implementation of the + interface. Most layout objects should extend this class. + + + + + + Subclasses must implement the + method. + + + Subclasses should set the in their default + constructor. + + + + Nicko Cadell + Gert Driesen + + + + Interface implemented by layout objects + + + + An object is used to format a + as text. The method is called by an + appender to transform the into a string. + + + The layout can also supply and + text that is appender before any events and after all the events respectively. + + + Nicko Cadell + Gert Driesen + + + + Implement this method to create your own layout format. + + The TextWriter to write the formatted event to + The event to format + + + This method is called by an appender to format + the as text and output to a writer. + + + If the caller does not have a and prefers the + event to be formatted as a then the following + code can be used to format the event into a . + + + StringWriter writer = new StringWriter(); + Layout.Format(writer, loggingEvent); + string formattedEvent = writer.ToString(); + + + + + + The content type output by this layout. + + The content type + + + The content type output by this layout. + + + This is a MIME type e.g. "text/plain". + + + + + + The header for the layout format. + + the layout header + + + The Header text will be appended before any logging events + are formatted and appended. + + + + + + The footer for the layout format. + + the layout footer + + + The Footer text will be appended after all the logging events + have been formatted and appended. + + + + + + Flag indicating if this layout handle exceptions + + false if this layout handles exceptions + + + If this layout handles the exception object contained within + , then the layout should return + false. Otherwise, if the layout ignores the exception + object, then the layout should return true. + + + + + + The header text + + + + See for more information. + + + + + + The footer text + + + + See for more information. + + + + + + Flag indicating if this layout handles exceptions + + + + false if this layout handles exceptions + + + + + + Empty default constructor + + + + Empty default constructor + + + + + + Activate component options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + This method must be implemented by the subclass. + + + + + + Implement this method to create your own layout format. + + The TextWriter to write the formatted event to + The event to format + + + This method is called by an appender to format + the as text. + + + + + + Convenience method for easily formatting the logging event into a string variable. + + + + Creates a new StringWriter instance to store the formatted logging event. + + + + + The content type output by this layout. + + The content type is "text/plain" + + + The content type output by this layout. + + + This base class uses the value "text/plain". + To change this value a subclass must override this + property. + + + + + + The header for the layout format. + + the layout header + + + The Header text will be appended before any logging events + are formatted and appended. + + + + + + The footer for the layout format. + + the layout footer + + + The Footer text will be appended after all the logging events + have been formatted and appended. + + + + - Default pattern string for log output. + Flag indicating if this layout handles exceptions + false if this layout handles exceptions - Default pattern string for log output. - Currently set to the string "%message%newline" - which just prints the application supplied message. + If this layout handles the exception object contained within + , then the layout should return + false. Otherwise, if the layout ignores the exception + object, then the layout should return true. - - - - - A detailed conversion pattern - - - A conversion pattern which includes Time, Thread, Logger, and Nested Context. - Current value is %timestamp [%thread] %level %logger %ndc - %message%newline. + Set this value to override a this default setting. The default + value is true, this layout does not handle the exception. + + + Default pattern string for log output. + + + + Default pattern string for log output. + Currently set to the string "%message%newline" + which just prints the application supplied message. + + + + + + A detailed conversion pattern + + + + A conversion pattern which includes Time, Thread, Logger, and Nested Context. + Current value is %timestamp [%thread] %level %logger %ndc - %message%newline. + + + - - Internal map of converter identifiers to converter types. - - - - This static map is overridden by the m_converterRegistry instance map - - + + Internal map of converter identifiers to converter types. + + + + This static map is overridden by the m_converterRegistry instance map + + - - the pattern - + + the pattern + - - the head of the pattern converter chain - + + the head of the pattern converter chain + - - patterns defined on this PatternLayout only - + + patterns defined on this PatternLayout only + - - Initialize the global registry - - - - Defines the builtin global rules. - - + + Initialize the global registry + + + + Defines the builtin global rules. + + @@ -17920,17 +19124,17 @@ - - - Add a converter to this PatternLayout - - the converter info - - - This version of the method is used by the configurator. - Programmatic users should use the alternative method. - - + + + Add a converter to this PatternLayout + + the converter info + + + This version of the method is used by the configurator. + Programmatic users should use the alternative method. + + @@ -17951,52 +19155,198 @@ + + The pattern formatting string + + + + The ConversionPattern option. This is the string which + controls formatting and consists of a mix of literal content and + conversion specifiers. + + + + + + The header PatternString + + + + + The footer PatternString + + + + + Constructs a DynamicPatternLayout using the DefaultConversionPattern + + + + The default pattern just produces the application supplied message. + + + + + + Constructs a DynamicPatternLayout using the supplied conversion pattern + + the pattern to use + + + + + + The header for the layout format. + + the layout header + + + The Header text will be appended before any logging events + are formatted and appended. + + The pattern will be formatted on each get operation. + + + + + The footer for the layout format. + + the layout footer + + + The Footer text will be appended after all the logging events + have been formatted and appended. + + The pattern will be formatted on each get operation. + + + - The pattern formatting string + A Layout that renders only the Exception text from the logging event - The ConversionPattern option. This is the string which - controls formatting and consists of a mix of literal content and - conversion specifiers. + A Layout that renders only the Exception text from the logging event. + + + This Layout should only be used with appenders that utilize multiple + layouts (e.g. ). + Nicko Cadell + Gert Driesen + + + + Default constructor + + + + Constructs a ExceptionLayout + + - + - Wrapper class used to map converter names to converter types + Activate component options - Pattern converter info class used during configuration to - pass to the - method. + Part of the component activation + framework. + + + This method does nothing as options become effective immediately. - + - default constructor + Gets the exception text from the logging event + The TextWriter to write the formatted event to + the event being logged + + + Write the exception string to the . + The exception string is retrieved from . + + - + - Gets or sets the name of the conversion pattern + Interface for raw layout objects - The name of the pattern in the format string + Interface used to format a + to an object. + + + This interface should not be confused with the + interface. This interface is used in + only certain specialized situations where a raw object is + required rather than a formatted string. The + is not generally useful than this interface. + Nicko Cadell + Gert Driesen + + + + Implement this method to create your own layout format. + + The event to format + returns the formatted event + + + Implement this method to create your own layout format. + + - + - Gets or sets the type of the converter + Adapts any to a - The value specified must extend the - type. + Where an is required this adapter + allows a to be specified. + + + Nicko Cadell + Gert Driesen + + + + The layout to adapt + + + + + Construct a new adapter + + the layout to adapt + + + Create the adapter for the specified . + + + + + + Format the logging event as an object. + + The event to format + returns the formatted event + + + Format the logging event as an object. + + + Uses the object supplied to + the constructor to perform the formatting. @@ -18028,30 +19378,30 @@ Gert Driesen - - Can the source type be converted to the type supported by this object - - the type to convert - true if the conversion is possible - - - Test if the can be converted to the - type supported by this converter. - - + + Can the source type be converted to the type supported by this object + + the type to convert + true if the conversion is possible + + + Test if the can be converted to the + type supported by this converter. + + - - Convert the source object to the type supported by this object - - the object to convert - the converted object - - - Converts the to the type supported - by this converter. - - + + Convert the source object to the type supported by this object + + the object to convert + the converted object + + + Converts the to the type supported + by this converter. + + @@ -18095,9 +19445,9 @@ Nicko Cadell - - Constructs a RawPropertyLayout - + + Constructs a RawPropertyLayout + @@ -18139,9 +19489,9 @@ Gert Driesen - - Constructs a RawTimeStampLayout - + + Constructs a RawTimeStampLayout + @@ -18172,9 +19522,9 @@ Gert Driesen - - Constructs a RawUtcTimeStampLayout - + + Constructs a RawUtcTimeStampLayout + @@ -18193,25 +19543,25 @@ - - A very simple layout - - - - SimpleLayout consists of the level of the log statement, - followed by " - " and then the log message itself. For example, - - DEBUG - Hello world - - - - Nicko Cadell - Gert Driesen + + A very simple layout + + + + SimpleLayout consists of the level of the log statement, + followed by " - " and then the log message itself. For example, + + DEBUG - Hello world + + + + Nicko Cadell + Gert Driesen - - Constructs a SimpleLayout - + + Constructs a SimpleLayout + @@ -18232,18 +19582,18 @@ - - Produces a simple formatted output. - - the event being logged - The TextWriter to write the formatted event to - - - Formats the event as the level of the even, - followed by " - " and then the log message itself. The - output is terminated by a newline. - - + + Produces a simple formatted output. + + the event being logged + The TextWriter to write the formatted event to + + + Formats the event as the level of the even, + followed by " - " and then the log message itself. The + output is terminated by a newline. + + @@ -18265,8 +19615,7 @@ <?xml version="1.0" ?> <!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [<!ENTITY data SYSTEM "abc">]> - - <log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2> + <log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2> &data; </log4net:events> @@ -18318,23 +19667,23 @@ - - Protected constructor to support subclasses - - - - The parameter determines whether - location information will be output by the layout. If - is set to true, then the - file name and line number of the statement at the origin of the log - statement will be output. - - - If you are embedding this layout within an SMTPAppender - then make sure to set the LocationInfo option of that - appender as well. - - + + Protected constructor to support subclasses + + + + The parameter determines whether + location information will be output by the layout. If + is set to true, then the + file name and line number of the statement at the origin of the log + statement will be output. + + + If you are embedding this layout within an SMTPAppender + then make sure to set the LocationInfo option of that + appender as well. + + @@ -18386,20 +19735,15 @@ - - Flag to indicate if location information should be included in - the XML events. - - - - - Writer adapter that ignores Close - + + Flag to indicate if location information should be included in + the XML events. + - - The string to replace invalid chars with - + + The string to replace invalid chars with + @@ -18424,56 +19768,56 @@ - - The string to replace characters that can not be expressed in XML with. - - - Not all characters may be expressed in XML. This property contains the - string to replace those that can not with. This defaults to a ?. Set it - to the empty string to simply remove offending characters. For more - details on the allowed character ranges see http://www.w3.org/TR/REC-xml/#charsets - Character replacement will occur in the log message, the property names - and the property values. - - - + + The string to replace characters that can not be expressed in XML with. + + + Not all characters may be expressed in XML. This property contains the + string to replace those that can not with. This defaults to a ?. Set it + to the empty string to simply remove offending characters. For more + details on the allowed character ranges see http://www.w3.org/TR/REC-xml/#charsets + Character replacement will occur in the log message, the property names + and the property values. + + + - - Gets the content type output by this layout. - - - As this is the XML layout, the value is always "text/xml". - - - - As this is the XML layout, the value is always "text/xml". - - + + Gets the content type output by this layout. + + + As this is the XML layout, the value is always "text/xml". + + + + As this is the XML layout, the value is always "text/xml". + + - - Constructs an XmlLayout - + + Constructs an XmlLayout + - - Constructs an XmlLayout. - - - - The LocationInfo 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. - - - If you are embedding this layout within an SmtpAppender - then make sure to set the LocationInfo option of that - appender as well. - - + + Constructs an XmlLayout. + + + + The LocationInfo 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. + + + If you are embedding this layout within an SmtpAppender + then make sure to set the LocationInfo option of that + appender as well. + + @@ -18510,21 +19854,21 @@ - - The prefix to use for all generated element names - + + The prefix to use for all generated element names + - - The prefix to use for all element names - - - - The default prefix is log4net. Set this property - to change the prefix. If the prefix is set to an empty string - then no prefix will be written. - - + + The prefix to use for all element names + + + + The default prefix is log4net. Set this property + to change the prefix. If the prefix is set to an empty string + then no prefix will be written. + + @@ -18556,67 +19900,67 @@ - - - Layout that formats the log events as XML elements compatible with the log4j schema - - - - Formats the log events according to the http://logging.apache.org/log4j schema. - - - Nicko Cadell - - - - The 1st of January 1970 in UTC - - - - - Constructs an XMLLayoutSchemaLog4j - - - - - Constructs an XMLLayoutSchemaLog4j. - - - - The LocationInfo 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. - - - If you are embedding this layout within an SMTPAppender - then make sure to set the LocationInfo option of that - appender as well. - - - - - - Actually do the writing of the xml - - the writer to use - the event to write - - - Generate XML that is compatible with the log4j schema. - - - + + + Layout that formats the log events as XML elements compatible with the log4j schema + + + + Formats the log events according to the http://logging.apache.org/log4j schema. + + + Nicko Cadell + + + + The 1st of January 1970 in UTC + + + + + Constructs an XMLLayoutSchemaLog4j + + + + + Constructs an XMLLayoutSchemaLog4j. + + + + The LocationInfo 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. + + + If you are embedding this layout within an SMTPAppender + then make sure to set the LocationInfo option of that + appender as well. + + + + + + Actually do the writing of the xml + + the writer to use + the event to write + + + Generate XML that is compatible with the log4j schema. + + + - - The version of the log4j schema to use. - - - - Only version 1.2 of the log4j schema is supported. - - + + The version of the log4j schema to use. + + + + Only version 1.2 of the log4j schema is supported. + + @@ -18649,35 +19993,35 @@ Gert Driesen - - Render the object to a string - - The map used to lookup renderers - The object to render - The writer to render to - - - Render the object to a - string. - - - The parameter is - provided to lookup and render other objects. This is - very useful where contains - nested objects of unknown type. The - method can be used to render these objects. - - + + Render the object to a string + + The map used to lookup renderers + The object to render + The writer to render to + + + Render the object to a + string. + + + The parameter is + provided to lookup and render other objects. This is + very useful where contains + nested objects of unknown type. The + method can be used to render these objects. + + - - Default constructor - - - - Default constructor - - + + Default constructor + + + + Default constructor + + @@ -18694,7 +20038,7 @@ The parameter is provided to lookup and render other objects. This is very useful where contains - nested objects of unknown type. The + nested objects of unknown type. The method can be used to render these objects. @@ -18768,55 +20112,55 @@ - - Render the array argument into a string - - The map used to lookup renderers - the array to render - The writer to render to - - - For a one dimensional array this is the - array type name, an open brace, followed by a comma - separated list of the elements (using the appropriate - renderer), followed by a close brace. For example: - int[] {1, 2, 3}. - - - If the array is not one dimensional the - Array.ToString() is returned. - - + + Render the array argument into a string + + The map used to lookup renderers + the array to render + The writer to render to + + + For a one dimensional array this is the + array type name, an open brace, followed by a comma + separated list of the elements (using the appropriate + renderer), followed by a close brace. For example: + int[] {1, 2, 3}. + + + If the array is not one dimensional the + Array.ToString() is returned. + + - - Render the enumerator argument into a string - - The map used to lookup renderers - the enumerator to render - The writer to render to - - - Rendered as an open brace, followed by a comma - separated list of the elements (using the appropriate - renderer), followed by a close brace. For example: - {a, b, c}. - - + + Render the enumerator argument into a string + + The map used to lookup renderers + the enumerator to render + The writer to render to + + + Rendered as an open brace, followed by a comma + separated list of the elements (using the appropriate + renderer), followed by a close brace. For example: + {a, b, c}. + + - - Render the DictionaryEntry argument into a string - - The map used to lookup renderers - the DictionaryEntry to render - The writer to render to - - - Render the key, an equals sign ('='), and the value (using the appropriate - renderer). For example: key=value. - - + + Render the DictionaryEntry argument into a string + + The map used to lookup renderers + the DictionaryEntry to render + The writer to render to + + + Render the key, an equals sign ('='), and the value (using the appropriate + renderer). For example: key=value. + + @@ -18829,7 +20173,7 @@ is used to render them. - The method is used to render an + The method is used to render an object using the appropriate renderers defined in this map. @@ -18837,14 +20181,14 @@ Gert Driesen - - Default Constructor - - - - Default constructor. - - + + Default Constructor + + + + Default constructor. + + @@ -18855,7 +20199,7 @@ This is a convenience method used to render an object to a string. - The alternative method + The alternative method should be used when streaming output to a . @@ -18870,27 +20214,27 @@ Find the appropriate renderer for the type of the parameter. This is accomplished by calling the - method. Once a renderer is found, it is + method. Once a renderer is found, it is applied on the object and the result is returned as a . - - Gets the renderer for the specified object type - - the object to lookup the renderer for - the renderer for - - - Gets the renderer for the specified object type. - - - Syntactic sugar method that calls - with the type of the object parameter. - - + + Gets the renderer for the specified object type + + the object to lookup the renderer for + the renderer for + + + Gets the renderer for the specified object type. + + + Syntactic sugar method that calls + with the type of the object parameter. + + @@ -18907,11 +20251,11 @@ - - Internal function to recursively search interfaces - - the type to lookup the renderer for - the renderer for the specified type + + Internal function to recursively search interfaces + + the type to lookup the renderer for + the renderer for the specified type @@ -18934,21 +20278,21 @@ Register an object renderer for a specific source type. - This renderer will be returned from a call to + This renderer will be returned from a call to specifying the same as an argument. - - Get the default renderer instance - - the default renderer - - - Get the default renderer - - + + Get the default renderer instance + + the default renderer + + + Get the default renderer + + @@ -18985,16 +20329,16 @@ - - Is called when the plugin is to shutdown. - - - - This method is called to notify the plugin that - it should stop operating and should detach from - the repository. - - + + Is called when the plugin is to shutdown. + + + + This method is called to notify the plugin that + it should stop operating and should detach from + the repository. + + @@ -19018,35 +20362,35 @@ Nicko Cadell - - Creates a read-only wrapper for a PluginCollection instance. - - list to create a readonly wrapper arround - - A PluginCollection wrapper that is read-only. - + + Creates a read-only wrapper for a PluginCollection instance. + + list to create a readonly wrapper arround + + A PluginCollection wrapper that is read-only. + - - Initializes a new instance of the PluginCollection class - that is empty and has the default initial capacity. - + + Initializes a new instance of the PluginCollection class + that is empty and has the default initial capacity. + - - Initializes a new instance of the PluginCollection class - that has the specified initial capacity. - - - The number of elements that the new PluginCollection is initially capable of storing. - + + Initializes a new instance of the PluginCollection class + that has the specified initial capacity. + + + The number of elements that the new PluginCollection is initially capable of storing. + - - Initializes a new instance of the PluginCollection class - that contains elements copied from the specified PluginCollection. - - The PluginCollection whose elements are copied to the new collection. + + Initializes a new instance of the PluginCollection class + that contains elements copied from the specified PluginCollection. + + The PluginCollection whose elements are copied to the new collection. @@ -19063,11 +20407,11 @@ The collection whose elements are copied to the new list. - - Allow subclasses to avoid our default constructors - - - + + Allow subclasses to avoid our default constructors + + + @@ -19092,9 +20436,9 @@ The index at which the value has been added. - - Removes all elements from the PluginCollection. - + + Removes all elements from the PluginCollection. + @@ -19180,42 +20524,42 @@ The new of the PluginCollection. - - Sets the capacity to the actual number of elements. - + + Sets the capacity to the actual number of elements. + - is less than zero. + is less than zero. -or- - is equal to or greater than . + is equal to or greater than . - is less than zero. + is less than zero. -or- - is equal to or greater than . + is equal to or greater than . - - Gets the number of elements actually contained in the PluginCollection. - + + Gets the number of elements actually contained in the PluginCollection. + - - Gets a value indicating whether access to the collection is synchronized (thread-safe). - - true if access to the ICollection is synchronized (thread-safe); otherwise, false. + + Gets a value indicating whether access to the collection is synchronized (thread-safe). + + true if access to the ICollection is synchronized (thread-safe); otherwise, false. - - Gets an object that can be used to synchronize access to the collection. - - - An object that can be used to synchronize access to the collection. - + + Gets an object that can be used to synchronize access to the collection. + + + An object that can be used to synchronize access to the collection. + @@ -19232,24 +20576,24 @@ - - Gets a value indicating whether the collection has a fixed size. - - true if the collection has a fixed size; otherwise, false. The default is false. + + Gets a value indicating whether the collection has a fixed size. + + true if the collection has a fixed size; otherwise, false. The default is false. - - Gets a value indicating whether the IList is read-only. - - true if the collection is read-only; otherwise, false. The default is false. + + Gets a value indicating whether the IList is read-only. + + true if the collection is read-only; otherwise, false. The default is false. - - Gets or sets the number of elements the PluginCollection can contain. - - - The number of elements the PluginCollection can contain. - + + Gets or sets the number of elements the PluginCollection can contain. + + + The number of elements the PluginCollection can contain. + @@ -19270,26 +20614,26 @@ - - Sets the enumerator to its initial position, before the first element in the collection. - + + Sets the enumerator to its initial position, before the first element in the collection. + - - Gets the current element in the collection. - + + Gets the current element in the collection. + - - Type visible only to our subclasses - Used to access protected constructor - - + + Type visible only to our subclasses + Used to access protected constructor + + - - A value - + + A value + @@ -19298,10 +20642,10 @@ - - Initializes a new instance of the Enumerator class. - - + + Initializes a new instance of the Enumerator class. + + @@ -19316,33 +20660,33 @@ - - Sets the enumerator to its initial position, before the first element in the collection. - + + Sets the enumerator to its initial position, before the first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - + - - Map of repository plugins. - - - - This class is a name keyed map of the plugins that are - attached to a repository. - - - Nicko Cadell - Gert Driesen + + Map of repository plugins. + + + + This class is a name keyed map of the plugins that are + attached to a repository. + + + Nicko Cadell + Gert Driesen @@ -19426,13 +20770,13 @@ Gert Driesen - - Constructor - - the name of the plugin - - Initializes a new Plugin with the specified name. - + + Constructor + + the name of the plugin + + Initializes a new Plugin with the specified name. + @@ -19449,26 +20793,26 @@ - - Is called when the plugin is to shutdown. - - - - This method is called to notify the plugin that - it should stop operating and should detach from - the repository. - - + + Is called when the plugin is to shutdown. + + + + This method is called to notify the plugin that + it should stop operating and should detach from + the repository. + + - - The name of this plugin. - + + The name of this plugin. + - - The repository this plugin is attached to. - + + The repository this plugin is attached to. + @@ -19562,29 +20906,38 @@ - - Is called when the plugin is to shutdown. - - - - When the plugin is shutdown the remote logging - sink is disconnected. - - + + Is called when the plugin is to shutdown. + + + + When the plugin is shutdown the remote logging + sink is disconnected. + + + + + + The fully qualified type of the RemoteLoggingServerPlugin class. + + + Used by the internal logger to record the Type of the + log message. + - - Gets or sets the URI of this sink. - - - The URI of this sink. - - - - This is the name under which the object is marshaled. - - - + + Gets or sets the URI of this sink. + + + The URI of this sink. + + + + This is the name under which the object is marshaled. + + + @@ -19621,18 +20974,18 @@ - - Obtains a lifetime service object to control the lifetime - policy for this instance. - - null to indicate that this instance should live forever. - - - Obtains a lifetime service object to control the lifetime - policy for this instance. This object should live forever - therefore this implementation returns null. - - + + Obtains a lifetime service object to control the lifetime + policy for this instance. + + null to indicate that this instance should live forever. + + + Obtains a lifetime service object to control the lifetime + policy for this instance. This object should live forever + therefore this implementation returns null. + + @@ -19664,7 +21017,7 @@ create new objects. - The method is called + The method is called to create a named . @@ -19674,10 +21027,11 @@ Nicko Cadell Gert Driesen - + Create a new instance + The that will own the . The name of the . The instance for the specified name. @@ -19705,10 +21059,11 @@ - + Create a new instance + The that will own the . The name of the . The instance for the specified name. @@ -19784,46 +21139,46 @@ - - Add to the list of appenders of this - Logger instance. - - An appender to add to this logger - - - Add to the list of appenders of this - Logger instance. - - - If is already in the list of - appenders, then it won't be added again. - - + + Add to the list of appenders of this + Logger instance. + + An appender to add to this logger + + + Add to the list of appenders of this + Logger instance. + + + If is already in the list of + appenders, then it won't be added again. + + - - Look for the appender named as name - - The name of the appender to lookup - The appender with the name specified, or null. - - - Returns the named appender, or null if the appender is not found. - - + + Look for the appender named as name + + The name of the appender to lookup + The appender with the name specified, or null. + + + Returns the named appender, or null if the appender is not found. + + - - Remove all previously added appenders from this Logger instance. - - - - Remove all previously added appenders from this Logger instance. - - - This is useful when re-reading configuration information. - - + + Remove all previously added appenders from this Logger instance. + + + + Remove all previously added appenders from this Logger instance. + + + This is useful when re-reading configuration information. + + @@ -19834,61 +21189,61 @@ Remove the appender passed as parameter form the list of appenders. - The appender removed is not closed. - If you are discarding the appender you must call - on the appender removed. - - - - - - Remove the appender passed as parameter form the list of appenders. - - The name of the appender to remove - The appender removed from the list - - - Remove the named appender passed as parameter form the list of appenders. - The appender removed is not closed. - If you are discarding the appender you must call - on the appender removed. - - - - - - This generic form is intended to be used by wrappers. - - The declaring type of the method that is - the stack boundary into the logging system for this call. - The level of the message to be logged. - The message object to log. - The exception to log, including its stack trace. - - - Generate a logging event for the specified using - the and . - - - This method must not throw any exception to the caller. + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. - + - This is the most generic printing method that is intended to be used - by wrappers. + Remove the appender passed as parameter form the list of appenders. - The event being logged. + The name of the appender to remove + The appender removed from the list - Logs the specified logging event through this logger. - - - This method must not throw any exception to the caller. + Remove the named appender passed as parameter form the list of appenders. + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + This generic form is intended to be used by wrappers. + + The declaring type of the method that is + the stack boundary into the logging system for this call. + The level of the message to be logged. + The message object to log. + The exception to log, including its stack trace. + + + Generate a logging event for the specified using + the and . + + + This method must not throw any exception to the caller. + + + + + + This is the most generic printing method that is intended to be used + by wrappers. + + The event being logged. + + + Logs the specified logging event through this logger. + + + This method must not throw any exception to the caller. + + + Checks if this logger is enabled for a given passed as parameter. @@ -19935,90 +21290,90 @@ - - This is the most generic printing method. This generic form is intended to be used by wrappers - - The level of the message to be logged. - The message object to log. - The exception to log, including its stack trace. - - - Generate a logging event for the specified using - the . - - + + This is the most generic printing method. This generic form is intended to be used by wrappers + + The level of the message to be logged. + The message object to log. + The exception to log, including its stack trace. + + + Generate a logging event for the specified using + the . + + - - Creates a new logging event and logs the event without further checks. - - The declaring type of the method that is - the stack boundary into the logging system for this call. - The level of the message to be logged. - The message object to log. - The exception to log, including its stack trace. - - - Generates a logging event and delivers it to the attached - appenders. - - + + Creates a new logging event and logs the event without further checks. + + The declaring type of the method that is + the stack boundary into the logging system for this call. + The level of the message to be logged. + The message object to log. + The exception to log, including its stack trace. + + + Generates a logging event and delivers it to the attached + appenders. + + - - Creates a new logging event and logs the event without further checks. - - The event being logged. - - - Delivers the logging event to the attached appenders. - - - - - - The fully qualified type of the Logger class. - + + Creates a new logging event and logs the event without further checks. + + The event being logged. + + + Delivers the logging event to the attached appenders. + + + + + + The fully qualified type of the Logger class. + - - The name of this logger. - + + The name of this logger. + - - The assigned level of this logger. - - - - The level variable need not be - assigned a value in which case it is inherited - form the hierarchy. - - + + The assigned level of this logger. + + + + The level variable need not be + assigned a value in which case it is inherited + form the hierarchy. + + - - The parent of this logger. - - - - The parent of this logger. - All loggers have at least one ancestor which is the root logger. - - + + The parent of this logger. + + + + The parent of this logger. + All loggers have at least one ancestor which is the root logger. + + - - Loggers need to know what Hierarchy they are in. - - - - Loggers need to know what Hierarchy they are in. - The hierarchy that this logger is a member of is stored - here. - - + + Loggers need to know what Hierarchy they are in. + + + + Loggers need to know what Hierarchy they are in. + The hierarchy that this logger is a member of is stored + here. + + @@ -20026,73 +21381,73 @@ - - Flag indicating if child loggers inherit their parents appenders - - - - Additivity is set to true by default, that is children inherit - the appenders of their ancestors by default. If this variable is - set to false then the appenders found in the - ancestors of this logger are not used. However, the children - of this logger will inherit its appenders, unless the children - have their additivity flag set to false too. See - the user manual for more details. - - + + Flag indicating if child loggers inherit their parents appenders + + + + Additivity is set to true by default, that is children inherit + the appenders of their ancestors by default. If this variable is + set to false then the appenders found in the + ancestors of this logger are not used. However, the children + of this logger will inherit its appenders, unless the children + have their additivity flag set to false too. See + the user manual for more details. + + - - Lock to protect AppenderAttachedImpl variable m_appenderAttachedImpl - + + Lock to protect AppenderAttachedImpl variable m_appenderAttachedImpl + - - Gets or sets the parent logger in the hierarchy. - - - The parent logger in the hierarchy. - - - - Part of the Composite pattern that makes the hierarchy. - The hierarchy is parent linked rather than child linked. - - + + Gets or sets the parent logger in the hierarchy. + + + The parent logger in the hierarchy. + + + + Part of the Composite pattern that makes the hierarchy. + The hierarchy is parent linked rather than child linked. + + - - Gets or sets a value indicating if child loggers inherit their parent's appenders. - - - true if child loggers inherit their parent's appenders. - - - - Additivity is set to true by default, that is children inherit - the appenders of their ancestors by default. If this variable is - set to false then the appenders found in the - ancestors of this logger are not used. However, the children - of this logger will inherit its appenders, unless the children - have their additivity flag set to false too. See - the user manual for more details. - - + + Gets or sets a value indicating if child loggers inherit their parent's appenders. + + + true if child loggers inherit their parent's appenders. + + + + Additivity is set to true by default, that is children inherit + the appenders of their ancestors by default. If this variable is + set to false then the appenders found in the + ancestors of this logger are not used. However, the children + of this logger will inherit its appenders, unless the children + have their additivity flag set to false too. See + the user manual for more details. + + - - Gets the effective level for this logger. - - The nearest level in the logger hierarchy. - - - Starting from this logger, searches the logger hierarchy for a - non-null level and returns it. Otherwise, returns the level of the - root logger. - - The Logger class is designed so that this method executes as - quickly as possible. - + + Gets the effective level for this logger. + + The nearest level in the logger hierarchy. + + + Starting from this logger, searches the logger hierarchy for a + non-null level and returns it. Otherwise, returns the level of the + root logger. + + The Logger class is designed so that this method executes as + quickly as possible. + @@ -20134,17 +21489,17 @@ - - Gets the logger name. - - - The name of the logger. - - - - The name of this logger - - + + Gets the logger name. + + + The name of the logger. + + + + The name of this logger + + @@ -20242,7 +21597,7 @@ The structure of the logger hierarchy is maintained by the - method. The hierarchy is such that children + method. The hierarchy is such that children link to their parent but parents do not have any references to their children. Moreover, loggers can be instantiated in any order, in particular descendant before ancestor. @@ -20280,7 +21635,7 @@ This interface is implemented by logger repositories. e.g. - . + . This interface is used by the @@ -20291,84 +21646,84 @@ Gert Driesen - - Check if the named logger exists in the repository. If so return - its reference, otherwise returns null. - - The name of the logger to lookup - The Logger object with the name specified - - - If the names logger exists it is returned, otherwise - null is returned. - - + + Check if the named logger exists in the repository. If so return + its reference, otherwise returns null. + + The name of the logger to lookup + The Logger object with the name specified + + + If the names logger exists it is returned, otherwise + null is returned. + + - - Returns all the currently defined loggers as an Array. - - All the defined loggers - - - Returns all the currently defined loggers as an Array. - - + + Returns all the currently defined loggers as an Array. + + All the defined loggers + + + Returns all the currently defined loggers as an Array. + + - - Returns a named logger instance - - The name of the logger to retrieve - The logger object with the name specified - - - Returns a named logger instance. - - - If a logger of that name already exists, then it will be - returned. Otherwise, a new logger will be instantiated and - then linked with its existing ancestors as well as children. - - + + Returns a named logger instance + + The name of the logger to retrieve + The logger object with the name specified + + + Returns a named logger instance. + + + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated and + then linked with its existing ancestors as well as children. + + - Shutdown the repository - - - Shutting down a repository will safely close and remove - all appenders in all loggers including the root logger. - - - Some appenders need to be closed before the - application exists. Otherwise, pending logging events might be - lost. - - - The method is careful to close nested - appenders before closing regular appenders. This is allows - configurations where a regular appender is attached to a logger - and again to a nested appender. - - + Shutdown the repository + + + Shutting down a repository will safely close and remove + all appenders in all loggers including the root logger. + + + Some appenders need to be closed before the + application exists. Otherwise, pending logging events might be + lost. + + + The method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + - - Reset the repositories configuration to a default state - - - - Reset all values contained in this instance to their - default state. - - - Existing loggers are not removed. They are just reset. - - - This method should be used sparingly and with care as it will - block all logging until it is completed. - - + + Reset the repositories configuration to a default state + + + + Reset all values contained in this instance to their + default state. + + + Existing loggers are not removed. They are just reset. + + + This method should be used sparingly and with care as it will + block all logging until it is completed. + + @@ -20380,7 +21735,7 @@ This method should not normally be used to log. The interface should be used for routine logging. This interface can be obtained - using the method. + using the method. The logEvent is delivered to the appropriate logger and @@ -20389,28 +21744,28 @@ - - Returns all the Appenders that are configured as an Array. - - All the Appenders - - - Returns all the Appenders that are configured as an Array. - - + + Returns all the Appenders that are configured as an Array. + + All the Appenders + + + Returns all the Appenders that are configured as an Array. + + - - The name of the repository - - - The name of the repository - - - - The name of the repository. - - + + The name of the repository + + + The name of the repository + + + + The name of the repository. + + @@ -20459,145 +21814,151 @@ - - The threshold for all events in this repository - - - The threshold for all events in this repository - - - - The threshold for all events in this repository. - - + + The threshold for all events in this repository + + + The threshold for all events in this repository + + + + The threshold for all events in this repository. + + - - Flag indicates if this repository has been configured. - - - Flag indicates if this repository has been configured. - - - - Flag indicates if this repository has been configured. - - + + Flag indicates if this repository has been configured. + + + Flag indicates if this repository has been configured. + + + + Flag indicates if this repository has been configured. + + + + + + Collection of internal messages captured during the most + recent configuration process. + - - Event to notify that the repository has been shutdown. - - - Event to notify that the repository has been shutdown. - - - - Event raised when the repository has been shutdown. - - + + Event to notify that the repository has been shutdown. + + + Event to notify that the repository has been shutdown. + + + + Event raised when the repository has been shutdown. + + - - Event to notify that the repository has had its configuration reset. - - - Event to notify that the repository has had its configuration reset. - - - - Event raised when the repository's configuration has been - reset to default. - - + + Event to notify that the repository has had its configuration reset. + + + Event to notify that the repository has had its configuration reset. + + + + Event raised when the repository's configuration has been + reset to default. + + - - Event to notify that the repository has had its configuration changed. - - - Event to notify that the repository has had its configuration changed. - - - - Event raised when the repository's configuration has been changed. - - + + Event to notify that the repository has had its configuration changed. + + + Event to notify that the repository has had its configuration changed. + + + + Event raised when the repository's configuration has been changed. + + - - Repository specific properties - - - Repository specific properties - - - - These properties can be specified on a repository specific basis. - - + + Repository specific properties + + + Repository specific properties + + + + These properties can be specified on a repository specific basis. + + - - Default Constructor - - - - Initializes the repository with default (empty) properties. - - + + Default Constructor + + + + Initializes the repository with default (empty) properties. + + - - Construct the repository using specific properties - - the properties to set for this repository - - - Initializes the repository with specified properties. - - + + Construct the repository using specific properties + + the properties to set for this repository + + + Initializes the repository with specified properties. + + - - Test if logger exists - - The name of the logger to lookup - The Logger object with the name specified - - - Check if the named logger exists in the repository. If so return - its reference, otherwise returns null. - - + + Test if logger exists + + The name of the logger to lookup + The Logger object with the name specified + + + Check if the named logger exists in the repository. If so return + its reference, otherwise returns null. + + - - Returns all the currently defined loggers in the repository - - All the defined loggers - - - Returns all the currently defined loggers in the repository as an Array. - - + + Returns all the currently defined loggers in the repository + + All the defined loggers + + + Returns all the currently defined loggers in the repository as an Array. + + - - Return a new logger instance - - The name of the logger to retrieve - The logger object with the name specified - - - Return a new logger instance. - - - If a logger of that name already exists, then it will be - returned. Otherwise, a new logger will be instantiated and - then linked with its existing ancestors as well as children. - - + + Return a new logger instance + + The name of the logger to retrieve + The logger object with the name specified + + + Return a new logger instance. + + + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated and + then linked with its existing ancestors as well as children. + + @@ -20605,30 +21966,30 @@ - Shutdown the repository. Can be overridden in a subclass. - This base class implementation notifies the - listeners and all attached plugins of the shutdown event. - - - - - - Reset the repositories configuration to a default state - - - - Reset all values contained in this instance to their - default state. - - - Existing loggers are not removed. They are just reset. - - - This method should be used sparingly and with care as it will - block all logging until it is completed. + Shutdown the repository. Can be overridden in a subclass. + This base class implementation notifies the + listeners and all attached plugins of the shutdown event. + + + Reset the repositories configuration to a default state + + + + Reset all values contained in this instance to their + default state. + + + Existing loggers are not removed. They are just reset. + + + This method should be used sparingly and with care as it will + block all logging until it is completed. + + + Log the logEvent through this repository. @@ -20639,7 +22000,7 @@ This method should not normally be used to log. The interface should be used for routine logging. This interface can be obtained - using the method. + using the method. The logEvent is delivered to the appropriate logger and @@ -20648,72 +22009,81 @@ - - Returns all the Appenders that are configured as an Array. - - All the Appenders - - - Returns all the Appenders that are configured as an Array. - - + + Returns all the Appenders that are configured as an Array. + + All the Appenders + + + Returns all the Appenders that are configured as an Array. + + + + + + The fully qualified type of the LoggerRepositorySkeleton class. + + + Used by the internal logger to record the Type of the + log message. + - - Adds an object renderer for a specific class. - - The type that will be rendered by the renderer supplied. - The object renderer used to render the object. - - - Adds an object renderer for a specific class. - - + + Adds an object renderer for a specific class. + + The type that will be rendered by the renderer supplied. + The object renderer used to render the object. + + + Adds an object renderer for a specific class. + + - - Notify the registered listeners that the repository is shutting down - - Empty EventArgs - - - Notify any listeners that this repository is shutting down. - - + + Notify the registered listeners that the repository is shutting down + + Empty EventArgs + + + Notify any listeners that this repository is shutting down. + + - - Notify the registered listeners that the repository has had its configuration reset - - Empty EventArgs - - - Notify any listeners that this repository's configuration has been reset. - - + + Notify the registered listeners that the repository has had its configuration reset + + Empty EventArgs + + + Notify any listeners that this repository's configuration has been reset. + + - - Notify the registered listeners that the repository has had its configuration changed - - Empty EventArgs - - - Notify any listeners that this repository's configuration has changed. - - + + Notify the registered listeners that the repository has had its configuration changed + + Empty EventArgs + + + Notify any listeners that this repository's configuration has changed. + + - - Raise a configuration changed event on this repository - - EventArgs.Empty - - - Applications that programmatically change the configuration of the repository should - raise this event notification to notify listeners. - - + + Raise a configuration changed event on this repository + + EventArgs.Empty + + + Applications that programmatically change the configuration of the repository should + raise this event notification to notify listeners. + + @@ -20731,17 +22101,17 @@ - - The threshold for all events in this repository - - - The threshold for all events in this repository - - - - The threshold for all events in this repository - - + + The threshold for all events in this repository + + + The threshold for all events in this repository + + + + The threshold for all events in this repository + + @@ -20790,68 +22160,74 @@ - - Flag indicates if this repository has been configured. - - - Flag indicates if this repository has been configured. - - - - Flag indicates if this repository has been configured. - - + + Flag indicates if this repository has been configured. + + + Flag indicates if this repository has been configured. + + + + Flag indicates if this repository has been configured. + + + + + + Contains a list of internal messages captures during the + last configuration. + - - Event to notify that the repository has been shutdown. - - - Event to notify that the repository has been shutdown. - - - - Event raised when the repository has been shutdown. - - + + Event to notify that the repository has been shutdown. + + + Event to notify that the repository has been shutdown. + + + + Event raised when the repository has been shutdown. + + - - Event to notify that the repository has had its configuration reset. - - - Event to notify that the repository has had its configuration reset. - - - - Event raised when the repository's configuration has been - reset to default. - - + + Event to notify that the repository has had its configuration reset. + + + Event to notify that the repository has had its configuration reset. + + + + Event raised when the repository's configuration has been + reset to default. + + - - Event to notify that the repository has had its configuration changed. - - - Event to notify that the repository has had its configuration changed. - - - - Event raised when the repository's configuration has been changed. - - + + Event to notify that the repository has had its configuration changed. + + + Event to notify that the repository has had its configuration changed. + + + + Event raised when the repository's configuration has been changed. + + - - Repository specific properties - - - Repository specific properties - - - These properties can be specified on a repository specific basis - + + Repository specific properties + + + Repository specific properties + + + These properties can be specified on a repository specific basis + @@ -20871,16 +22247,28 @@ Gert Driesen - - Initialize the repository using the specified appender - - the appender to use to log all logging events - - - Configure the repository to route all logging events to the - specified appender. - - + + Initialize the repository using the specified appender + + the appender to use to log all logging events + + + Configure the repository to route all logging events to the + specified appender. + + + + + + Initialize the repository using the specified appenders + + the appenders to use to log all logging events + + + Configure the repository to route all logging events to the + specified appenders. + + @@ -20899,16 +22287,16 @@ Gert Driesen - - Initialize the repository using the specified config - - the element containing the root of the config - - - The schema for the XML configuration data is defined by - the implementation. - - + + Initialize the repository using the specified config + + the element containing the root of the config + + + The schema for the XML configuration data is defined by + the implementation. + + @@ -20957,72 +22345,72 @@ - - Test if a logger exists - - The name of the logger to lookup - The Logger object with the name specified - - - Check if the named logger exists in the hierarchy. If so return - its reference, otherwise returns null. - - + + Test if a logger exists + + The name of the logger to lookup + The Logger object with the name specified + + + Check if the named logger exists in the hierarchy. If so return + its reference, otherwise returns null. + + - - Returns all the currently defined loggers in the hierarchy as an Array - - All the defined loggers - - - Returns all the currently defined loggers in the hierarchy as an Array. - The root logger is not included in the returned - enumeration. - - + + Returns all the currently defined loggers in the hierarchy as an Array + + All the defined loggers + + + Returns all the currently defined loggers in the hierarchy as an Array. + The root logger is not included in the returned + enumeration. + + - - Return a new logger instance named as the first parameter using - the default factory. - - - - Return a new logger instance named as the first parameter using - the default factory. - - - If a logger of that name already exists, then it will be - returned. Otherwise, a new logger will be instantiated and - then linked with its existing ancestors as well as children. - - - The name of the logger to retrieve - The logger object with the name specified + + Return a new logger instance named as the first parameter using + the default factory. + + + + Return a new logger instance named as the first parameter using + the default factory. + + + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated and + then linked with its existing ancestors as well as children. + + + The name of the logger to retrieve + The logger object with the name specified - - Shutting down a hierarchy will safely close and remove - all appenders in all loggers including the root logger. - - - - Shutting down a hierarchy will safely close and remove - all appenders in all loggers including the root logger. - - - Some appenders need to be closed before the - application exists. Otherwise, pending logging events might be - lost. - - - The Shutdown method is careful to close nested - appenders before closing regular appenders. This is allows - configurations where a regular appender is attached to a logger - and again to a nested appender. - - + + Shutting down a hierarchy will safely close and remove + all appenders in all loggers including the root logger. + + + + Shutting down a hierarchy will safely close and remove + all appenders in all loggers including the root logger. + + + Some appenders need to be closed before the + application exists. Otherwise, pending logging events might be + lost. + + + The Shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + @@ -21056,7 +22444,7 @@ This method should not normally be used to log. The interface should be used for routine logging. This interface can be obtained - using the method. + using the method. The logEvent is delivered to the appropriate logger and @@ -21096,42 +22484,48 @@ - - Initialize the log4net system using the specified appender - - the appender to use to log all logging events - - - - Initialize the log4net system using the specified appender - - the appender to use to log all logging events - - - This method provides the same functionality as the - method implemented - on this object, but it is protected and therefore can be called by subclasses. - - + + Initialize the log4net system using the specified appender + + the appender to use to log all logging events + + + + Initialize the log4net system using the specified appenders + + the appenders to use to log all logging events + + + + Initialize the log4net system using the specified appenders + + the appenders to use to log all logging events + + + This method provides the same functionality as the + method implemented + on this object, but it is protected and therefore can be called by subclasses. + + - - Initialize the log4net system using the specified config - - the element containing the root of the config + + Initialize the log4net system using the specified config + + the element containing the root of the config - - Initialize the log4net system using the specified config - - the element containing the root of the config - - - This method provides the same functionality as the - method implemented - on this object, but it is protected and therefore can be called by subclasses. - - + + Initialize the log4net system using the specified config + + the element containing the root of the config + + + This method provides the same functionality as the + method implemented + on this object, but it is protected and therefore can be called by subclasses. + + @@ -21157,83 +22551,83 @@ - - Clear all logger definitions from the internal hashtable - - - - This call will clear all logger definitions from the internal - hashtable. Invoking this method will irrevocably mess up the - logger hierarchy. - - - You should really know what you are doing before - invoking this method. - - + + Clear all logger definitions from the internal hashtable + + + + This call will clear all logger definitions from the internal + hashtable. Invoking this method will irrevocably mess up the + logger hierarchy. + + + You should really know what you are doing before + invoking this method. + + - - Return a new logger instance named as the first parameter using - . - - The name of the logger to retrieve - The factory that will make the new logger instance - The logger object with the name specified - - - If a logger of that name already exists, then it will be - returned. Otherwise, a new logger will be instantiated by the - parameter and linked with its existing - ancestors as well as children. - - + + Return a new logger instance named as the first parameter using + . + + The name of the logger to retrieve + The factory that will make the new logger instance + The logger object with the name specified + + + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated by the + parameter and linked with its existing + ancestors as well as children. + + - - Sends a logger creation event to all registered listeners - - The newly created logger - - Raises the logger creation event. - + + Sends a logger creation event to all registered listeners + + The newly created logger + + Raises the logger creation event. + - - Updates all the parents of the specified logger - - The logger to update the parents for - - - This method loops through all the potential parents of - . There 3 possible cases: - - - - No entry for the potential parent of exists - - We create a ProvisionNode for this potential - parent and insert in that provision node. - - - - The entry is of type Logger for the potential parent. - - The entry is 's nearest existing parent. We - update 's parent field with this entry. We also break from - he loop because updating our parent's parent is our parent's - responsibility. - - - - The entry is of type ProvisionNode for this potential parent. - - We add to the list of children for this - potential parent. - - - - + + Updates all the parents of the specified logger + + The logger to update the parents for + + + This method loops through all the potential parents of + . There 3 possible cases: + + + + No entry for the potential parent of exists + + We create a ProvisionNode for this potential + parent and insert in that provision node. + + + + The entry is of type Logger for the potential parent. + + The entry is 's nearest existing parent. We + update 's parent field with this entry. We also break from + he loop because updating our parent's parent is our parent's + responsibility. + + + + The entry is of type ProvisionNode for this potential parent. + + We add to the list of children for this + potential parent. + + + + @@ -21256,176 +22650,143 @@ 'log' then there is no need to update 'c'. - Otherwise, we set log's parent field to c's parent and set - c's parent field to log. - - - - - - Define or redefine a Level using the values in the argument - - the level values - - - Define or redefine a Level using the values in the argument - - - Supports setting levels via the configuration file. - - - - - - Set a Property using the values in the argument - - the property value - - - Set a Property using the values in the argument. - - - Supports setting property values via the configuration file. - - - - - - Event used to notify that a logger has been created. - - - - Event raised when a logger is created. - - - - - - Has no appender warning been emitted - - - - Flag to indicate if we have already issued a warning - about not having an appender warning. - - - - - - Get the root of this hierarchy - - - - Get the root of this hierarchy. - - - - - - Gets or sets the default instance. - - The default - - - The logger factory is used to create logger instances. - - - - - - A class to hold the value, name and display name for a level - - - - A class to hold the value, name and display name for a level + Otherwise, we set log's parent field to c's parent and set + c's parent field to log. - - - Override Object.ToString to return sensible debug info - - string info about this object - - + - Value of the level + Define or redefine a Level using the values in the argument + the level values - If the value is not set (defaults to -1) the value will be looked - up for the current level with the same name. + Define or redefine a Level using the values in the argument - - - - - Name of the level - - - The name of the level - - - The name of the level. + Supports setting levels via the configuration file. - + - Display name for the level + Set a Property using the values in the argument - - The display name of the level - + the property value - The display name of the level. + Set a Property using the values in the argument. - - - - - A class to hold the key and data for a property set in the config file - - - A class to hold the key and data for a property set in the config file + Supports setting property values via the configuration file. - - - Override Object.ToString to return sensible debug info - - string info about this object + + + The fully qualified type of the Hierarchy class. + + + Used by the internal logger to record the Type of the + log message. + - - - Property Key - - - Property Key - - - - Property Key. - - + + + Event used to notify that a logger has been created. + + + + Event raised when a logger is created. + + + + + + Has no appender warning been emitted + + + + Flag to indicate if we have already issued a warning + about not having an appender warning. + + + + + + Get the root of this hierarchy + + + + Get the root of this hierarchy. + + - + - Property Value + Gets or sets the default instance. - - Property Value - + The default - Property Value. + The logger factory is used to create logger instances. + + + A class to hold the value, name and display name for a level + + + + A class to hold the value, name and display name for a level + + + + + + Override Object.ToString to return sensible debug info + + string info about this object + + + + Value of the level + + + + If the value is not set (defaults to -1) the value will be looked + up for the current level with the same name. + + + + + + Name of the level + + + The name of the level + + + + The name of the level. + + + + + + Display name for the level + + + The display name of the level + + + + The display name of the level. + + + Used internally to accelerate hash table searches. @@ -21468,15 +22829,15 @@ The name of the logger. - - Returns a hash code for the current instance. - - A hash code for the current instance. - - - Returns the cached hashcode. - - + + Returns a hash code for the current instance. + + A hash code for the current instance. + + + Returns the cached hashcode. + + @@ -21558,6 +22919,15 @@ + + + The fully qualified type of the RootLogger class. + + + Used by the internal logger to record the Type of the + log message. + + Gets the assigned level value without walking the logger hierarchy. @@ -21610,125 +22980,125 @@ - - Configure the hierarchy by parsing a DOM tree of XML elements. - - The root element to parse. - - - Configure the hierarchy by parsing a DOM tree of XML elements. - - + + Configure the hierarchy by parsing a DOM tree of XML elements. + + The root element to parse. + + + Configure the hierarchy by parsing a DOM tree of XML elements. + + - - Parse appenders by IDREF. - - The appender ref element. - The instance of the appender that the ref refers to. - - - Parse an XML element that represents an appender and return - the appender. - - + + Parse appenders by IDREF. + + The appender ref element. + The instance of the appender that the ref refers to. + + + Parse an XML element that represents an appender and return + the appender. + + - - Parses an appender element. - - The appender element. - The appender instance or null when parsing failed. - - - Parse an XML element that represents an appender and return - the appender instance. - - + + Parses an appender element. + + The appender element. + The appender instance or null when parsing failed. + + + Parse an XML element that represents an appender and return + the appender instance. + + - - Parses a logger element. - - The logger element. - - - Parse an XML element that represents a logger. - - + + Parses a logger element. + + The logger element. + + + Parse an XML element that represents a logger. + + - - Parses the root logger element. - - The root element. - - - Parse an XML element that represents the root logger. - - + + Parses the root logger element. + + The root element. + + + Parse an XML element that represents the root logger. + + - - Parses the children of a logger element. - - The category element. - The logger instance. - Flag to indicate if the logger is the root logger. - - - Parse the child elements of a <logger> element. - - + + Parses the children of a logger element. + + The category element. + The logger instance. + Flag to indicate if the logger is the root logger. + + + Parse the child elements of a <logger> element. + + - - Parses an object renderer. - - The renderer element. - - - Parse an XML element that represents a renderer. - - + + Parses an object renderer. + + The renderer element. + + + Parse an XML element that represents a renderer. + + - - Parses a level element. - - The level element. - The logger object to set the level on. - Flag to indicate if the logger is the root logger. - - - Parse an XML element that represents a level. - - + + Parses a level element. + + The level element. + The logger object to set the level on. + Flag to indicate if the logger is the root logger. + + + Parse an XML element that represents a level. + + - - Sets a parameter on an object. - - The parameter element. - The object to set the parameter on. - - The parameter name must correspond to a writable property - on the object. The value of the parameter is a string, - therefore this function will attempt to set a string - property first. If unable to set a string property it - will inspect the property and its argument type. It will - attempt to call a static method called Parse on the - type of the property. This method will take a single - string argument and return a value that can be used to - set the property. - + + Sets a parameter on an object. + + The parameter element. + The object to set the parameter on. + + The parameter name must correspond to a writable property + on the object. The value of the parameter is a string, + therefore this function will attempt to set a string + property first. If unable to set a string property it + will inspect the property and its argument type. It will + attempt to call a static method called Parse on the + type of the property. This method will take a single + string argument and return a value that can be used to + set the property. + - - Test if an element has no attributes or child elements - - the element to inspect - true if the element has any attributes or child elements, false otherwise + + Test if an element has no attributes or child elements + + the element to inspect + true if the element has any attributes or child elements, false otherwise @@ -21738,63 +23108,88 @@ true if the type is creatable using a default constructor, false otherwise - - Look for a method on the that matches the supplied - - the type that has the method - the name of the method - the method info found - - - The method must be a public instance method on the . - The method must be named or "Add" followed by . - The method must take a single parameter. - - + + Look for a method on the that matches the supplied + + the type that has the method + the name of the method + the method info found + + + The method must be a public instance method on the . + The method must be named or "Add" followed by . + The method must take a single parameter. + + - - Converts a string value to a target type. - - The type of object to convert the string to. - The string value to use as the value of the object. - - - An object of type with value or - null when the conversion could not be performed. - - + + Converts a string value to a target type. + + The type of object to convert the string to. + The string value to use as the value of the object. + + + An object of type with value or + null when the conversion could not be performed. + + - - Creates an object as specified in XML. - - The XML element that contains the definition of the object. - The object type to use if not explicitly specified. - The type that the returned object must be or must inherit from. - The object or null - - - Parse an XML element and create an object instance based on the configuration - data. - - - The type of the instance may be specified in the XML. If not - specified then the is used - as the type. However the type is specified it must support the - type. - - + + Creates an object as specified in XML. + + The XML element that contains the definition of the object. + The object type to use if not explicitly specified. + The type that the returned object must be or must inherit from. + The object or null + + + Parse an XML element and create an object instance based on the configuration + data. + + + The type of the instance may be specified in the XML. If not + specified then the is used + as the type. However the type is specified it must support the + type. + + - - key: appenderName, value: appender. - + + key: appenderName, value: appender. + - - The Hierarchy being configured. - + + The Hierarchy being configured. + + + + + The fully qualified type of the XmlHierarchyConfigurator class. + + + Used by the internal logger to record the Type of the + log message. + + + + + + + + + + + + + + + + + @@ -21833,27 +23228,27 @@ - - Write the name of the current AppDomain to the output - - - - Write the name of the current AppDomain to the output writer - - - Nicko Cadell + + Write the name of the current AppDomain to the output + + + + Write the name of the current AppDomain to the output writer + + + Nicko Cadell - - Write the name of the current AppDomain to the output - - the writer to write to - null, state is not set - - - Writes name of the current AppDomain to the output . - - + + Write the name of the current AppDomain to the output + + the writer to write to + null, state is not set + + + Writes name of the current AppDomain to the output . + + @@ -21898,7 +23293,7 @@ Any other pattern string uses the formatter. This formatter passes the pattern string to the - method. + method. For details on valid patterns see DateTimeFormatInfo Class. @@ -21956,57 +23351,122 @@ - + + + The fully qualified type of the DatePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + - Write an environment variable to the output + Write an folder path to the output - Write an environment variable to the output writer. + Write an special path environment folder path to the output writer. The value of the determines - the name of the variable to output. + the name of the variable to output. + should be a value in the enumeration. - Nicko Cadell + Ron Grabowski - + - Write an environment variable to the output + Write an special path environment folder path to the output the writer to write to null, state is not set - Writes the environment variable to the output . - The name of the environment variable to output must be set + Writes the special path environment folder path to the output . + The name of the special path environment folder path to output must be set using the property. - + + + The fully qualified type of the EnvironmentFolderPathPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + - Write the current thread identity to the output + Write an environment variable to the output - Write the current thread identity to the output writer + Write an environment variable to the output writer. + The value of the determines + the name of the variable to output. Nicko Cadell - + - Write the current thread identity to the output + Write an environment variable to the output the writer to write to null, state is not set - Writes the current thread identity to the output . + Writes the environment variable to the output . + The name of the environment variable to output must be set + using the + property. + + + The fully qualified type of the EnvironmentPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write the current thread identity to the output + + + + Write the current thread identity to the output writer + + + Nicko Cadell + + + + Write the current thread identity to the output + + the writer to write to + null, state is not set + + + Writes the current thread identity to the output . + + + + + + The fully qualified type of the IdentityPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + Pattern converter for literal string instances in the pattern @@ -22112,27 +23572,36 @@ - - Write the current process ID to the output - - - - Write the current process ID to the output writer - - - Nicko Cadell + + Write the current process ID to the output + + + + Write the current process ID to the output writer + + + Nicko Cadell - - Write the current process ID to the output - - the writer to write to - null, state is not set - - - Write the current process ID to the output . - - + + Write the current process ID to the output + + the writer to write to + null, state is not set + + + Write the current process ID to the output . + + + + + + The fully qualified type of the ProcessIdPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + @@ -22193,68 +23662,86 @@ Nicko Cadell - - Shared random number generator - - - - - Length of random string to generate. Default length 4. - - - - - Initialize the converter options - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - Write a randoim string to the output - - the writer to write to - null, state is not set - - - Write a randoim string to the output . - - - - - - Write the current threads username to the output - - - - Write the current threads username to the output writer - - - Nicko Cadell + + Shared random number generator + - + + + Length of random string to generate. Default length 4. + + + - Write the current threads username to the output + Initialize the converter options - the writer to write to - null, state is not set - Write the current threads username to the output . + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + Write a randoim string to the output + + the writer to write to + null, state is not set + + + Write a randoim string to the output . + + + + + + The fully qualified type of the RandomStringPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write the current threads username to the output + + + + Write the current threads username to the output writer + + + Nicko Cadell + + + + Write the current threads username to the output + + the writer to write to + null, state is not set + + + Write the current threads username to the output . + + + + + + The fully qualified type of the UserNamePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + Write the UTC date time to the output @@ -22288,6 +23775,15 @@ + + + The fully qualified type of the UtcDatePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + Type converter for Boolean. @@ -22433,8 +23929,8 @@ types. - Use the and - methods to register new converters. + Use the and + methods to register new converters. The and methods lookup appropriate converters to use. @@ -22453,26 +23949,26 @@ - - Static constructor. - - - - This constructor defines the intrinsic type converters. - - + + Static constructor. + + + + This constructor defines the intrinsic type converters. + + - - Adds a converter for a specific type. - - The type being converted to. - The type converter to use to convert to the destination type. - - - Adds a converter instance for a specific type. - - + + Adds a converter for a specific type. + + The type being converted to. + The type converter to use to convert to the destination type. + + + Adds a converter instance for a specific type. + + @@ -22487,46 +23983,46 @@ - - Gets the type converter to use to convert values to the destination type. - - The type being converted from. - The type being converted to. - - The type converter instance to use for type conversions or null - if no type converter is found. - - - - Gets the type converter to use to convert values to the destination type. - - + + Gets the type converter to use to convert values to the destination type. + + The type being converted from. + The type being converted to. + + The type converter instance to use for type conversions or null + if no type converter is found. + + + + Gets the type converter to use to convert values to the destination type. + + - - Gets the type converter to use to convert values to the destination type. - - The type being converted to. - - The type converter instance to use for type conversions or null - if no type converter is found. - - - - Gets the type converter to use to convert values to the destination type. - - + + Gets the type converter to use to convert values to the destination type. + + The type being converted to. + + The type converter instance to use for type conversions or null + if no type converter is found. + + + + Gets the type converter to use to convert values to the destination type. + + - - Lookups the type converter to use as specified by the attributes on the - destination type. - - The type being converted to. - - The type converter instance to use for type conversions or null - if no type converter is found. - + + Lookups the type converter to use as specified by the attributes on the + destination type. + + The type being converted to. + + The type converter instance to use for type conversions or null + if no type converter is found. + @@ -22545,6 +24041,15 @@ + + + The fully qualified type of the ConverterRegistry class. + + + Used by the internal logger to record the Type of the + log message. + + Mapping from to type converter. @@ -22586,7 +24091,7 @@ the encoding - Uses the method to + Uses the method to convert the argument to an . @@ -22609,31 +24114,31 @@ Nicko Cadell - - Returns whether this converter can convert the object to the specified type - - A Type that represents the type you want to convert to - true if the conversion is possible - - - Test if the type supported by this converter can be converted to the - . - - + + Returns whether this converter can convert the object to the specified type + + A Type that represents the type you want to convert to + true if the conversion is possible + + + Test if the type supported by this converter can be converted to the + . + + - - Converts the given value object to the specified type, using the arguments - - the object to convert - The Type to convert the value parameter to - the converted object - - - Converts the (which must be of the type supported - by this converter) to the specified.. - - + + Converts the given value object to the specified type, using the arguments + + the object to convert + The Type to convert the value parameter to + the converted object + + + Converts the (which must be of the type supported + by this converter) to the specified.. + + @@ -22681,9 +24186,9 @@ - - Valid characters in an IPv4 or IPv6 address string. (Does not support subnets) - + + Valid characters in an IPv4 or IPv6 address string. (Does not support subnets) + @@ -22776,7 +24281,7 @@ the converted object - Uses the method to convert the + Uses the method to convert the argument to a . @@ -22853,7 +24358,7 @@ the Type - Uses the method to convert the + Uses the method to convert the argument to a . Additional effort is made to locate partially specified types by searching the loaded assemblies. @@ -22866,37 +24371,37 @@ - - Attribute used to associate a type converter - - - - Class and Interface level attribute that specifies a type converter - to use with the associated type. - - - To associate a type converter with a target type apply a - TypeConverterAttribute to the target type. Specify the - type of the type converter on the attribute. - - - Nicko Cadell - Gert Driesen + + Attribute used to associate a type converter + + + + Class and Interface level attribute that specifies a type converter + to use with the associated type. + + + To associate a type converter with a target type apply a + TypeConverterAttribute to the target type. Specify the + type of the type converter on the attribute. + + + Nicko Cadell + Gert Driesen - - The string type name of the type converter - + + The string type name of the type converter + - - Default constructor - - - - Default constructor - - + + Default constructor + + + + Default constructor + + @@ -23003,40 +24508,40 @@ - - Attaches an appender. - - The appender to add. - - - If the appender is already in the list it won't be added again. - - + + Attaches an appender. + + The appender to add. + + + If the appender is already in the list it won't be added again. + + - - Gets an attached appender with the specified name. - - The name of the appender to get. - - The appender with the name specified, or null if no appender with the - specified name is found. - - - - Lookup an attached appender by name. - - + + Gets an attached appender with the specified name. + + The name of the appender to get. + + The appender with the name specified, or null if no appender with the + specified name is found. + + + + Lookup an attached appender by name. + + - - Removes all attached appenders. - - - - Removes and closes all attached appenders - - + + Removes all attached appenders. + + + + Removes and closes all attached appenders + + @@ -23067,28 +24572,37 @@ - - List of appenders - + + List of appenders + - - Array of appenders, used to cache the m_appenderList - + + Array of appenders, used to cache the m_appenderList + + + + + The fully qualified type of the AppenderAttachedImpl class. + + + Used by the internal logger to record the Type of the + log message. + - - Gets all attached appenders. - - - A collection of attached appenders, or null if there - are no attached appenders. - - - - The read only collection of all currently attached appenders. - - + + Gets all attached appenders. + + + A collection of attached appenders, or null if there + are no attached appenders. + + + + The read only collection of all currently attached appenders. + + @@ -23113,28 +24627,28 @@ - - Add a Properties Dictionary to this composite collection - - the properties to add - - - Properties dictionaries added first take precedence over dictionaries added - later. - - + + Add a Properties Dictionary to this composite collection + + the properties to add + + + Properties dictionaries added first take precedence over dictionaries added + later. + + - - Flatten this composite collection into a single properties dictionary - - the flattened dictionary - - - Reduces the collection of ordered dictionaries to a single dictionary - containing the resultant values for the keys. - - + + Flatten this composite collection into a single properties dictionary + + the flattened dictionary + + + Reduces the collection of ordered dictionaries to a single dictionary + containing the resultant values for the keys. + + @@ -23158,29 +24672,77 @@ - - Base class for Context Properties implementations - - - - This class defines a basic property get set accessor - - - Nicko Cadell + + Base class for Context Properties implementations + + + + This class defines a basic property get set accessor + + + Nicko Cadell + + Gets or sets the value of a property + + + The value for the property with the specified key + + + + Gets or sets the value of a property + + + + + + Wrapper class used to map converter names to converter types + + + + Pattern converter info class used during configuration by custom + PatternString and PatternLayer converters. + + + + + + default constructor + + + + + + + + + + + Gets or sets the name of the conversion pattern + + + + The name of the pattern in the format string + + + + - Gets or sets the value of a property + Gets or sets the type of the converter - - The value for the property with the specified key - - Gets or sets the value of a property + The value specified must extend the + type. + + + + + Subclass of that maintains a count of @@ -23221,9 +24783,9 @@ Nicko Cadell - - The writer to forward messages to - + + The writer to forward messages to + @@ -23239,70 +24801,70 @@ - - Closes the writer and releases any system resources associated with the writer - - - - - + + Closes the writer and releases any system resources associated with the writer + + + + + - - Dispose this writer - - flag indicating if we are being disposed - - - Dispose this writer - - + + Dispose this writer + + flag indicating if we are being disposed + + + Dispose this writer + + - - Flushes any buffered output - - - - Clears all buffers for the writer and causes any buffered data to be written - to the underlying device - - + + Flushes any buffered output + + + + Clears all buffers for the writer and causes any buffered data to be written + to the underlying device + + - - Writes a character to the wrapped TextWriter - - the value to write to the TextWriter - - - Writes a character to the wrapped TextWriter - - + + Writes a character to the wrapped TextWriter + + the value to write to the TextWriter + + + Writes a character to the wrapped TextWriter + + - - Writes a character buffer to the wrapped TextWriter - - the data buffer - the start index - the number of characters to write - - - Writes a character buffer to the wrapped TextWriter - - + + Writes a character buffer to the wrapped TextWriter + + the data buffer + the start index + the number of characters to write + + + Writes a character buffer to the wrapped TextWriter + + - - Writes a string to the wrapped TextWriter - - the value to write to the TextWriter - - - Writes a string to the wrapped TextWriter - - + + Writes a string to the wrapped TextWriter + + the value to write to the TextWriter + + + Writes a string to the wrapped TextWriter + + @@ -23331,123 +24893,123 @@ - - Gets an object that controls formatting - - - The format provider - - - - Gets an object that controls formatting - - + + Gets an object that controls formatting + + + The format provider + + + + Gets an object that controls formatting + + - - Gets or sets the line terminator string used by the TextWriter - - - The line terminator to use - - - - Gets or sets the line terminator string used by the TextWriter - - + + Gets or sets the line terminator string used by the TextWriter + + + The line terminator to use + + + + Gets or sets the line terminator string used by the TextWriter + + - - Constructor - - the writer to actually write to - the error handler to report error to - - - Create a new QuietTextWriter using a writer and error handler - - + + Constructor + + the writer to actually write to + the error handler to report error to + + + Create a new QuietTextWriter using a writer and error handler + + - - Writes a character to the underlying writer - - the char to write - - - Writes a character to the underlying writer - - + + Writes a character to the underlying writer + + the char to write + + + Writes a character to the underlying writer + + - - Writes a buffer to the underlying writer - - the buffer to write - the start index to write from - the number of characters to write - - - Writes a buffer to the underlying writer - - + + Writes a buffer to the underlying writer + + the buffer to write + the start index to write from + the number of characters to write + + + Writes a buffer to the underlying writer + + - - Writes a string to the output. - - The string data to write to the output. - - - Writes a string to the output. - - + + Writes a string to the output. + + The string data to write to the output. + + + Writes a string to the output. + + - - Closes the underlying output writer. - - - - Closes the underlying output writer. - - + + Closes the underlying output writer. + + + + Closes the underlying output writer. + + - - The error handler instance to pass all errors to - + + The error handler instance to pass all errors to + - - Flag to indicate if this writer is closed - + + Flag to indicate if this writer is closed + - - Gets or sets the error handler that all errors are passed to. - - - The error handler that all errors are passed to. - - - - Gets or sets the error handler that all errors are passed to. - - + + Gets or sets the error handler that all errors are passed to. + + + The error handler that all errors are passed to. + + + + Gets or sets the error handler that all errors are passed to. + + - - Gets a value indicating whether this writer is closed. - - - true if this writer is closed, otherwise false. - - - - Gets a value indicating whether this writer is closed. - - + + Gets a value indicating whether this writer is closed. + + + true if this writer is closed, otherwise false. + + + + Gets a value indicating whether this writer is closed. + + @@ -23501,34 +25063,34 @@ - - Total number of bytes written. - + + Total number of bytes written. + - - Gets or sets the total number of bytes written. - - - The total number of bytes written. - - - - Gets or sets the total number of bytes written. - - + + Gets or sets the total number of bytes written. + + + The total number of bytes written. + + + + Gets or sets the total number of bytes written. + + - - A fixed size rolling buffer of logging events. - - - - An array backed fixed size leaky bucket. - - - Nicko Cadell - Gert Driesen + + A fixed size rolling buffer of logging events. + + + + An array backed fixed size leaky bucket. + + + Nicko Cadell + Gert Driesen @@ -23544,74 +25106,74 @@ The argument is not a positive integer. - - Appends a to the buffer. - - The event to append to the buffer. - The event discarded from the buffer, if the buffer is full, otherwise null. - - - Append an event to the buffer. If the buffer still contains free space then - null is returned. If the buffer is full then an event will be dropped - to make space for the new event, the event dropped is returned. - - + + Appends a to the buffer. + + The event to append to the buffer. + The event discarded from the buffer, if the buffer is full, otherwise null. + + + Append an event to the buffer. If the buffer still contains free space then + null is returned. If the buffer is full then an event will be dropped + to make space for the new event, the event dropped is returned. + + - - Get and remove the oldest event in the buffer. - - The oldest logging event in the buffer - - - Gets the oldest (first) logging event in the buffer and removes it - from the buffer. - - + + Get and remove the oldest event in the buffer. + + The oldest logging event in the buffer + + + Gets the oldest (first) logging event in the buffer and removes it + from the buffer. + + - - Pops all the logging events from the buffer into an array. - - An array of all the logging events in the buffer. - - - Get all the events in the buffer and clear the buffer. - - + + Pops all the logging events from the buffer into an array. + + An array of all the logging events in the buffer. + + + Get all the events in the buffer and clear the buffer. + + - - Clear the buffer - - - - Clear the buffer of all events. The events in the buffer are lost. - - + + Clear the buffer + + + + Clear the buffer of all events. The events in the buffer are lost. + + - - Gets the th oldest event currently in the buffer. - - The th oldest event currently in the buffer. - - - If is outside the range 0 to the number of events - currently in the buffer, then null is returned. - - + + Gets the th oldest event currently in the buffer. + + The th oldest event currently in the buffer. + + + If is outside the range 0 to the number of events + currently in the buffer, then null is returned. + + - - Gets the maximum size of the buffer. - - The maximum size of the buffer. - - - Gets the maximum size of the buffer - - + + Gets the maximum size of the buffer. + + The maximum size of the buffer. + + + Gets the maximum size of the buffer + + @@ -23680,20 +25242,20 @@ - - The singleton instance of the empty collection. - + + The singleton instance of the empty collection. + - - Gets the singleton instance of the empty collection. - - The singleton instance of the empty collection. - - - Gets the singleton instance of the empty collection. - - + + Gets the singleton instance of the empty collection. + + The singleton instance of the empty collection. + + + Gets the singleton instance of the empty collection. + + @@ -23857,9 +25419,9 @@ This dictionary is always empty and cannot be modified. - - The singleton instance of the empty dictionary. - + + The singleton instance of the empty dictionary. + @@ -24008,44 +25570,44 @@ - - Gets or sets the minimum value. - - - The minimum value. - - - - Gets or sets the minimum value. - - + + Gets or sets the minimum value. + + + The minimum value. + + + + Gets or sets the minimum value. + + - - Gets or sets the maximum value. - - - The maximum value. - - - - Gets or sets the maximum value. - - + + Gets or sets the maximum value. + + + The maximum value. + + + + Gets or sets the maximum value. + + - - Gets or sets a flag indicating whether left align is enabled - or not. - - - A flag indicating whether left align is enabled or not. - - - - Gets or sets a flag indicating whether left align is enabled or not. - - + + Gets or sets a flag indicating whether left align is enabled + or not. + + + A flag indicating whether left align is enabled or not. + + + + Gets or sets a flag indicating whether left align is enabled or not. + + @@ -24064,20 +25626,20 @@ Nicko Cadell - - The read only copy of the properties. - - - - This variable is declared volatile to prevent the compiler and JIT from - reordering reads and writes of this thread performed on different threads. - - + + The read only copy of the properties. + + + + This variable is declared volatile to prevent the compiler and JIT from + reordering reads and writes of this thread performed on different threads. + + - - Lock object used to synchronize updates within this instance - + + Lock object used to synchronize updates within this instance + @@ -24090,48 +25652,48 @@ - - Remove a property from the global context - - the key for the entry to remove - - - Removing an entry from the global context properties is relatively expensive compared - with reading a value. - - + + Remove a property from the global context + + the key for the entry to remove + + + Removing an entry from the global context properties is relatively expensive compared + with reading a value. + + - - Clear the global context properties - + + Clear the global context properties + - - Get a readonly immutable copy of the properties - - the current global context properties - - - This implementation is fast because the GlobalContextProperties class - stores a readonly copy of the properties. - - + + Get a readonly immutable copy of the properties + + the current global context properties + + + This implementation is fast because the GlobalContextProperties class + stores a readonly copy of the properties. + + - - Gets or sets the value of a property - - - The value for the property with the specified key - - - - Reading the value for a key is faster than setting the value. - When the value is written a new read only copy of - the properties is created. - - + + Gets or sets the value of a property + + + The value for the property with the specified key + + + + Reading the value for a key is faster than setting the value. + When the value is written a new read only copy of + the properties is created. + + @@ -24191,292 +25753,405 @@ - Caches the sorted list of in an array - - - - - - Implementation of Properties collection for the - - - - Class implements a collection of properties that is specific to each thread. - The class is not synchronized as each thread has its own . - - - Nicko Cadell - - - - Constructor - - - - Initializes a new instance of the class. - - - - - - Remove a property - - the key for the entry to remove - - - Remove the value for the specified from the context. - - - - - - Clear all the context properties - - - - Clear all the context properties - - - - - - Get the PropertiesDictionary stored in the LocalDataStoreSlot for this thread. - - create the dictionary if it does not exist, otherwise return null if is does not exist - the properties for this thread - - - The collection returned is only to be used on the calling thread. If the - caller needs to share the collection between different threads then the - caller must clone the collection before doings so. - - - - - - Gets or sets the value of a property - - - The value for the property with the specified key - - - - Get or set the property value for the specified. - - - - - - Outputs log statements from within the log4net assembly. - - - - Log4net components cannot make log4net logging calls. However, it is - sometimes useful for the user to learn about what log4net is - doing. - - - All log4net internal debug calls go to the standard output stream - whereas internal error messages are sent to the standard error output - stream. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - - Uses a private access modifier to prevent instantiation of this class. - - - - - - Static constructor that initializes logging by reading - settings from the application configuration file. - - - - The log4net.Internal.Debug application setting - controls internal debugging. This setting should be set - to true to enable debugging. - - - The log4net.Internal.Quiet application setting - suppresses all internal logging including error messages. - This setting should be set to true to enable message - suppression. - - - - - - Writes log4net internal debug messages to the - standard output stream. - - The message to log. - - - All internal debug messages are prepended with - the string "log4net: ". - - - - - - Writes log4net internal debug messages to the - standard output stream. - - The message to log. - An exception to log. - - - All internal debug messages are prepended with - the string "log4net: ". - - - - - - Writes log4net internal warning messages to the - standard error stream. - - The message to log. - - - All internal warning messages are prepended with - the string "log4net:WARN ". - - - - - - Writes log4net internal warning messages to the - standard error stream. - - The message to log. - An exception to log. - - - All internal warning messages are prepended with - the string "log4net:WARN ". + Caches the sorted list of in an array - + - Writes log4net internal error messages to the - standard error stream. + Implementation of Properties collection for the - The message to log. - All internal error messages are prepended with - the string "log4net:ERROR ". + Class implements a collection of properties that is specific to each thread. + The class is not synchronized as each thread has its own . + + + This class stores its properties in a slot on the named + log4net.Util.LogicalThreadContextProperties. + + + The requires a link time + for the + . + If the calling code does not have this permission then this context will be disabled. + It will not store any property values set on it. + Nicko Cadell - + + + Flag used to disable this context if we don't have permission to access the CallContext. + + + - Writes log4net internal error messages to the - standard error stream. + Constructor - The message to log. - An exception to log. - All internal debug messages are prepended with - the string "log4net:ERROR ". + Initializes a new instance of the class. - + + + Remove a property + + the key for the entry to remove + + + Remove the value for the specified from the context. + + + + + + Clear all the context properties + + + + Clear all the context properties + + + + + + Get the PropertiesDictionary stored in the LocalDataStoreSlot for this thread. + + create the dictionary if it does not exist, otherwise return null if is does not exist + the properties for this thread + + + The collection returned is only to be used on the calling thread. If the + caller needs to share the collection between different threads then the + caller must clone the collection before doings so. + + + + - Writes output to the standard output stream. + Gets the call context get data. - The message to log. + The peroperties dictionary stored in the call context - - Writes to both Console.Out and System.Diagnostics.Trace. - Note that the System.Diagnostics.Trace is not supported - on the Compact Framework. - - - If the AppDomain is not configured with a config file then - the call to System.Diagnostics.Trace may fail. This is only - an issue if you are programmatically creating your own AppDomains. - + The method has a + security link demand, therfore we must put the method call in a seperate method + that we can wrap in an exception handler. - + - Writes output to the standard error stream. + Sets the call context data. - The message to log. + The properties. - - Writes to both Console.Error and System.Diagnostics.Trace. - Note that the System.Diagnostics.Trace is not supported - on the Compact Framework. - - - If the AppDomain is not configured with a config file then - the call to System.Diagnostics.Trace may fail. This is only - an issue if you are programmatically creating your own AppDomains. - + The method has a + security link demand, therfore we must put the method call in a seperate method + that we can wrap in an exception handler. - + + + The fully qualified type of the LogicalThreadContextProperties class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets or sets the value of a property + + + The value for the property with the specified key + + + + Get or set the property value for the specified. + + + + + + + + + + + + + Outputs log statements from within the log4net assembly. + + + + Log4net components cannot make log4net logging calls. However, it is + sometimes useful for the user to learn about what log4net is + doing. + + + All log4net internal debug calls go to the standard output stream + whereas internal error messages are sent to the standard error output + stream. + + + Nicko Cadell + Gert Driesen + + + + Formats Prefix, Source, and Message in the same format as the value + sent to Console.Out and Trace.Write. + + + + - Default debug level + Initializes a new instance of the class. + + + + + + + + Static constructor that initializes logging by reading + settings from the application configuration file. + + + + The log4net.Internal.Debug application setting + controls internal debugging. This setting should be set + to true to enable debugging. + + + The log4net.Internal.Quiet application setting + suppresses all internal logging including error messages. + This setting should be set to true to enable message + suppression. + + + + + + Raises the LogReceived event when an internal messages is received. + + + + + + + + + Writes log4net internal debug messages to the + standard output stream. + + + The message to log. + + + All internal debug messages are prepended with + the string "log4net: ". + + + + + + Writes log4net internal debug messages to the + standard output stream. + + The Type that generated this message. + The message to log. + An exception to log. + + + All internal debug messages are prepended with + the string "log4net: ". + + + + + + Writes log4net internal warning messages to the + standard error stream. + + The Type that generated this message. + The message to log. + + + All internal warning messages are prepended with + the string "log4net:WARN ". + + + + + + Writes log4net internal warning messages to the + standard error stream. + + The Type that generated this message. + The message to log. + An exception to log. + + + All internal warning messages are prepended with + the string "log4net:WARN ". + + + + + + Writes log4net internal error messages to the + standard error stream. + + The Type that generated this message. + The message to log. + + + All internal error messages are prepended with + the string "log4net:ERROR ". + + + + + + Writes log4net internal error messages to the + standard error stream. + + The Type that generated this message. + The message to log. + An exception to log. + + + All internal debug messages are prepended with + the string "log4net:ERROR ". + + + + + + Writes output to the standard output stream. + + The message to log. + + + Writes to both Console.Out and System.Diagnostics.Trace. + Note that the System.Diagnostics.Trace is not supported + on the Compact Framework. + + + If the AppDomain is not configured with a config file then + the call to System.Diagnostics.Trace may fail. This is only + an issue if you are programmatically creating your own AppDomains. + + + + + + Writes output to the standard error stream. + + The message to log. + + + Writes to both Console.Error and System.Diagnostics.Trace. + Note that the System.Diagnostics.Trace is not supported + on the Compact Framework. + + + If the AppDomain is not configured with a config file then + the call to System.Diagnostics.Trace may fail. This is only + an issue if you are programmatically creating your own AppDomains. + + + + + + Default debug level + - - In quietMode not even errors generate any output. - + + In quietMode not even errors generate any output. + + + + + The event raised when an internal message has been received. + + + + + The Type that generated the internal message. + + + + + The DateTime stamp of when the internal message was received. + + + + + A string indicating the severity of the internal message. + + + "log4net: ", + "log4net:ERROR ", + "log4net:WARN " + + + + + The internal log message. + + + + + The Exception related to the message. + + + Optional. Will be null if no Exception was passed. + - - Gets or sets a value indicating whether log4net internal logging - is enabled or disabled. - - - true if log4net internal logging is enabled, otherwise - false. - - - - When set to true, internal debug level logging will be - displayed. - - - This value can be set by setting the application setting - log4net.Internal.Debug in the application configuration - file. - - - The default value is false, i.e. debugging is - disabled. - - - - - The following example enables internal debugging using the - application configuration file : - - - - - - - - - + + Gets or sets a value indicating whether log4net internal logging + is enabled or disabled. + + + true if log4net internal logging is enabled, otherwise + false. + + + + When set to true, internal debug level logging will be + displayed. + + + This value can be set by setting the application setting + log4net.Internal.Debug in the application configuration + file. + + + The default value is false, i.e. debugging is + disabled. + + + + + The following example enables internal debugging using the + application configuration file : + + + + + + + + + @@ -24514,56 +26189,99 @@ + + + + + - - Test if LogLog.Debug is enabled for output. - - - true if Debug is enabled - - - - Test if LogLog.Debug is enabled for output. - - + + Test if LogLog.Debug is enabled for output. + + + true if Debug is enabled + + + + Test if LogLog.Debug is enabled for output. + + - - Test if LogLog.Warn is enabled for output. - - - true if Warn is enabled - - - - Test if LogLog.Warn is enabled for output. - - + + Test if LogLog.Warn is enabled for output. + + + true if Warn is enabled + + + + Test if LogLog.Warn is enabled for output. + + - - Test if LogLog.Error is enabled for output. - - - true if Error is enabled - - - - Test if LogLog.Error is enabled for output. - - + + Test if LogLog.Error is enabled for output. + + + true if Error is enabled + + + + Test if LogLog.Error is enabled for output. + + + + + + Subscribes to the LogLog.LogReceived event and stores messages + to the supplied IList instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - Represents a native error code and message. - - - - Represents a Win32 platform native error. - - - Nicko Cadell - Gert Driesen + + Represents a native error code and message. + + + + Represents a Win32 platform native error. + + + Nicko Cadell + Gert Driesen @@ -24610,92 +26328,92 @@ - - Retrieves the message corresponding with a Win32 message identifier. - - Message identifier for the requested message. - - The message corresponding with the specified message identifier. - - - - The message will be searched for in system message-table resource(s) - using the native FormatMessage function. - - + + Retrieves the message corresponding with a Win32 message identifier. + + Message identifier for the requested message. + + The message corresponding with the specified message identifier. + + + + The message will be searched for in system message-table resource(s) + using the native FormatMessage function. + + - - Return error information string - - error information string - - - Return error information string - - + + Return error information string + + error information string + + + Return error information string + + - - Formats a message string. - - Formatting options, and how to interpret the parameter. - Location of the message definition. - Message identifier for the requested message. - Language identifier for the requested message. - If includes FORMAT_MESSAGE_ALLOCATE_BUFFER, the function allocates a buffer using the LocalAlloc function, and places the pointer to the buffer at the address specified in . - If the FORMAT_MESSAGE_ALLOCATE_BUFFER flag is not set, this parameter specifies the maximum number of TCHARs that can be stored in the output buffer. If FORMAT_MESSAGE_ALLOCATE_BUFFER is set, this parameter specifies the minimum number of TCHARs to allocate for an output buffer. - Pointer to an array of values that are used as insert values in the formatted message. - - - The function requires a message definition as input. The message definition can come from a - buffer passed into the function. It can come from a message table resource in an - already-loaded module. Or the caller can ask the function to search the system's message - table resource(s) for the message definition. The function finds the message definition - in a message table resource based on a message identifier and a language identifier. - The function copies the formatted message text to an output buffer, processing any embedded - insert sequences if requested. - - - To prevent the usage of unsafe code, this stub does not support inserting values in the formatted message. - - - - - If the function succeeds, the return value is the number of TCHARs stored in the output - buffer, excluding the terminating null character. - - - If the function fails, the return value is zero. To get extended error information, - call . - - + + Formats a message string. + + Formatting options, and how to interpret the parameter. + Location of the message definition. + Message identifier for the requested message. + Language identifier for the requested message. + If includes FORMAT_MESSAGE_ALLOCATE_BUFFER, the function allocates a buffer using the LocalAlloc function, and places the pointer to the buffer at the address specified in . + If the FORMAT_MESSAGE_ALLOCATE_BUFFER flag is not set, this parameter specifies the maximum number of TCHARs that can be stored in the output buffer. If FORMAT_MESSAGE_ALLOCATE_BUFFER is set, this parameter specifies the minimum number of TCHARs to allocate for an output buffer. + Pointer to an array of values that are used as insert values in the formatted message. + + + The function requires a message definition as input. The message definition can come from a + buffer passed into the function. It can come from a message table resource in an + already-loaded module. Or the caller can ask the function to search the system's message + table resource(s) for the message definition. The function finds the message definition + in a message table resource based on a message identifier and a language identifier. + The function copies the formatted message text to an output buffer, processing any embedded + insert sequences if requested. + + + To prevent the usage of unsafe code, this stub does not support inserting values in the formatted message. + + + + + If the function succeeds, the return value is the number of TCHARs stored in the output + buffer, excluding the terminating null character. + + + If the function fails, the return value is zero. To get extended error information, + call . + + - - Gets the number of the native error. - - - The number of the native error. - - - - Gets the number of the native error. - - + + Gets the number of the native error. + + + The number of the native error. + + + + Gets the number of the native error. + + - - Gets the message of the native error. - - - The message of the native error. - - - - - Gets the message of the native error. - + + Gets the message of the native error. + + + The message of the native error. + + + + + Gets the message of the native error. + @@ -24936,44 +26654,45 @@ - - Private constructor - - - - Private constructor for singleton pattern. - - + + Private constructor + + + + Private constructor for singleton pattern. + + - - Impersonate this SecurityContext - - State supplied by the caller - null - - - No impersonation is done and null is always returned. - - + + Impersonate this SecurityContext + + State supplied by the caller + null + + + No impersonation is done and null is always returned. + + - - Implements log4net's default error handling policy which consists - of emitting a message for the first error in an appender and - ignoring all subsequent errors. - - - - The error message is printed on the standard error output stream. - - - This policy aims at protecting an otherwise working application - from being flooded with error messages when logging fails. - - - Nicko Cadell - Gert Driesen + + Implements log4net's default error handling policy which consists + of emitting a message for the first error in an appender and + ignoring all subsequent errors. + + + + The error message is processed using the LogLog sub-system by default. + + + This policy aims at protecting an otherwise working application + from being flooded with error messages when logging fails. + + + Nicko Cadell + Gert Driesen + Ron Grabowski @@ -24997,6 +26716,11 @@ + + + Reset the error handler back to its initial disabled state. + + Log an Error @@ -25006,8 +26730,20 @@ The internal error code. - Prints the message and the stack trace of the exception on the standard - error output stream. + Invokes if and only if this is the first error or the first error after has been called. + + + + + + Log the very first error + + The error message. + The exception. + The internal error code. + + + Sends the error information to 's Error method. @@ -25019,8 +26755,7 @@ The exception. - Prints the message and the stack trace of the exception on the standard - error output stream. + Invokes if and only if this is the first error or the first error after has been called. @@ -25031,20 +26766,48 @@ The error message. - Print a the error message passed as parameter on the standard - error output stream. + Invokes if and only if this is the first error or the first error after has been called. + + + The date the error was recorded. + + - - Flag to indicate if it is the first error - + + Flag to indicate if it is the first error + + + + + The message recorded during the first error. + + + + + The exception recorded during the first error. + + + + + The error code recorded during the first error. + - - String to prefix each message with - + + String to prefix each message with + + + + + The fully qualified type of the OnlyOnceErrorHandler class. + + + Used by the internal logger to record the Type of the + log message. + @@ -25057,177 +26820,212 @@ - - - A convenience class to convert property values to specific types. - - - - Utility functions for converting types and parsing values. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - - Uses a private access modifier to prevent instantiation of this class. - - + + + The date the first error that trigged this error handler occured. + - - - Converts a string to a value. - - String to convert. - The default value. - The value of . - - - If is "true", then true is returned. - If is "false", then false is returned. - Otherwise, is returned. - - + + + The message from the first error that trigged this error handler. + - - - Parses a file size into a number. - - String to parse. - The default value. - The value of . - - - Parses a file size of the form: number[KB|MB|GB] into a - long value. It is scaled with the appropriate multiplier. - - - is returned when - cannot be converted to a value. - - + + + The exception from the first error that trigged this error handler. + + + May be . + - + - Converts a string to an object. + The error code from the first error that trigged this error handler. - The target type to convert to. - The string to convert to an object. - - The object converted from a string or null when the - conversion failed. - - - Converts a string to an object. Uses the converter registry to try - to convert the string value into the specified target type. - + Defaults to - - - Checks if there is an appropriate type conversion from the source type to the target type. - - The type to convert from. - The type to convert to. - true if there is a conversion from the source type to the target type. - - Checks if there is an appropriate type conversion from the source type to the target type. - - - + + + A convenience class to convert property values to specific types. + + + + Utility functions for converting types and parsing values. + + + Nicko Cadell + Gert Driesen - + - Converts an object to the target type. + Initializes a new instance of the class. - The object to convert to the target type. - The type to convert to. - The converted object. - Converts an object to the target type. + Uses a private access modifier to prevent instantiation of this class. - + - Instantiates an object given a class name. + Converts a string to a value. - The fully qualified class name of the object to instantiate. - The class to which the new object should belong. - The object to return in case of non-fulfillment. - - An instance of the or - if the object could not be instantiated. - + String to convert. + The default value. + The value of . - Checks that the is a subclass of - . If that test fails or the object could - not be instantiated, then is returned. + If is "true", then true is returned. + If is "false", then false is returned. + Otherwise, is returned. - + - Performs variable substitution in string from the - values of keys found in . + Parses a file size into a number. - The string on which variable substitution is performed. - The dictionary to use to lookup variables. - The result of the substitutions. + String to parse. + The default value. + The value of . - The variable substitution delimiters are ${ and }. - - - For example, if props contains key=value, then the call - - - - string s = OptionConverter.SubstituteVariables("Value of key is ${key}."); - - - - will set the variable s to "Value of key is value.". - - - If no value could be found for the specified key, then substitution - defaults to an empty string. - - - For example, if system properties contains no value for the key - "nonExistentKey", then the call - - - - string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]"); - - - - will set s to "Value of nonExistentKey is []". + Parses a file size of the form: number[KB|MB|GB] into a + long value. It is scaled with the appropriate multiplier. - An Exception is thrown if contains a start - delimiter "${" which is not balanced by a stop delimiter "}". + is returned when + cannot be converted to a value. + + + Converts a string to an object. + + The target type to convert to. + The string to convert to an object. + + The object converted from a string or null when the + conversion failed. + + + + Converts a string to an object. Uses the converter registry to try + to convert the string value into the specified target type. + + + + + + Checks if there is an appropriate type conversion from the source type to the target type. + + The type to convert from. + The type to convert to. + true if there is a conversion from the source type to the target type. + + Checks if there is an appropriate type conversion from the source type to the target type. + + + + + + + Converts an object to the target type. + + The object to convert to the target type. + The type to convert to. + The converted object. + + + Converts an object to the target type. + + + + + + Instantiates an object given a class name. + + The fully qualified class name of the object to instantiate. + The class to which the new object should belong. + The object to return in case of non-fulfillment. + + An instance of the or + if the object could not be instantiated. + + + + Checks that the is a subclass of + . If that test fails or the object could + not be instantiated, then is returned. + + + + + + Performs variable substitution in string from the + values of keys found in . + + The string on which variable substitution is performed. + The dictionary to use to lookup variables. + The result of the substitutions. + + + The variable substitution delimiters are ${ and }. + + + For example, if props contains key=value, then the call + + + + string s = OptionConverter.SubstituteVariables("Value of key is ${key}."); + + + + will set the variable s to "Value of key is value.". + + + If no value could be found for the specified key, then substitution + defaults to an empty string. + + + For example, if system properties contains no value for the key + "nonExistentKey", then the call + + + + string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]"); + + + + will set s to "Value of nonExistentKey is []". + + + An Exception is thrown if contains a start + delimiter "${" which is not balanced by a stop delimiter "}". + + + - - Converts the string representation of the name or numeric value of one or - more enumerated constants to an equivalent enumerated object. - - The type to convert to. - The enum string value. - If true, ignore case; otherwise, regard case. - An object of type whose value is represented by . + + Converts the string representation of the name or numeric value of one or + more enumerated constants to an equivalent enumerated object. + + The type to convert to. + The enum string value. + If true, ignore case; otherwise, regard case. + An object of type whose value is represented by . + + + + The fully qualified type of the OptionConverter class. + + + Used by the internal logger to record the Type of the + log message. + @@ -25256,97 +27054,106 @@ - - Parses the pattern into a chain of pattern converters. - - The head of a chain of pattern converters. - - - Parses the pattern into a chain of pattern converters. - - + + Parses the pattern into a chain of pattern converters. + + The head of a chain of pattern converters. + + + Parses the pattern into a chain of pattern converters. + + - - Build the unified cache of converters from the static and instance maps - - the list of all the converter names - - - Build the unified cache of converters from the static and instance maps - - + + Build the unified cache of converters from the static and instance maps + + the list of all the converter names + + + Build the unified cache of converters from the static and instance maps + + - - Internal method to parse the specified pattern to find specified matches - - the pattern to parse - the converter names to match in the pattern - - - The matches param must be sorted such that longer strings come before shorter ones. - - + + Internal method to parse the specified pattern to find specified matches + + the pattern to parse + the converter names to match in the pattern + + + The matches param must be sorted such that longer strings come before shorter ones. + + - - Process a parsed literal - - the literal text + + Process a parsed literal + + the literal text - - Process a parsed converter pattern - - the name of the converter - the optional option for the converter - the formatting info for the converter + + Process a parsed converter pattern + + the name of the converter + the optional option for the converter + the formatting info for the converter - - Resets the internal state of the parser and adds the specified pattern converter - to the chain. - - The pattern converter to add. + + Resets the internal state of the parser and adds the specified pattern converter + to the chain. + + The pattern converter to add. - - The first pattern converter in the chain - + + The first pattern converter in the chain + - - the last pattern converter in the chain - + + the last pattern converter in the chain + - - The pattern - + + The pattern + - - Internal map of converter identifiers to converter types - - - - This map overrides the static s_globalRulesRegistry map. - - + + Internal map of converter identifiers to converter types + + + + This map overrides the static s_globalRulesRegistry map. + + + + + + The fully qualified type of the PatternParser class. + + + Used by the internal logger to record the Type of the + log message. + - - Get the converter registry used by this parser - - - The converter registry used by this parser - - - - Get the converter registry used by this parser - - + + Get the converter registry used by this parser + + + The converter registry used by this parser + + + + Get the converter registry used by this parser + + @@ -25395,7 +27202,7 @@ date - Used to output the date of the logging event in the local time zone. + Used to output the current date and time in the local time zone. To output the date in universal time use the %utcdate pattern. The date conversion specifier may be followed by a date format specifier enclosed @@ -25406,7 +27213,7 @@ The date format specifier admits the same syntax as the - time pattern string of the . + time pattern string of the . For better results it is recommended to use the log4net date @@ -25419,7 +27226,7 @@ These dedicated date formatters perform significantly - better than . + better than . @@ -25541,7 +27348,7 @@ The date format specifier admits the same syntax as the - time pattern string of the . + time pattern string of the . For better results it is recommended to use the log4net date @@ -25554,7 +27361,7 @@ These dedicated date formatters perform significantly - better than . + better than . @@ -25569,8 +27376,8 @@ Additional pattern converters may be registered with a specific - instance using or - . + instance using or + . See the for details on the @@ -25580,29 +27387,29 @@ Nicko Cadell - - Internal map of converter identifiers to converter types. - + + Internal map of converter identifiers to converter types. + - - the pattern - + + the pattern + - - the head of the pattern converter chain - + + the head of the pattern converter chain + - - patterns defined on this PatternString only - + + patterns defined on this PatternString only + - - Initialize the global registry - + + Initialize the global registry + @@ -25658,142 +27465,101 @@ - - Produces a formatted string as specified by the conversion pattern. - - The TextWriter to write the formatted event to - - - Format the pattern to the . - - + + Produces a formatted string as specified by the conversion pattern. + + The TextWriter to write the formatted event to + + + Format the pattern to the . + + - - Format the pattern as a string - - the pattern formatted as a string - - - Format the pattern to a string. - - - - - - Add a converter to this PatternString - - the converter info - - - This version of the method is used by the configurator. - Programmatic users should use the alternative method. - - + + Format the pattern as a string + + the pattern formatted as a string + + + Format the pattern to a string. + + + + + + Add a converter to this PatternString + + the converter info + + + This version of the method is used by the configurator. + Programmatic users should use the alternative method. + + - - Add a converter to this PatternString - - the name of the conversion pattern for this converter - the type of the converter - - - Add a converter to this PatternString - - + + Add a converter to this PatternString + + the name of the conversion pattern for this converter + the type of the converter + + + Add a converter to this PatternString + + - - Gets or sets the pattern formatting string - - - The pattern formatting string - - - - The ConversionPattern option. This is the string which - controls formatting and consists of a mix of literal content and - conversion specifiers. - - - - - - Wrapper class used to map converter names to converter types - - - - Wrapper class used to map converter names to converter types - - - - - - default constructor - - - - - Gets or sets the name of the conversion pattern - - - The name of the conversion pattern - - - - Gets or sets the name of the conversion pattern - - - - - - Gets or sets the type of the converter - - - The type of the converter - - - - Gets or sets the type of the converter - - + + Gets or sets the pattern formatting string + + + The pattern formatting string + + + + The ConversionPattern option. This is the string which + controls formatting and consists of a mix of literal content and + conversion specifiers. + + - - String keyed object map. - - - - While this collection is serializable only member - objects that are serializable will - be serialized along with this collection. - - - Nicko Cadell - Gert Driesen + + String keyed object map. + + + + While this collection is serializable only member + objects that are serializable will + be serialized along with this collection. + + + Nicko Cadell + Gert Driesen - - String keyed object map that is read only. - - - - This collection is readonly and cannot be modified. - - - While this collection is serializable only member - objects that are serializable will - be serialized along with this collection. - - - Nicko Cadell - Gert Driesen + + String keyed object map that is read only. + + + + This collection is readonly and cannot be modified. + + + While this collection is serializable only member + objects that are serializable will + be serialized along with this collection. + + + Nicko Cadell + Gert Driesen - - The Hashtable used to store the properties data - + + The Hashtable used to store the properties data + @@ -25830,27 +27596,27 @@ - - Gets the key names. - - An array of all the keys. - - - Gets the key names. - - + + Gets the key names. + + An array of all the keys. + + + Gets the key names. + + - - Test if the dictionary contains a specified key - - the key to look for - true if the dictionary contains the specified key - - - Test if the dictionary contains a specified key - - + + Test if the dictionary contains a specified key + + the key to look for + true if the dictionary contains the specified key + + + Test if the dictionary contains a specified key + + @@ -25883,9 +27649,9 @@ - - Remove all properties from the properties collection - + + Remove all properties from the properties collection + @@ -25907,33 +27673,33 @@ - - Gets or sets the value of the property with the specified key. - - - The value of the property with the specified key. - - The key of the property to get or set. - - - The property value will only be serialized if it is serializable. - If it cannot be serialized it will be silently ignored if - a serialization operation is performed. - - + + Gets or sets the value of the property with the specified key. + + + The value of the property with the specified key. + + The key of the property to get or set. + + + The property value will only be serialized if it is serializable. + If it cannot be serialized it will be silently ignored if + a serialization operation is performed. + + - - The hashtable used to store the properties - - - The internal collection used to store the properties - - - - The hashtable used to store the properties - - + + The hashtable used to store the properties + + + The internal collection used to store the properties + + + + The hashtable used to store the properties + + @@ -25966,9 +27732,9 @@ - - The number of properties in this collection - + + The number of properties in this collection + @@ -26010,15 +27776,15 @@ - - Remove the entry with the specified key from this dictionary - - the key for the entry to remove - - - Remove the entry with the specified key from this dictionary - - + + Remove the entry with the specified key from this dictionary + + the key for the entry to remove + + + Remove the entry with the specified key from this dictionary + + @@ -26055,14 +27821,14 @@ - - Remove all properties from the properties collection - - - - Remove all properties from the properties collection - - + + Remove all properties from the properties collection + + + + Remove all properties from the properties collection + + @@ -26086,24 +27852,24 @@ - See - - - - - Gets or sets the value of the property with the specified key. - - - The value of the property with the specified key. - - The key of the property to get or set. - - - The property value will only be serialized if it is serializable. - If it cannot be serialized it will be silently ignored if - a serialization operation is performed. - - + See + + + + + Gets or sets the value of the property with the specified key. + + + The value of the property with the specified key. + + The key of the property to get or set. + + + The property value will only be serialized if it is serializable. + If it cannot be serialized it will be silently ignored if + a serialization operation is performed. + + @@ -26158,6 +27924,48 @@ See + + + A class to hold the key and data for a property set in the config file + + + + A class to hold the key and data for a property set in the config file + + + + + + Override Object.ToString to return sensible debug info + + string info about this object + + + + Property Key + + + Property Key + + + + Property Key. + + + + + + Property Value + + + Property Value + + + + Property Value. + + + A that ignores the message @@ -26171,15 +27979,15 @@ Nicko Cadell - - Constructor - - the writer to actually write to - - - Create a new ProtectCloseTextWriter using a writer - - + + Constructor + + the writer to actually write to + + + Create a new ProtectCloseTextWriter using a writer + + @@ -26193,15 +28001,15 @@ - - Does not close the underlying output writer. - - - - Does not close the underlying output writer. - This method does nothing. - - + + Does not close the underlying output writer. + + + + Does not close the underlying output writer. + This method does nothing. + + @@ -26257,25 +28065,25 @@ - - Acquires the writer lock - - - - This method blocks if another thread has a reader lock or writer lock. - - + + Acquires the writer lock + + + + This method blocks if another thread has a reader lock or writer lock. + + - - Decrements the lock count on the writer lock - - - - ReleaseWriterLock decrements the writer lock count. - When the count reaches zero, the writer lock is released. - - + + Decrements the lock count on the writer lock + + + + ReleaseWriterLock decrements the writer lock count. + When the count reaches zero, the writer lock is released. + + @@ -26301,75 +28109,75 @@ - - Override Dispose to prevent closing of writer - - flag - - - Override Dispose to prevent closing of writer - - + + Override Dispose to prevent closing of writer + + flag + + + Override Dispose to prevent closing of writer + + - - Reset this string writer so that it can be reused. - - the maximum buffer capacity before it is trimmed - the default size to make the buffer - - - Reset this string writer so that it can be reused. - The internal buffers are cleared and reset. - - + + Reset this string writer so that it can be reused. + + the maximum buffer capacity before it is trimmed + the default size to make the buffer + + + Reset this string writer so that it can be reused. + The internal buffers are cleared and reset. + + - - Utility class for system specific information. - - - - Utility class of static methods for system specific information. - - - Nicko Cadell - Gert Driesen - Alexey Solofnenko + + Utility class for system specific information. + + + + Utility class of static methods for system specific information. + + + Nicko Cadell + Gert Driesen + Alexey Solofnenko - - Private constructor to prevent instances. - - - - Only static methods are exposed from this type. - - + + Private constructor to prevent instances. + + + + Only static methods are exposed from this type. + + - - Initialize default values for private static fields. - - - - Only static methods are exposed from this type. - - + + Initialize default values for private static fields. + + + + Only static methods are exposed from this type. + + - - Gets the assembly location path for the specified assembly. - - The assembly to get the location for. - The location of the assembly. - - - This method does not guarantee to return the correct path - to the assembly. If only tries to give an indication as to - where the assembly was loaded from. - - + + Gets the assembly location path for the specified assembly. + + The assembly to get the location for. + The location of the assembly. + + + This method does not guarantee to return the correct path + to the assembly. If only tries to give an indication as to + where the assembly was loaded from. + + @@ -26424,80 +28232,80 @@ - - Loads the type specified in the type string. - - A sibling type to use to load the type. - The name of the type to load. - Flag set to true to throw an exception if the type cannot be loaded. - true to ignore the case of the type name; otherwise, false - The type loaded or null if it could not be loaded. - - - If the type name is fully qualified, i.e. if contains an assembly name in - the type name, the type will be loaded from the system using - . - - - If the type name is not fully qualified, it will be loaded from the assembly - containing the specified relative type. If the type is not found in the assembly - then all the loaded assemblies will be searched for the type. - - + + Loads the type specified in the type string. + + A sibling type to use to load the type. + The name of the type to load. + Flag set to true to throw an exception if the type cannot be loaded. + true to ignore the case of the type name; otherwise, false + The type loaded or null if it could not be loaded. + + + If the type name is fully qualified, i.e. if contains an assembly name in + the type name, the type will be loaded from the system using + . + + + If the type name is not fully qualified, it will be loaded from the assembly + containing the specified relative type. If the type is not found in the assembly + then all the loaded assemblies will be searched for the type. + + - - Loads the type specified in the type string. - - The name of the type to load. - Flag set to true to throw an exception if the type cannot be loaded. - true to ignore the case of the type name; otherwise, false - The type loaded or null if it could not be loaded. - - - If the type name is fully qualified, i.e. if contains an assembly name in - the type name, the type will be loaded from the system using - . - - - If the type name is not fully qualified it will be loaded from the - assembly that is directly calling this method. If the type is not found - in the assembly then all the loaded assemblies will be searched for the type. - - + + Loads the type specified in the type string. + + The name of the type to load. + Flag set to true to throw an exception if the type cannot be loaded. + true to ignore the case of the type name; otherwise, false + The type loaded or null if it could not be loaded. + + + If the type name is fully qualified, i.e. if contains an assembly name in + the type name, the type will be loaded from the system using + . + + + If the type name is not fully qualified it will be loaded from the + assembly that is directly calling this method. If the type is not found + in the assembly then all the loaded assemblies will be searched for the type. + + - - Loads the type specified in the type string. - - An assembly to load the type from. - The name of the type to load. - Flag set to true to throw an exception if the type cannot be loaded. - true to ignore the case of the type name; otherwise, false - The type loaded or null if it could not be loaded. - - - If the type name is fully qualified, i.e. if contains an assembly name in - the type name, the type will be loaded from the system using - . - - - If the type name is not fully qualified it will be loaded from the specified - assembly. If the type is not found in the assembly then all the loaded assemblies - will be searched for the type. - - + + Loads the type specified in the type string. + + An assembly to load the type from. + The name of the type to load. + Flag set to true to throw an exception if the type cannot be loaded. + true to ignore the case of the type name; otherwise, false + The type loaded or null if it could not be loaded. + + + If the type name is fully qualified, i.e. if contains an assembly name in + the type name, the type will be loaded from the system using + . + + + If the type name is not fully qualified it will be loaded from the specified + assembly. If the type is not found in the assembly then all the loaded assemblies + will be searched for the type. + + - - Generate a new guid - - A new Guid - - - Generate a new guid - - + + Generate a new guid + + A new Guid + + + Generate a new guid + + @@ -26548,35 +28356,49 @@ - + - Lookup an application setting + Parse a string into an value - the application settings key to lookup - the value for the key, or null + the string to parse + out param where the parsed value is placed + true if the string was able to be parsed into an integer - Configuration APIs are not supported under the Compact Framework + Attempts to parse the string into an integer. If the string cannot + be parsed then this method returns false. The method does not throw an exception. + + + Lookup an application setting + + the application settings key to lookup + the value for the key, or null + + + Configuration APIs are not supported under the Compact Framework + + + - - Convert a path into a fully qualified local file path. - - The path to convert. - The fully qualified path. - - - Converts the path specified to a fully - qualified path. If the path is relative it is - taken as relative from the application base - directory. - - - The path specified must be a local file path, a URI is not supported. - - + + Convert a path into a fully qualified local file path. + + The path to convert. + The fully qualified path. + + + Converts the path specified to a fully + qualified path. If the path is relative it is + taken as relative from the application base + directory. + + + The path specified must be a local file path, a URI is not supported. + + @@ -26590,53 +28412,62 @@ - - Gets an empty array of types. - - - - The Type.EmptyTypes field is not available on - the .NET Compact Framework 1.0. - - + + Gets an empty array of types. + + + + The Type.EmptyTypes field is not available on + the .NET Compact Framework 1.0. + + + + + + The fully qualified type of the SystemInfo class. + + + Used by the internal logger to record the Type of the + log message. + - - Cache the host name for the current machine - + + Cache the host name for the current machine + - - Cache the application friendly name - + + Cache the application friendly name + - - Text to output when a null is encountered. - + + Text to output when a null is encountered. + - - Text to output when an unsupported feature is requested. - + + Text to output when an unsupported feature is requested. + - - Start time for the current process. - + + Start time for the current process. + - - Gets the system dependent line terminator. - - - The system dependent line terminator. - - - - Gets the system dependent line terminator. - - + + Gets the system dependent line terminator. + + + The system dependent line terminator. + + + + Gets the system dependent line terminator. + + @@ -26680,28 +28511,28 @@ - - Gets the ID of the current thread. - - The ID of the current thread. - - - On the .NET framework, the AppDomain.GetCurrentThreadId method - is used to obtain the thread ID for the current thread. This is the - operating system ID for the thread. - - - On the .NET Compact Framework 1.0 it is not possible to get the - operating system thread ID for the current thread. The native method - GetCurrentThreadId is implemented inline in a header file - and cannot be called. - - - On the .NET Framework 2.0 the Thread.ManagedThreadId is used as this - gives a stable id unrelated to the operating system thread ID which may - change if the runtime is using fibers. - - + + Gets the ID of the current thread. + + The ID of the current thread. + + + On the .NET framework, the AppDomain.GetCurrentThreadId method + is used to obtain the thread ID for the current thread. This is the + operating system ID for the thread. + + + On the .NET Compact Framework 1.0 it is not possible to get the + operating system thread ID for the current thread. The native method + GetCurrentThreadId is implemented inline in a header file + and cannot be called. + + + On the .NET Framework 2.0 the Thread.ManagedThreadId is used as this + gives a stable id unrelated to the operating system thread ID which may + change if the runtime is using fibers. + + @@ -26723,85 +28554,85 @@ - - Get this application's friendly name - - - The friendly name of this application as a string - - - - If available the name of the application is retrieved from - the AppDomain using AppDomain.CurrentDomain.FriendlyName. - - - Otherwise the file name of the entry assembly is used. - - + + Get this application's friendly name + + + The friendly name of this application as a string + + + + If available the name of the application is retrieved from + the AppDomain using AppDomain.CurrentDomain.FriendlyName. + + + Otherwise the file name of the entry assembly is used. + + - - Get the start time for the current process. - - - - This is the time at which the log4net library was loaded into the - AppDomain. Due to reports of a hang in the call to System.Diagnostics.Process.StartTime - this is not the start time for the current process. - - - The log4net library should be loaded by an application early during its - startup, therefore this start time should be a good approximation for - the actual start time. - - - Note that AppDomains may be loaded and unloaded within the - same process without the process terminating, however this start time - will be set per AppDomain. - - + + Get the start time for the current process. + + + + This is the time at which the log4net library was loaded into the + AppDomain. Due to reports of a hang in the call to System.Diagnostics.Process.StartTime + this is not the start time for the current process. + + + The log4net library should be loaded by an application early during its + startup, therefore this start time should be a good approximation for + the actual start time. + + + Note that AppDomains may be loaded and unloaded within the + same process without the process terminating, however this start time + will be set per AppDomain. + + - - Text to output when a null is encountered. - - - - Use this value to indicate a null has been encountered while - outputting a string representation of an item. - - - The default value is (null). This value can be overridden by specifying - a value for the log4net.NullText appSetting in the application's - .config file. - - + + Text to output when a null is encountered. + + + + Use this value to indicate a null has been encountered while + outputting a string representation of an item. + + + The default value is (null). This value can be overridden by specifying + a value for the log4net.NullText appSetting in the application's + .config file. + + - - Text to output when an unsupported feature is requested. - - - - Use this value when an unsupported feature is requested. - - - The default value is NOT AVAILABLE. This value can be overridden by specifying - a value for the log4net.NotAvailableText appSetting in the application's - .config file. - - + + Text to output when an unsupported feature is requested. + + + + Use this value when an unsupported feature is requested. + + + The default value is NOT AVAILABLE. This value can be overridden by specifying + a value for the log4net.NotAvailableText appSetting in the application's + .config file. + + - - Utility class that represents a format string. - - - - Utility class that represents a format string. - - - Nicko Cadell + + Utility class that represents a format string. + + + + Utility class that represents a format string. + + + Nicko Cadell @@ -26812,10 +28643,10 @@ An array containing zero or more objects to format. - - Format the string and arguments - - the formatted string + + Format the string and arguments + + the formatted string @@ -26838,19 +28669,28 @@ - - Process an error during StringFormat - + + Process an error during StringFormat + - - Dump the contents of an array into a string builder - + + Dump the contents of an array into a string builder + - - Dump an object to a string - + + Dump an object to a string + + + + + The fully qualified type of the SystemStringFormat class. + + + Used by the internal logger to record the Type of the + log message. + @@ -26864,10 +28704,10 @@ Nicko Cadell - - - The thread local data slot to use to store a PropertiesDictionary. - + + + Each thread will automatically have its instance. + @@ -26880,52 +28720,61 @@ - - Remove a property - - the key for the entry to remove - - - Remove a property - - + + Remove a property + + the key for the entry to remove + + + Remove a property + + + + + + Get the keys stored in the properties. + + + Gets the keys stored in the properties. + + a set of the defined keys - - Clear all properties - - - - Clear all properties - - + + Clear all properties + + + + Clear all properties + + - - Get the PropertiesDictionary for this thread. - - create the dictionary if it does not exist, otherwise return null if is does not exist - the properties for this thread - - - The collection returned is only to be used on the calling thread. If the - caller needs to share the collection between different threads then the - caller must clone the collection before doing so. - - + + Get the PropertiesDictionary for this thread. + + create the dictionary if it does not exist, otherwise return null if does not exist + the properties for this thread + + + The collection returned is only to be used on the calling thread. If the + caller needs to share the collection between different threads then the + caller must clone the collection before doing so. + + - - Gets or sets the value of a property - - - The value for the property with the specified key - - - - Gets or sets the value of a property - - + + Gets or sets the value of a property + + + The value for the property with the specified key + + + + Gets or sets the value of a property + + @@ -26939,9 +28788,9 @@ Nicko Cadell - - The stack store. - + + The stack store. + @@ -26971,17 +28820,17 @@ - - Removes the top context from this stack. - - The message in the context that was removed from the top of this stack. - - - Remove the top context from this stack, and return - it to the caller. If this stack is empty then an - empty string (not ) is returned. - - + + Removes the top context from this stack. + + The message in the context that was removed from the top of this stack. + + + Remove the top context from this stack, and return + it to the caller. If this stack is empty then an + empty string (not ) is returned. + + @@ -27009,32 +28858,32 @@ - - Gets the current context information for this stack. - - The current context information. + + Gets the current context information for this stack. + + The current context information. - - Gets the current context information for this stack. - - Gets the current context information - - - Gets the current context information for this stack. - - + + Gets the current context information for this stack. + + Gets the current context information + + + Gets the current context information for this stack. + + - - Get a portable version of this object - - the portable instance of this object - - - Get a cross thread portable version of this object - - + + Get a portable version of this object + + the portable instance of this object + + + Get a cross thread portable version of this object + + @@ -27065,14 +28914,14 @@ - - Inner class used to represent a single context frame in the stack. - - - - Inner class used to represent a single context frame in the stack. - - + + Inner class used to represent a single context frame in the stack. + + + + Inner class used to represent a single context frame in the stack. + + @@ -27088,28 +28937,28 @@ - - Get the message. - - The message. - - - Get the message. - - + + Get the message. + + The message. + + + Get the message. + + - - Gets the full text of the context down to the root level. - - - The full text of the context down to the root level. - - - - Gets the full text of the context down to the root level. - - + + Gets the full text of the context down to the root level. + + + The full text of the context down to the root level. + + + + Gets the full text of the context down to the root level. + + @@ -27123,14 +28972,14 @@ - - The ThreadContextStack internal stack - + + The ThreadContextStack internal stack + - - The depth to trim the stack to when this instance is disposed - + + The depth to trim the stack to when this instance is disposed + @@ -27146,14 +28995,14 @@ - - Returns the stack to the correct depth. - - - - Returns the stack to the correct depth. - - + + Returns the stack to the correct depth. + + + + Returns the stack to the correct depth. + + @@ -27176,30 +29025,39 @@ + + + The fully qualified type of the ThreadContextStacks class. + + + Used by the internal logger to record the Type of the + log message. + + - - Gets the named thread context stack - - - The named stack - - - - Gets the named thread context stack - - + + Gets the named thread context stack + + + The named stack + + + + Gets the named thread context stack + + - - Utility class for transforming strings. - - - - Utility class for transforming strings. - - - Nicko Cadell - Gert Driesen + + Utility class for transforming strings. + + + + Utility class for transforming strings. + + + Nicko Cadell + Gert Driesen @@ -27226,35 +29084,40 @@ - - Replace invalid XML characters in text string - - the XML text input string - the string to use in place of invalid characters - A string that does not contain invalid XML characters. - - - Certain Unicode code points are not allowed in the XML InfoSet, for - details see: http://www.w3.org/TR/REC-xml/#charsets. - - - This method replaces any illegal characters in the input string - with the mask string specified. - - + + Replace invalid XML characters in text string + + the XML text input string + the string to use in place of invalid characters + A string that does not contain invalid XML characters. + + + Certain Unicode code points are not allowed in the XML InfoSet, for + details see: http://www.w3.org/TR/REC-xml/#charsets. + + + This method replaces any illegal characters in the input string + with the mask string specified. + + - - Count the number of times that the substring occurs in the text - - the text to search - the substring to find - the number of times the substring occurs in the text - - - The substring is assumed to be non repeating within itself. - - + + Count the number of times that the substring occurs in the text + + the text to search + the substring to find + the number of times the substring occurs in the text + + + The substring is assumed to be non repeating within itself. + + + + + + Characters illegal in XML 1.0 + @@ -27272,14 +29135,14 @@ - - Default constructor - - - - Default constructor - - + + Default constructor + + + + Default constructor + + @@ -27424,14 +29287,14 @@ - - Impersonate a user using the credentials supplied - + + Impersonate a user using the credentials supplied + - - Revert this the thread to the credentials of the process - + + Revert this the thread to the credentials of the process + @@ -27445,25 +29308,25 @@ - - Constructor - - the impersonation context being wrapped - - - Constructor - - + + Constructor + + the impersonation context being wrapped + + + Constructor + + - - Revert the impersonation - - - - Revert the impersonation - - + + Revert the impersonation + + + + Revert the impersonation + + @@ -27493,30 +29356,53 @@ Nicko Cadell - - Private Constructor. - - - Uses a private access modifier to prevent instantiation of this class. - + + Private Constructor. + + + Uses a private access modifier to prevent instantiation of this class. + - - The global context properties instance - + + The global context properties instance + - - The global properties map. - - - The global properties map. - - - - The global properties map. - - + + The global properties map. + + + The global properties map. + + + + The global properties map. + + + + + + Provides information about the environment the assembly has + been built for. + + + + Version of the assembly + + + Version of the framework targeted + + + Type of framework targeted + + + Does it target a client profile? + + + + Identifies the version and target for this assembly. + @@ -27544,6 +29430,13 @@ The Logical Thread Context is managed on a per basis. + + The requires a link time + for the + . + If the calling code does not have this permission then this context will be disabled. + It will not store any property values set on it. + Example of using the thread context properties to store a username. @@ -27564,24 +29457,24 @@ Nicko Cadell - - Private Constructor. - - - - Uses a private access modifier to prevent instantiation of this class. - - + + Private Constructor. + + + + Uses a private access modifier to prevent instantiation of this class. + + - - The thread context properties instance - + + The thread context properties instance + - - The thread context stacks instance - + + The thread context stacks instance + @@ -27598,17 +29491,17 @@ - - The thread stacks - - - stack map - - - - The logical thread stacks. - - + + The thread stacks + + + stack map + + + + The logical thread stacks. + + @@ -27617,7 +29510,7 @@ This class has static methods that are used by a client to request - a logger instance. The method is + a logger instance. The method is used to retrieve a logger. @@ -27651,266 +29544,266 @@ - Returns the named logger if it exists. - - Returns the named logger if it exists. - - - - If the named logger exists (in the default repository) then it - returns a reference to the logger, otherwise it returns null. - - - The fully qualified logger name to look for. - The logger found, or null if no logger could be found. + Returns the named logger if it exists. + + Returns the named logger if it exists. + + + + If the named logger exists (in the default repository) then it + returns a reference to the logger, otherwise it returns null. + + + The fully qualified logger name to look for. + The logger found, or null if no logger could be found. - - Returns the named logger if it exists. - - - - If the named logger exists (in the specified repository) then it - returns a reference to the logger, otherwise it returns - null. - - - The repository to lookup in. - The fully qualified logger name to look for. - - The logger found, or null if the logger doesn't exist in the specified - repository. - + + Returns the named logger if it exists. + + + + If the named logger exists (in the specified repository) then it + returns a reference to the logger, otherwise it returns + null. + + + The repository to lookup in. + The fully qualified logger name to look for. + + The logger found, or null if the logger doesn't exist in the specified + repository. + - - Returns the named logger if it exists. - - - - If the named logger exists (in the repository for the specified assembly) then it - returns a reference to the logger, otherwise it returns - null. - - - The assembly to use to lookup the repository. - The fully qualified logger name to look for. - - The logger, or null if the logger doesn't exist in the specified - assembly's repository. - + + Returns the named logger if it exists. + + + + If the named logger exists (in the repository for the specified assembly) then it + returns a reference to the logger, otherwise it returns + null. + + + The assembly to use to lookup the repository. + The fully qualified logger name to look for. + + The logger, or null if the logger doesn't exist in the specified + assembly's repository. + - Get the currently defined loggers. - - Returns all the currently defined loggers in the default repository. - - - The root logger is not included in the returned array. - - All the defined loggers. + Get the currently defined loggers. + + Returns all the currently defined loggers in the default repository. + + + The root logger is not included in the returned array. + + All the defined loggers. - - Returns all the currently defined loggers in the specified repository. - - The repository to lookup in. - - The root logger is not included in the returned array. - - All the defined loggers. + + Returns all the currently defined loggers in the specified repository. + + The repository to lookup in. + + The root logger is not included in the returned array. + + All the defined loggers. - - Returns all the currently defined loggers in the specified assembly's repository. - - The assembly to use to lookup the repository. - - The root logger is not included in the returned array. - - All the defined loggers. + + Returns all the currently defined loggers in the specified assembly's repository. + + The assembly to use to lookup the repository. + + The root logger is not included in the returned array. + + All the defined loggers. - Get or create a logger. - - Retrieves or creates a named logger. - - - - Retrieves a logger named as the - parameter. If the named logger already exists, then the - existing instance will be returned. Otherwise, a new instance is - created. - - By default, loggers do not have a set level but inherit - it from the hierarchy. This is one of the central features of - log4net. - - - The name of the logger to retrieve. - The logger with the name specified. + Get or create a logger. + + Retrieves or creates a named logger. + + + + Retrieves a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + + The name of the logger to retrieve. + The logger with the name specified. - - Retrieves or creates a named logger. - - - - Retrieve a logger named as the - parameter. If the named logger already exists, then the - existing instance will be returned. Otherwise, a new instance is - created. - - - By default, loggers do not have a set level but inherit - it from the hierarchy. This is one of the central features of - log4net. - - - The repository to lookup in. - The name of the logger to retrieve. - The logger with the name specified. + + Retrieves or creates a named logger. + + + + Retrieve a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + + The repository to lookup in. + The name of the logger to retrieve. + The logger with the name specified. - - Retrieves or creates a named logger. - - - - Retrieve a logger named as the - parameter. If the named logger already exists, then the - existing instance will be returned. Otherwise, a new instance is - created. - - - By default, loggers do not have a set level but inherit - it from the hierarchy. This is one of the central features of - log4net. - - - The assembly to use to lookup the repository. - The name of the logger to retrieve. - The logger with the name specified. + + Retrieves or creates a named logger. + + + + Retrieve a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + + The assembly to use to lookup the repository. + The name of the logger to retrieve. + The logger with the name specified. - - Shorthand for . - - - Get the logger for the fully qualified name of the type specified. - - The full name of will be used as the name of the logger to retrieve. - The logger with the name specified. + + Shorthand for . + + + Get the logger for the fully qualified name of the type specified. + + The full name of will be used as the name of the logger to retrieve. + The logger with the name specified. - - Shorthand for . - - - Gets the logger for the fully qualified name of the type specified. - - The repository to lookup in. - The full name of will be used as the name of the logger to retrieve. - The logger with the name specified. + + Shorthand for . + + + Gets the logger for the fully qualified name of the type specified. + + The repository to lookup in. + The full name of will be used as the name of the logger to retrieve. + The logger with the name specified. - - Shorthand for . - - - Gets the logger for the fully qualified name of the type specified. - - The assembly to use to lookup the repository. - The full name of will be used as the name of the logger to retrieve. - The logger with the name specified. + + Shorthand for . + + + Gets the logger for the fully qualified name of the type specified. + + The assembly to use to lookup the repository. + The full name of will be used as the name of the logger to retrieve. + The logger with the name specified. - - Shuts down the log4net system. - - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in all the - default repositories. - - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - The shutdown method is careful to close nested - appenders before closing regular appenders. This is allows - configurations where a regular appender is attached to a logger - and again to a nested appender. - - + + Shuts down the log4net system. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in all the + default repositories. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + - Shutdown a logger repository. - - Shuts down the default repository. - - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in the - default repository. - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - The shutdown method is careful to close nested - appenders before closing regular appenders. This is allows - configurations where a regular appender is attached to a logger - and again to a nested appender. - - + Shutdown a logger repository. + + Shuts down the default repository. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + default repository. + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + - - Shuts down the repository for the repository specified. - - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in the - specified. - - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - The shutdown method is careful to close nested - appenders before closing regular appenders. This is allows - configurations where a regular appender is attached to a logger - and again to a nested appender. - - - The repository to shutdown. + + Shuts down the repository for the repository specified. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + specified. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + The repository to shutdown. - - Shuts down the repository specified. - - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in the - repository. The repository is looked up using - the specified. - - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - - The shutdown method is careful to close nested - appenders before closing regular appenders. This is allows - configurations where a regular appender is attached to a logger - and again to a nested appender. - - - The assembly to use to lookup the repository. + + Shuts down the repository specified. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + repository. The repository is looked up using + the specified. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + The assembly to use to lookup the repository. Reset the configuration of a repository @@ -27968,7 +29861,7 @@ Gets the for the repository specified - by the callers assembly (). + by the callers assembly (). The instance for the default repository. @@ -28007,7 +29900,7 @@ Gets the for the repository specified - by the callers assembly (). + by the callers assembly (). The instance for the default repository. @@ -28049,7 +29942,7 @@ The created will be associated with the repository - specified such that a call to will return + specified such that a call to will return the same repository instance. @@ -28070,7 +29963,7 @@ The created will be associated with the repository - specified such that a call to will return + specified such that a call to will return the same repository instance. @@ -28161,7 +30054,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -28178,7 +30071,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -28200,18 +30093,18 @@ An array of all the known objects. - - Looks up the wrapper object for the logger specified. - - The logger to get the wrapper for. - The wrapper for the logger specified. + + Looks up the wrapper object for the logger specified. + + The logger to get the wrapper for. + The wrapper for the logger specified. - - Looks up the wrapper objects for the loggers specified. - - The loggers to get the wrappers for. - The wrapper objects for the loggers specified. + + Looks up the wrapper objects for the loggers specified. + + The loggers to get the wrappers for. + The wrapper objects for the loggers specified. @@ -28294,13 +30187,13 @@ - Puts a context value (the parameter) as identified + Puts a context value (the parameter) as identified with the parameter into the current thread's context map. If a value is already defined for the - specified then the value will be replaced. If the + specified then the value will be replaced. If the is specified as null then the key value mapping will be removed. @@ -28605,24 +30498,24 @@ Nicko Cadell - - Private Constructor. - - - - Uses a private access modifier to prevent instantiation of this class. - - + + Private Constructor. + + + + Uses a private access modifier to prevent instantiation of this class. + + - - The thread context properties instance - + + The thread context properties instance + - - The thread context stacks instance - + + The thread context stacks instance + @@ -28639,17 +30532,17 @@ - - The thread stacks - - - stack map - - - - The thread local stacks. - - + + The thread stacks + + + stack map + + + + The thread local stacks. + + diff --git a/packages/log4net.1.2.10/lib/2.0/log4net.xml b/packages/log4net.2.0.3/lib/net35-client/log4net.xml similarity index 85% rename from packages/log4net.1.2.10/lib/2.0/log4net.xml rename to packages/log4net.2.0.3/lib/net35-client/log4net.xml index fab7af2..f48155d 100644 --- a/packages/log4net.1.2.10/lib/2.0/log4net.xml +++ b/packages/log4net.2.0.3/lib/net35-client/log4net.xml @@ -109,7 +109,7 @@ the underlying database in one go. - Subclasses should override the + Subclasses should override the method to deliver the buffered events. The BufferingAppenderSkeleton maintains a fixed size cyclic @@ -119,14 +119,14 @@ A is used to inspect each event as it arrives in the appender. If the triggers, then the current buffer is sent immediately - (see ). Otherwise the event + (see ). Otherwise the event is stored in the buffer. For example, an evaluator can be used to deliver the events immediately when an ERROR event arrives. The buffering appender can be configured in a mode. By default the appender is NOT lossy. When the buffer is full all - the buffered events are sent with . + the buffered events are sent with . If the property is set to true then the buffer will not be sent when it is full, and new events arriving in the appender will overwrite the oldest event in the buffer. @@ -152,7 +152,7 @@ Appenders can also implement the interface. Therefore - they would require that the method + they would require that the method be called after the appenders properties have been configured. @@ -170,7 +170,7 @@ Appenders can also implement the interface. Therefore - they would require that the method + they would require that the method be called after the appenders properties have been configured. @@ -340,13 +340,13 @@ Performs threshold checks and invokes filters before delegating actual logging to the subclasses specific - method. + method. The event to log. This method cannot be overridden by derived classes. A - derived class should override the method + derived class should override the method which is called by this method. @@ -368,14 +368,14 @@ - Calls and checks that + Calls and checks that it returns true. If all of the above steps succeed then the - will be passed to the abstract method. + will be passed to the abstract method. @@ -383,13 +383,13 @@ Performs threshold checks and invokes filters before delegating actual logging to the subclasses specific - method. + method. The array of events to log. This method cannot be overridden by derived classes. A - derived class should override the method + derived class should override the method which is called by this method. @@ -399,26 +399,26 @@ - Checks that the severity of the + Checks that the severity of the is greater than or equal to the of this appender. Checks that the chain accepts the - . + . - Calls and checks that + Calls and checks that it returns true. If all of the above steps succeed then the - will be passed to the method. + will be passed to the method. @@ -521,12 +521,12 @@ A subclass must implement this method to perform logging of the . - This method will be called by + This method will be called by if all the conditions listed for that method are met. To restrict the logging of events in the appender - override the method. + override the method. @@ -537,34 +537,34 @@ the array of logging events - This base class implementation calls the + This base class implementation calls the method for each element in the bulk array. A sub class that can better process a bulk array of events should - override this method in addition to . + override this method in addition to . - Called before as a precondition. + Called before as a precondition. - This method is called by - before the call to the abstract method. + This method is called by + before the call to the abstract method. This method can be overridden in a subclass to extend the checks - made before the event is passed to the method. + made before the event is passed to the method. A subclass should ensure that they delegate this call to this base class if it is overridden. - true if the call to should proceed. + true if the call to should proceed. @@ -585,7 +585,7 @@ Where possible use the alternative version of this method - . + . That method streams the rendering onto an existing Writer which can give better performance if the caller already has a open and ready for writing. @@ -610,9 +610,9 @@ will append the exception text to the rendered string. - Use this method in preference to + Use this method in preference to where possible. If, however, the caller needs to render the event - to a string then does + to a string then does provide an efficient mechanism for doing so. @@ -698,6 +698,15 @@ StringWriter used to render events + + + The fully qualified type of the AppenderSkeleton class. + + + Used by the internal logger to record the Type of the + log message. + + Gets or sets the threshold of this appender. @@ -775,7 +784,7 @@ then the appender should return true. - This default implementation always returns true. + This default implementation always returns false. @@ -887,7 +896,7 @@ - This method is called by the method. + This method is called by the method. the event to log @@ -911,7 +920,7 @@ Before the event is stored in the buffer it is fixed - (see ) to ensure that + (see ) to ensure that any data referenced by the event will be valid when the buffer is processed. @@ -925,7 +934,7 @@ The buffer containing the events that need to be send. - The subclass must override . + The subclass must override . @@ -1059,7 +1068,7 @@ The evaluator will be called for each event that is appended to this appender. If the evaluator triggers then the current buffer will - immediately be sent (see ). + immediately be sent (see ). If is set to true then an must be specified. @@ -1076,7 +1085,7 @@ The evaluator will be called for each event that is discarded from this appender. If the evaluator triggers then the current buffer will immediately - be sent (see ). + be sent (see ). @@ -1095,7 +1104,7 @@ event data to be fixed and serialized. This will improve performance. - See for more information. + See for more information. @@ -1201,10 +1210,27 @@ Text that can be passed to a . - + - Connects to the database. - + Creates an instance used to connect to the database. + + + This method is called whenever a new IDbConnection is needed (i.e. when a reconnect is necessary). + + The of the object. + The connectionString output from the ResolveConnectionString method. + An instance with a valid connection string. + + + + Resolves the connection string from the ConnectionString, ConnectionStringName, or AppSettingsKey + property. + + + ConnectiongStringName is only supported on .NET 2.0 and higher. + + Additional information describing the connection string. + A connection string used to connect to the database. @@ -1228,6 +1254,27 @@ Prepares the database command and initialize the parameters. + + + Connects to the database. + + + + + Cleanup the existing command. + + + If true, a message will be written using LogLog.Warn if an exception is encountered when calling Dispose. + + + + + Cleanup the existing connection. + + + Calls the IDbConnection's method. + + Flag to indicate if we are using a command object @@ -1270,6 +1317,16 @@ Database connection string. + + + The appSettings key from App.Config that contains the connection string. + + + + + The connectionStrings key from App.Config that contains the connection string. + + String type name of the type name. @@ -1295,6 +1352,15 @@ Indicates whether to use transactions when writing to the database. + + + The fully qualified type of the AdoNetAppender class. + + + Used by the internal logger to record the Type of the + log message. + + Gets or sets the database connection string that is used to connect to @@ -1319,6 +1385,19 @@ "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;" + + + The appSettings key from App.Config that contains the connection string. + + + + + The connectionStrings key from App.Config that contains the connection string. + + + This property requires at least .NET 2.0. + + Gets or sets the type name of the connection @@ -1641,6 +1720,9 @@ This property is optional. If not specified the ADO.NET provider will attempt to infer the size from the value. + + For BLOB data types like VARCHAR(max) it may be impossible to infer the value automatically, use -1 as the size in this case. + @@ -1795,7 +1877,7 @@ - This method is called by the method. + This method is called by the method. The event to log. @@ -1903,6 +1985,11 @@ text is displayed with a strikethrough + + + text color is light + + The enum of possible foreground or background color values for @@ -2248,16 +2335,16 @@ - is less than zero + is less than zero -or- - is equal to or greater than . + is equal to or greater than . - is less than zero + is less than zero -or- - is equal to or greater than . + is equal to or greater than . @@ -2381,65 +2468,6 @@ - - - - Appends log events to the ASP.NET system. - - - - - Diagnostic information and tracing messages that you specify are appended to the output - of the page that is sent to the requesting browser. Optionally, you can view this information - from a separate trace viewer (Trace.axd) that displays trace information for every page in a - given application. - - - Trace statements are processed and displayed only when tracing is enabled. You can control - whether tracing is displayed to a page, to the trace viewer, or both. - - - The logging event is passed to the or - method depending on the level of the logging event. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - - Default constructor. - - - - - - Write the logging event to the ASP.NET trace - - the event to log - - - Write the logging event to the ASP.NET trace - HttpContext.Current.Trace - (). - - - - - - This appender requires a to be set. - - true - - - This appender requires a to be set. - - - Buffers events and then forwards them to attached appenders. @@ -2797,7 +2825,7 @@ - This method is called by the method. + This method is called by the method. The event to log. @@ -3052,7 +3080,7 @@ - This method is called by the method. + This method is called by the method. The event to log. @@ -3103,7 +3131,7 @@ debug system. - Events are written using the + Events are written using the method. The event's logger name is passed as the value for the category name to the Write method. @@ -3198,8 +3226,17 @@ + The appender will fail if you try to write using an event source that doesn't exist unless it is running with local administrator privileges. + See also http://logging.apache.org/log4net/release/faq.html#trouble-EventLog + + The EventID of the event log entry can be - set using the EventLogEventID property () + set using the EventID property () + on the . + + + The Category of the event log entry can be + set using the Category property () on the . @@ -3297,7 +3334,7 @@ - This method is called by the + This method is called by the method. the event to log @@ -3315,10 +3352,10 @@ - Get the equivalent for a + Get the equivalent for a the Level to convert to an EventLogEntryType - The equivalent for a + The equivalent for a Because there are fewer applicable values to use in logging levels than there are in the @@ -3354,6 +3391,88 @@ The security context to use for privileged calls + + + The event ID to use unless one is explicitly specified via the LoggingEvent's properties. + + + + + The event category to use unless one is explicitly specified via the LoggingEvent's properties. + + + + + The fully qualified type of the EventLogAppender class. + + + Used by the internal logger to record the Type of the + log message. + + + + + The maximum size supported by default. + + + http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx + The 32766 documented max size is two bytes shy of 32K (I'm assuming 32766 + may leave space for a two byte null terminator of #0#0). The 32766 max + length is what the .NET 4.0 source code checks for, but this is WRONG! + Strings with a length > 31839 on Windows Vista or higher can CORRUPT + the event log! See: System.Diagnostics.EventLogInternal.InternalWriteEvent() + for the use of the 32766 max size. + + + + + The maximum size supported by a windows operating system that is vista + or newer. + + + See ReportEvent API: + http://msdn.microsoft.com/en-us/library/aa363679(VS.85).aspx + ReportEvent's lpStrings parameter: + "A pointer to a buffer containing an array of + null-terminated strings that are merged into the message before Event Viewer + displays the string to the user. This parameter must be a valid pointer + (or NULL), even if wNumStrings is zero. Each string is limited to 31,839 characters." + + Going beyond the size of 31839 will (at some point) corrupt the event log on Windows + Vista or higher! It may succeed for a while...but you will eventually run into the + error: "System.ComponentModel.Win32Exception : A device attached to the system is + not functioning", and the event log will then be corrupt (I was able to corrupt + an event log using a length of 31877 on Windows 7). + + The max size for Windows Vista or higher is documented here: + http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx. + Going over this size may succeed a few times but the buffer will overrun and + eventually corrupt the log (based on testing). + + The maxEventMsgSize size is based on the max buffer size of the lpStrings parameter of the ReportEvent API. + The documented max size for EventLog.WriteEntry for Windows Vista and higher is 31839, but I'm leaving room for a + terminator of #0#0, as we cannot see the source of ReportEvent (though we could use an API monitor to examine the + buffer, given enough time). + + + + + The maximum size that the operating system supports for + a event log message. + + + Used to determine the maximum string length that can be written + to the operating system event log and eventually truncate a string + that exceeds the limits. + + + + + This method determines the maximum event log message size allowed for + the current environment. + + + The name of the log where messages will be stored. @@ -3420,6 +3539,32 @@ + + + Gets or sets the EventId to use unless one is explicitly specified via the LoggingEvent's properties. + + + + The EventID of the event log entry will normally be + set using the EventID property () + on the . + This property provides the fallback value which defaults to 0. + + + + + + Gets or sets the Category to use unless one is explicitly specified via the LoggingEvent's properties. + + + + The Category of the event log entry will normally be + set using the Category property () + on the . + This property provides the fallback value which defaults to 0. + + + This appender requires a to be set. @@ -3488,8 +3633,13 @@ the property. The default behavior, implemented by is to obtain an exclusive write lock on the file until this appender is closed. - The alternative model, , only holds a - write lock while the appender is writing a logging event. + The alternative models only hold a + write lock while the appender is writing a logging event () + or synchronize by using a named system wide Mutex (). + + + All locking strategies have issues and you should seriously consider using a different strategy that + avoids having multiple processes logging to the same file. Nicko Cadell @@ -3562,7 +3712,7 @@ - This method checked if an output target has been set and if a + This method checks if an output target has been set and if a layout has been set. @@ -3570,7 +3720,7 @@ - This method is called by the + This method is called by the method. The event to log. @@ -3586,7 +3736,7 @@ - This method is called by the + This method is called by the method. The array of events to log. @@ -3692,6 +3842,15 @@ + + + The fully qualified type of the TextWriterAppender class. + + + Used by the internal logger to record the Type of the + log message. + + Gets or set whether the appender will flush at the end @@ -3849,7 +4008,7 @@ - This method is called by the + This method is called by the method. The event to log. @@ -3865,7 +4024,7 @@ - This method is called by the + This method is called by the method. The array of events to log. @@ -3954,9 +4113,9 @@ the file stream that has been opened for writing - This implementation of creates a + This implementation of creates a over the and passes it to the - method. + method. This method can be overridden by sub classes that want to wrap the @@ -4023,6 +4182,15 @@ The locking model to use + + + The fully qualified type of the FileAppender class. + + + Used by the internal logger to record the Type of the + log message. + + Gets or sets the path to the file that logging will be written to. @@ -4095,9 +4263,10 @@ Gets or sets the used to handle locking of the file. - There are two built in locking models, and . - The former locks the file from the start of logging to the end and the - later lock only for the minimal amount of time when logging each message. + There are three built in locking models, , and . + The first locks the file from the start of logging to the end, the + second locks only for the minimal amount of time when logging each message + and the last synchronizes processes using a named system wide Mutex. The default locking model is the . @@ -4237,6 +4406,33 @@ + + + Helper method that creates a FileStream under CurrentAppender's SecurityContext. + + + + Typically called during OpenFile or AcquireLock. + + + If the directory portion of the does not exist, it is created + via Directory.CreateDirecctory. + + + + + + + + + + Helper method to close under CurrentAppender's SecurityContext. + + + Does not set to null. + + + Gets or sets the for this LockingModel @@ -4379,6 +4575,55 @@ + + + Provides cross-process file locking. + + Ron Grabowski + Steve Wranovsky + + + + Open the file specified and prepare for logging. + + The filename to use + Whether to append to the file, or overwrite + The encoding to use + + + Open the file specified and prepare for logging. + No writes will be made until is called. + Must be called before any calls to , + - and . + + + + + + Close the file + + + + Close the file. No further writes will be made. + + + + + + Acquire the lock on the file + + A stream that is ready to be written to. + + + Does nothing. The lock is already taken + + + + + + + + This appender forwards logging events to attached appenders. @@ -4592,7 +4837,7 @@ - This method is called by the method. + This method is called by the method. The event to log. @@ -4920,31 +5165,223 @@ - + - Stores logging events in an array. + Appends colorful logging events to the console, using the .NET 2 + built-in capabilities. - The memory appender stores all the logging events - that are appended in an in-memory array. + ManagedColoredConsoleAppender appends log events to the standard output stream + or the error output stream using a layout specified by the + user. It also allows the color of a specific type of message to be set. - Use the method to get - the current list of events that have been appended. + By default, all output is written to the console's standard output stream. + The property can be set to direct the output to the + error stream. - Use the method to clear the - current list of events. + When configuring the colored console appender, mappings should be + specified to map logging levels to colors. For example: + + + + + + + + + + + + + + + + + + + + + + The Level is the standard log4net logging level while + ForeColor and BackColor are the values of + enumeration. + + + Based on the ColoredConsoleAppender - Julian Biddle + Rick Hobbs Nicko Cadell - Gert Driesen + Pavlos Touboulidis - + - Initializes a new instance of the class. + The to use when writing to the Console + standard output stream. + + + + The to use when writing to the Console + standard output stream. + + + + + + The to use when writing to the Console + standard error output stream. + + + + The to use when writing to the Console + standard error output stream. + + + + + + Initializes a new instance of the class. + + + The instance of the class is set up to write + to the standard output stream. + + + + + Add a mapping of level to color - done by the config file + + The mapping to add + + + Add a mapping to this appender. + Each mapping defines the foreground and background colors + for a level. + + + + + + This method is called by the method. + + The event to log. + + + Writes the event to the console. + + + The format of the output will depend on the appender's layout. + + + + + + Initialize the options for this appender + + + + Initialize the level to color mappings set on this appender. + + + + + + Flag to write output to the error stream rather than the standard output stream + + + + + Mapping from level object to color value + + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + A class to act as a mapping between the level that a logging call is made at and + the color it should be displayed as. + + + + Defines the mapping between a level and the color it should be displayed in. + + + + + + The mapped foreground color for the specified level + + + + Required property. + The mapped foreground color for the specified level. + + + + + + The mapped background color for the specified level + + + + Required property. + The mapped background color for the specified level. + + + + + + Stores logging events in an array. + + + + The memory appender stores all the logging events + that are appended in an in-memory array. + + + Use the method to get + the current list of events that have been appended. + + + Use the method to clear the + current list of events. + + + Julian Biddle + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. @@ -4965,7 +5402,7 @@ - This method is called by the method. + This method is called by the method. the event to log @@ -5008,7 +5445,7 @@ data to be fixed and stored in the appender, hereby improving performance. - See for more information. + See for more information. @@ -5054,10 +5491,10 @@ Send a message to a user account on the local machine - = <name of the local machine> + = <name of the local machine> - = <user name> + = <user name> @@ -5065,10 +5502,10 @@ Send a message to a user account on a remote machine - = <name of the remote machine> + = <name of the remote machine> - = <user name> + = <user name> @@ -5076,10 +5513,10 @@ Send a message to a domain user account - = <name of a domain controller | uninitialized> + = <name of a domain controller | uninitialized> - = <user name> + = <user name> @@ -5087,7 +5524,7 @@ Send a message to all the names in a workgroup or domain - = <workgroup name | domain name>* + = <workgroup name | domain name>* @@ -5095,10 +5532,10 @@ Send a message from the local machine to a remote machine - = <name of the local machine | uninitialized> + = <name of the local machine | uninitialized> - = <name of the remote machine> + = <name of the remote machine> @@ -5179,7 +5616,7 @@ - This method is called by the method. + This method is called by the method. The event to log. @@ -5524,7 +5961,7 @@ - This method is called by the method. + This method is called by the method. The event to log. @@ -5756,6 +6193,16 @@ Syslog port 514 + + + Initial buffer size + + + + + Maximum buffer size before it is recycled + + Initializes a new instance of the class. @@ -5778,7 +6225,7 @@ - This method is called by the method. + This method is called by the method. The event to log. @@ -6359,6 +6806,15 @@ + + + The fully qualified type of the RollingFileAppender class. + + + Used by the internal logger to record the Type of the + log message. + + Sets the quiet writer being used. @@ -6484,6 +6940,17 @@ + + + Attempts to extract a number from the end of the file name that indicates + the number of the times the file has been rolled over. + + + Certain date pattern extensions like yyyyMMdd will be parsed as valid backup indexes. + + + + Takes a list of files and a base file name, and looks for @@ -6531,6 +6998,14 @@ + + + + + + .1, .2, .3, etc. + + Rollover the file(s) to date/time tagged file(s). @@ -6661,7 +7136,8 @@ This object supplies the current date/time. Allows test code to plug in - a method to control this class when testing date/time based rolling. + a method to control this class when testing date/time based rolling. The default + implementation uses the underlying value of DateTime.Now. @@ -6732,6 +7208,11 @@ Value indicating whether to always log to the same file. + + + Value indicating whether to preserve the file name extension when rolling. + + FileName provided in configuration. Used for rolling properly @@ -6742,6 +7223,30 @@ The 1st of January 1970 in UTC + + + Gets or sets the strategy for determining the current date and time. The default + implementation is to use LocalDateTime which internally calls through to DateTime.Now. + DateTime.UtcNow may be used on frameworks newer than .NET 1.0 by specifying + . + + + An implementation of the interface which returns the current date and time. + + + + Gets or sets the used to return the current date and time. + + + There are two built strategies for determining the current date and time, + + and . + + + The default strategy is . + + + Gets or sets the date pattern to be used for generating file names @@ -6878,6 +7383,22 @@ + + + Gets or sets a value indicating whether to preserve the file name extension when rolling. + + + true if the file name extension should be preserved. + + + + By default file.log is rolled to file.log.yyyy-MM-dd or file.log.curSizeRollBackup. + However, under Windows the new file name will loose any program associations as the + extension is changed. Optionally file.log can be renamed to file.yyyy-MM-dd.log or + file.curSizeRollBackup.log to maintain any program associations. + + + Gets or sets a value indicating whether to always log to @@ -7007,12 +7528,28 @@ - + Default implementation of that returns the current time. - + + + Gets the current time. + + The current time. + + + Gets the current time. + + + + + + Implementation of that returns the current time as the coordinated universal time (UTC). + + + Gets the current time. @@ -7081,7 +7618,51 @@ - Gets or sets a semicolon-delimited list of recipient e-mail addresses. + Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses (use semicolon on .NET 1.1 and comma for later versions). + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + + Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses + that will be carbon copied (use semicolon on .NET 1.1 and comma for later versions). + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + + Gets or sets a semicolon-delimited list of recipient e-mail addresses + that will be blind carbon copied. A semicolon-delimited list of e-mail addresses. @@ -7221,6 +7802,38 @@ + + + Enable or disable use of SSL when sending e-mail message + + + This is available on MS .NET 2.0 runtime and higher + + + + + Gets or sets the reply-to e-mail address. + + + This is available on MS .NET 2.0 runtime and higher + + + + + Gets or sets the subject encoding to be used. + + + The default encoding is the operating system's current ANSI codepage. + + + + + Gets or sets the body encoding to be used. + + + The default encoding is the operating system's current ANSI codepage. + + This appender requires a to be set. @@ -7453,7 +8066,16 @@ - + + + The fully qualified type of the TelnetAppender class. + + + Used by the internal logger to record the Type of the + log message. + + + Overrides the parent method to close the socket handler @@ -7660,7 +8282,8 @@ Events are written using the System.Diagnostics.Trace.Write(string,string) - method. The event's logger name is passed as the value for the category name to the Write method. + method. The event's logger name is the default value for the category parameter + of the Write method. Compact Framework
@@ -7673,6 +8296,7 @@ Douglas de la Torre Nicko Cadell Gert Driesen + Ron Grabowski @@ -7724,6 +8348,11 @@ The default value is true. + + + Defaults to %logger + + Gets or sets a value that indicates whether the appender will @@ -7744,6 +8373,19 @@ + + + The category parameter sent to the Trace method. + + + + Defaults to %logger which will use the logger name of the current + as the category parameter. + + + + + This appender requires a to be set. @@ -7853,13 +8495,22 @@ Appenders can also implement the interface. Therefore - they would require that the method + they would require that the method be called after the appenders properties have been configured. Nicko Cadell Gert Driesen + + + The fully qualified type of the BasicConfigurator class. + + + Used by the internal logger to record the Type of the + log message. + + Initializes a new instance of the class. @@ -7895,6 +8546,17 @@ + + + Initializes the log4net system using the specified appenders. + + The appenders to use to log all logging events. + + + Initializes the log4net system using the specified appenders. + + + Initializes the with a default configuration. @@ -7922,6 +8584,18 @@ + + + Initializes the using the specified appenders. + + The repository to configure. + The appenders to use to log all logging events. + + + Initializes the using the specified appender. + + + Base class for all log4net configuration attributes. @@ -8335,10 +9009,10 @@ For more information on how to configure log4net using - a separate configuration file, see . + a separate configuration file, see . - + @@ -8363,10 +9037,10 @@ For more information on how to configure log4net using - a separate configuration file, see . + a separate configuration file, see . - + @@ -8382,7 +9056,7 @@ Use this attribute to configure the - without calling one of the + without calling one of the methods. @@ -8400,7 +9074,7 @@ Use this attribute to configure the - without calling one of the + without calling one of the methods. @@ -8431,7 +9105,7 @@ If you cannot guarantee the order in which log4net calls will be made from different assemblies you must use programmatic configuration instead, i.e. - call the method directly. + call the method directly. @@ -8462,7 +9136,7 @@ configure it. - The does not extend . + The does not extend . @@ -8485,6 +9159,15 @@ The assembly that this attribute was defined on. The repository to configure. + + + The fully qualified type of the XmlConfiguratorAttribute class. + + + Used by the internal logger to record the Type of the + log message. + + Gets or sets the filename of the configuration file. @@ -8683,7 +9366,7 @@ - Overrides base class method to + Overrides base class method to return a representation of the properties of this object. @@ -8729,7 +9412,7 @@ Use this attribute to configure the - without calling one of the + without calling one of the methods. @@ -8760,6 +9443,15 @@ + + + The fully qualified type of the SecurityContextProviderAttribute class. + + + Used by the internal logger to record the Type of the + log message. + + Gets or sets the type of the provider to use. @@ -9051,10 +9743,10 @@ For more information on how to configure log4net using - a separate configuration file, see . + a separate configuration file, see . - + @@ -9076,12 +9768,12 @@ For more information on how to configure log4net using - a separate configuration file, see . + a separate configuration file, see . - + - + Configures the specified repository using a log4net element. @@ -9098,6 +9790,22 @@ + + + Maps repository names to ConfigAndWatchHandler instances to allow a particular + ConfigAndWatchHandler to dispose of its FileSystemWatcher when a repository is + reconfigured. + + + + + The fully qualified type of the XmlConfigurator class. + + + Used by the internal logger to record the Type of the + log message. + + Class used to watch config files. @@ -9122,18 +9830,6 @@ before reloading the config file. - - - Watch a specified config file used to configure a repository - - The repository to configure. - The configuration file to watch. - - - Watch a specified config file used to configure a repository - - - Holds the FileInfo used to configure the XmlConfigurator @@ -9149,9 +9845,16 @@ The timer used to compress the notification events. + + + Watches file for changes. This object should be disposed when no longer + needed to free system handles on the watched resources. + + - Initializes a new instance of the class. + Initializes a new instance of the class to + watch a specified config file used to configure a repository. The repository to configure. The configuration file to watch. @@ -9191,6 +9894,11 @@ null + + + Release the handles held by the watcher and timer. + + The implementation of the interface suitable @@ -9251,7 +9959,7 @@ The named Lookup a named . This is the repository created by - calling . + calling . @@ -9264,7 +9972,7 @@ The created will be associated with the domain - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -9284,7 +9992,7 @@ The created will be associated with the name - specified such that a call to with the + specified such that a call to with the same name will return the same repository instance. @@ -9297,8 +10005,8 @@ true if the repository exists - Test if a named repository exists. Use - to create a new repository and to retrieve + Test if a named repository exists. Use + to create a new repository and to retrieve a repository. @@ -9374,7 +10082,7 @@ Get the named . The default repository is log4net-default-repository. Other repositories - must be created using the . + must be created using the . If the named repository does not exist an exception is thrown. @@ -9414,7 +10122,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same repository specified will return the same repository instance. @@ -9436,8 +10144,8 @@ true if the repository exists - Test if a named repository exists. Use - to create a new repository and to retrieve + Test if a named repository exists. Use + to create a new repository and to retrieve a repository. @@ -9453,6 +10161,15 @@ + + + The fully qualified type of the CompactRepositorySelector class. + + + Used by the internal logger to record the Type of the + log message. + + Notify the registered listeners that the repository has been created @@ -9547,7 +10264,7 @@ does not exist a is thrown. - Use to create a repository. + Use to create a repository. is . @@ -9563,7 +10280,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -9603,7 +10320,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -9642,7 +10359,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same repository specified will return the same repository instance. @@ -9657,8 +10374,8 @@ true if the repository exists - Test if a named repository exists. Use - to create a new repository and to retrieve + Test if a named repository exists. Use + to create a new repository and to retrieve a repository. @@ -9753,6 +10470,15 @@ is . + + + The fully qualified type of the DefaultRepositorySelector class. + + + Used by the internal logger to record the Type of the + log message. + + Event to notify that a logger repository has been created. @@ -9771,11 +10497,11 @@ - Defined error codes that can be passed to the method. + Defined error codes that can be passed to the method. - Values passed to the method. + Values passed to the method. Nicko Cadell @@ -9815,6 +10541,94 @@ Failed to parse address + + + An evaluator that triggers on an Exception type + + + + This evaluator will trigger if the type of the Exception + passed to + is equal to a Type in . /// + + + Drew Schaeffer + + + + Test if an triggers an action + + + + Implementations of this interface allow certain appenders to decide + when to perform an appender specific action. + + + The action or behavior triggered is defined by the implementation. + + + Nicko Cadell + + + + Test if this event triggers the action + + The event to check + true if this event triggers the action, otherwise false + + + Return true if this event triggers the action + + + + + + The type that causes the trigger to fire. + + + + + Causes subclasses of to cause the trigger to fire. + + + + + Default ctor to allow dynamic creation through a configurator. + + + + + Constructs an evaluator and initializes to trigger on + + the type that triggers this evaluator. + If true, this evaluator will trigger on subclasses of . + + + + Is this the triggering event? + + The event to check + This method returns true, if the logging event Exception + Type is . + Otherwise it returns false + + + This evaluator will trigger if the Exception Type of the event + passed to + is . + + + + + + The type that triggers this evaluator. + + + + + If true, this evaluator will trigger on subclasses of . + + Appenders may delegate their error handling to an . @@ -9851,7 +10665,7 @@ The that was thrown when the error occurred. - See . + See . @@ -9862,7 +10676,7 @@ The message associated with the error. - See . + See . @@ -10072,33 +10886,6 @@ - - - Test if an triggers an action - - - - Implementations of this interface allow certain appenders to decide - when to perform an appender specific action. - - - The action or behavior triggered is defined by the implementation. - - - Nicko Cadell - - - - Test if this event triggers the action - - The event to check - true if this event triggers the action, otherwise false - - - Return true if this event triggers the action - - - Defines the default set of levels recognized by the system. @@ -10410,6 +11197,12 @@ The level designates a higher level than all the rest. + + + The level designates very severe error events. + System unusable, emergencies. + + The level designates very severe error events. @@ -10717,16 +11510,16 @@ - is less than zero + is less than zero -or- - is equal to or greater than . + is equal to or greater than . - is less than zero + is less than zero -or- - is equal to or greater than . + is equal to or greater than . @@ -10851,7 +11644,7 @@ This evaluator will trigger if the level of the event - passed to + passed to is equal to or greater than the level. @@ -10873,7 +11666,7 @@ This evaluator will trigger if the level of the event - passed to + passed to is equal to or greater than the level. @@ -10890,7 +11683,7 @@ This evaluator will trigger if the level of the event - passed to + passed to is equal to or greater than the level. @@ -10907,7 +11700,7 @@ This evaluator will trigger if the level of the event - passed to + passed to is equal to or greater than the level. @@ -10923,7 +11716,7 @@ This evaluator will trigger if the level of the event - passed to + passed to is equal to or greater than the level. @@ -10979,7 +11772,7 @@ Create a new Level and add it to the map - + @@ -11118,6 +11911,15 @@ + + + The fully qualified type of the LocationInfo class. + + + Used by the internal logger to record the Type of the + log message. + + Gets the fully qualified class name of the caller making the logging @@ -11188,6 +11990,11 @@ + + + Gets the stack frames from the stack trace of the caller making the log request + + Static manager that controls the creation of repositories @@ -11396,7 +12203,7 @@ - Shorthand for . + Shorthand for . The repository to lookup in. The of which the fullname will be used as the name of the logger to retrieve. @@ -11409,7 +12216,7 @@ - Shorthand for . + Shorthand for . the assembly to use to lookup the repository The of which the fullname will be used as the name of the logger to retrieve. @@ -11612,7 +12419,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -11629,7 +12436,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -11662,7 +12469,7 @@ Called when the event fires. - When the event is triggered the log4net system is . + When the event is triggered the log4net system is . @@ -11677,10 +12484,19 @@ Called when the event fires. - When the event is triggered the log4net system is . + When the event is triggered the log4net system is . + + + The fully qualified type of the LoggerManager class. + + + Used by the internal logger to record the Type of the + log message. + + Initialize the default repository selector @@ -11702,7 +12518,7 @@ The caller to supplies either a string name or an assembly (if not supplied the assembly is inferred using - ). + ). This context is used by the selector to lookup a specific repository. @@ -11953,7 +12769,7 @@ - Fix the event properties + Fix the event properties. Active properties must implement in order to be eligible for fixing. @@ -12002,8 +12818,8 @@ time the event is delivered to appenders, but will not be consistent at any time afterwards. If an event is to be stored and then processed at a later time these volatile values must be fixed by calling - . There is a performance penalty - for incurred by calling but it + . There is a performance penalty + for incurred by calling but it is essential to maintaining data consistency. @@ -12043,7 +12859,7 @@ Except , and , all fields of LoggingEvent are filled when actually needed. Call - to cache all data locally + to cache all data locally to prevent inconsistencies. This method is called by the log4net framework @@ -12068,7 +12884,7 @@ be useful if you require a custom serialization scheme. - Use the method to obtain an + Use the method to obtain an instance of the class. @@ -12094,7 +12910,7 @@ be useful if you require a custom serialization scheme. - Use the method to obtain an + Use the method to obtain an instance of the class. @@ -12117,7 +12933,7 @@ be useful if you require a custom serialization scheme. - Use the method to obtain an + Use the method to obtain an instance of the class. @@ -12172,7 +12988,7 @@ The data in this event must be fixed before it can be serialized. - The method must be called during the + The method must be called during the method call if this event is to be used outside that method. @@ -12247,17 +13063,17 @@ time the event is delivered to appenders, but will not be consistent at any time afterwards. If an event is to be stored and then processed at a later time these volatile values must be fixed by calling - . There is a performance penalty - incurred by calling but it + . There is a performance penalty + incurred by calling but it is essential to maintaining data consistency. - Calling is equivalent to - calling passing the parameter + Calling is equivalent to + calling passing the parameter false. - See for more + See for more information. @@ -12274,8 +13090,8 @@ time the event is delivered to appenders, but will not be consistent at any time afterwards. If an event is to be stored and then processed at a later time these volatile values must be fixed by calling - . There is a performance penalty - for incurred by calling but it + . There is a performance penalty + for incurred by calling but it is essential to maintaining data consistency. @@ -12714,7 +13530,7 @@ DEBUG - The and methods log messages + The and methods log messages at the DEBUG level. That is the level with that name defined in the repositories . The default value for this level is . The @@ -12724,7 +13540,7 @@ INFO - The and methods log messages + The and methods log messages at the INFO level. That is the level with that name defined in the repositories . The default value for this level is . The @@ -12734,7 +13550,7 @@ WARN - The and methods log messages + The and methods log messages at the WARN level. That is the level with that name defined in the repositories . The default value for this level is . The @@ -12744,7 +13560,7 @@ ERROR - The and methods log messages + The and methods log messages at the ERROR level. That is the level with that name defined in the repositories . The default value for this level is . The @@ -12754,7 +13570,7 @@ FATAL - The and methods log messages + The and methods log messages at the FATAL level. That is the level with that name defined in the repositories . The default value for this level is . The @@ -12778,7 +13594,7 @@ Use the to obtain logger instances - that implement this interface. The + that implement this interface. The static method is used to get logger instances. @@ -12807,7 +13623,7 @@ - + Nicko Cadell Gert Driesen @@ -12832,10 +13648,10 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. - + @@ -12848,10 +13664,10 @@ The exception to log, including its stack trace. - See the form for more detailed information. + See the form for more detailed information. - + @@ -12864,16 +13680,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -12885,16 +13701,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -12907,16 +13723,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -12930,16 +13746,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -12952,16 +13768,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -12984,11 +13800,11 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. The message object to log. - + @@ -13001,10 +13817,10 @@ The exception to log, including its stack trace. - See the form for more detailed information. + See the form for more detailed information. - + @@ -13017,16 +13833,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13038,16 +13854,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13060,16 +13876,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13083,16 +13899,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13105,16 +13921,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13137,11 +13953,11 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. The message object to log. - + @@ -13154,10 +13970,10 @@ The exception to log, including its stack trace. - See the form for more detailed information. + See the form for more detailed information. - + @@ -13170,16 +13986,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13191,16 +14007,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13213,16 +14029,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13236,16 +14052,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13258,16 +14074,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13291,10 +14107,10 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. - + @@ -13307,10 +14123,10 @@ The exception to log, including its stack trace. - See the form for more detailed information. + See the form for more detailed information. - + @@ -13323,16 +14139,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13344,16 +14160,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13366,16 +14182,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13389,16 +14205,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13411,16 +14227,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13443,11 +14259,11 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. The message object to log. - + @@ -13460,10 +14276,10 @@ The exception to log, including its stack trace. - See the form for more detailed information. + See the form for more detailed information. - + @@ -13476,16 +14292,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13497,16 +14313,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13519,16 +14335,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13542,16 +14358,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13564,16 +14380,16 @@ The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior + for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. - + @@ -13611,7 +14427,7 @@ the other hand, if the log is debug enabled, you will incur the cost of evaluating whether the logger is debug enabled twice. Once in and once in - the . This is an insignificant overhead + the . This is an insignificant overhead since evaluating a logger takes about 1% of the time it takes to actually log. This is the preferred style of logging. @@ -13644,8 +14460,8 @@ speed or runtime flexibility. - - + + @@ -13657,8 +14473,8 @@ For more information see . - - + + @@ -13671,8 +14487,8 @@ For more information see . - - + + @@ -13685,8 +14501,8 @@ For more information see . - - + + @@ -13699,8 +14515,8 @@ For more information see . - - + + @@ -13746,7 +14562,7 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. @@ -13763,10 +14579,10 @@ as a parameter. - See the form for more detailed information. + See the form for more detailed information. - + @@ -13776,18 +14592,18 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13800,18 +14616,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13825,18 +14641,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13851,18 +14667,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13876,13 +14692,13 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13908,7 +14724,7 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. @@ -13925,10 +14741,10 @@ passed as a parameter. - See the form for more detailed information. + See the form for more detailed information. - + @@ -13938,18 +14754,18 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13962,18 +14778,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -13987,18 +14803,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14013,18 +14829,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14038,13 +14854,13 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14070,7 +14886,7 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. @@ -14087,10 +14903,10 @@ passed as a parameter. - See the form for more detailed information. + See the form for more detailed information. - + @@ -14100,18 +14916,18 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14124,18 +14940,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14149,18 +14965,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14175,18 +14991,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14200,13 +15016,13 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14232,7 +15048,7 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. @@ -14249,10 +15065,10 @@ passed as a parameter. - See the form for more detailed information. + See the form for more detailed information. - + @@ -14262,18 +15078,18 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14286,18 +15102,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14311,18 +15127,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14337,18 +15153,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14362,13 +15178,13 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14394,7 +15210,7 @@ WARNING Note that passing an to this method will print the name of the but no stack trace. To print a stack trace use the - form instead. + form instead. @@ -14411,10 +15227,10 @@ passed as a parameter. - See the form for more detailed information. + See the form for more detailed information. - + @@ -14424,18 +15240,18 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14448,18 +15264,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14473,18 +15289,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14499,18 +15315,18 @@ An Object to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. The string is formatted using the format provider. To specify a localized provider use the - method. + method. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14524,13 +15340,13 @@ An Object array containing zero or more objects to format - The message is formatted using the method. See + The message is formatted using the method. See String.Format for details of the syntax of the format string and the behavior of the formatting. This method does not take an object to include in the - log event. To pass an use one of the + log event. To pass an use one of the methods instead. @@ -14654,18 +15470,97 @@ - + - A SecurityContext used by log4net when interacting with protected resources + provides method information without actually referencing a System.Reflection.MethodBase + as that would require that the containing assembly is loaded. - - - A SecurityContext used by log4net when interacting with protected resources - for example with operating system services. This can be used to impersonate - a principal that has been granted privileges on the system resources. - - - Nicko Cadell + + + + + When location information is not available the constant + NA is returned. Current value of this string + constant is ?. + + + + + constructs a method item for an unknown method. + + + + + constructs a method item from the name of the method. + + + + + + constructs a method item from the name of the method and its parameters. + + + + + + + constructs a method item from a method base by determining the method name and its parameters. + + + + + + The fully qualified type of the StackFrameItem class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets the method name of the caller making the logging + request. + + + The method name of the caller making the logging + request. + + + + Gets the method name of the caller making the logging + request. + + + + + + Gets the method parameters of the caller making + the logging request. + + + The method parameters of the caller making + the logging request + + + + Gets the method parameters of the caller making + the logging request. + + + + + + A SecurityContext used by log4net when interacting with protected resources + + + + A SecurityContext used by log4net when interacting with protected resources + for example with operating system services. This can be used to impersonate + a principal that has been granted privileges on the system resources. + + + Nicko Cadell @@ -14774,6 +15669,195 @@ + + + provides stack frame information without actually referencing a System.Diagnostics.StackFrame + as that would require that the containing assembly is loaded. + + + + + + When location information is not available the constant + NA is returned. Current value of this string + constant is ?. + + + + + returns a stack frame item from a stack frame. This + + + + + + + The fully qualified type of the StackFrameItem class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets the fully qualified class name of the caller making the logging + request. + + + The fully qualified class name of the caller making the logging + request. + + + + Gets the fully qualified class name of the caller making the logging + request. + + + + + + Gets the file name of the caller. + + + The file name of the caller. + + + + Gets the file name of the caller. + + + + + + Gets the line number of the caller. + + + The line number of the caller. + + + + Gets the line number of the caller. + + + + + + Gets the method name of the caller. + + + The method name of the caller. + + + + Gets the method name of the caller. + + + + + + Gets all available caller information + + + All available caller information, in the format + fully.qualified.classname.of.caller.methodName(Filename:line) + + + + Gets all available caller information, in the format + fully.qualified.classname.of.caller.methodName(Filename:line) + + + + + + An evaluator that triggers after specified number of seconds. + + + + This evaluator will trigger if the specified time period + has passed since last check. + + + Robert Sevcik + + + + The default time threshold for triggering in seconds. Zero means it won't trigger at all. + + + + + The time threshold for triggering in seconds. Zero means it won't trigger at all. + + + + + The time of last check. This gets updated when the object is created and when the evaluator triggers. + + + + + Create a new evaluator using the time threshold in seconds. + + + + Create a new evaluator using the time threshold in seconds. + + + This evaluator will trigger if the specified time period + has passed since last check. + + + + + + Create a new evaluator using the specified time threshold in seconds. + + + The time threshold in seconds to trigger after. + Zero means it won't trigger at all. + + + + Create a new evaluator using the specified time threshold in seconds. + + + This evaluator will trigger if the specified time period + has passed since last check. + + + + + + Is this the triggering event? + + The event to check + This method returns true, if the specified time period + has passed since last check.. + Otherwise it returns false + + + This evaluator will trigger if the specified time period + has passed since last check. + + + + + + The time threshold in seconds to trigger after + + + The time threshold in seconds to trigger after. + Zero means it won't trigger at all. + + + + This evaluator will trigger if the specified time period + has passed since last check. + + + Delegate used to handle creation of new wrappers. @@ -15010,7 +16094,7 @@ as a string. - + Last stored time with precision up to the second, formatted as a string. @@ -15103,11 +16187,11 @@ - Formats the using the method. + Formats the using the method. - Formats the using the method. + Formats the using the method. Nicko Cadell @@ -15125,20 +16209,20 @@ The format string must be compatible with the options - that can be supplied to . + that can be supplied to . - Formats the date using . + Formats the date using . The date to convert to a string. The writer to write to. Uses the date format string supplied to the constructor to call - the method to format the date. + the method to format the date. @@ -15149,7 +16233,7 @@ The format string must be compatible with the options - that can be supplied to . + that can be supplied to . @@ -15621,7 +16705,7 @@ The rendered message is matched against the . If the equals the beginning of - the incoming () + the incoming () then a match will have occurred. If no match occurs this function will return allowing other filters to check the event. If a match occurs then @@ -15655,7 +16739,7 @@ This filter will attempt to match this value against logger name in the following way. The match will be done against the beginning of the - logger name (using ). The match is + logger name (using ). The match is case sensitive. If a match is found then the result depends on the value of . @@ -16020,6 +17104,27 @@ + + + Write an dictionary to a + + the writer to write to + a to use for object conversion + the value to write to the writer + + + Writes the to a writer in the form: + + + {key1=value1, key2=value2, key3=value3} + + + If the specified + is not null then it is used to render the key and value to text, otherwise + the object's ToString method is called. + + + Write an object to a @@ -16074,6 +17179,11 @@ + + + + + Initializes a new instance of the class. @@ -16176,7 +17286,7 @@ Any other pattern string uses the formatter. This formatter passes the pattern string to the - method. + method. For details on valid patterns see DateTimeFormatInfo Class. @@ -16234,6 +17344,15 @@ + + + The fully qualified type of the DatePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + Write the exception text to the output @@ -16271,11 +17390,32 @@ trailing newline. - If there is no exception then nothing will be output + If there is no exception or the exception property specified + by the Option value does not exist then nothing will be output and no trailing newline will be appended. It is typical to put a newline before the exception and to have the exception as the last data in the pattern. + + Recognized values for the Option parameter are: + + + + Message + + + Source + + + StackTrace + + + TargetSite + + + HelpLink + + @@ -16476,6 +17616,15 @@ specified by the property. + + + The fully qualified type of the NamedPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + Gets the fully qualified name of the logger @@ -16636,516 +17785,249 @@ end time (in the current local time zone) the time difference in milliseconds - + - Converter to include event thread name + Write the caller stack frames to the output - Writes the to the output. + Writes the to the output writer, using format: + type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...) - Nicko Cadell + Adam Davies - + - Write the ThreadName to the output + Write the caller stack frames to the output - that will receive the formatted result. - the event being logged - Writes the to the . + Writes the to the output writer, using format: + type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1 + Michael Cromwell - + - Pattern converter for the class name + Initialize the converter - Outputs the of the event. + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. - Nicko Cadell - + - Gets the fully qualified name of the class + Write the strack frames to the output + that will receive the formatted result. the event being logged - The fully qualified type name for the caller location - Returns the of the . + Writes the to the output writer. - - - Converter to include event user name - - Douglas de la Torre - Nicko Cadell - - + - Convert the pattern to the rendered message + Returns the Name of the method - that will receive the formatted result. - the event being logged + + This method was created, so this class could be used as a base class for StackTraceDetailPatternConverter + string - + - Write the TimeStamp to the output + The fully qualified type of the StackTracePatternConverter class. - - Date pattern converter, uses a to format - the date of a . - - - Uses a to format the - in Universal time. - - - See the for details on the date pattern syntax. - + Used by the internal logger to record the Type of the + log message. - - Nicko Cadell - + - Write the TimeStamp to the output + The fully qualified type of the StackTraceDetailPatternConverter class. - that will receive the formatted result. - the event being logged - - Pass the to the - for it to render it to the writer. - - - The passed is in the local time zone, this is converted - to Universal time before it is rendered. - + Used by the internal logger to record the Type of the + log message. - - + - A Layout that renders only the Exception text from the logging event + Converter to include event thread name - A Layout that renders only the Exception text from the logging event. - - - This Layout should only be used with appenders that utilize multiple - layouts (e.g. ). + Writes the to the output. Nicko Cadell - Gert Driesen - + - Extend this abstract class to create your own log layout format. + Write the ThreadName to the output + that will receive the formatted result. + the event being logged - This is the base implementation of the - interface. Most layout objects should extend this class. - - - - - - Subclasses must implement the - method. - - - Subclasses should set the in their default - constructor. + Writes the to the . - - Nicko Cadell - Gert Driesen - + - Interface implemented by layout objects + Pattern converter for the class name - An object is used to format a - as text. The method is called by an - appender to transform the into a string. - - - The layout can also supply and - text that is appender before any events and after all the events respectively. + Outputs the of the event. Nicko Cadell - Gert Driesen - + - Implement this method to create your own layout format. + Gets the fully qualified name of the class - The TextWriter to write the formatted event to - The event to format + the event being logged + The fully qualified type name for the caller location - This method is called by an appender to format - the as text and output to a writer. - - - If the caller does not have a and prefers the - event to be formatted as a then the following - code can be used to format the event into a . + Returns the of the . - - StringWriter writer = new StringWriter(); - Layout.Format(writer, loggingEvent); - string formattedEvent = writer.ToString(); - - + - The content type output by this layout. + Converter to include event user name - The content type - - - The content type output by this layout. - - - This is a MIME type e.g. "text/plain". - - + Douglas de la Torre + Nicko Cadell - + - The header for the layout format. + Convert the pattern to the rendered message - the layout header - - - The Header text will be appended before any logging events - are formatted and appended. - - + that will receive the formatted result. + the event being logged - + - The footer for the layout format. + Write the TimeStamp to the output - the layout footer - The Footer text will be appended after all the logging events - have been formatted and appended. + Date pattern converter, uses a to format + the date of a . - - - - - Flag indicating if this layout handle exceptions - - false if this layout handles exceptions - - If this layout handles the exception object contained within - , then the layout should return - false. Otherwise, if the layout ignores the exception - object, then the layout should return true. + Uses a to format the + in Universal time. - - - - - The header text - - - See for more information. + See the for details on the date pattern syntax. + + Nicko Cadell - + - The footer text + Write the TimeStamp to the output + that will receive the formatted result. + the event being logged - See for more information. + Pass the to the + for it to render it to the writer. + + + The passed is in the local time zone, this is converted + to Universal time before it is rendered. + - + - Flag indicating if this layout handles exceptions + The fully qualified type of the UtcDatePatternConverter class. - - false if this layout handles exceptions - + Used by the internal logger to record the Type of the + log message. - + - Empty default constructor + A flexible layout configurable with pattern string that re-evaluates on each call. - - Empty default constructor - + This class is built on and provides all the + features and capabilities of PatternLayout. PatternLayout is a 'static' class + in that its layout is done once at configuration time. This class will recreate + the layout on each reference. + One important difference between PatternLayout and DynamicPatternLayout is the + treatment of the Header and Footer parameters in the configuration. The Header and Footer + parameters for DynamicPatternLayout must be syntactically in the form of a PatternString, + but should not be marked as type log4net.Util.PatternString. Doing so causes the + pattern to be statically converted at configuration time and causes DynamicPatternLayout + to perform the same as PatternLayout. + Please see for complete documentation. + + <layout type="log4net.Layout.DynamicPatternLayout"> + <param name="Header" value="%newline**** Trace Opened Local: %date{yyyy-MM-dd HH:mm:ss.fff} UTC: %utcdate{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /> + <param name="Footer" value="**** Trace Closed %date{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /> + </layout> + - + - Activate component options + A flexible layout configurable with pattern string. - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. + The goal of this class is to a + as a string. The results + depend on the conversion pattern. - If any of the configuration properties are modified then - must be called again. + The conversion pattern is closely related to the conversion + pattern of the printf function in C. A conversion pattern is + composed of literal text and format control expressions called + conversion specifiers. - This method must be implemented by the subclass. + You are free to insert any literal text within the conversion + pattern. - - - - - Implement this method to create your own layout format. - - The TextWriter to write the formatted event to - The event to format - - This method is called by an appender to format - the as text. + Each conversion specifier starts with a percent sign (%) and is + followed by optional format modifiers and a conversion + pattern name. The conversion pattern name specifies the type of + data, e.g. logger, level, date, thread name. The format + modifiers control such things as field width, padding, left and + right justification. The following is a simple example. - - - - - The content type output by this layout. - - The content type is "text/plain" - - The content type output by this layout. - - - This base class uses the value "text/plain". - To change this value a subclass must override this - property. - - - - - - The header for the layout format. - - the layout header - - - The Header text will be appended before any logging events - are formatted and appended. - - - - - - The footer for the layout format. - - the layout footer - - - The Footer text will be appended after all the logging events - have been formatted and appended. - - - - - - Flag indicating if this layout handles exceptions - - false if this layout handles exceptions - - - If this layout handles the exception object contained within - , then the layout should return - false. Otherwise, if the layout ignores the exception - object, then the layout should return true. - - - Set this value to override a this default setting. The default - value is true, this layout does not handle the exception. - - - - - - Default constructor - - - - Constructs a ExceptionLayout - - - - - - Activate component options - - - - Part of the component activation - framework. - - - This method does nothing as options become effective immediately. - - - - - - Gets the exception text from the logging event - - The TextWriter to write the formatted event to - the event being logged - - - Write the exception string to the . - The exception string is retrieved from . - - - - - - Interface for raw layout objects - - - - Interface used to format a - to an object. - - - This interface should not be confused with the - interface. This interface is used in - only certain specialized situations where a raw object is - required rather than a formatted string. The - is not generally useful than this interface. - - - Nicko Cadell - Gert Driesen - - - - Implement this method to create your own layout format. - - The event to format - returns the formatted event - - - Implement this method to create your own layout format. - - - - - - Adapts any to a - - - - Where an is required this adapter - allows a to be specified. - - - Nicko Cadell - Gert Driesen - - - - The layout to adapt - - - - - Construct a new adapter - - the layout to adapt - - - Create the adapter for the specified . - - - - - - Format the logging event as an object. - - The event to format - returns the formatted event - - - Format the logging event as an object. - - - Uses the object supplied to - the constructor to perform the formatting. - - - - - - A flexible layout configurable with pattern string. - - - - The goal of this class is to a - as a string. The results - depend on the conversion pattern. - - - The conversion pattern is closely related to the conversion - pattern of the printf function in C. A conversion pattern is - composed of literal text and format control expressions called - conversion specifiers. - - - You are free to insert any literal text within the conversion - pattern. - - - Each conversion specifier starts with a percent sign (%) and is - followed by optional format modifiers and a conversion - pattern name. The conversion pattern name specifies the type of - data, e.g. logger, level, date, thread name. The format - modifiers control such things as field width, padding, left and - right justification. The following is a simple example. - - - Let the conversion pattern be "%-5level [%thread]: %message%newline" and assume - that the log4net environment was set to use a PatternLayout. Then the - statements + Let the conversion pattern be "%-5level [%thread]: %message%newline" and assume + that the log4net environment was set to use a PatternLayout. Then the + statements ILog log = LogManager.GetLogger(typeof(TestApp)); @@ -17184,6 +18066,50 @@ logging event was generated. + + aspnet-cache + + + Used to output all cache items in the case of %aspnet-cache or just one named item if used as %aspnet-cache{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + + + aspnet-context + + + Used to output all context items in the case of %aspnet-context or just one named item if used as %aspnet-context{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + + + aspnet-request + + + Used to output all request parameters in the case of %aspnet-request or just one named param if used as %aspnet-request{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + + + aspnet-session + + + Used to output all session items in the case of %aspnet-session or just one named item if used as %aspnet-session{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + c Equivalent to logger @@ -17215,7 +18141,7 @@ The date format specifier admits the same syntax as the - time pattern string of the . + time pattern string of the . For better results it is recommended to use the log4net date @@ -17228,7 +18154,7 @@ These dedicated date formatters perform significantly - better than . + better than . @@ -17494,6 +18420,42 @@ r Equivalent to timestamp + + stacktrace + + + Used to output the stack trace of the logging event + The stack trace level specifier may be enclosed + between braces. For example, %stacktrace{level}. + If no stack trace level specifier is given then 1 is assumed + + + Output uses the format: + type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1 + + + This pattern is not available for Compact Framework assemblies. + + + + + stacktracedetail + + + Used to output the stack trace of the logging event + The stack trace level specifier may be enclosed + between braces. For example, %stacktracedetail{level}. + If no stack trace level specifier is given then 1 is assumed + + + Output uses the format: + type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...) + + + This pattern is not available for Compact Framework assemblies. + + + t Equivalent to thread @@ -17576,7 +18538,7 @@ The date format specifier admits the same syntax as the - time pattern string of the . + time pattern string of the . For better results it is recommended to use the log4net date @@ -17589,7 +18551,7 @@ These dedicated date formatters perform significantly - better than . + better than . @@ -17761,7 +18723,7 @@ Additional pattern converters may be registered with a specific - instance using the method. + instance using the method. @@ -17781,19 +18743,278 @@ Douglas de la Torre Daniel Cazzulino - + - Default pattern string for log output. + Extend this abstract class to create your own log layout format. - Default pattern string for log output. - Currently set to the string "%message%newline" - which just prints the application supplied message. + This is the base implementation of the + interface. Most layout objects should extend this class. - - + + + + Subclasses must implement the + method. + + + Subclasses should set the in their default + constructor. + + + + Nicko Cadell + Gert Driesen + + + + Interface implemented by layout objects + + + + An object is used to format a + as text. The method is called by an + appender to transform the into a string. + + + The layout can also supply and + text that is appender before any events and after all the events respectively. + + + Nicko Cadell + Gert Driesen + + + + Implement this method to create your own layout format. + + The TextWriter to write the formatted event to + The event to format + + + This method is called by an appender to format + the as text and output to a writer. + + + If the caller does not have a and prefers the + event to be formatted as a then the following + code can be used to format the event into a . + + + StringWriter writer = new StringWriter(); + Layout.Format(writer, loggingEvent); + string formattedEvent = writer.ToString(); + + + + + + The content type output by this layout. + + The content type + + + The content type output by this layout. + + + This is a MIME type e.g. "text/plain". + + + + + + The header for the layout format. + + the layout header + + + The Header text will be appended before any logging events + are formatted and appended. + + + + + + The footer for the layout format. + + the layout footer + + + The Footer text will be appended after all the logging events + have been formatted and appended. + + + + + + Flag indicating if this layout handle exceptions + + false if this layout handles exceptions + + + If this layout handles the exception object contained within + , then the layout should return + false. Otherwise, if the layout ignores the exception + object, then the layout should return true. + + + + + + The header text + + + + See for more information. + + + + + + The footer text + + + + See for more information. + + + + + + Flag indicating if this layout handles exceptions + + + + false if this layout handles exceptions + + + + + + Empty default constructor + + + + Empty default constructor + + + + + + Activate component options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + This method must be implemented by the subclass. + + + + + + Implement this method to create your own layout format. + + The TextWriter to write the formatted event to + The event to format + + + This method is called by an appender to format + the as text. + + + + + + Convenience method for easily formatting the logging event into a string variable. + + + + Creates a new StringWriter instance to store the formatted logging event. + + + + + The content type output by this layout. + + The content type is "text/plain" + + + The content type output by this layout. + + + This base class uses the value "text/plain". + To change this value a subclass must override this + property. + + + + + + The header for the layout format. + + the layout header + + + The Header text will be appended before any logging events + are formatted and appended. + + + + + + The footer for the layout format. + + the layout footer + + + The Footer text will be appended after all the logging events + have been formatted and appended. + + + + + + Flag indicating if this layout handles exceptions + + false if this layout handles exceptions + + + If this layout handles the exception object contained within + , then the layout should return + false. Otherwise, if the layout ignores the exception + object, then the layout should return true. + + + Set this value to override a this default setting. The default + value is true, this layout does not handle the exception. + + + + + + Default pattern string for log output. + + + + Default pattern string for log output. + Currently set to the string "%message%newline" + which just prints the application supplied message. + + + + A detailed conversion pattern @@ -17920,7 +19141,7 @@ - + Add a converter to this PatternLayout @@ -17928,7 +19149,7 @@ This version of the method is used by the configurator. - Programmatic users should use the alternative method. + Programmatic users should use the alternative method. @@ -17962,41 +19183,187 @@ - + - Wrapper class used to map converter names to converter types + The header PatternString + + + + + The footer PatternString + + + + + Constructs a DynamicPatternLayout using the DefaultConversionPattern - Pattern converter info class used during configuration to - pass to the - method. + The default pattern just produces the application supplied message. - + - default constructor + Constructs a DynamicPatternLayout using the supplied conversion pattern + the pattern to use + + - + - Gets or sets the name of the conversion pattern + The header for the layout format. + the layout header - The name of the pattern in the format string + The Header text will be appended before any logging events + are formatted and appended. + The pattern will be formatted on each get operation. - + - Gets or sets the type of the converter + The footer for the layout format. + the layout footer - The value specified must extend the - type. + The Footer text will be appended after all the logging events + have been formatted and appended. + + The pattern will be formatted on each get operation. + + + + + A Layout that renders only the Exception text from the logging event + + + + A Layout that renders only the Exception text from the logging event. + + + This Layout should only be used with appenders that utilize multiple + layouts (e.g. ). + + + Nicko Cadell + Gert Driesen + + + + Default constructor + + + + Constructs a ExceptionLayout + + + + + + Activate component options + + + + Part of the component activation + framework. + + + This method does nothing as options become effective immediately. + + + + + + Gets the exception text from the logging event + + The TextWriter to write the formatted event to + the event being logged + + + Write the exception string to the . + The exception string is retrieved from . + + + + + + Interface for raw layout objects + + + + Interface used to format a + to an object. + + + This interface should not be confused with the + interface. This interface is used in + only certain specialized situations where a raw object is + required rather than a formatted string. The + is not generally useful than this interface. + + + Nicko Cadell + Gert Driesen + + + + Implement this method to create your own layout format. + + The event to format + returns the formatted event + + + Implement this method to create your own layout format. + + + + + + Adapts any to a + + + + Where an is required this adapter + allows a to be specified. + + + Nicko Cadell + Gert Driesen + + + + The layout to adapt + + + + + Construct a new adapter + + the layout to adapt + + + Create the adapter for the specified . + + + + + + Format the logging event as an object. + + The event to format + returns the formatted event + + + Format the logging event as an object. + + + Uses the object supplied to + the constructor to perform the formatting. @@ -18391,11 +19758,6 @@ the XML events. - - - Writer adapter that ignores Close - - The string to replace invalid chars with @@ -18664,7 +20026,7 @@ The parameter is provided to lookup and render other objects. This is very useful where contains - nested objects of unknown type. The + nested objects of unknown type. The method can be used to render these objects. @@ -18694,7 +20056,7 @@ The parameter is provided to lookup and render other objects. This is very useful where contains - nested objects of unknown type. The + nested objects of unknown type. The method can be used to render these objects. @@ -18829,7 +20191,7 @@ is used to render them. - The method is used to render an + The method is used to render an object using the appropriate renderers defined in this map. @@ -18855,7 +20217,7 @@ This is a convenience method used to render an object to a string. - The alternative method + The alternative method should be used when streaming output to a . @@ -18870,7 +20232,7 @@ Find the appropriate renderer for the type of the parameter. This is accomplished by calling the - method. Once a renderer is found, it is + method. Once a renderer is found, it is applied on the object and the result is returned as a . @@ -18887,7 +20249,7 @@ Gets the renderer for the specified object type. - Syntactic sugar method that calls + Syntactic sugar method that calls with the type of the object parameter. @@ -18934,7 +20296,7 @@ Register an object renderer for a specific source type. - This renderer will be returned from a call to + This renderer will be returned from a call to specifying the same as an argument. @@ -19186,16 +20548,16 @@ - is less than zero. + is less than zero. -or- - is equal to or greater than . + is equal to or greater than . - is less than zero. + is less than zero. -or- - is equal to or greater than . + is equal to or greater than . @@ -19572,6 +20934,15 @@ + + + The fully qualified type of the RemoteLoggingServerPlugin class. + + + Used by the internal logger to record the Type of the + log message. + + Gets or sets the URI of this sink. @@ -19582,7 +20953,7 @@ This is the name under which the object is marshaled. - + @@ -19664,7 +21035,7 @@ create new objects. - The method is called + The method is called to create a named . @@ -19674,10 +21045,11 @@ Nicko Cadell Gert Driesen - + Create a new instance + The that will own the . The name of the . The instance for the specified name. @@ -19705,10 +21077,11 @@ - + Create a new instance + The that will own the . The name of the . The instance for the specified name. @@ -19975,7 +21348,7 @@ - + The fully qualified type of the Logger class. @@ -20242,7 +21615,7 @@ The structure of the logger hierarchy is maintained by the - method. The hierarchy is such that children + method. The hierarchy is such that children link to their parent but parents do not have any references to their children. Moreover, loggers can be instantiated in any order, in particular descendant before ancestor. @@ -20280,7 +21653,7 @@ This interface is implemented by logger repositories. e.g. - . + . This interface is used by the @@ -20345,7 +21718,7 @@ lost. - The method is careful to close nested + The method is careful to close nested appenders before closing regular appenders. This is allows configurations where a regular appender is attached to a logger and again to a nested appender. @@ -20380,7 +21753,7 @@ This method should not normally be used to log. The interface should be used for routine logging. This interface can be obtained - using the method. + using the method. The logEvent is delivered to the appropriate logger and @@ -20484,6 +21857,12 @@ + + + Collection of internal messages captured during the most + recent configuration process. + + Event to notify that the repository has been shutdown. @@ -20639,7 +22018,7 @@ This method should not normally be used to log. The interface should be used for routine logging. This interface can be obtained - using the method. + using the method. The logEvent is delivered to the appropriate logger and @@ -20658,6 +22037,15 @@ + + + The fully qualified type of the LoggerRepositorySkeleton class. + + + Used by the internal logger to record the Type of the + log message. + + Adds an object renderer for a specific class. @@ -20802,6 +22190,12 @@ + + + Contains a list of internal messages captures during the + last configuration. + + Event to notify that the repository has been shutdown. @@ -20882,6 +22276,18 @@ + + + Initialize the repository using the specified appenders + + the appenders to use to log all logging events + + + Configure the repository to route all logging events to the + specified appenders. + + + Configure repository using XML @@ -21056,7 +22462,7 @@ This method should not normally be used to log. The interface should be used for routine logging. This interface can be obtained - using the method. + using the method. The logEvent is delivered to the appropriate logger and @@ -21101,15 +22507,21 @@ the appender to use to log all logging events - + - Initialize the log4net system using the specified appender + Initialize the log4net system using the specified appenders - the appender to use to log all logging events + the appenders to use to log all logging events + + + + Initialize the log4net system using the specified appenders + + the appenders to use to log all logging events This method provides the same functionality as the - method implemented + method implemented on this object, but it is protected and therefore can be called by subclasses. @@ -21128,7 +22540,7 @@ This method provides the same functionality as the - method implemented + method implemented on this object, but it is protected and therefore can be called by subclasses. @@ -21275,7 +22687,7 @@ - + Set a Property using the values in the argument @@ -21289,6 +22701,15 @@ + + + The fully qualified type of the Hierarchy class. + + + Used by the internal logger to record the Type of the + log message. + + Event used to notify that a logger has been created. @@ -21384,48 +22805,6 @@ - - - A class to hold the key and data for a property set in the config file - - - - A class to hold the key and data for a property set in the config file - - - - - - Override Object.ToString to return sensible debug info - - string info about this object - - - - Property Key - - - Property Key - - - - Property Key. - - - - - - Property Value - - - Property Value - - - - Property Value. - - - Used internally to accelerate hash table searches. @@ -21558,6 +22937,15 @@ + + + The fully qualified type of the RootLogger class. + + + Used by the internal logger to record the Type of the + log message. + + Gets the assigned level value without walking the logger hierarchy. @@ -21796,6 +23184,31 @@ The Hierarchy being configured. + + + The fully qualified type of the XmlHierarchyConfigurator class. + + + Used by the internal logger to record the Type of the + log message. + + + + + + + + + + + + + + + + + + Delegate used to handle logger repository shutdown event notifications @@ -21898,7 +23311,7 @@ Any other pattern string uses the formatter. This formatter passes the pattern string to the - method. + method. For details on valid patterns see DateTimeFormatInfo Class. @@ -21956,2182 +23369,3392 @@ + + + The fully qualified type of the DatePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write an folder path to the output + + + + Write an special path environment folder path to the output writer. + The value of the determines + the name of the variable to output. + should be a value in the enumeration. + + + Ron Grabowski + + + + Write an special path environment folder path to the output + + the writer to write to + null, state is not set + + + Writes the special path environment folder path to the output . + The name of the special path environment folder path to output must be set + using the + property. + + + + + + The fully qualified type of the EnvironmentFolderPathPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + Write an environment variable to the output - Write an environment variable to the output writer. - The value of the determines - the name of the variable to output. + Write an environment variable to the output writer. + The value of the determines + the name of the variable to output. + + + Nicko Cadell + + + + Write an environment variable to the output + + the writer to write to + null, state is not set + + + Writes the environment variable to the output . + The name of the environment variable to output must be set + using the + property. + + + + + + The fully qualified type of the EnvironmentPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write the current thread identity to the output + + + + Write the current thread identity to the output writer + + + Nicko Cadell + + + + Write the current thread identity to the output + + the writer to write to + null, state is not set + + + Writes the current thread identity to the output . + + + + + + The fully qualified type of the IdentityPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Pattern converter for literal string instances in the pattern + + + + Writes the literal string value specified in the + property to + the output. + + + Nicko Cadell + + + + Set the next converter in the chain + + The next pattern converter in the chain + The next pattern converter + + + Special case the building of the pattern converter chain + for instances. Two adjacent + literals in the pattern can be represented by a single combined + pattern converter. This implementation detects when a + is added to the chain + after this converter and combines its value with this converter's + literal value. + + + + + + Write the literal to the output + + the writer to write to + null, not set + + + Override the formatting behavior to ignore the FormattingInfo + because we have a literal instead. + + + Writes the value of + to the output . + + + + + + Convert this pattern into the rendered message + + that will receive the formatted result. + null, not set + + + This method is not used. + + + + + + Writes a newline to the output + + + + Writes the system dependent line terminator to the output. + This behavior can be overridden by setting the : + + + + Option Value + Output + + + DOS + DOS or Windows line terminator "\r\n" + + + UNIX + UNIX line terminator "\n" + + + + Nicko Cadell + + + + Initialize the converter + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Write the current process ID to the output + + + + Write the current process ID to the output writer + + + Nicko Cadell + + + + Write the current process ID to the output + + the writer to write to + null, state is not set + + + Write the current process ID to the output . + + + + + + The fully qualified type of the ProcessIdPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Property pattern converter + + + + This pattern converter reads the thread and global properties. + The thread properties take priority over global properties. + See for details of the + thread properties. See for + details of the global properties. + + + If the is specified then that will be used to + lookup a single property. If no is specified + then all properties will be dumped as a list of key value pairs. + + + Nicko Cadell + + + + Write the property value to the output + + that will receive the formatted result. + null, state is not set + + + Writes out the value of a named property. The property name + should be set in the + property. + + + If the is set to null + then all the properties are written as key value pairs. + + + + + + A Pattern converter that generates a string of random characters + + + + The converter generates a string of random characters. By default + the string is length 4. This can be changed by setting the + to the string value of the length required. + + + The random characters in the string are limited to uppercase letters + and numbers only. + + + The random number generator used by this class is not cryptographically secure. + + + Nicko Cadell + + + + Shared random number generator + + + + + Length of random string to generate. Default length 4. + + + + + Initialize the converter options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Write a randoim string to the output + + the writer to write to + null, state is not set + + + Write a randoim string to the output . + + + + + + The fully qualified type of the RandomStringPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write the current threads username to the output + + + + Write the current threads username to the output writer + + + Nicko Cadell + + + + Write the current threads username to the output + + the writer to write to + null, state is not set + + + Write the current threads username to the output . + + + + + + The fully qualified type of the UserNamePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write the UTC date time to the output + + + + Date pattern converter, uses a to format + the current date and time in Universal time. + + + See the for details on the date pattern syntax. + + + + Nicko Cadell + + + + Write the current date and time to the output + + that will receive the formatted result. + null, state is not set + + + Pass the current date and time to the + for it to render it to the writer. + + + The date is in Universal time when it is rendered. + + + + + + + The fully qualified type of the UtcDatePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Type converter for Boolean. + + + + Supports conversion from string to bool type. + + + + + + Nicko Cadell + Gert Driesen + + + + Can the source type be converted to the type supported by this object + + the type to convert + true if the conversion is possible + + + Returns true if the is + the type. + + + + + + Convert the source object to the type supported by this object + + the object to convert + the converted object + + + Uses the method to convert the + argument to a . + + + + The object cannot be converted to the + target type. To check for this condition use the + method. + + + + + Exception base type for conversion errors. + + + + This type extends . It + does not add any new functionality but does differentiate the + type of exception being thrown. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + + + Initializes a new instance of the class. + + + + + + Constructor + + A message to include with the exception. + + + Initializes a new instance of the class + with the specified message. + + + + + + Constructor + + A message to include with the exception. + A nested exception to include. + + + Initializes a new instance of the class + with the specified message and inner exception. + + + + + + Serialization constructor + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + + + Initializes a new instance of the class + with serialized data. + + + + + + Creates a new instance of the class. + + The conversion destination type. + The value to convert. + An instance of the . + + + Creates a new instance of the class. + + + + + + Creates a new instance of the class. + + The conversion destination type. + The value to convert. + A nested exception to include. + An instance of the . + + + Creates a new instance of the class. + + + + + + Register of type converters for specific types. + + + + Maintains a registry of type converters used to convert between + types. + + + Use the and + methods to register new converters. + The and methods + lookup appropriate converters to use. + + + + + Nicko Cadell + Gert Driesen + + + + Private constructor + + + Initializes a new instance of the class. + + + + + Static constructor. + + + + This constructor defines the intrinsic type converters. + + + + + + Adds a converter for a specific type. + + The type being converted to. + The type converter to use to convert to the destination type. + + + Adds a converter instance for a specific type. + + + + + + Adds a converter for a specific type. + + The type being converted to. + The type of the type converter to use to convert to the destination type. + + + Adds a converter for a specific type. + + + + + + Gets the type converter to use to convert values to the destination type. + + The type being converted from. + The type being converted to. + + The type converter instance to use for type conversions or null + if no type converter is found. + + + + Gets the type converter to use to convert values to the destination type. + + + + + + Gets the type converter to use to convert values to the destination type. + + The type being converted to. + + The type converter instance to use for type conversions or null + if no type converter is found. + + + + Gets the type converter to use to convert values to the destination type. + + + + + + Lookups the type converter to use as specified by the attributes on the + destination type. + + The type being converted to. + + The type converter instance to use for type conversions or null + if no type converter is found. + + + + + Creates the instance of the type converter. + + The type of the type converter. + + The type converter instance to use for type conversions or null + if no type converter is found. + + + + The type specified for the type converter must implement + the or interfaces + and must have a public default (no argument) constructor. + + + + + + The fully qualified type of the ConverterRegistry class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Mapping from to type converter. + + + + + Supports conversion from string to type. + + + + Supports conversion from string to type. + + + + + + Nicko Cadell + Gert Driesen + + + + Can the source type be converted to the type supported by this object + + the type to convert + true if the conversion is possible + + + Returns true if the is + the type. + + + + + + Overrides the ConvertFrom method of IConvertFrom. + + the object to convert to an encoding + the encoding + + + Uses the method to + convert the argument to an . + + + + The object cannot be converted to the + target type. To check for this condition use the + method. + + + + + Interface supported by type converters + + + + This interface supports conversion from a single type to arbitrary types. + See . + + + Nicko Cadell + + + + Returns whether this converter can convert the object to the specified type + + A Type that represents the type you want to convert to + true if the conversion is possible + + + Test if the type supported by this converter can be converted to the + . + + + + + + Converts the given value object to the specified type, using the arguments + + the object to convert + The Type to convert the value parameter to + the converted object + + + Converts the (which must be of the type supported + by this converter) to the specified.. + + + + + + Supports conversion from string to type. + + + + Supports conversion from string to type. + + + + + Nicko Cadell + + + + Can the source type be converted to the type supported by this object + + the type to convert + true if the conversion is possible + + + Returns true if the is + the type. + + + + + + Overrides the ConvertFrom method of IConvertFrom. + + the object to convert to an IPAddress + the IPAddress + + + Uses the method to convert the + argument to an . + If that fails then the string is resolved as a DNS hostname. + + + + The object cannot be converted to the + target type. To check for this condition use the + method. + + + + + Valid characters in an IPv4 or IPv6 address string. (Does not support subnets) + + + + + Supports conversion from string to type. + + + + Supports conversion from string to type. + + + The string is used as the + of the . + + + Nicko Cadell - + - Write an environment variable to the output + Can the source type be converted to the type supported by this object - the writer to write to - null, state is not set + the type to convert + true if the conversion is possible - Writes the environment variable to the output . - The name of the environment variable to output must be set - using the - property. + Returns true if the is + the type. - + - Write the current thread identity to the output + Overrides the ConvertFrom method of IConvertFrom. + the object to convert to a PatternLayout + the PatternLayout - Write the current thread identity to the output writer + Creates and returns a new using + the as the + . - Nicko Cadell + + The object cannot be converted to the + target type. To check for this condition use the + method. + - + - Write the current thread identity to the output + Convert between string and - the writer to write to - null, state is not set - Writes the current thread identity to the output . + Supports conversion from string to type, + and from a type to a string. - - - - - Pattern converter for literal string instances in the pattern - - - Writes the literal string value specified in the - property to - the output. + The string is used as the + of the . + + + Nicko Cadell - + - Set the next converter in the chain + Can the target type be converted to the type supported by this object - The next pattern converter in the chain - The next pattern converter + A that represents the type you want to convert to + true if the conversion is possible - Special case the building of the pattern converter chain - for instances. Two adjacent - literals in the pattern can be represented by a single combined - pattern converter. This implementation detects when a - is added to the chain - after this converter and combines its value with this converter's - literal value. + Returns true if the is + assignable from a type. - + - Write the literal to the output + Converts the given value object to the specified type, using the arguments - the writer to write to - null, not set + the object to convert + The Type to convert the value parameter to + the converted object - Override the formatting behavior to ignore the FormattingInfo - because we have a literal instead. - - - Writes the value of - to the output . + Uses the method to convert the + argument to a . + + The object cannot be converted to the + . To check for this condition use the + method. + - + - Convert this pattern into the rendered message + Can the source type be converted to the type supported by this object - that will receive the formatted result. - null, not set + the type to convert + true if the conversion is possible - This method is not used. + Returns true if the is + the type. - + - Writes a newline to the output + Overrides the ConvertFrom method of IConvertFrom. + the object to convert to a PatternString + the PatternString - Writes the system dependent line terminator to the output. - This behavior can be overridden by setting the : + Creates and returns a new using + the as the + . - - - Option Value - Output - - - DOS - DOS or Windows line terminator "\r\n" - - - UNIX - UNIX line terminator "\n" - - - Nicko Cadell + + The object cannot be converted to the + target type. To check for this condition use the + method. + - + - Initialize the converter + Supports conversion from string to type. - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. + Supports conversion from string to type. + + + + Nicko Cadell - + - Write the current process ID to the output + Can the source type be converted to the type supported by this object + the type to convert + true if the conversion is possible - Write the current process ID to the output writer + Returns true if the is + the type. - Nicko Cadell - + - Write the current process ID to the output + Overrides the ConvertFrom method of IConvertFrom. - the writer to write to - null, state is not set + the object to convert to a Type + the Type - Write the current process ID to the output . + Uses the method to convert the + argument to a . + Additional effort is made to locate partially specified types + by searching the loaded assemblies. + + The object cannot be converted to the + target type. To check for this condition use the + method. + - + - Property pattern converter + Attribute used to associate a type converter - This pattern converter reads the thread and global properties. - The thread properties take priority over global properties. - See for details of the - thread properties. See for - details of the global properties. + Class and Interface level attribute that specifies a type converter + to use with the associated type. - If the is specified then that will be used to - lookup a single property. If no is specified - then all properties will be dumped as a list of key value pairs. + To associate a type converter with a target type apply a + TypeConverterAttribute to the target type. Specify the + type of the type converter on the attribute. Nicko Cadell + Gert Driesen - + - Write the property value to the output + The string type name of the type converter + + + + + Default constructor - that will receive the formatted result. - null, state is not set - Writes out the value of a named property. The property name - should be set in the - property. - - - If the is set to null - then all the properties are written as key value pairs. + Default constructor - + - A Pattern converter that generates a string of random characters + Create a new type converter attribute for the specified type name + The string type name of the type converter - The converter generates a string of random characters. By default - the string is length 4. This can be changed by setting the - to the string value of the length required. - - - The random characters in the string are limited to uppercase letters - and numbers only. - - - The random number generator used by this class is not cryptographically secure. + The type specified must implement the + or the interfaces. - Nicko Cadell - - - - Shared random number generator - - - - - Length of random string to generate. Default length 4. - - + - Initialize the converter options + Create a new type converter attribute for the specified type + The type of the type converter - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. + The type specified must implement the + or the interfaces. - + - Write a randoim string to the output + The string type name of the type converter - the writer to write to - null, state is not set + + The string type name of the type converter + - Write a randoim string to the output . + The type specified must implement the + or the interfaces. - + - Write the current threads username to the output + A straightforward implementation of the interface. - Write the current threads username to the output writer + This is the default implementation of the + interface. Implementors of the interface + should aggregate an instance of this type. Nicko Cadell + Gert Driesen - + - Write the current threads username to the output + Constructor - the writer to write to - null, state is not set - Write the current threads username to the output . + Initializes a new instance of the class. - + - Write the UTC date time to the output + Append on on all attached appenders. + The event being logged. + The number of appenders called. - Date pattern converter, uses a to format - the current date and time in Universal time. - - - See the for details on the date pattern syntax. + Calls the method on all + attached appenders. - - Nicko Cadell - + - Write the current date and time to the output + Append on on all attached appenders. - that will receive the formatted result. - null, state is not set + The array of events being logged. + The number of appenders called. - Pass the current date and time to the - for it to render it to the writer. - - - The date is in Universal time when it is rendered. + Calls the method on all + attached appenders. - - + - Type converter for Boolean. + Calls the DoAppende method on the with + the objects supplied. + The appender + The events - Supports conversion from string to bool type. + If the supports the + interface then the will be passed + through using that interface. Otherwise the + objects in the array will be passed one at a time. - - - - Nicko Cadell - Gert Driesen - + - Can the source type be converted to the type supported by this object + Attaches an appender. - the type to convert - true if the conversion is possible + The appender to add. - Returns true if the is - the type. + If the appender is already in the list it won't be added again. - + - Convert the source object to the type supported by this object + Gets an attached appender with the specified name. - the object to convert - the converted object + The name of the appender to get. + + The appender with the name specified, or null if no appender with the + specified name is found. + - Uses the method to convert the - argument to a . + Lookup an attached appender by name. - - The object cannot be converted to the - target type. To check for this condition use the - method. - - + - Exception base type for conversion errors. + Removes all attached appenders. - This type extends . It - does not add any new functionality but does differentiate the - type of exception being thrown. + Removes and closes all attached appenders - Nicko Cadell - Gert Driesen - + - Constructor + Removes the specified appender from the list of attached appenders. + The appender to remove. + The appender removed from the list - Initializes a new instance of the class. + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. - + - Constructor + Removes the appender with the specified name from the list of appenders. - A message to include with the exception. + The name of the appender to remove. + The appender removed from the list - Initializes a new instance of the class - with the specified message. + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. - + - Constructor + List of appenders + + + + + Array of appenders, used to cache the m_appenderList + + + + + The fully qualified type of the AppenderAttachedImpl class. - A message to include with the exception. - A nested exception to include. - - Initializes a new instance of the class - with the specified message and inner exception. - + Used by the internal logger to record the Type of the + log message. - + - Serialization constructor + Gets all attached appenders. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. + + A collection of attached appenders, or null if there + are no attached appenders. + - Initializes a new instance of the class - with serialized data. + The read only collection of all currently attached appenders. - + - Creates a new instance of the class. + This class aggregates several PropertiesDictionary collections together. - The conversion destination type. - The value to convert. - An instance of the . - Creates a new instance of the class. + Provides a dictionary style lookup over an ordered list of + collections. + Nicko Cadell - + - Creates a new instance of the class. + Constructor - The conversion destination type. - The value to convert. - A nested exception to include. - An instance of the . - Creates a new instance of the class. + Initializes a new instance of the class. - + - Register of type converters for specific types. + Add a Properties Dictionary to this composite collection + the properties to add - Maintains a registry of type converters used to convert between - types. - - - Use the and - methods to register new converters. - The and methods - lookup appropriate converters to use. + Properties dictionaries added first take precedence over dictionaries added + later. - - - Nicko Cadell - Gert Driesen - + - Private constructor + Flatten this composite collection into a single properties dictionary + the flattened dictionary - Initializes a new instance of the class. + + Reduces the collection of ordered dictionaries to a single dictionary + containing the resultant values for the keys. + - + - Static constructor. + Gets the value of a property + + The value for the property with the specified key + - This constructor defines the intrinsic type converters. + Looks up the value for the specified. + The collections are searched + in the order in which they were added to this collection. The value + returned is the value held by the first collection that contains + the specified key. + + + If none of the collections contain the specified key then + null is returned. - + - Adds a converter for a specific type. - - The type being converted to. - The type converter to use to convert to the destination type. + Base class for Context Properties implementations + - Adds a converter instance for a specific type. + This class defines a basic property get set accessor + Nicko Cadell - + - Adds a converter for a specific type. + Gets or sets the value of a property - The type being converted to. - The type of the type converter to use to convert to the destination type. + + The value for the property with the specified key + - Adds a converter for a specific type. + Gets or sets the value of a property - + - Gets the type converter to use to convert values to the destination type. + Wrapper class used to map converter names to converter types - The type being converted from. - The type being converted to. - - The type converter instance to use for type conversions or null - if no type converter is found. - - Gets the type converter to use to convert values to the destination type. + Pattern converter info class used during configuration by custom + PatternString and PatternLayer converters. - + - Gets the type converter to use to convert values to the destination type. + default constructor + + + + + + + + + + + Gets or sets the name of the conversion pattern - The type being converted to. - - The type converter instance to use for type conversions or null - if no type converter is found. - - Gets the type converter to use to convert values to the destination type. + The name of the pattern in the format string - - - Lookups the type converter to use as specified by the attributes on the - destination type. - - The type being converted to. - - The type converter instance to use for type conversions or null - if no type converter is found. - - - + - Creates the instance of the type converter. + Gets or sets the type of the converter - The type of the type converter. - - The type converter instance to use for type conversions or null - if no type converter is found. - - The type specified for the type converter must implement - the or interfaces - and must have a public default (no argument) constructor. + The value specified must extend the + type. - + - Mapping from to type converter. + - + - Supports conversion from string to type. + Subclass of that maintains a count of + the number of bytes written. - Supports conversion from string to type. + This writer counts the number of bytes written. - - - Nicko Cadell Gert Driesen - + - Can the source type be converted to the type supported by this object + that does not leak exceptions - the type to convert - true if the conversion is possible - Returns true if the is - the type. + does not throw exceptions when things go wrong. + Instead, it delegates error handling to its . + Nicko Cadell + Gert Driesen - + - Overrides the ConvertFrom method of IConvertFrom. + Adapter that extends and forwards all + messages to an instance of . - the object to convert to an encoding - the encoding - Uses the method to - convert the argument to an . + Adapter that extends and forwards all + messages to an instance of . - - The object cannot be converted to the - target type. To check for this condition use the - method. - + Nicko Cadell - + - Interface supported by type converters + The writer to forward messages to + + + + Create an instance of that forwards all + messages to a . + + The to forward to - This interface supports conversion from a single type to arbitrary types. - See . + Create an instance of that forwards all + messages to a . - Nicko Cadell - + - Returns whether this converter can convert the object to the specified type + Closes the writer and releases any system resources associated with the writer - A Type that represents the type you want to convert to - true if the conversion is possible - Test if the type supported by this converter can be converted to the - . - + - Converts the given value object to the specified type, using the arguments + Dispose this writer - the object to convert - The Type to convert the value parameter to - the converted object + flag indicating if we are being disposed - Converts the (which must be of the type supported - by this converter) to the specified.. + Dispose this writer - + - Supports conversion from string to type. + Flushes any buffered output - Supports conversion from string to type. + Clears all buffers for the writer and causes any buffered data to be written + to the underlying device - - - Nicko Cadell - + - Can the source type be converted to the type supported by this object + Writes a character to the wrapped TextWriter - the type to convert - true if the conversion is possible + the value to write to the TextWriter - Returns true if the is - the type. + Writes a character to the wrapped TextWriter - + - Overrides the ConvertFrom method of IConvertFrom. + Writes a character buffer to the wrapped TextWriter - the object to convert to an IPAddress - the IPAddress + the data buffer + the start index + the number of characters to write - Uses the method to convert the - argument to an . - If that fails then the string is resolved as a DNS hostname. + Writes a character buffer to the wrapped TextWriter - - The object cannot be converted to the - target type. To check for this condition use the - method. - - - - - Valid characters in an IPv4 or IPv6 address string. (Does not support subnets) - - + - Supports conversion from string to type. + Writes a string to the wrapped TextWriter + the value to write to the TextWriter - Supports conversion from string to type. - - - The string is used as the - of the . + Writes a string to the wrapped TextWriter - - - - Nicko Cadell - + - Can the source type be converted to the type supported by this object + Gets or sets the underlying . - the type to convert - true if the conversion is possible + + The underlying . + - Returns true if the is - the type. + Gets or sets the underlying . - + - Overrides the ConvertFrom method of IConvertFrom. + The Encoding in which the output is written - the object to convert to a PatternLayout - the PatternLayout + + The + - Creates and returns a new using - the as the - . + The Encoding in which the output is written - - The object cannot be converted to the - target type. To check for this condition use the - method. - - + - Convert between string and + Gets an object that controls formatting + + The format provider + - Supports conversion from string to type, - and from a type to a string. - - - The string is used as the - of the . + Gets an object that controls formatting - - - - Nicko Cadell - + - Can the target type be converted to the type supported by this object - - A that represents the type you want to convert to - true if the conversion is possible + Gets or sets the line terminator string used by the TextWriter + + + The line terminator to use + - Returns true if the is - assignable from a type. + Gets or sets the line terminator string used by the TextWriter - + - Converts the given value object to the specified type, using the arguments + Constructor - the object to convert - The Type to convert the value parameter to - the converted object + the writer to actually write to + the error handler to report error to - Uses the method to convert the - argument to a . + Create a new QuietTextWriter using a writer and error handler - - The object cannot be converted to the - . To check for this condition use the - method. - - + - Can the source type be converted to the type supported by this object + Writes a character to the underlying writer - the type to convert - true if the conversion is possible + the char to write - Returns true if the is - the type. + Writes a character to the underlying writer - + - Overrides the ConvertFrom method of IConvertFrom. + Writes a buffer to the underlying writer - the object to convert to a PatternString - the PatternString + the buffer to write + the start index to write from + the number of characters to write - Creates and returns a new using - the as the - . + Writes a buffer to the underlying writer - - The object cannot be converted to the - target type. To check for this condition use the - method. - - + - Supports conversion from string to type. + Writes a string to the output. + The string data to write to the output. - Supports conversion from string to type. + Writes a string to the output. - - - - Nicko Cadell - + - Can the source type be converted to the type supported by this object + Closes the underlying output writer. - the type to convert - true if the conversion is possible - Returns true if the is - the type. + Closes the underlying output writer. - + - Overrides the ConvertFrom method of IConvertFrom. + The error handler instance to pass all errors to - the object to convert to a Type - the Type + + + + Flag to indicate if this writer is closed + + + + + Gets or sets the error handler that all errors are passed to. + + + The error handler that all errors are passed to. + - Uses the method to convert the - argument to a . - Additional effort is made to locate partially specified types - by searching the loaded assemblies. + Gets or sets the error handler that all errors are passed to. - - The object cannot be converted to the - target type. To check for this condition use the - method. - - + - Attribute used to associate a type converter + Gets a value indicating whether this writer is closed. + + true if this writer is closed, otherwise false. + - Class and Interface level attribute that specifies a type converter - to use with the associated type. - - - To associate a type converter with a target type apply a - TypeConverterAttribute to the target type. Specify the - type of the type converter on the attribute. + Gets a value indicating whether this writer is closed. - Nicko Cadell - Gert Driesen - + - The string type name of the type converter + Constructor + The to actually write to. + The to report errors to. + + + Creates a new instance of the class + with the specified and . + + - + - Default constructor + Writes a character to the underlying writer and counts the number of bytes written. + the char to write - Default constructor + Overrides implementation of . Counts + the number of bytes written. - + - Create a new type converter attribute for the specified type name + Writes a buffer to the underlying writer and counts the number of bytes written. - The string type name of the type converter + the buffer to write + the start index to write from + the number of characters to write - The type specified must implement the - or the interfaces. + Overrides implementation of . Counts + the number of bytes written. - + - Create a new type converter attribute for the specified type + Writes a string to the output and counts the number of bytes written. - The type of the type converter + The string data to write to the output. - The type specified must implement the - or the interfaces. + Overrides implementation of . Counts + the number of bytes written. - + - The string type name of the type converter + Total number of bytes written. + + + + + Gets or sets the total number of bytes written. - The string type name of the type converter + The total number of bytes written. - The type specified must implement the - or the interfaces. + Gets or sets the total number of bytes written. - + - A straightforward implementation of the interface. + A fixed size rolling buffer of logging events. - This is the default implementation of the - interface. Implementors of the interface - should aggregate an instance of this type. + An array backed fixed size leaky bucket. Nicko Cadell Gert Driesen - + Constructor + The maximum number of logging events in the buffer. - Initializes a new instance of the class. - - - - - - Append on on all attached appenders. - - The event being logged. - The number of appenders called. - - - Calls the method on all - attached appenders. + Initializes a new instance of the class with + the specified maximum number of buffered logging events. + The argument is not a positive integer. - + - Append on on all attached appenders. + Appends a to the buffer. - The array of events being logged. - The number of appenders called. + The event to append to the buffer. + The event discarded from the buffer, if the buffer is full, otherwise null. - Calls the method on all - attached appenders. + Append an event to the buffer. If the buffer still contains free space then + null is returned. If the buffer is full then an event will be dropped + to make space for the new event, the event dropped is returned. - + - Calls the DoAppende method on the with - the objects supplied. + Get and remove the oldest event in the buffer. - The appender - The events + The oldest logging event in the buffer - If the supports the - interface then the will be passed - through using that interface. Otherwise the - objects in the array will be passed one at a time. + Gets the oldest (first) logging event in the buffer and removes it + from the buffer. - + - Attaches an appender. + Pops all the logging events from the buffer into an array. - The appender to add. + An array of all the logging events in the buffer. - If the appender is already in the list it won't be added again. + Get all the events in the buffer and clear the buffer. - + - Gets an attached appender with the specified name. + Clear the buffer - The name of the appender to get. - - The appender with the name specified, or null if no appender with the - specified name is found. - - Lookup an attached appender by name. + Clear the buffer of all events. The events in the buffer are lost. - + - Removes all attached appenders. + Gets the th oldest event currently in the buffer. + The th oldest event currently in the buffer. - Removes and closes all attached appenders + If is outside the range 0 to the number of events + currently in the buffer, then null is returned. - + - Removes the specified appender from the list of attached appenders. + Gets the maximum size of the buffer. - The appender to remove. - The appender removed from the list + The maximum size of the buffer. - The appender removed is not closed. - If you are discarding the appender you must call - on the appender removed. + Gets the maximum size of the buffer - + - Removes the appender with the specified name from the list of appenders. + Gets the number of logging events in the buffer. - The name of the appender to remove. - The appender removed from the list + The number of logging events in the buffer. - The appender removed is not closed. - If you are discarding the appender you must call - on the appender removed. + This number is guaranteed to be in the range 0 to + (inclusive). - - - List of appenders - - - - - Array of appenders, used to cache the m_appenderList - - - + - Gets all attached appenders. + An always empty . - - A collection of attached appenders, or null if there - are no attached appenders. - - The read only collection of all currently attached appenders. + A singleton implementation of the + interface that always represents an empty collection. + Nicko Cadell + Gert Driesen - + - This class aggregates several PropertiesDictionary collections together. + Initializes a new instance of the class. - Provides a dictionary style lookup over an ordered list of - collections. + Uses a private access modifier to enforce the singleton pattern. - Nicko Cadell - + - Constructor + Copies the elements of the to an + , starting at a particular Array index. + The one-dimensional + that is the destination of the elements copied from + . The Array must have zero-based + indexing. + The zero-based index in array at which + copying begins. - Initializes a new instance of the class. + As the collection is empty no values are copied into the array. - + - Add a Properties Dictionary to this composite collection + Returns an enumerator that can iterate through a collection. - the properties to add + + An that can be used to + iterate through the collection. + - Properties dictionaries added first take precedence over dictionaries added - later. + As the collection is empty a is returned. - + - Flatten this composite collection into a single properties dictionary + The singleton instance of the empty collection. - the flattened dictionary + + + + Gets the singleton instance of the empty collection. + + The singleton instance of the empty collection. - Reduces the collection of ordered dictionaries to a single dictionary - containing the resultant values for the keys. + Gets the singleton instance of the empty collection. - + - Gets the value of a property + Gets a value indicating if access to the is synchronized (thread-safe). - The value for the property with the specified key + true if access to the is synchronized (thread-safe); otherwise, false. - Looks up the value for the specified. - The collections are searched - in the order in which they were added to this collection. The value - returned is the value held by the first collection that contains - the specified key. - - - If none of the collections contain the specified key then - null is returned. + For the this property is always true. - + - Base class for Context Properties implementations + Gets the number of elements contained in the . + + The number of elements contained in the . + - This class defines a basic property get set accessor + As the collection is empty the is always 0. - Nicko Cadell - + - Gets or sets the value of a property + Gets an object that can be used to synchronize access to the . - The value for the property with the specified key + An object that can be used to synchronize access to the . - Gets or sets the value of a property + As the collection is empty and thread safe and synchronized this instance is also + the object. - + - Subclass of that maintains a count of - the number of bytes written. + An always empty . - This writer counts the number of bytes written. + A singleton implementation of the + interface that always represents an empty collection. Nicko Cadell Gert Driesen - + - that does not leak exceptions + Initializes a new instance of the class. - does not throw exceptions when things go wrong. - Instead, it delegates error handling to its . + Uses a private access modifier to enforce the singleton pattern. - Nicko Cadell - Gert Driesen - + - Adapter that extends and forwards all - messages to an instance of . + Copies the elements of the to an + , starting at a particular Array index. + The one-dimensional + that is the destination of the elements copied from + . The Array must have zero-based + indexing. + The zero-based index in array at which + copying begins. - Adapter that extends and forwards all - messages to an instance of . + As the collection is empty no values are copied into the array. - Nicko Cadell - + - The writer to forward messages to + Returns an enumerator that can iterate through a collection. + + An that can be used to + iterate through the collection. + + + + As the collection is empty a is returned. + + - + - Create an instance of that forwards all - messages to a . + Adds an element with the provided key and value to the + . - The to forward to + The to use as the key of the element to add. + The to use as the value of the element to add. - Create an instance of that forwards all - messages to a . + As the collection is empty no new values can be added. A + is thrown if this method is called. + This dictionary is always empty and cannot be modified. - + - Closes the writer and releases any system resources associated with the writer + Removes all elements from the . + As the collection is empty no values can be removed. A + is thrown if this method is called. + This dictionary is always empty and cannot be modified. - + - Dispose this writer + Determines whether the contains an element + with the specified key. - flag indicating if we are being disposed + The key to locate in the . + false - Dispose this writer + As the collection is empty the method always returns false. - + - Flushes any buffered output + Returns an enumerator that can iterate through a collection. + + An that can be used to + iterate through the collection. + - Clears all buffers for the writer and causes any buffered data to be written - to the underlying device + As the collection is empty a is returned. - + - Writes a character to the wrapped TextWriter + Removes the element with the specified key from the . - the value to write to the TextWriter + The key of the element to remove. - Writes a character to the wrapped TextWriter + As the collection is empty no values can be removed. A + is thrown if this method is called. + This dictionary is always empty and cannot be modified. - + - Writes a character buffer to the wrapped TextWriter + The singleton instance of the empty dictionary. - the data buffer - the start index - the number of characters to write + + + + Gets the singleton instance of the . + + The singleton instance of the . - Writes a character buffer to the wrapped TextWriter + Gets the singleton instance of the . - + - Writes a string to the wrapped TextWriter + Gets a value indicating if access to the is synchronized (thread-safe). - the value to write to the TextWriter + + true if access to the is synchronized (thread-safe); otherwise, false. + - Writes a string to the wrapped TextWriter + For the this property is always true. - + - Gets or sets the underlying . + Gets the number of elements contained in the - The underlying . + The number of elements contained in the . - Gets or sets the underlying . + As the collection is empty the is always 0. - + - The Encoding in which the output is written + Gets an object that can be used to synchronize access to the . - The + An object that can be used to synchronize access to the . - The Encoding in which the output is written + As the collection is empty and thread safe and synchronized this instance is also + the object. - + - Gets an object that controls formatting + Gets a value indicating whether the has a fixed size. - - The format provider - + true - Gets an object that controls formatting + As the collection is empty always returns true. - + - Gets or sets the line terminator string used by the TextWriter + Gets a value indicating whether the is read-only. - - The line terminator to use - + true - Gets or sets the line terminator string used by the TextWriter + As the collection is empty always returns true. - + - Constructor + Gets an containing the keys of the . - the writer to actually write to - the error handler to report error to + An containing the keys of the . - Create a new QuietTextWriter using a writer and error handler + As the collection is empty a is returned. - + - Writes a character to the underlying writer + Gets an containing the values of the . - the char to write + An containing the values of the . - Writes a character to the underlying writer + As the collection is empty a is returned. - + - Writes a buffer to the underlying writer + Gets or sets the element with the specified key. - the buffer to write - the start index to write from - the number of characters to write + The key of the element to get or set. + null - Writes a buffer to the underlying writer + As the collection is empty no values can be looked up or stored. + If the index getter is called then null is returned. + A is thrown if the setter is called. + This dictionary is always empty and cannot be modified. - + - Writes a string to the output. + Contain the information obtained when parsing formatting modifiers + in conversion modifiers. - The string data to write to the output. - Writes a string to the output. + Holds the formatting information extracted from the format string by + the . This is used by the + objects when rendering the output. + Nicko Cadell + Gert Driesen - + - Closes the underlying output writer. + Defaut Constructor - Closes the underlying output writer. + Initializes a new instance of the class. - + - The error handler instance to pass all errors to + Constructor + + + Initializes a new instance of the class + with the specified parameters. + + - + - Flag to indicate if this writer is closed + Gets or sets the minimum value. + + The minimum value. + + + + Gets or sets the minimum value. + + - + - Gets or sets the error handler that all errors are passed to. + Gets or sets the maximum value. - The error handler that all errors are passed to. + The maximum value. - Gets or sets the error handler that all errors are passed to. + Gets or sets the maximum value. - + - Gets a value indicating whether this writer is closed. + Gets or sets a flag indicating whether left align is enabled + or not. - true if this writer is closed, otherwise false. + A flag indicating whether left align is enabled or not. - Gets a value indicating whether this writer is closed. + Gets or sets a flag indicating whether left align is enabled or not. - + - Constructor + Implementation of Properties collection for the - The to actually write to. - The to report errors to. - Creates a new instance of the class - with the specified and . + This class implements a properties collection that is thread safe and supports both + storing properties and capturing a read only copy of the current propertied. + + + This class is optimized to the scenario where the properties are read frequently + and are modified infrequently. + Nicko Cadell - + - Writes a character to the underlying writer and counts the number of bytes written. + The read only copy of the properties. - the char to write - Overrides implementation of . Counts - the number of bytes written. + This variable is declared volatile to prevent the compiler and JIT from + reordering reads and writes of this thread performed on different threads. - + - Writes a buffer to the underlying writer and counts the number of bytes written. + Lock object used to synchronize updates within this instance + + + + + Constructor - the buffer to write - the start index to write from - the number of characters to write - Overrides implementation of . Counts - the number of bytes written. + Initializes a new instance of the class. - + - Writes a string to the output and counts the number of bytes written. + Remove a property from the global context - The string data to write to the output. + the key for the entry to remove - Overrides implementation of . Counts - the number of bytes written. + Removing an entry from the global context properties is relatively expensive compared + with reading a value. - + - Total number of bytes written. + Clear the global context properties - + - Gets or sets the total number of bytes written. + Get a readonly immutable copy of the properties + + the current global context properties + + + This implementation is fast because the GlobalContextProperties class + stores a readonly copy of the properties. + + + + + + Gets or sets the value of a property - The total number of bytes written. + The value for the property with the specified key - Gets or sets the total number of bytes written. + Reading the value for a key is faster than setting the value. + When the value is written a new read only copy of + the properties is created. - + - A fixed size rolling buffer of logging events. + The static class ILogExtensions contains a set of widely used + methods that ease the interaction with the ILog interface implementations. - An array backed fixed size leaky bucket. + This class contains methods for logging at different levels and checks the + properties for determining if those logging levels are enabled in the current + configuration. - Nicko Cadell - Gert Driesen + Simple example of logging messages + + using log4net.Util; + + ILog log = LogManager.GetLogger("application-log"); + + log.InfoExt("Application Start"); + log.DebugExt("This is a debug message"); + + - + - Constructor + The fully qualified type of the Logger class. - The maximum number of logging events in the buffer. + + + + Log a message object with the level. + + The logger on which the message is logged. + The lambda expression that gets the object to log. - Initializes a new instance of the class with - the specified maximum number of buffered logging events. + This method first checks if this logger is INFO + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is INFO enabled, then it converts + the message object (retrieved by invocation of the provided callback) to a + string by invoking the appropriate . + It then proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. - The argument is not a positive integer. + + - + - Appends a to the buffer. + Log a message object with the level including + the stack trace of the passed + as a parameter. - The event to append to the buffer. - The event discarded from the buffer, if the buffer is full, otherwise null. + The logger on which the message is logged. + The lambda expression that gets the object to log. + The exception to log, including its stack trace. - Append an event to the buffer. If the buffer still contains free space then - null is returned. If the buffer is full then an event will be dropped - to make space for the new event, the event dropped is returned. + See the form for more detailed information. + + + + + + + Log a message object with the level. //TODO + + Log a message object with the level. + + The logger on which the message is logged. + The message object to log. + + + This method first checks if this logger is INFO + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is INFO enabled, then it converts + the message object (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + - + - Get and remove the oldest event in the buffer. + Log a message object with the level including + the stack trace of the passed + as a parameter. - The oldest logging event in the buffer + The logger on which the message is logged. + The message object to log. + The exception to log, including its stack trace. - Gets the oldest (first) logging event in the buffer and removes it - from the buffer. + See the form for more detailed information. + + - + - Pops all the logging events from the buffer into an array. + Logs a formatted message string with the level. - An array of all the logging events in the buffer. + The logger on which the message is logged. + A String containing zero or more format items + An Object to format - Get all the events in the buffer and clear the buffer. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. - - - - - Clear the buffer - - - Clear the buffer of all events. The events in the buffer are lost. + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + - + - Gets the th oldest event currently in the buffer. + Logs a formatted message string with the level. - The th oldest event currently in the buffer. + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format - If is outside the range 0 to the number of events - currently in the buffer, then null is returned. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + - + - Gets the maximum size of the buffer. + Logs a formatted message string with the level. - The maximum size of the buffer. + An that supplies culture-specific formatting information + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format - Gets the maximum size of the buffer + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + - + - Gets the number of logging events in the buffer. + Logs a formatted message string with the level. - The number of logging events in the buffer. + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format - This number is guaranteed to be in the range 0 to - (inclusive). + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + - + - An always empty . + Logs a formatted message string with the level. + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format + An Object to format - A singleton implementation of the - interface that always represents an empty collection. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. - Nicko Cadell - Gert Driesen + + - + - Initializes a new instance of the class. + Log a message object with the level. + The logger on which the message is logged. + The lambda expression that gets the object to log. - Uses a private access modifier to enforce the singleton pattern. + This method first checks if this logger is INFO + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is INFO enabled, then it converts + the message object (retrieved by invocation of the provided callback) to a + string by invoking the appropriate . + It then proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + - + - Copies the elements of the to an - , starting at a particular Array index. + Log a message object with the level including + the stack trace of the passed + as a parameter. - The one-dimensional - that is the destination of the elements copied from - . The Array must have zero-based - indexing. - The zero-based index in array at which - copying begins. + The logger on which the message is logged. + The lambda expression that gets the object to log. + The exception to log, including its stack trace. - As the collection is empty no values are copied into the array. + See the form for more detailed information. + + - + + Log a message object with the level. //TODO - Returns an enumerator that can iterate through a collection. + Log a message object with the level. - - An that can be used to - iterate through the collection. - + The logger on which the message is logged. + The message object to log. - As the collection is empty a is returned. + This method first checks if this logger is INFO + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is INFO enabled, then it converts + the message object (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + - - - The singleton instance of the empty collection. - - - + - Gets the singleton instance of the empty collection. + Log a message object with the level including + the stack trace of the passed + as a parameter. - The singleton instance of the empty collection. + The logger on which the message is logged. + The message object to log. + The exception to log, including its stack trace. - Gets the singleton instance of the empty collection. + See the form for more detailed information. + + - + - Gets a value indicating if access to the is synchronized (thread-safe). + Logs a formatted message string with the level. - - true if access to the is synchronized (thread-safe); otherwise, false. - + The logger on which the message is logged. + A String containing zero or more format items + An Object to format - For the this property is always true. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + - + - Gets the number of elements contained in the . + Logs a formatted message string with the level. - - The number of elements contained in the . - + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format - As the collection is empty the is always 0. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + - + - Gets an object that can be used to synchronize access to the . + Logs a formatted message string with the level. - - An object that can be used to synchronize access to the . - + An that supplies culture-specific formatting information + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format - As the collection is empty and thread safe and synchronized this instance is also - the object. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + - + - An always empty . + Logs a formatted message string with the level. + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format - A singleton implementation of the - interface that always represents an empty collection. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. - Nicko Cadell - Gert Driesen + + - + - Initializes a new instance of the class. + Logs a formatted message string with the level. + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format + An Object to format - Uses a private access modifier to enforce the singleton pattern. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + - + - Copies the elements of the to an - , starting at a particular Array index. + Log a message object with the level. - The one-dimensional - that is the destination of the elements copied from - . The Array must have zero-based - indexing. - The zero-based index in array at which - copying begins. + The logger on which the message is logged. + The lambda expression that gets the object to log. - As the collection is empty no values are copied into the array. + This method first checks if this logger is WARN + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is WARN enabled, then it converts + the message object (retrieved by invocation of the provided callback) to a + string by invoking the appropriate . + It then proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + - + - Returns an enumerator that can iterate through a collection. + Log a message object with the level including + the stack trace of the passed + as a parameter. - - An that can be used to - iterate through the collection. - + The logger on which the message is logged. + The lambda expression that gets the object to log. + The exception to log, including its stack trace. - As the collection is empty a is returned. + See the form for more detailed information. + + - + + Log a message object with the level. //TODO - Adds an element with the provided key and value to the - . + Log a message object with the level. - The to use as the key of the element to add. - The to use as the value of the element to add. + The logger on which the message is logged. + The message object to log. - As the collection is empty no new values can be added. A - is thrown if this method is called. + This method first checks if this logger is WARN + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is WARN enabled, then it converts + the message object (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. - This dictionary is always empty and cannot be modified. + + - + - Removes all elements from the . + Log a message object with the level including + the stack trace of the passed + as a parameter. + The logger on which the message is logged. + The message object to log. + The exception to log, including its stack trace. - As the collection is empty no values can be removed. A - is thrown if this method is called. + See the form for more detailed information. - This dictionary is always empty and cannot be modified. + + - + - Determines whether the contains an element - with the specified key. + Logs a formatted message string with the level. - The key to locate in the . - false + The logger on which the message is logged. + A String containing zero or more format items + An Object to format - As the collection is empty the method always returns false. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + - + - Returns an enumerator that can iterate through a collection. + Logs a formatted message string with the level. - - An that can be used to - iterate through the collection. - + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format - As the collection is empty a is returned. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + - + - Removes the element with the specified key from the . + Logs a formatted message string with the level. - The key of the element to remove. + An that supplies culture-specific formatting information + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format - As the collection is empty no values can be removed. A - is thrown if this method is called. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. - This dictionary is always empty and cannot be modified. - - - - The singleton instance of the empty dictionary. - + + - + - Gets the singleton instance of the . + Logs a formatted message string with the level. - The singleton instance of the . + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format - Gets the singleton instance of the . + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + - + - Gets a value indicating if access to the is synchronized (thread-safe). + Logs a formatted message string with the level. - - true if access to the is synchronized (thread-safe); otherwise, false. - + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format + An Object to format - For the this property is always true. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + - + - Gets the number of elements contained in the + Log a message object with the level. - - The number of elements contained in the . - + The logger on which the message is logged. + The lambda expression that gets the object to log. - As the collection is empty the is always 0. + This method first checks if this logger is ERROR + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is ERROR enabled, then it converts + the message object (retrieved by invocation of the provided callback) to a + string by invoking the appropriate . + It then proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + - + - Gets an object that can be used to synchronize access to the . + Log a message object with the level including + the stack trace of the passed + as a parameter. - - An object that can be used to synchronize access to the . - + The logger on which the message is logged. + The lambda expression that gets the object to log. + The exception to log, including its stack trace. - As the collection is empty and thread safe and synchronized this instance is also - the object. + See the form for more detailed information. + + - + + Log a message object with the level. //TODO - Gets a value indicating whether the has a fixed size. + Log a message object with the level. - true + The logger on which the message is logged. + The message object to log. - As the collection is empty always returns true. + This method first checks if this logger is ERROR + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is ERROR enabled, then it converts + the message object (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + - + - Gets a value indicating whether the is read-only. + Log a message object with the level including + the stack trace of the passed + as a parameter. - true + The logger on which the message is logged. + The message object to log. + The exception to log, including its stack trace. - As the collection is empty always returns true. + See the form for more detailed information. + + - + - Gets an containing the keys of the . + Logs a formatted message string with the level. - An containing the keys of the . + The logger on which the message is logged. + A String containing zero or more format items + An Object to format - As the collection is empty a is returned. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + - + - Gets an containing the values of the . + Logs a formatted message string with the level. - An containing the values of the . + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format - As the collection is empty a is returned. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + - + - Gets or sets the element with the specified key. + Logs a formatted message string with the level. - The key of the element to get or set. - null + An that supplies culture-specific formatting information + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format - As the collection is empty no values can be looked up or stored. - If the index getter is called then null is returned. - A is thrown if the setter is called. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. - This dictionary is always empty and cannot be modified. + + - + - Contain the information obtained when parsing formatting modifiers - in conversion modifiers. + Logs a formatted message string with the level. + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format - Holds the formatting information extracted from the format string by - the . This is used by the - objects when rendering the output. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. - Nicko Cadell - Gert Driesen + + - + - Defaut Constructor + Logs a formatted message string with the level. + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format + An Object to format - Initializes a new instance of the class. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + - + - Constructor + Log a message object with the level. + The logger on which the message is logged. + The lambda expression that gets the object to log. - Initializes a new instance of the class - with the specified parameters. + This method first checks if this logger is FATAL + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is FATAL enabled, then it converts + the message object (retrieved by invocation of the provided callback) to a + string by invoking the appropriate . + It then proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + - + - Gets or sets the minimum value. + Log a message object with the level including + the stack trace of the passed + as a parameter. - - The minimum value. - + The logger on which the message is logged. + The lambda expression that gets the object to log. + The exception to log, including its stack trace. - Gets or sets the minimum value. + See the form for more detailed information. + + - + + Log a message object with the level. //TODO - Gets or sets the maximum value. + Log a message object with the level. - - The maximum value. - + The logger on which the message is logged. + The message object to log. - Gets or sets the maximum value. + This method first checks if this logger is FATAL + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is FATAL enabled, then it converts + the message object (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + - + - Gets or sets a flag indicating whether left align is enabled - or not. + Log a message object with the level including + the stack trace of the passed + as a parameter. - - A flag indicating whether left align is enabled or not. - + The logger on which the message is logged. + The message object to log. + The exception to log, including its stack trace. - Gets or sets a flag indicating whether left align is enabled or not. + See the form for more detailed information. + + - + - Implementation of Properties collection for the + Logs a formatted message string with the level. + The logger on which the message is logged. + A String containing zero or more format items + An Object to format - This class implements a properties collection that is thread safe and supports both - storing properties and capturing a read only copy of the current propertied. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. - This class is optimized to the scenario where the properties are read frequently - and are modified infrequently. + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. - Nicko Cadell + + - + - The read only copy of the properties. + Logs a formatted message string with the level. + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format - This variable is declared volatile to prevent the compiler and JIT from - reordering reads and writes of this thread performed on different threads. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. - - - - - Lock object used to synchronize updates within this instance - - - - - Constructor - - - Initializes a new instance of the class. + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + - + - Remove a property from the global context + Logs a formatted message string with the level. - the key for the entry to remove + An that supplies culture-specific formatting information + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format - Removing an entry from the global context properties is relatively expensive compared - with reading a value. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + - - - Clear the global context properties - - - + - Get a readonly immutable copy of the properties + Logs a formatted message string with the level. - the current global context properties + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format - This implementation is fast because the GlobalContextProperties class - stores a readonly copy of the properties. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + - + - Gets or sets the value of a property + Logs a formatted message string with the level. - - The value for the property with the specified key - + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format + An Object to format - Reading the value for a key is faster than setting the value. - When the value is written a new read only copy of - the properties is created. + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + @@ -24204,9 +26827,25 @@ Class implements a collection of properties that is specific to each thread. The class is not synchronized as each thread has its own . + + This class stores its properties in a slot on the named + log4net.Util.LogicalThreadContextProperties. + + + The requires a link time + for the + . + If the calling code does not have this permission then this context will be disabled. + It will not store any property values set on it. + Nicko Cadell + + + Flag used to disable this context if we don't have permission to access the CallContext. + + Constructor @@ -24238,18 +26877,49 @@ - + + + Get the PropertiesDictionary stored in the LocalDataStoreSlot for this thread. + + create the dictionary if it does not exist, otherwise return null if is does not exist + the properties for this thread + + + The collection returned is only to be used on the calling thread. If the + caller needs to share the collection between different threads then the + caller must clone the collection before doings so. + + + + + + Gets the call context get data. + + The peroperties dictionary stored in the call context + + The method has a + security link demand, therfore we must put the method call in a seperate method + that we can wrap in an exception handler. + + + + + Sets the call context data. + + The properties. + + The method has a + security link demand, therfore we must put the method call in a seperate method + that we can wrap in an exception handler. + + + - Get the PropertiesDictionary stored in the LocalDataStoreSlot for this thread. + The fully qualified type of the LogicalThreadContextProperties class. - create the dictionary if it does not exist, otherwise return null if is does not exist - the properties for this thread - - The collection returned is only to be used on the calling thread. If the - caller needs to share the collection between different threads then the - caller must clone the collection before doings so. - + Used by the internal logger to record the Type of the + log message. @@ -24265,6 +26935,13 @@ + + + + + + + Outputs log statements from within the log4net assembly. @@ -24284,15 +26961,21 @@ Nicko Cadell Gert Driesen - + + + Formats Prefix, Source, and Message in the same format as the value + sent to Console.Out and Trace.Write. + + + + Initializes a new instance of the class. - - - Uses a private access modifier to prevent instantiation of this class. - - + + + + @@ -24313,11 +26996,21 @@ - + + + Raises the LogReceived event when an internal messages is received. + + + + + + + Writes log4net internal debug messages to the standard output stream. + The message to log. @@ -24326,11 +27019,12 @@ - + Writes log4net internal debug messages to the standard output stream. + The Type that generated this message. The message to log. An exception to log. @@ -24340,11 +27034,12 @@ - + Writes log4net internal warning messages to the standard error stream. + The Type that generated this message. The message to log. @@ -24353,11 +27048,12 @@ - + Writes log4net internal warning messages to the standard error stream. + The Type that generated this message. The message to log. An exception to log. @@ -24367,11 +27063,12 @@ - + Writes log4net internal error messages to the standard error stream. + The Type that generated this message. The message to log. @@ -24380,11 +27077,12 @@ - + Writes log4net internal error messages to the standard error stream. + The Type that generated this message. The message to log. An exception to log. @@ -24440,6 +27138,44 @@ In quietMode not even errors generate any output. + + + The event raised when an internal message has been received. + + + + + The Type that generated the internal message. + + + + + The DateTime stamp of when the internal message was received. + + + + + A string indicating the severity of the internal message. + + + "log4net: ", + "log4net:ERROR ", + "log4net:WARN " + + + + + The internal log message. + + + + + The Exception related to the message. + + + Optional. Will be null if no Exception was passed. + + Gets or sets a value indicating whether log4net internal logging @@ -24514,6 +27250,11 @@ + + + + + Test if LogLog.Debug is enabled for output. @@ -24553,6 +27294,44 @@ + + + Subscribes to the LogLog.LogReceived event and stores messages + to the supplied IList instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents a native error code and message. @@ -24639,11 +27418,11 @@ Formats a message string. - Formatting options, and how to interpret the parameter. + Formatting options, and how to interpret the parameter. Location of the message definition. Message identifier for the requested message. Language identifier for the requested message. - If includes FORMAT_MESSAGE_ALLOCATE_BUFFER, the function allocates a buffer using the LocalAlloc function, and places the pointer to the buffer at the address specified in . + If includes FORMAT_MESSAGE_ALLOCATE_BUFFER, the function allocates a buffer using the LocalAlloc function, and places the pointer to the buffer at the address specified in . If the FORMAT_MESSAGE_ALLOCATE_BUFFER flag is not set, this parameter specifies the maximum number of TCHARs that can be stored in the output buffer. If FORMAT_MESSAGE_ALLOCATE_BUFFER is set, this parameter specifies the minimum number of TCHARs to allocate for an output buffer. Pointer to an array of values that are used as insert values in the formatted message. @@ -24667,7 +27446,7 @@ If the function fails, the return value is zero. To get extended error information, - call . + call . @@ -24965,7 +27744,7 @@ - The error message is printed on the standard error output stream. + The error message is processed using the LogLog sub-system by default. This policy aims at protecting an otherwise working application @@ -24974,6 +27753,7 @@ Nicko Cadell Gert Driesen + Ron Grabowski @@ -24997,6 +27777,11 @@ + + + Reset the error handler back to its initial disabled state. + + Log an Error @@ -25006,8 +27791,20 @@ The internal error code. - Prints the message and the stack trace of the exception on the standard - error output stream. + Invokes if and only if this is the first error or the first error after has been called. + + + + + + Log the very first error + + The error message. + The exception. + The internal error code. + + + Sends the error information to 's Error method. @@ -25019,8 +27816,7 @@ The exception. - Prints the message and the stack trace of the exception on the standard - error output stream. + Invokes if and only if this is the first error or the first error after has been called. @@ -25031,21 +27827,49 @@ The error message. - Print a the error message passed as parameter on the standard - error output stream. + Invokes if and only if this is the first error or the first error after has been called. + + + The date the error was recorded. + + Flag to indicate if it is the first error + + + The message recorded during the first error. + + + + + The exception recorded during the first error. + + + + + The error code recorded during the first error. + + String to prefix each message with + + + The fully qualified type of the OnlyOnceErrorHandler class. + + + Used by the internal logger to record the Type of the + log message. + + Is error logging enabled @@ -25057,6 +27881,32 @@ + + + The date the first error that trigged this error handler occured. + + + + + The message from the first error that trigged this error handler. + + + + + The exception from the first error that trigged this error handler. + + + May be . + + + + + The error code from the first error that trigged this error handler. + + + Defaults to + + A convenience class to convert property values to specific types. @@ -25176,7 +28026,7 @@ - Performs variable substitution in string from the + Performs variable substitution in string from the values of keys found in . The string on which variable substitution is performed. @@ -25229,6 +28079,15 @@ If true, ignore case; otherwise, regard case. An object of type whose value is represented by . + + + The fully qualified type of the OptionConverter class. + + + Used by the internal logger to record the Type of the + log message. + + Most of the work of the class @@ -25335,6 +28194,15 @@ + + + The fully qualified type of the PatternParser class. + + + Used by the internal logger to record the Type of the + log message. + + Get the converter registry used by this parser @@ -25395,7 +28263,7 @@ date - Used to output the date of the logging event in the local time zone. + Used to output the current date and time in the local time zone. To output the date in universal time use the %utcdate pattern. The date conversion specifier may be followed by a date format specifier enclosed @@ -25406,7 +28274,7 @@ The date format specifier admits the same syntax as the - time pattern string of the . + time pattern string of the . For better results it is recommended to use the log4net date @@ -25419,7 +28287,7 @@ These dedicated date formatters perform significantly - better than . + better than . @@ -25541,7 +28409,7 @@ The date format specifier admits the same syntax as the - time pattern string of the . + time pattern string of the . For better results it is recommended to use the log4net date @@ -25554,7 +28422,7 @@ These dedicated date formatters perform significantly - better than . + better than . @@ -25569,8 +28437,8 @@ Additional pattern converters may be registered with a specific - instance using or - . + instance using or + . See the for details on the @@ -25679,7 +28547,7 @@ - + Add a converter to this PatternString @@ -25687,7 +28555,7 @@ This version of the method is used by the configurator. - Programmatic users should use the alternative method. + Programmatic users should use the alternative method. @@ -25718,47 +28586,6 @@ - - - Wrapper class used to map converter names to converter types - - - - Wrapper class used to map converter names to converter types - - - - - - default constructor - - - - - Gets or sets the name of the conversion pattern - - - The name of the conversion pattern - - - - Gets or sets the name of the conversion pattern - - - - - - Gets or sets the type of the converter - - - The type of the converter - - - - Gets or sets the type of the converter - - - String keyed object map. @@ -26158,6 +28985,48 @@ See + + + A class to hold the key and data for a property set in the config file + + + + A class to hold the key and data for a property set in the config file + + + + + + Override Object.ToString to return sensible debug info + + string info about this object + + + + Property Key + + + Property Key + + + + Property Key. + + + + + + Property Value + + + Property Value + + + + Property Value. + + + A that ignores the message @@ -26436,7 +29305,7 @@ If the type name is fully qualified, i.e. if contains an assembly name in the type name, the type will be loaded from the system using - . + . If the type name is not fully qualified, it will be loaded from the assembly @@ -26457,7 +29326,7 @@ If the type name is fully qualified, i.e. if contains an assembly name in the type name, the type will be loaded from the system using - . + . If the type name is not fully qualified it will be loaded from the @@ -26479,7 +29348,7 @@ If the type name is fully qualified, i.e. if contains an assembly name in the type name, the type will be loaded from the system using - . + . If the type name is not fully qualified it will be loaded from the specified @@ -26548,6 +29417,20 @@ + + + Parse a string into an value + + the string to parse + out param where the parsed value is placed + true if the string was able to be parsed into an integer + + + Attempts to parse the string into an integer. If the string cannot + be parsed then this method returns false. The method does not throw an exception. + + + Lookup an application setting @@ -26600,6 +29483,15 @@ + + + The fully qualified type of the SystemInfo class. + + + Used by the internal logger to record the Type of the + log message. + + Cache the host name for the current machine @@ -26852,6 +29744,15 @@ Dump an object to a string + + + The fully qualified type of the SystemStringFormat class. + + + Used by the internal logger to record the Type of the + log message. + + Implementation of Properties collection for the @@ -26864,9 +29765,9 @@ Nicko Cadell - + - The thread local data slot to use to store a PropertiesDictionary. + Each thread will automatically have its instance. @@ -26890,6 +29791,15 @@ + + + Get the keys stored in the properties. + + + Gets the keys stored in the properties. + + a set of the defined keys + Clear all properties @@ -26904,7 +29814,7 @@ Get the PropertiesDictionary for this thread. - create the dictionary if it does not exist, otherwise return null if is does not exist + create the dictionary if it does not exist, otherwise return null if does not exist the properties for this thread @@ -27176,6 +30086,15 @@ + + + The fully qualified type of the ThreadContextStacks class. + + + Used by the internal logger to record the Type of the + log message. + + Gets the named thread context stack @@ -27256,6 +30175,11 @@ + + + Characters illegal in XML 1.0 + + Impersonate a Windows Account @@ -27518,6 +30442,29 @@ + + + Provides information about the environment the assembly has + been built for. + + + + Version of the assembly + + + Version of the framework targeted + + + Type of framework targeted + + + Does it target a client profile? + + + + Identifies the version and target for this assembly. + + The log4net Logical Thread Context. @@ -27544,6 +30491,13 @@ The Logical Thread Context is managed on a per basis. + + The requires a link time + for the + . + If the calling code does not have this permission then this context will be disabled. + It will not store any property values set on it. + Example of using the thread context properties to store a username. @@ -27617,7 +30571,7 @@ This class has static methods that are used by a client to request - a logger instance. The method is + a logger instance. The method is used to retrieve a logger. @@ -27794,7 +30748,7 @@ - Shorthand for . + Shorthand for . Get the logger for the fully qualified name of the type specified. @@ -27804,7 +30758,7 @@ - Shorthand for . + Shorthand for . Gets the logger for the fully qualified name of the type specified. @@ -27815,7 +30769,7 @@ - Shorthand for . + Shorthand for . Gets the logger for the fully qualified name of the type specified. @@ -27968,7 +30922,7 @@ Gets the for the repository specified - by the callers assembly (). + by the callers assembly (). The instance for the default repository. @@ -28007,7 +30961,7 @@ Gets the for the repository specified - by the callers assembly (). + by the callers assembly (). The instance for the default repository. @@ -28049,7 +31003,7 @@ The created will be associated with the repository - specified such that a call to will return + specified such that a call to will return the same repository instance. @@ -28070,7 +31024,7 @@ The created will be associated with the repository - specified such that a call to will return + specified such that a call to will return the same repository instance. @@ -28161,7 +31115,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -28178,7 +31132,7 @@ The created will be associated with the repository - specified such that a call to with the + specified such that a call to with the same assembly specified will return the same repository instance. @@ -28294,13 +31248,13 @@ - Puts a context value (the parameter) as identified + Puts a context value (the parameter) as identified with the parameter into the current thread's context map. If a value is already defined for the - specified then the value will be replaced. If the + specified then the value will be replaced. If the is specified as null then the key value mapping will be removed.