79156cd27decc56257a86756f96cd4dd323766a9.svn-base 52 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Common.Logging.Core</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Common.Logging.Factory.StringFormatMethodAttribute">
  8. <summary>
  9. Indicates that the marked method builds string by format pattern and (optional) arguments.
  10. Parameter, which contains format string, should be given in constructor. The format string
  11. should be in <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/>-like form
  12. </summary>
  13. <example><code>
  14. [StringFormatMethod("message")]
  15. public void ShowError(string message, params object[] args) { /* do something */ }
  16. public void Foo() {
  17. ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
  18. }
  19. </code></example>
  20. </member>
  21. <member name="M:Common.Logging.Factory.StringFormatMethodAttribute.#ctor(System.String)">
  22. <param name="formatParameterName">
  23. Specifies which parameter of an annotated method should be treated as format-string
  24. </param>
  25. </member>
  26. <member name="P:Common.Logging.Factory.StringFormatMethodAttribute.FormatParameterName">
  27. <summary>
  28. The name of the string parameter being formatted
  29. </summary>
  30. </member>
  31. <member name="T:Common.Logging.FormatMessageHandler">
  32. <summary>
  33. The type of method that is passed into e.g. <see cref="M:Common.Logging.ILog.Debug(System.Action{Common.Logging.FormatMessageHandler})"/>
  34. and allows the callback method to "submit" it's message to the underlying output system.
  35. </summary>
  36. <param name="format">the format argument as in <see cref="M:System.String.Format(System.String,System.Object[])"/></param>
  37. <param name="args">the argument list as in <see cref="M:System.String.Format(System.String,System.Object[])"/></param>
  38. <seealso cref="T:Common.Logging.ILog"/>
  39. <author>Erich Eichinger</author>
  40. </member>
  41. <member name="T:Common.Logging.IConfigurationReader">
  42. <summary>
  43. Interface for basic operations to read .NET application configuration information.
  44. </summary>
  45. <remarks>Provides a simple abstraction to handle BCL API differences between .NET 1.x and 2.0. Also
  46. useful for testing scenarios.</remarks>
  47. <author>Mark Pollack</author>
  48. </member>
  49. <member name="M:Common.Logging.IConfigurationReader.GetSection(System.String)">
  50. <summary>
  51. Parses the configuration section and returns the resulting object.
  52. </summary>
  53. <remarks>
  54. <p>
  55. Primary purpose of this method is to allow us to parse and
  56. load configuration sections using the same API regardless
  57. of the .NET framework version.
  58. </p>
  59. See also <c>System.Configuration.ConfigurationManager</c>
  60. </remarks>
  61. <param name="sectionName">Name of the configuration section.</param>
  62. <returns>Object created by a corresponding IConfigurationSectionHandler.</returns>
  63. </member>
  64. <member name="T:Common.Logging.ILog">
  65. <summary>
  66. A simple logging interface abstracting logging APIs.
  67. </summary>
  68. <remarks>
  69. <para>
  70. Implementations should defer calling a message's <see cref="M:System.Object.ToString"/> until the message really needs
  71. to be logged to avoid performance penalties.
  72. </para>
  73. <para>
  74. Each <see cref="T:Common.Logging.ILog"/> log method offers to pass in a <see cref="T:System.Action`1"/> instead of the actual message.
  75. Using this style has the advantage to defer possibly expensive message argument evaluation and formatting (and formatting arguments!) until the message gets
  76. actually logged. If the message is not logged at all (e.g. due to <see cref="T:Common.Logging.LogLevel"/> settings),
  77. you won't have to pay the peformance penalty of creating the message.
  78. </para>
  79. </remarks>
  80. <example>
  81. The example below demonstrates using callback style for creating the message, where the call to the
  82. <see cref="M:System.Random.NextDouble"/> and the underlying <see cref="M:System.String.Format(System.String,System.Object[])"/> only happens, if level <see cref="F:Common.Logging.LogLevel.Debug"/> is enabled:
  83. <code>
  84. Log.Debug( m=&gt;m("result is {0}", random.NextDouble()) );
  85. Log.Debug(delegate(m) { m("result is {0}", random.NextDouble()); });
  86. </code>
  87. </example>
  88. <seealso cref="T:System.Action`1"/>
  89. <author>Mark Pollack</author>
  90. <author>Bruno Baia</author>
  91. <author>Erich Eichinger</author>
  92. </member>
  93. <member name="M:Common.Logging.ILog.Trace(System.Object)">
  94. <summary>
  95. Log a message object with the <see cref="F:Common.Logging.LogLevel.Trace"/> level.
  96. </summary>
  97. <param name="message">The message object to log.</param>
  98. </member>
  99. <member name="M:Common.Logging.ILog.Trace(System.Object,System.Exception)">
  100. <summary>
  101. Log a message object with the <see cref="F:Common.Logging.LogLevel.Trace"/> level including
  102. the stack trace of the <see cref="T:System.Exception"/> passed
  103. as a parameter.
  104. </summary>
  105. <param name="message">The message object to log.</param>
  106. <param name="exception">The exception to log, including its stack trace.</param>
  107. </member>
  108. <member name="M:Common.Logging.ILog.TraceFormat(System.String,System.Object[])">
  109. <summary>
  110. Log a message with the <see cref="F:Common.Logging.LogLevel.Trace"/> level.
  111. </summary>
  112. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  113. <param name="args">the list of format arguments</param>
  114. </member>
  115. <member name="M:Common.Logging.ILog.TraceFormat(System.String,System.Exception,System.Object[])">
  116. <summary>
  117. Log a message with the <see cref="F:Common.Logging.LogLevel.Trace"/> level.
  118. </summary>
  119. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  120. <param name="exception">The exception to log.</param>
  121. <param name="args">the list of format arguments</param>
  122. </member>
  123. <member name="M:Common.Logging.ILog.TraceFormat(System.IFormatProvider,System.String,System.Object[])">
  124. <summary>
  125. Log a message with the <see cref="F:Common.Logging.LogLevel.Trace"/> level.
  126. </summary>
  127. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  128. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  129. <param name="args"></param>
  130. </member>
  131. <member name="M:Common.Logging.ILog.TraceFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
  132. <summary>
  133. Log a message with the <see cref="F:Common.Logging.LogLevel.Trace"/> level.
  134. </summary>
  135. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  136. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  137. <param name="exception">The exception to log.</param>
  138. <param name="args"></param>
  139. </member>
  140. <member name="M:Common.Logging.ILog.Trace(System.Action{Common.Logging.FormatMessageHandler})">
  141. <summary>
  142. Log a message with the <see cref="F:Common.Logging.LogLevel.Trace"/> level using a callback to obtain the message
  143. </summary>
  144. <remarks>
  145. Using this method avoids the cost of creating a message and evaluating message arguments
  146. that probably won't be logged due to loglevel settings.
  147. </remarks>
  148. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  149. </member>
  150. <member name="M:Common.Logging.ILog.Trace(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
  151. <summary>
  152. Log a message with the <see cref="F:Common.Logging.LogLevel.Trace"/> level using a callback to obtain the message
  153. </summary>
  154. <remarks>
  155. Using this method avoids the cost of creating a message and evaluating message arguments
  156. that probably won't be logged due to loglevel settings.
  157. </remarks>
  158. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  159. <param name="exception">The exception to log, including its stack trace.</param>
  160. </member>
  161. <member name="M:Common.Logging.ILog.Trace(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
  162. <summary>
  163. Log a message with the <see cref="F:Common.Logging.LogLevel.Trace"/> level using a callback to obtain the message
  164. </summary>
  165. <remarks>
  166. Using this method avoids the cost of creating a message and evaluating message arguments
  167. that probably won't be logged due to loglevel settings.
  168. </remarks>
  169. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  170. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  171. </member>
  172. <member name="M:Common.Logging.ILog.Trace(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
  173. <summary>
  174. Log a message with the <see cref="F:Common.Logging.LogLevel.Trace"/> level using a callback to obtain the message
  175. </summary>
  176. <remarks>
  177. Using this method avoids the cost of creating a message and evaluating message arguments
  178. that probably won't be logged due to loglevel settings.
  179. </remarks>
  180. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  181. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  182. <param name="exception">The exception to log, including its stack trace.</param>
  183. </member>
  184. <member name="M:Common.Logging.ILog.Debug(System.Object)">
  185. <summary>
  186. Log a message object with the <see cref="F:Common.Logging.LogLevel.Debug"/> level.
  187. </summary>
  188. <param name="message">The message object to log.</param>
  189. </member>
  190. <member name="M:Common.Logging.ILog.Debug(System.Object,System.Exception)">
  191. <summary>
  192. Log a message object with the <see cref="F:Common.Logging.LogLevel.Debug"/> level including
  193. the stack trace of the <see cref="T:System.Exception"/> passed
  194. as a parameter.
  195. </summary>
  196. <param name="message">The message object to log.</param>
  197. <param name="exception">The exception to log, including its stack trace.</param>
  198. </member>
  199. <member name="M:Common.Logging.ILog.DebugFormat(System.String,System.Object[])">
  200. <summary>
  201. Log a message with the <see cref="F:Common.Logging.LogLevel.Debug"/> level.
  202. </summary>
  203. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  204. <param name="args">the list of format arguments</param>
  205. </member>
  206. <member name="M:Common.Logging.ILog.DebugFormat(System.String,System.Exception,System.Object[])">
  207. <summary>
  208. Log a message with the <see cref="F:Common.Logging.LogLevel.Debug"/> level.
  209. </summary>
  210. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  211. <param name="exception">The exception to log.</param>
  212. <param name="args">the list of format arguments</param>
  213. </member>
  214. <member name="M:Common.Logging.ILog.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
  215. <summary>
  216. Log a message with the <see cref="F:Common.Logging.LogLevel.Debug"/> level.
  217. </summary>
  218. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  219. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  220. <param name="args"></param>
  221. </member>
  222. <member name="M:Common.Logging.ILog.DebugFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
  223. <summary>
  224. Log a message with the <see cref="F:Common.Logging.LogLevel.Debug"/> level.
  225. </summary>
  226. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  227. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  228. <param name="exception">The exception to log.</param>
  229. <param name="args"></param>
  230. </member>
  231. <member name="M:Common.Logging.ILog.Debug(System.Action{Common.Logging.FormatMessageHandler})">
  232. <summary>
  233. Log a message with the <see cref="F:Common.Logging.LogLevel.Debug"/> level using a callback to obtain the message
  234. </summary>
  235. <remarks>
  236. Using this method avoids the cost of creating a message and evaluating message arguments
  237. that probably won't be logged due to loglevel settings.
  238. </remarks>
  239. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  240. </member>
  241. <member name="M:Common.Logging.ILog.Debug(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
  242. <summary>
  243. Log a message with the <see cref="F:Common.Logging.LogLevel.Debug"/> level using a callback to obtain the message
  244. </summary>
  245. <remarks>
  246. Using this method avoids the cost of creating a message and evaluating message arguments
  247. that probably won't be logged due to loglevel settings.
  248. </remarks>
  249. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  250. <param name="exception">The exception to log, including its stack trace.</param>
  251. </member>
  252. <member name="M:Common.Logging.ILog.Debug(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
  253. <summary>
  254. Log a message with the <see cref="F:Common.Logging.LogLevel.Debug"/> level using a callback to obtain the message
  255. </summary>
  256. <remarks>
  257. Using this method avoids the cost of creating a message and evaluating message arguments
  258. that probably won't be logged due to loglevel settings.
  259. </remarks>
  260. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  261. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  262. </member>
  263. <member name="M:Common.Logging.ILog.Debug(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
  264. <summary>
  265. Log a message with the <see cref="F:Common.Logging.LogLevel.Debug"/> level using a callback to obtain the message
  266. </summary>
  267. <remarks>
  268. Using this method avoids the cost of creating a message and evaluating message arguments
  269. that probably won't be logged due to loglevel settings.
  270. </remarks>
  271. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  272. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  273. <param name="exception">The exception to log, including its stack Debug.</param>
  274. </member>
  275. <member name="M:Common.Logging.ILog.Info(System.Object)">
  276. <summary>
  277. Log a message object with the <see cref="F:Common.Logging.LogLevel.Info"/> level.
  278. </summary>
  279. <param name="message">The message object to log.</param>
  280. </member>
  281. <member name="M:Common.Logging.ILog.Info(System.Object,System.Exception)">
  282. <summary>
  283. Log a message object with the <see cref="F:Common.Logging.LogLevel.Info"/> level including
  284. the stack trace of the <see cref="T:System.Exception"/> passed
  285. as a parameter.
  286. </summary>
  287. <param name="message">The message object to log.</param>
  288. <param name="exception">The exception to log, including its stack trace.</param>
  289. </member>
  290. <member name="M:Common.Logging.ILog.InfoFormat(System.String,System.Object[])">
  291. <summary>
  292. Log a message with the <see cref="F:Common.Logging.LogLevel.Info"/> level.
  293. </summary>
  294. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  295. <param name="args">the list of format arguments</param>
  296. </member>
  297. <member name="M:Common.Logging.ILog.InfoFormat(System.String,System.Exception,System.Object[])">
  298. <summary>
  299. Log a message with the <see cref="F:Common.Logging.LogLevel.Info"/> level.
  300. </summary>
  301. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  302. <param name="exception">The exception to log.</param>
  303. <param name="args">the list of format arguments</param>
  304. </member>
  305. <member name="M:Common.Logging.ILog.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
  306. <summary>
  307. Log a message with the <see cref="F:Common.Logging.LogLevel.Info"/> level.
  308. </summary>
  309. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  310. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  311. <param name="args"></param>
  312. </member>
  313. <member name="M:Common.Logging.ILog.InfoFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
  314. <summary>
  315. Log a message with the <see cref="F:Common.Logging.LogLevel.Info"/> level.
  316. </summary>
  317. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  318. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  319. <param name="exception">The exception to log.</param>
  320. <param name="args"></param>
  321. </member>
  322. <member name="M:Common.Logging.ILog.Info(System.Action{Common.Logging.FormatMessageHandler})">
  323. <summary>
  324. Log a message with the <see cref="F:Common.Logging.LogLevel.Info"/> level using a callback to obtain the message
  325. </summary>
  326. <remarks>
  327. Using this method avoids the cost of creating a message and evaluating message arguments
  328. that probably won't be logged due to loglevel settings.
  329. </remarks>
  330. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  331. </member>
  332. <member name="M:Common.Logging.ILog.Info(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
  333. <summary>
  334. Log a message with the <see cref="F:Common.Logging.LogLevel.Info"/> level using a callback to obtain the message
  335. </summary>
  336. <remarks>
  337. Using this method avoids the cost of creating a message and evaluating message arguments
  338. that probably won't be logged due to loglevel settings.
  339. </remarks>
  340. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  341. <param name="exception">The exception to log, including its stack trace.</param>
  342. </member>
  343. <member name="M:Common.Logging.ILog.Info(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
  344. <summary>
  345. Log a message with the <see cref="F:Common.Logging.LogLevel.Info"/> level using a callback to obtain the message
  346. </summary>
  347. <remarks>
  348. Using this method avoids the cost of creating a message and evaluating message arguments
  349. that probably won't be logged due to loglevel settings.
  350. </remarks>
  351. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  352. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  353. </member>
  354. <member name="M:Common.Logging.ILog.Info(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
  355. <summary>
  356. Log a message with the <see cref="F:Common.Logging.LogLevel.Info"/> level using a callback to obtain the message
  357. </summary>
  358. <remarks>
  359. Using this method avoids the cost of creating a message and evaluating message arguments
  360. that probably won't be logged due to loglevel settings.
  361. </remarks>
  362. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  363. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  364. <param name="exception">The exception to log, including its stack Info.</param>
  365. </member>
  366. <member name="M:Common.Logging.ILog.Warn(System.Object)">
  367. <summary>
  368. Log a message object with the <see cref="F:Common.Logging.LogLevel.Warn"/> level.
  369. </summary>
  370. <param name="message">The message object to log.</param>
  371. </member>
  372. <member name="M:Common.Logging.ILog.Warn(System.Object,System.Exception)">
  373. <summary>
  374. Log a message object with the <see cref="F:Common.Logging.LogLevel.Warn"/> level including
  375. the stack trace of the <see cref="T:System.Exception"/> passed
  376. as a parameter.
  377. </summary>
  378. <param name="message">The message object to log.</param>
  379. <param name="exception">The exception to log, including its stack trace.</param>
  380. </member>
  381. <member name="M:Common.Logging.ILog.WarnFormat(System.String,System.Object[])">
  382. <summary>
  383. Log a message with the <see cref="F:Common.Logging.LogLevel.Warn"/> level.
  384. </summary>
  385. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  386. <param name="args">the list of format arguments</param>
  387. </member>
  388. <member name="M:Common.Logging.ILog.WarnFormat(System.String,System.Exception,System.Object[])">
  389. <summary>
  390. Log a message with the <see cref="F:Common.Logging.LogLevel.Warn"/> level.
  391. </summary>
  392. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  393. <param name="exception">The exception to log.</param>
  394. <param name="args">the list of format arguments</param>
  395. </member>
  396. <member name="M:Common.Logging.ILog.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
  397. <summary>
  398. Log a message with the <see cref="F:Common.Logging.LogLevel.Warn"/> level.
  399. </summary>
  400. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  401. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  402. <param name="args"></param>
  403. </member>
  404. <member name="M:Common.Logging.ILog.WarnFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
  405. <summary>
  406. Log a message with the <see cref="F:Common.Logging.LogLevel.Warn"/> level.
  407. </summary>
  408. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  409. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  410. <param name="exception">The exception to log.</param>
  411. <param name="args"></param>
  412. </member>
  413. <member name="M:Common.Logging.ILog.Warn(System.Action{Common.Logging.FormatMessageHandler})">
  414. <summary>
  415. Log a message with the <see cref="F:Common.Logging.LogLevel.Warn"/> level using a callback to obtain the message
  416. </summary>
  417. <remarks>
  418. Using this method avoids the cost of creating a message and evaluating message arguments
  419. that probably won't be logged due to loglevel settings.
  420. </remarks>
  421. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  422. </member>
  423. <member name="M:Common.Logging.ILog.Warn(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
  424. <summary>
  425. Log a message with the <see cref="F:Common.Logging.LogLevel.Warn"/> level using a callback to obtain the message
  426. </summary>
  427. <remarks>
  428. Using this method avoids the cost of creating a message and evaluating message arguments
  429. that probably won't be logged due to loglevel settings.
  430. </remarks>
  431. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  432. <param name="exception">The exception to log, including its stack trace.</param>
  433. </member>
  434. <member name="M:Common.Logging.ILog.Warn(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
  435. <summary>
  436. Log a message with the <see cref="F:Common.Logging.LogLevel.Warn"/> level using a callback to obtain the message
  437. </summary>
  438. <remarks>
  439. Using this method avoids the cost of creating a message and evaluating message arguments
  440. that probably won't be logged due to loglevel settings.
  441. </remarks>
  442. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  443. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  444. </member>
  445. <member name="M:Common.Logging.ILog.Warn(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
  446. <summary>
  447. Log a message with the <see cref="F:Common.Logging.LogLevel.Warn"/> level using a callback to obtain the message
  448. </summary>
  449. <remarks>
  450. Using this method avoids the cost of creating a message and evaluating message arguments
  451. that probably won't be logged due to loglevel settings.
  452. </remarks>
  453. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  454. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  455. <param name="exception">The exception to log, including its stack Warn.</param>
  456. </member>
  457. <member name="M:Common.Logging.ILog.Error(System.Object)">
  458. <summary>
  459. Log a message object with the <see cref="F:Common.Logging.LogLevel.Error"/> level.
  460. </summary>
  461. <param name="message">The message object to log.</param>
  462. </member>
  463. <member name="M:Common.Logging.ILog.Error(System.Object,System.Exception)">
  464. <summary>
  465. Log a message object with the <see cref="F:Common.Logging.LogLevel.Error"/> level including
  466. the stack trace of the <see cref="T:System.Exception"/> passed
  467. as a parameter.
  468. </summary>
  469. <param name="message">The message object to log.</param>
  470. <param name="exception">The exception to log, including its stack trace.</param>
  471. </member>
  472. <member name="M:Common.Logging.ILog.ErrorFormat(System.String,System.Object[])">
  473. <summary>
  474. Log a message with the <see cref="F:Common.Logging.LogLevel.Error"/> level.
  475. </summary>
  476. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  477. <param name="args">the list of format arguments</param>
  478. </member>
  479. <member name="M:Common.Logging.ILog.ErrorFormat(System.String,System.Exception,System.Object[])">
  480. <summary>
  481. Log a message with the <see cref="F:Common.Logging.LogLevel.Error"/> level.
  482. </summary>
  483. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  484. <param name="exception">The exception to log.</param>
  485. <param name="args">the list of format arguments</param>
  486. </member>
  487. <member name="M:Common.Logging.ILog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
  488. <summary>
  489. Log a message with the <see cref="F:Common.Logging.LogLevel.Error"/> level.
  490. </summary>
  491. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  492. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  493. <param name="args"></param>
  494. </member>
  495. <member name="M:Common.Logging.ILog.ErrorFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
  496. <summary>
  497. Log a message with the <see cref="F:Common.Logging.LogLevel.Error"/> level.
  498. </summary>
  499. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  500. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  501. <param name="exception">The exception to log.</param>
  502. <param name="args"></param>
  503. </member>
  504. <member name="M:Common.Logging.ILog.Error(System.Action{Common.Logging.FormatMessageHandler})">
  505. <summary>
  506. Log a message with the <see cref="F:Common.Logging.LogLevel.Error"/> level using a callback to obtain the message
  507. </summary>
  508. <remarks>
  509. Using this method avoids the cost of creating a message and evaluating message arguments
  510. that probably won't be logged due to loglevel settings.
  511. </remarks>
  512. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  513. </member>
  514. <member name="M:Common.Logging.ILog.Error(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
  515. <summary>
  516. Log a message with the <see cref="F:Common.Logging.LogLevel.Error"/> level using a callback to obtain the message
  517. </summary>
  518. <remarks>
  519. Using this method avoids the cost of creating a message and evaluating message arguments
  520. that probably won't be logged due to loglevel settings.
  521. </remarks>
  522. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  523. <param name="exception">The exception to log, including its stack trace.</param>
  524. </member>
  525. <member name="M:Common.Logging.ILog.Error(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
  526. <summary>
  527. Log a message with the <see cref="F:Common.Logging.LogLevel.Error"/> level using a callback to obtain the message
  528. </summary>
  529. <remarks>
  530. Using this method avoids the cost of creating a message and evaluating message arguments
  531. that probably won't be logged due to loglevel settings.
  532. </remarks>
  533. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  534. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  535. </member>
  536. <member name="M:Common.Logging.ILog.Error(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
  537. <summary>
  538. Log a message with the <see cref="F:Common.Logging.LogLevel.Error"/> level using a callback to obtain the message
  539. </summary>
  540. <remarks>
  541. Using this method avoids the cost of creating a message and evaluating message arguments
  542. that probably won't be logged due to loglevel settings.
  543. </remarks>
  544. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  545. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  546. <param name="exception">The exception to log, including its stack Error.</param>
  547. </member>
  548. <member name="M:Common.Logging.ILog.Fatal(System.Object)">
  549. <summary>
  550. Log a message object with the <see cref="F:Common.Logging.LogLevel.Fatal"/> level.
  551. </summary>
  552. <param name="message">The message object to log.</param>
  553. </member>
  554. <member name="M:Common.Logging.ILog.Fatal(System.Object,System.Exception)">
  555. <summary>
  556. Log a message object with the <see cref="F:Common.Logging.LogLevel.Fatal"/> level including
  557. the stack trace of the <see cref="T:System.Exception"/> passed
  558. as a parameter.
  559. </summary>
  560. <param name="message">The message object to log.</param>
  561. <param name="exception">The exception to log, including its stack trace.</param>
  562. </member>
  563. <member name="M:Common.Logging.ILog.FatalFormat(System.String,System.Object[])">
  564. <summary>
  565. Log a message with the <see cref="F:Common.Logging.LogLevel.Fatal"/> level.
  566. </summary>
  567. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  568. <param name="args">the list of format arguments</param>
  569. </member>
  570. <member name="M:Common.Logging.ILog.FatalFormat(System.String,System.Exception,System.Object[])">
  571. <summary>
  572. Log a message with the <see cref="F:Common.Logging.LogLevel.Fatal"/> level.
  573. </summary>
  574. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  575. <param name="exception">The exception to log.</param>
  576. <param name="args">the list of format arguments</param>
  577. </member>
  578. <member name="M:Common.Logging.ILog.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
  579. <summary>
  580. Log a message with the <see cref="F:Common.Logging.LogLevel.Fatal"/> level.
  581. </summary>
  582. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  583. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  584. <param name="args"></param>
  585. </member>
  586. <member name="M:Common.Logging.ILog.FatalFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
  587. <summary>
  588. Log a message with the <see cref="F:Common.Logging.LogLevel.Fatal"/> level.
  589. </summary>
  590. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  591. <param name="format">The format of the message object to log.<see cref="M:System.String.Format(System.String,System.Object[])"/> </param>
  592. <param name="exception">The exception to log.</param>
  593. <param name="args"></param>
  594. </member>
  595. <member name="M:Common.Logging.ILog.Fatal(System.Action{Common.Logging.FormatMessageHandler})">
  596. <summary>
  597. Log a message with the <see cref="F:Common.Logging.LogLevel.Fatal"/> level using a callback to obtain the message
  598. </summary>
  599. <remarks>
  600. Using this method avoids the cost of creating a message and evaluating message arguments
  601. that probably won't be logged due to loglevel settings.
  602. </remarks>
  603. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  604. </member>
  605. <member name="M:Common.Logging.ILog.Fatal(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
  606. <summary>
  607. Log a message with the <see cref="F:Common.Logging.LogLevel.Fatal"/> level using a callback to obtain the message
  608. </summary>
  609. <remarks>
  610. Using this method avoids the cost of creating a message and evaluating message arguments
  611. that probably won't be logged due to loglevel settings.
  612. </remarks>
  613. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  614. <param name="exception">The exception to log, including its stack trace.</param>
  615. </member>
  616. <member name="M:Common.Logging.ILog.Fatal(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
  617. <summary>
  618. Log a message with the <see cref="F:Common.Logging.LogLevel.Fatal"/> level using a callback to obtain the message
  619. </summary>
  620. <remarks>
  621. Using this method avoids the cost of creating a message and evaluating message arguments
  622. that probably won't be logged due to loglevel settings.
  623. </remarks>
  624. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  625. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  626. </member>
  627. <member name="M:Common.Logging.ILog.Fatal(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
  628. <summary>
  629. Log a message with the <see cref="F:Common.Logging.LogLevel.Fatal"/> level using a callback to obtain the message
  630. </summary>
  631. <remarks>
  632. Using this method avoids the cost of creating a message and evaluating message arguments
  633. that probably won't be logged due to loglevel settings.
  634. </remarks>
  635. <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  636. <param name="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
  637. <param name="exception">The exception to log, including its stack Fatal.</param>
  638. </member>
  639. <member name="P:Common.Logging.ILog.IsTraceEnabled">
  640. <summary>
  641. Checks if this logger is enabled for the <see cref="F:Common.Logging.LogLevel.Trace"/> level.
  642. </summary>
  643. </member>
  644. <member name="P:Common.Logging.ILog.IsDebugEnabled">
  645. <summary>
  646. Checks if this logger is enabled for the <see cref="F:Common.Logging.LogLevel.Debug"/> level.
  647. </summary>
  648. </member>
  649. <member name="P:Common.Logging.ILog.IsErrorEnabled">
  650. <summary>
  651. Checks if this logger is enabled for the <see cref="F:Common.Logging.LogLevel.Error"/> level.
  652. </summary>
  653. </member>
  654. <member name="P:Common.Logging.ILog.IsFatalEnabled">
  655. <summary>
  656. Checks if this logger is enabled for the <see cref="F:Common.Logging.LogLevel.Fatal"/> level.
  657. </summary>
  658. </member>
  659. <member name="P:Common.Logging.ILog.IsInfoEnabled">
  660. <summary>
  661. Checks if this logger is enabled for the <see cref="F:Common.Logging.LogLevel.Info"/> level.
  662. </summary>
  663. </member>
  664. <member name="P:Common.Logging.ILog.IsWarnEnabled">
  665. <summary>
  666. Checks if this logger is enabled for the <see cref="F:Common.Logging.LogLevel.Warn"/> level.
  667. </summary>
  668. </member>
  669. <member name="P:Common.Logging.ILog.GlobalVariablesContext">
  670. <summary>
  671. Returns the global context for variables
  672. </summary>
  673. </member>
  674. <member name="P:Common.Logging.ILog.ThreadVariablesContext">
  675. <summary>
  676. Returns the thread-specific context for variables
  677. </summary>
  678. </member>
  679. <member name="T:Common.Logging.ILoggerFactoryAdapter">
  680. <summary>
  681. LoggerFactoryAdapter interface is used internally by LogManager
  682. Only developers wishing to write new Common.Logging adapters need to
  683. worry about this interface.
  684. </summary>
  685. <author>Gilles Bayon</author>
  686. </member>
  687. <member name="M:Common.Logging.ILoggerFactoryAdapter.GetLogger(System.Type)">
  688. <summary>
  689. Get a ILog instance by type.
  690. </summary>
  691. <param name="type">The type to use for the logger</param>
  692. <returns></returns>
  693. </member>
  694. <member name="M:Common.Logging.ILoggerFactoryAdapter.GetLogger(System.String)">
  695. <summary>
  696. Get a ILog instance by key.
  697. </summary>
  698. <param name="key">The key of the logger</param>
  699. <returns></returns>
  700. </member>
  701. <member name="T:Common.Logging.ILogManager">
  702. <summary>
  703. Interface for LogManager
  704. </summary>
  705. </member>
  706. <member name="M:Common.Logging.ILogManager.Reset">
  707. <summary>
  708. Reset the <see cref="N:Common.Logging"/> infrastructure to its default settings. This means, that configuration settings
  709. will be re-read from section <c>&lt;common/logging&gt;</c> of your <c>app.config</c>.
  710. </summary>
  711. <remarks>
  712. This is mainly used for unit testing, you wouldn't normally use this in your applications.<br/>
  713. <b>Note:</b><see cref="T:Common.Logging.ILog"/> instances already handed out from this LogManager are not(!) affected.
  714. Resetting LogManager only affects new instances being handed out.
  715. </remarks>
  716. </member>
  717. <member name="M:Common.Logging.ILogManager.Reset(Common.Logging.IConfigurationReader)">
  718. <summary>
  719. Reset the <see cref="N:Common.Logging"/> infrastructure to its default settings. This means, that configuration settings
  720. will be re-read from section <c>&lt;common/logging&gt;</c> of your <c>app.config</c>.
  721. </summary>
  722. <remarks>
  723. This is mainly used for unit testing, you wouldn't normally use this in your applications.<br/>
  724. <b>Note:</b><see cref="T:Common.Logging.ILog"/> instances already handed out from this LogManager are not(!) affected.
  725. Resetting LogManager only affects new instances being handed out.
  726. </remarks>
  727. <param name="reader">
  728. the <see cref="T:Common.Logging.IConfigurationReader"/> instance to obtain settings for
  729. re-initializing the LogManager.
  730. </param>
  731. </member>
  732. <member name="M:Common.Logging.ILogManager.GetCurrentClassLogger">
  733. <summary>
  734. Gets the logger by calling <see cref="M:Common.Logging.ILoggerFactoryAdapter.GetLogger(System.Type)"/>
  735. on the currently configured <see cref="P:Common.Logging.ILogManager.Adapter"/> using the type of the calling class.
  736. </summary>
  737. <remarks>
  738. This method needs to inspect the StackTrace in order to determine the calling
  739. class. This of course comes with a performance penalty, thus you shouldn't call it too
  740. often in your application.
  741. </remarks>
  742. <seealso cref="M:Common.Logging.ILogManager.GetLogger(System.Type)"/>
  743. <returns>the logger instance obtained from the current <see cref="P:Common.Logging.ILogManager.Adapter"/></returns>
  744. </member>
  745. <member name="M:Common.Logging.ILogManager.GetLogger``1">
  746. <summary>
  747. Gets the logger by calling <see cref="M:Common.Logging.ILoggerFactoryAdapter.GetLogger(System.Type)"/>
  748. on the currently configured <see cref="P:Common.Logging.ILogManager.Adapter"/> using the specified type.
  749. </summary>
  750. <returns>the logger instance obtained from the current <see cref="P:Common.Logging.ILogManager.Adapter"/></returns>
  751. </member>
  752. <member name="M:Common.Logging.ILogManager.GetLogger(System.Type)">
  753. <summary>
  754. Gets the logger by calling <see cref="M:Common.Logging.ILoggerFactoryAdapter.GetLogger(System.Type)"/>
  755. on the currently configured <see cref="P:Common.Logging.ILogManager.Adapter"/> using the specified type.
  756. </summary>
  757. <param name="type">The type.</param>
  758. <returns>the logger instance obtained from the current <see cref="P:Common.Logging.ILogManager.Adapter"/></returns>
  759. </member>
  760. <member name="M:Common.Logging.ILogManager.GetLogger(System.String)">
  761. <summary>
  762. Gets the logger by calling <see cref="M:Common.Logging.ILoggerFactoryAdapter.GetLogger(System.String)"/>
  763. on the currently configured <see cref="P:Common.Logging.ILogManager.Adapter"/> using the specified key.
  764. </summary>
  765. <param name="key">The key.</param>
  766. <returns>the logger instance obtained from the current <see cref="P:Common.Logging.ILogManager.Adapter"/></returns>
  767. </member>
  768. <member name="P:Common.Logging.ILogManager.COMMON_LOGGING_SECTION">
  769. <summary>
  770. The key of the default configuration section to read settings from.
  771. </summary>
  772. <remarks>
  773. You can always change the source of your configuration settings by setting another <see cref="T:Common.Logging.IConfigurationReader"/> instance
  774. on <see cref="P:Common.Logging.ILogManager.ConfigurationReader"/>.
  775. </remarks>
  776. </member>
  777. <member name="P:Common.Logging.ILogManager.ConfigurationReader">
  778. <summary>
  779. Gets the configuration reader used to initialize the LogManager.
  780. </summary>
  781. <remarks>Primarily used for testing purposes but maybe useful to obtain configuration
  782. information from some place other than the .NET application configuration file.</remarks>
  783. <value>The configuration reader.</value>
  784. </member>
  785. <member name="P:Common.Logging.ILogManager.Adapter">
  786. <summary>
  787. Gets or sets the adapter.
  788. </summary>
  789. <value>The adapter.</value>
  790. </member>
  791. <member name="T:Common.Logging.IVariablesContext">
  792. <summary>
  793. A context for logger variables
  794. </summary>
  795. </member>
  796. <member name="M:Common.Logging.IVariablesContext.Set(System.String,System.Object)">
  797. <summary>
  798. Sets the value of a new or existing variable within the global context
  799. </summary>
  800. <param name="key">The key of the variable that is to be added</param>
  801. <param name="value">The value to add</param>
  802. </member>
  803. <member name="M:Common.Logging.IVariablesContext.Get(System.String)">
  804. <summary>
  805. Gets the value of a variable within the global context
  806. </summary>
  807. <param name="key">The key of the variable to get</param>
  808. <returns>The value or null if not found</returns>
  809. </member>
  810. <member name="M:Common.Logging.IVariablesContext.Contains(System.String)">
  811. <summary>
  812. Checks if a variable is set within the global context
  813. </summary>
  814. <param name="key">The key of the variable to check for</param>
  815. <returns>True if the variable is set</returns>
  816. </member>
  817. <member name="M:Common.Logging.IVariablesContext.Remove(System.String)">
  818. <summary>
  819. Removes a variable from the global context by key
  820. </summary>
  821. <param name="key">The key of the variable to remove</param>
  822. </member>
  823. <member name="M:Common.Logging.IVariablesContext.Clear">
  824. <summary>
  825. Clears the global context variables
  826. </summary>
  827. </member>
  828. <member name="T:Common.Logging.LogLevel">
  829. <summary>
  830. The 7 possible logging levels
  831. </summary>
  832. <author>Gilles Bayon</author>
  833. </member>
  834. <member name="F:Common.Logging.LogLevel.All">
  835. <summary>
  836. All logging levels
  837. </summary>
  838. </member>
  839. <member name="F:Common.Logging.LogLevel.Trace">
  840. <summary>
  841. A trace logging level
  842. </summary>
  843. </member>
  844. <member name="F:Common.Logging.LogLevel.Debug">
  845. <summary>
  846. A debug logging level
  847. </summary>
  848. </member>
  849. <member name="F:Common.Logging.LogLevel.Info">
  850. <summary>
  851. A info logging level
  852. </summary>
  853. </member>
  854. <member name="F:Common.Logging.LogLevel.Warn">
  855. <summary>
  856. A warn logging level
  857. </summary>
  858. </member>
  859. <member name="F:Common.Logging.LogLevel.Error">
  860. <summary>
  861. An error logging level
  862. </summary>
  863. </member>
  864. <member name="F:Common.Logging.LogLevel.Fatal">
  865. <summary>
  866. A fatal logging level
  867. </summary>
  868. </member>
  869. <member name="F:Common.Logging.LogLevel.Off">
  870. <summary>
  871. Do not log anything.
  872. </summary>
  873. </member>
  874. </members>
  875. </doc>