Common.Logging.xml 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Common.Logging</name>
  5. </assembly>
  6. <members>
  7. <member name="T:AssemblyDoc">
  8. <summary>
  9. This assembly contains the core functionality of the Common.Logging framework.
  10. In particular, checkout <see cref="T:Common.Logging.LogManager"/> and <see cref="T:Common.Logging.ILog"/> for usage information.
  11. </summary>
  12. </member>
  13. <member name="T:Common.Logging.Configuration.NameValueCollectionHelper">
  14. <summary>
  15. Helper class for working with NameValueCollection
  16. </summary>
  17. </member>
  18. <member name="M:Common.Logging.Configuration.NameValueCollectionHelper.ToCommonLoggingCollection(System.Collections.Specialized.NameValueCollection)">
  19. <summary>
  20. Convert a <see cref="T:System.Collections.Specialized.NameValueCollection"/> into the corresponding
  21. common logging equivalent <see cref="T:Common.Logging.Configuration.NameValueCollection"/>
  22. </summary>
  23. <param name="properties">The properties.</param>
  24. <returns></returns>
  25. </member>
  26. <member name="T:Common.Logging.Simple.CommonLoggingTraceListener">
  27. <summary>
  28. A <see cref="T:System.Diagnostics.TraceListener"/> implementation sending all <see cref="T:System.Diagnostics.Trace">System.Diagnostics.Trace</see> output to
  29. the Common.Logging infrastructure.
  30. </summary>
  31. <remarks>
  32. This listener captures all output sent by calls to <see cref="T:System.Diagnostics.Trace">System.Diagnostics.Trace</see> and
  33. and <see cref="T:System.Diagnostics.TraceSource"/> and sends it to an <see cref="T:Common.Logging.ILog"/> instance.<br/>
  34. The <see cref="T:Common.Logging.ILog"/> instance to be used is obtained by calling
  35. <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>. The name of the logger is created by passing
  36. this listener's <see cref="P:System.Diagnostics.TraceListener.Name"/> and any <c>source</c> or <c>category</c> passed
  37. into this listener (see <see cref="M:System.Diagnostics.TraceListener.WriteLine(System.Object,System.String)"/> or <see cref="M:System.Diagnostics.TraceListener.TraceEvent(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.String,System.Object[])"/> for example).
  38. </remarks>
  39. <example>
  40. The snippet below shows how to add and configure this listener to your app.config:
  41. <code lang="XML">
  42. &lt;system.diagnostics&gt;
  43. &lt;sharedListeners&gt;
  44. &lt;add name="Diagnostics"
  45. type="Common.Logging.Simple.CommonLoggingTraceListener, Common.Logging"
  46. initializeData="DefaultTraceEventType=Information; LoggerNameFormat={listenerName}.{sourceName}"&gt;
  47. &lt;filter type="System.Diagnostics.EventTypeFilter" initializeData="Information"/&gt;
  48. &lt;/add&gt;
  49. &lt;/sharedListeners&gt;
  50. &lt;trace&gt;
  51. &lt;listeners&gt;
  52. &lt;add name="Diagnostics" /&gt;
  53. &lt;/listeners&gt;
  54. &lt;/trace&gt;
  55. &lt;/system.diagnostics&gt;
  56. </code>
  57. </example>
  58. <author>Erich Eichinger</author>
  59. </member>
  60. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.#ctor">
  61. <summary>
  62. Creates a new instance with the default name "Diagnostics" and <see cref="T:Common.Logging.LogLevel"/> "Trace".
  63. </summary>
  64. </member>
  65. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.#ctor(System.String)">
  66. <summary>
  67. Creates a new instance initialized with properties from the <paramref name="initializeData"/>. string.
  68. </summary>
  69. <remarks>
  70. <paramref name="initializeData"/> is a semicolon separated string of name/value pairs, where each pair has
  71. the form <c>key=value</c>. E.g.
  72. "<c>Name=MyLoggerName;LogLevel=Debug</c>"
  73. </remarks>
  74. <param name="initializeData">a semicolon separated list of name/value pairs.</param>
  75. </member>
  76. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.#ctor(System.Collections.Specialized.NameValueCollection)">
  77. <summary>
  78. Creates a new instance initialized with the specified properties.
  79. </summary>
  80. <param name="properties">name/value configuration properties.</param>
  81. </member>
  82. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.Log(System.Diagnostics.TraceEventType,System.String,System.Int32,System.String,System.Object[])">
  83. <summary>
  84. Logs the given message to the Common.Logging infrastructure.
  85. </summary>
  86. <param name="eventType">the eventType</param>
  87. <param name="source">the <see cref="T:System.Diagnostics.TraceSource"/> name or category name passed into e.g. <see cref="M:System.Diagnostics.Trace.Write(System.Object,System.String)"/>.</param>
  88. <param name="id">the id of this event</param>
  89. <param name="format">the message format</param>
  90. <param name="args">the message arguments</param>
  91. </member>
  92. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.Write(System.Object)">
  93. <summary>
  94. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>.
  95. </summary>
  96. </member>
  97. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.Write(System.Object,System.String)">
  98. <summary>
  99. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>.
  100. </summary>
  101. </member>
  102. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.Write(System.String)">
  103. <summary>
  104. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>.
  105. </summary>
  106. </member>
  107. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.Write(System.String,System.String)">
  108. <summary>
  109. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>.
  110. </summary>
  111. </member>
  112. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.WriteLine(System.Object)">
  113. <summary>
  114. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>.
  115. </summary>
  116. </member>
  117. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.WriteLine(System.Object,System.String)">
  118. <summary>
  119. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>.
  120. </summary>
  121. </member>
  122. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.WriteLine(System.String)">
  123. <summary>
  124. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>.
  125. </summary>
  126. </member>
  127. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.WriteLine(System.String,System.String)">
  128. <summary>
  129. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>
  130. </summary>
  131. </member>
  132. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.TraceEvent(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32)">
  133. <summary>
  134. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>
  135. </summary>
  136. </member>
  137. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.TraceEvent(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.String)">
  138. <summary>
  139. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>
  140. </summary>
  141. </member>
  142. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.TraceEvent(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.String,System.Object[])">
  143. <summary>
  144. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>
  145. </summary>
  146. </member>
  147. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.TraceData(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.Object[])">
  148. <summary>
  149. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>
  150. </summary>
  151. </member>
  152. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.TraceData(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.Object)">
  153. <summary>
  154. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>
  155. </summary>
  156. </member>
  157. <member name="P:Common.Logging.Simple.CommonLoggingTraceListener.DefaultTraceEventType">
  158. <summary>
  159. Sets the default <see cref="T:System.Diagnostics.TraceEventType"/> to use for logging
  160. all events emitted by <see cref="T:System.Diagnostics.Trace"/><c>.Write(...)</c> and
  161. <see cref="T:System.Diagnostics.Trace"/><c>.WriteLine(...)</c> methods.
  162. </summary>
  163. <remarks>
  164. This listener captures all output sent by calls to <see cref="T:System.Diagnostics.Trace"/> and
  165. sends it to an <see cref="T:Common.Logging.ILog"/> instance using the <see cref="T:Common.Logging.LogLevel"/> specified
  166. on <see cref="T:Common.Logging.LogLevel"/>.
  167. </remarks>
  168. </member>
  169. <member name="P:Common.Logging.Simple.CommonLoggingTraceListener.LoggerNameFormat">
  170. <summary>
  171. Format to use for creating the logger name. Defaults to "{listenerName}.{sourceName}".
  172. </summary>
  173. <remarks>
  174. Available placeholders are:
  175. <list type="bullet">
  176. <item>{listenerName}: the configured name of this listener instance.</item>
  177. <item>{sourceName}: the trace source name an event originates from (see e.g. <see cref="M:System.Diagnostics.TraceListener.TraceEvent(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.String,System.Object[])"/>.</item>
  178. </list>
  179. </remarks>
  180. </member>
  181. <member name="T:Common.Logging.ConfigurationSectionHandler">
  182. <summary>
  183. Used in an application's configuration file (App.Config or Web.Config) to configure the logging subsystem.
  184. </summary>
  185. <example>
  186. An example configuration section that writes log messages to the Console using the
  187. built-in Console Logger.
  188. <code lang="XML">
  189. &lt;configuration&gt;
  190. &lt;configSections&gt;
  191. &lt;sectionGroup name=&quot;common&quot;&gt;
  192. &lt;section name=&quot;logging&quot; type=&quot;Common.Logging.ConfigurationSectionHandler, Common.Logging&quot; /&gt;
  193. &lt;/sectionGroup&gt;
  194. &lt;/configSections&gt;
  195. &lt;common&gt;
  196. &lt;logging&gt;
  197. &lt;factoryAdapter type=&quot;Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter, Common.Logging&quot;&gt;
  198. &lt;arg key=&quot;showLogName&quot; value=&quot;true&quot; /&gt;
  199. &lt;arg key=&quot;showDataTime&quot; value=&quot;true&quot; /&gt;
  200. &lt;arg key=&quot;level&quot; value=&quot;ALL&quot; /&gt;
  201. &lt;arg key=&quot;dateTimeFormat&quot; value=&quot;yyyy/MM/dd HH:mm:ss:fff&quot; /&gt;
  202. &lt;/factoryAdapter&gt;
  203. &lt;/logging&gt;
  204. &lt;/common&gt;
  205. &lt;/configuration&gt;
  206. </code>
  207. </example>
  208. </member>
  209. <member name="M:Common.Logging.ConfigurationSectionHandler.#cctor">
  210. <summary>
  211. Ensure static fields get initialized before any class member
  212. can be accessed (avoids beforeFieldInit)
  213. </summary>
  214. </member>
  215. <member name="M:Common.Logging.ConfigurationSectionHandler.#ctor">
  216. <summary>
  217. Constructor
  218. </summary>
  219. </member>
  220. <member name="M:Common.Logging.ConfigurationSectionHandler.ReadConfiguration(System.Xml.XmlNode)">
  221. <summary>
  222. Retrieves the <see cref="T:System.Type"/> of the logger the use by looking at the logFactoryAdapter element
  223. of the logging configuration element.
  224. </summary>
  225. <param name="section"></param>
  226. <returns>
  227. A <see cref="T:Common.Logging.Configuration.LogSetting"/> object containing the specified type that implements
  228. <see cref="T:Common.Logging.ILoggerFactoryAdapter"/> along with zero or more properties that will be
  229. passed to the logger factory adapter's constructor as an <see cref="T:System.Collections.IDictionary"/>.
  230. </returns>
  231. </member>
  232. <member name="M:Common.Logging.ConfigurationSectionHandler.Create(Common.Logging.Configuration.LogSetting,System.Object,System.Xml.XmlNode)">
  233. <summary>
  234. Verifies that the logFactoryAdapter element appears once in the configuration section.
  235. </summary>
  236. <param name="parent">settings of a parent section - atm this must always be null</param>
  237. <param name="configContext">Additional information about the configuration process.</param>
  238. <param name="section">The configuration section to apply an XPath query too.</param>
  239. <returns>
  240. A <see cref="T:Common.Logging.Configuration.LogSetting"/> object containing the specified logFactoryAdapter type
  241. along with user supplied configuration properties.
  242. </returns>
  243. </member>
  244. <member name="M:Common.Logging.ConfigurationSectionHandler.System#Configuration#IConfigurationSectionHandler#Create(System.Object,System.Object,System.Xml.XmlNode)">
  245. <summary>
  246. Verifies that the logFactoryAdapter element appears once in the configuration section.
  247. </summary>
  248. <param name="parent">The parent of the current item.</param>
  249. <param name="configContext">Additional information about the configuration process.</param>
  250. <param name="section">The configuration section to apply an XPath query too.</param>
  251. <returns>
  252. A <see cref="T:Common.Logging.Configuration.LogSetting"/> object containing the specified logFactoryAdapter type
  253. along with user supplied configuration properties.
  254. </returns>
  255. </member>
  256. <member name="T:Common.Logging.NamespaceDoc">
  257. <summary>
  258. This namespace contains all core classes making up the Common.Logging framework.
  259. </summary>
  260. </member>
  261. <member name="T:NamespaceDoc">
  262. <summary>
  263. <h1>Overview</h1>
  264. <para>
  265. There are a variety of logging implementations for .NET currently in use, log4net, Enterprise
  266. Library Logging, NLog, to name the most popular. The downside of having differerent implementation
  267. is that they do not share a common interface and therefore impose a particular logging
  268. implementation on the users of your library. To solve this dependency problem the Common.Logging
  269. library introduces a simple abstraction to allow you to select a specific logging implementation at
  270. runtime.
  271. </para>
  272. <para>
  273. The library is based on work done by the developers of IBatis.NET and it's usage is inspired by
  274. log4net. Many thanks to the developers of those projects!
  275. </para>
  276. <h1>Usage</h1>
  277. <para>
  278. The core logging library Common.Logging provides the base logging <see cref="T:Common.Logging.ILog"/> interface as
  279. well as the global <see cref="T:Common.Logging.LogManager"/> that you use to instrument your code:
  280. </para>
  281. <code lang="C#">
  282. ILog log = LogManager.GetLogger(this.GetType());
  283. log.DebugFormat("Hi {0}", "dude");
  284. </code>
  285. <para>
  286. To output the information logged, you need to tell Common.Logging, what underlying logging system
  287. to use. Common.Logging already includes simple console and trace based logger implementations
  288. usable out of the box. Adding the following configuration snippet to your app.config causes
  289. Common.Logging to output all information to the console:
  290. </para>
  291. <code lang="XML">
  292. &lt;configuration&gt;
  293. &lt;configSections&gt;
  294. &lt;sectionGroup name="common"&gt;
  295. &lt;section name="logging" type="Common.Logging.ConfigurationSectionHandler, Common.Logging" /&gt;
  296. &lt;/sectionGroup&gt;
  297. &lt;/configSections&gt;
  298. &lt;common&gt;
  299. &lt;logging&gt;
  300. &lt;factoryAdapter type="Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter, Common.Logging"&gt;
  301. &lt;arg key="level" value="DEBUG" /&gt;
  302. &lt;/factoryAdapter&gt;
  303. &lt;/logging&gt;
  304. &lt;/common&gt;
  305. &lt;/configuration&gt;
  306. </code>
  307. <h1>Customizing</h1>
  308. <para>
  309. In the case you want to integrate your own logging system that is not supported by Common.Logging yet, it is easily
  310. possible to implement your own plugin by implementing <see cref="T:Common.Logging.ILoggerFactoryAdapter"/>.
  311. For convenience there is a base <see cref="T:Common.Logging.Factory.AbstractCachingLoggerFactoryAdapter"/> implementation available that usually
  312. makes implementing your own adapter a breeze.
  313. </para>
  314. <h1>&lt;system.diagnostics&gt; Integration</h1>
  315. <para>
  316. If your code already uses the .NET framework's built-in <a href="http://msdn.microsoft.com/library/system.diagnostics.trace.aspx">System.Diagnostics.Trace</a>
  317. system, you can use <see cref="T:Common.Logging.Simple.CommonLoggingTraceListener"/> to redirect all trace output to the
  318. Common.Logging infrastructure.
  319. </para>
  320. </summary>
  321. </member>
  322. <member name="T:Common.Logging.Simple.ConsoleOutLogger">
  323. <summary>
  324. Sends log messages to <see cref="P:System.Console.Out"/>.
  325. </summary>
  326. <author>Gilles Bayon</author>
  327. </member>
  328. <member name="M:Common.Logging.Simple.ConsoleOutLogger.#ctor(System.String,Common.Logging.LogLevel,System.Boolean,System.Boolean,System.Boolean,System.String)">
  329. <summary>
  330. Creates and initializes a logger that writes messages to <see cref="P:System.Console.Out"/>.
  331. </summary>
  332. <param name="logName">The name, usually type name of the calling class, of the logger.</param>
  333. <param name="logLevel">The current logging threshold. Messages recieved that are beneath this threshold will not be logged.</param>
  334. <param name="showLevel">Include the current log level in the log message.</param>
  335. <param name="showDateTime">Include the current time in the log message.</param>
  336. <param name="showLogName">Include the instance name in the log message.</param>
  337. <param name="dateTimeFormat">The date and time format to use in the log message.</param>
  338. </member>
  339. <member name="M:Common.Logging.Simple.ConsoleOutLogger.WriteInternal(Common.Logging.LogLevel,System.Object,System.Exception)">
  340. <summary>
  341. Do the actual logging by constructing the log message using a <see cref="T:System.Text.StringBuilder"/> then
  342. sending the output to <see cref="P:System.Console.Out"/>.
  343. </summary>
  344. <param name="level">The <see cref="T:Common.Logging.LogLevel"/> of the message.</param>
  345. <param name="message">The log message.</param>
  346. <param name="e">An optional <see cref="T:System.Exception"/> associated with the message.</param>
  347. </member>
  348. <member name="T:Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter">
  349. <summary>
  350. Factory for creating <see cref="T:Common.Logging.ILog"/> instances that write data to <see cref="P:System.Console.Out"/>.
  351. </summary>
  352. <remarks>
  353. <example>
  354. Below is an example how to configure this adapter:
  355. <code>
  356. &lt;configuration&gt;
  357. &lt;configSections&gt;
  358. &lt;sectionGroup name="common"&gt;
  359. &lt;section name="logging"
  360. type="Common.Logging.ConfigurationSectionHandler, Common.Logging"
  361. requirePermission="false" /&gt;
  362. &lt;/sectionGroup&gt;
  363. &lt;/configSections&gt;
  364. &lt;common&gt;
  365. &lt;logging&gt;
  366. &lt;factoryAdapter type="Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter, Common.Logging"&gt;
  367. &lt;arg key="level" value="ALL" /&gt;
  368. &lt;/factoryAdapter&gt;
  369. &lt;/logging&gt;
  370. &lt;/common&gt;
  371. &lt;/configuration&gt;
  372. </code>
  373. </example>
  374. </remarks>
  375. <seealso cref="T:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter"/>
  376. <seealso cref="P:Common.Logging.LogManager.Adapter"/>
  377. <seealso cref="T:Common.Logging.ConfigurationSectionHandler"/>
  378. <author>Gilles Bayon</author>
  379. <author>Mark Pollack</author>
  380. <author>Erich Eichinger</author>
  381. </member>
  382. <member name="M:Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter.#ctor">
  383. <summary>
  384. Initializes a new instance of the <see cref="T:Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter"/> class using default
  385. settings.
  386. </summary>
  387. </member>
  388. <member name="M:Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter.#ctor(Common.Logging.Configuration.NameValueCollection)">
  389. <summary>
  390. Initializes a new instance of the <see cref="T:Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter"/> class.
  391. </summary>
  392. <remarks>
  393. Looks for level, showDateTime, showLogName, dateTimeFormat items from
  394. <paramref name="properties"/> for use when the GetLogger methods are called.
  395. <see cref="T:Common.Logging.ConfigurationSectionHandler"/> for more information on how to use the
  396. standard .NET application configuraiton file (App.config/Web.config)
  397. to configure this adapter.
  398. </remarks>
  399. <param name="properties">The name value collection, typically specified by the user in
  400. a configuration section named common/logging.</param>
  401. </member>
  402. <member name="M:Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter.#ctor(System.Collections.Specialized.NameValueCollection)">
  403. <summary>
  404. Constructor for binary backwards compatibility with non-portableversions
  405. </summary>
  406. <param name="properties">The properties.</param>
  407. </member>
  408. <member name="M:Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter.#ctor(Common.Logging.LogLevel,System.Boolean,System.Boolean,System.Boolean,System.String)">
  409. <summary>
  410. Initializes a new instance of the <see cref="T:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter"/> class with
  411. default settings for the loggers created by this factory.
  412. </summary>
  413. </member>
  414. <member name="M:Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter.CreateLogger(System.String,Common.Logging.LogLevel,System.Boolean,System.Boolean,System.Boolean,System.String)">
  415. <summary>
  416. Creates a new <see cref="T:Common.Logging.Simple.ConsoleOutLogger"/> instance.
  417. </summary>
  418. </member>
  419. <member name="T:Common.Logging.Simple.TraceLogger">
  420. <summary>
  421. Logger sending everything to the trace output stream using <see cref="T:System.Diagnostics.Trace"/>.
  422. </summary>
  423. <remarks>
  424. Beware not to use <see cref="T:Common.Logging.Simple.CommonLoggingTraceListener"/> in combination with this logger as
  425. this would result in an endless loop for obvious reasons!
  426. </remarks>
  427. <seealso cref="P:Common.Logging.LogManager.Adapter"/>
  428. <seealso cref="T:Common.Logging.ConfigurationSectionHandler"/>
  429. <author>Gilles Bayon</author>
  430. <author>Erich Eichinger</author>
  431. </member>
  432. <member name="M:Common.Logging.Simple.TraceLogger.#ctor(System.Boolean,System.String,Common.Logging.LogLevel,System.Boolean,System.Boolean,System.Boolean,System.String)">
  433. <summary>
  434. Creates a new TraceLogger instance.
  435. </summary>
  436. <param name="useTraceSource">whether to use <see cref="T:System.Diagnostics.TraceSource"/> or <see cref="T:System.Diagnostics.Trace"/> for logging.</param>
  437. <param name="logName">the name of this logger</param>
  438. <param name="logLevel">the default log level to use</param>
  439. <param name="showLevel">Include the current log level in the log message.</param>
  440. <param name="showDateTime">Include the current time in the log message.</param>
  441. <param name="showLogName">Include the instance name in the log message.</param>
  442. <param name="dateTimeFormat">The date and time format to use in the log message.</param>
  443. </member>
  444. <member name="M:Common.Logging.Simple.TraceLogger.IsLevelEnabled(Common.Logging.LogLevel)">
  445. <summary>
  446. Determines if the given log level is currently enabled.
  447. checks <see cref="P:System.Diagnostics.TraceSource.Switch"/> if <see cref="P:Common.Logging.Simple.TraceLoggerFactoryAdapter.UseTraceSource"/> is true.
  448. </summary>
  449. </member>
  450. <member name="M:Common.Logging.Simple.TraceLogger.WriteInternal(Common.Logging.LogLevel,System.Object,System.Exception)">
  451. <summary>
  452. Do the actual logging.
  453. </summary>
  454. <param name="level"></param>
  455. <param name="message"></param>
  456. <param name="e"></param>
  457. </member>
  458. <member name="M:Common.Logging.Simple.TraceLogger.OnDeserialization(System.Object)">
  459. <summary>
  460. Called after deserialization completed.
  461. </summary>
  462. </member>
  463. <member name="T:Common.Logging.Simple.TraceLogger.FormatOutputMessage">
  464. <summary>
  465. Used to defer message formatting until it is really needed.
  466. </summary>
  467. <remarks>
  468. This class also improves performance when multiple
  469. <see cref="T:System.Diagnostics.TraceListener"/>s are configured.
  470. </remarks>
  471. </member>
  472. <member name="T:Common.Logging.Simple.TraceLoggerFactoryAdapter">
  473. <summary>
  474. Factory for creating <see cref="T:Common.Logging.ILog"/> instances that send
  475. everything to the <see cref="T:System.Diagnostics.Trace"/> output stream.
  476. </summary>
  477. <remarks>
  478. Beware not to use <see cref="T:Common.Logging.Simple.CommonLoggingTraceListener"/> in combination with this logger factory
  479. as this would result in an endless loop for obvious reasons!
  480. <example>
  481. Below is an example how to configure this adapter:
  482. <code>
  483. &lt;configuration&gt;
  484. &lt;configSections&gt;
  485. &lt;sectionGroup name="common"&gt;
  486. &lt;section name="logging"
  487. type="Common.Logging.ConfigurationSectionHandler, Common.Logging"
  488. requirePermission="false" /&gt;
  489. &lt;/sectionGroup&gt;
  490. &lt;/configSections&gt;
  491. &lt;common&gt;
  492. &lt;logging&gt;
  493. &lt;factoryAdapter type="Common.Logging.Simple.TraceLoggerFactoryAdapter, Common.Logging"&gt;
  494. &lt;arg key="level" value="ALL" /&gt;
  495. &lt;/factoryAdapter&gt;
  496. &lt;/logging&gt;
  497. &lt;/common&gt;
  498. &lt;/configuration&gt;
  499. </code>
  500. </example>
  501. </remarks>
  502. <seealso cref="T:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter"/>
  503. <seealso cref="P:Common.Logging.LogManager.Adapter"/>
  504. <seealso cref="T:Common.Logging.ConfigurationSectionHandler"/>
  505. <author>Gilles Bayon</author>
  506. <author>Mark Pollack</author>
  507. <author>Erich Eichinger</author>
  508. </member>
  509. <member name="M:Common.Logging.Simple.TraceLoggerFactoryAdapter.#ctor">
  510. <summary>
  511. Initializes a new instance of the <see cref="T:Common.Logging.Simple.TraceLoggerFactoryAdapter"/> class using default settings.
  512. </summary>
  513. </member>
  514. <member name="M:Common.Logging.Simple.TraceLoggerFactoryAdapter.#ctor(Common.Logging.Configuration.NameValueCollection)">
  515. <summary>
  516. Initializes a new instance of the <see cref="T:Common.Logging.Simple.TraceLoggerFactoryAdapter"/> class.
  517. </summary>
  518. <remarks>
  519. Looks for level, showDateTime, showLogName, dateTimeFormat items from
  520. <paramref name="properties"/> for use when the GetLogger methods are called.
  521. <see cref="T:Common.Logging.ConfigurationSectionHandler"/> for more information on how to use the
  522. standard .NET application configuraiton file (App.config/Web.config)
  523. to configure this adapter.
  524. </remarks>
  525. <param name="properties">The name value collection, typically specified by the user in
  526. a configuration section named common/logging.</param>
  527. </member>
  528. <member name="M:Common.Logging.Simple.TraceLoggerFactoryAdapter.#ctor(Common.Logging.LogLevel,System.Boolean,System.Boolean,System.Boolean,System.String,System.Boolean)">
  529. <summary>
  530. Initializes a new instance of the <see cref="T:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter"/> class with
  531. default settings for the loggers created by this factory.
  532. </summary>
  533. </member>
  534. <member name="M:Common.Logging.Simple.TraceLoggerFactoryAdapter.CreateLogger(System.String,Common.Logging.LogLevel,System.Boolean,System.Boolean,System.Boolean,System.String)">
  535. <summary>
  536. Creates a new <see cref="T:Common.Logging.Simple.TraceLogger"/> instance.
  537. </summary>
  538. </member>
  539. <member name="P:Common.Logging.Simple.TraceLoggerFactoryAdapter.UseTraceSource">
  540. <summary>
  541. Whether to use <see cref="T:System.Diagnostics.Trace"/>.<c>TraceXXXX(string,object[])</c> methods for logging
  542. or <see cref="T:System.Diagnostics.TraceSource"/>.
  543. </summary>
  544. </member>
  545. <member name="T:CoverageExcludeAttribute">
  546. <summary>
  547. Indicates classes or members to be ignored by NCover
  548. </summary>
  549. <remarks>
  550. Note, the name is chosen, because TestDriven.NET uses it as //ea argument to "Test With... Coverage"
  551. </remarks>
  552. <author>Erich Eichinger</author>
  553. </member>
  554. </members>
  555. </doc>