You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

ServiceStack.Common.xml 18 KiB

4 年之前
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>ServiceStack.Common</name>
  5. </assembly>
  6. <members>
  7. <member name="T:ServiceStack.MiniProfiler.Data.ExecuteType">
  8. <summary>
  9. Categories of sql statements.
  10. </summary>
  11. </member>
  12. <member name="F:ServiceStack.MiniProfiler.Data.ExecuteType.None">
  13. <summary>
  14. Unknown
  15. </summary>
  16. </member>
  17. <member name="F:ServiceStack.MiniProfiler.Data.ExecuteType.NonQuery">
  18. <summary>
  19. DML statements that alter database state, e.g. INSERT, UPDATE
  20. </summary>
  21. </member>
  22. <member name="F:ServiceStack.MiniProfiler.Data.ExecuteType.Scalar">
  23. <summary>
  24. Statements that return a single record
  25. </summary>
  26. </member>
  27. <member name="F:ServiceStack.MiniProfiler.Data.ExecuteType.Reader">
  28. <summary>
  29. Statements that iterate over a result set
  30. </summary>
  31. </member>
  32. <member name="T:ServiceStack.MiniProfiler.Data.IDbProfiler">
  33. <summary>
  34. A callback for ProfiledDbConnection and family
  35. </summary>
  36. </member>
  37. <member name="M:ServiceStack.MiniProfiler.Data.IDbProfiler.ExecuteStart(System.Data.Common.DbCommand,ServiceStack.MiniProfiler.Data.ExecuteType)">
  38. <summary>
  39. Called when a command starts executing
  40. </summary>
  41. <param name="profiledDbCommand"></param>
  42. <param name="executeType"></param>
  43. </member>
  44. <member name="M:ServiceStack.MiniProfiler.Data.IDbProfiler.ExecuteFinish(System.Data.Common.DbCommand,ServiceStack.MiniProfiler.Data.ExecuteType,System.Data.Common.DbDataReader)">
  45. <summary>
  46. Called when a reader finishes executing
  47. </summary>
  48. <param name="profiledDbCommand"></param>
  49. <param name="executeType"></param>
  50. <param name="reader"></param>
  51. </member>
  52. <member name="M:ServiceStack.MiniProfiler.Data.IDbProfiler.ReaderFinish(System.Data.Common.DbDataReader)">
  53. <summary>
  54. Called when a reader is done iterating through the data
  55. </summary>
  56. <param name="reader"></param>
  57. </member>
  58. <member name="M:ServiceStack.MiniProfiler.Data.IDbProfiler.OnError(System.Data.Common.DbCommand,ServiceStack.MiniProfiler.Data.ExecuteType,System.Exception)">
  59. <summary>
  60. Called when an error happens during execution of a command
  61. </summary>
  62. <param name="profiledDbCommand"></param>
  63. <param name="executeType"></param>
  64. <param name="exception"></param>
  65. </member>
  66. <member name="P:ServiceStack.MiniProfiler.Data.IDbProfiler.IsActive">
  67. <summary>
  68. True if the profiler instance is active
  69. </summary>
  70. </member>
  71. <member name="T:ServiceStack.MiniProfiler.Data.ProfiledConnection">
  72. <summary>
  73. Wraps a database connection, allowing sql execution timings to be collected when a <see cref="T:ServiceStack.MiniProfiler.Data.IDbProfiler"/> session is started.
  74. </summary>
  75. </member>
  76. <member name="M:ServiceStack.MiniProfiler.Data.ProfiledConnection.#ctor(System.Data.Common.DbConnection,ServiceStack.MiniProfiler.Data.IDbProfiler,System.Boolean)">
  77. <summary>
  78. Returns a new <see cref="T:ServiceStack.MiniProfiler.Data.ProfiledConnection"/> that wraps <paramref name="connection"/>,
  79. providing query execution profiling. If profiler is null, no profiling will occur.
  80. </summary>
  81. <param name="connection">Your provider-specific flavor of connection, e.g. SqlConnection, OracleConnection</param>
  82. <param name="profiler">The currently started <see cref="T:ServiceStack.MiniProfiler.Data.IDbProfiler"/> or null.</param>
  83. <param name="autoDisposeConnection">Determines whether the ProfiledDbConnection will dispose the underlying connection.</param>
  84. </member>
  85. <member name="P:ServiceStack.MiniProfiler.Data.ProfiledConnection.InnerConnection">
  86. <summary>
  87. The underlying, real database connection to your db provider.
  88. </summary>
  89. </member>
  90. <member name="P:ServiceStack.MiniProfiler.Data.ProfiledConnection.Profiler">
  91. <summary>
  92. The current profiler instance; could be null.
  93. </summary>
  94. </member>
  95. <member name="P:ServiceStack.MiniProfiler.Data.ProfiledConnection.WrappedConnection">
  96. <summary>
  97. The raw connection this is wrapping
  98. </summary>
  99. </member>
  100. <member name="T:ServiceStack.MiniProfiler.Data.ProfiledProviderFactory">
  101. <summary>
  102. Wrapper for a db provider factory to enable profiling
  103. </summary>
  104. </member>
  105. <member name="F:ServiceStack.MiniProfiler.Data.ProfiledProviderFactory.Instance">
  106. <summary>
  107. Every provider factory must have an Instance public field
  108. </summary>
  109. </member>
  110. <member name="M:ServiceStack.MiniProfiler.Data.ProfiledProviderFactory.InitProfiledDbProviderFactory(ServiceStack.MiniProfiler.Data.IDbProfiler,System.Data.Common.DbProviderFactory)">
  111. <summary>
  112. Allow to re-init the provider factory.
  113. </summary>
  114. <param name="profiler"></param>
  115. <param name="wrappedFactory"></param>
  116. </member>
  117. <member name="M:ServiceStack.MiniProfiler.Data.ProfiledProviderFactory.#ctor(ServiceStack.MiniProfiler.Data.IDbProfiler,System.Data.Common.DbProviderFactory)">
  118. <summary>
  119. proxy
  120. </summary>
  121. <param name="profiler"></param>
  122. <param name="wrappedFactory"></param>
  123. </member>
  124. <member name="P:ServiceStack.MiniProfiler.Data.ProfiledProviderFactory.CanCreateDataSourceEnumerator">
  125. <summary>
  126. proxy
  127. </summary>
  128. </member>
  129. <member name="M:ServiceStack.MiniProfiler.Data.ProfiledProviderFactory.CreateDataSourceEnumerator">
  130. <summary>
  131. proxy
  132. </summary>
  133. </member>
  134. <member name="M:ServiceStack.MiniProfiler.Data.ProfiledProviderFactory.CreateCommand">
  135. <summary>
  136. proxy
  137. </summary>
  138. </member>
  139. <member name="M:ServiceStack.MiniProfiler.Data.ProfiledProviderFactory.CreateConnection">
  140. <summary>
  141. proxy
  142. </summary>
  143. </member>
  144. <member name="M:ServiceStack.MiniProfiler.Data.ProfiledProviderFactory.CreateParameter">
  145. <summary>
  146. proxy
  147. </summary>
  148. </member>
  149. <member name="M:ServiceStack.MiniProfiler.Data.ProfiledProviderFactory.CreateConnectionStringBuilder">
  150. <summary>
  151. proxy
  152. </summary>
  153. </member>
  154. <member name="M:ServiceStack.MiniProfiler.Data.ProfiledProviderFactory.CreateCommandBuilder">
  155. <summary>
  156. proxy
  157. </summary>
  158. </member>
  159. <member name="M:ServiceStack.MiniProfiler.Data.ProfiledProviderFactory.CreateDataAdapter">
  160. <summary>
  161. proxy
  162. </summary>
  163. </member>
  164. <member name="M:ServiceStack.MiniProfiler.Data.ProfiledProviderFactory.CreatePermission(System.Security.Permissions.PermissionState)">
  165. <summary>
  166. proxy
  167. </summary>
  168. </member>
  169. <member name="M:ServiceStack.EnumerableExtensions.Safe``1(System.Collections.Generic.IEnumerable{``0})">
  170. <summary>
  171. Return T[0] when enumerable is null, safe to use in enumerations like foreach
  172. </summary>
  173. </member>
  174. <member name="M:ServiceStack.EnumExtensions.ToDescription(System.Enum)">
  175. <summary>
  176. Gets the textual description of the enum if it has one. e.g.
  177. <code>
  178. enum UserColors
  179. {
  180. [Description("Bright Red")]
  181. BrightRed
  182. }
  183. UserColors.BrightRed.ToDescription();
  184. </code>
  185. </summary>
  186. <param name="enum"></param>
  187. <returns></returns>
  188. </member>
  189. <member name="T:ServiceStack.Logging.ConsoleLogFactory">
  190. <summary>
  191. Creates a Console Logger, that logs all messages to: System.Console
  192. Made public so its testable
  193. </summary>
  194. </member>
  195. <member name="T:ServiceStack.Logging.ConsoleLogger">
  196. <summary>
  197. Default logger is to Console.WriteLine
  198. Made public so its testable
  199. </summary>
  200. </member>
  201. <member name="M:ServiceStack.Logging.ConsoleLogger.#ctor(System.String)">
  202. <summary>
  203. Initializes a new instance of the <see cref="T:ServiceStack.Logging.DebugLogger"/> class.
  204. </summary>
  205. </member>
  206. <member name="M:ServiceStack.Logging.ConsoleLogger.#ctor(System.Type)">
  207. <summary>
  208. Initializes a new instance of the <see cref="T:ServiceStack.Logging.DebugLogger"/> class.
  209. </summary>
  210. </member>
  211. <member name="M:ServiceStack.Logging.ConsoleLogger.Log(System.Object,System.Exception)">
  212. <summary>
  213. Logs the specified message.
  214. </summary>
  215. </member>
  216. <member name="M:ServiceStack.Logging.ConsoleLogger.LogFormat(System.Object,System.Object[])">
  217. <summary>
  218. Logs the format.
  219. </summary>
  220. </member>
  221. <member name="M:ServiceStack.Logging.ConsoleLogger.Log(System.Object)">
  222. <summary>
  223. Logs the specified message.
  224. </summary>
  225. </member>
  226. <member name="T:ServiceStack.Logging.DebugLogFactory">
  227. <summary>
  228. Creates a Debug Logger, that logs all messages to: System.Diagnostics.Debug
  229. Made public so its testable
  230. </summary>
  231. </member>
  232. <member name="T:ServiceStack.Logging.DebugLogger">
  233. <summary>
  234. Default logger is to System.Diagnostics.Debug.WriteLine
  235. Made public so its testable
  236. </summary>
  237. </member>
  238. <member name="M:ServiceStack.Logging.DebugLogger.#ctor(System.String)">
  239. <summary>
  240. Initializes a new instance of the <see cref="T:ServiceStack.Logging.DebugLogger"/> class.
  241. </summary>
  242. </member>
  243. <member name="M:ServiceStack.Logging.DebugLogger.#ctor(System.Type)">
  244. <summary>
  245. Initializes a new instance of the <see cref="T:ServiceStack.Logging.DebugLogger"/> class.
  246. </summary>
  247. </member>
  248. <member name="M:ServiceStack.Logging.DebugLogger.Log(System.Object,System.Exception)">
  249. <summary>
  250. Logs the specified message.
  251. </summary>
  252. </member>
  253. <member name="M:ServiceStack.Logging.DebugLogger.LogFormat(System.Object,System.Object[])">
  254. <summary>
  255. Logs the format.
  256. </summary>
  257. </member>
  258. <member name="M:ServiceStack.Logging.DebugLogger.Log(System.Object)">
  259. <summary>
  260. Logs the specified message.
  261. </summary>
  262. </member>
  263. <member name="M:ServiceStack.Reflection.PropertyAccessor`1.TypedGetPropertyFn``1">
  264. <summary>
  265. Func to get the Strongly-typed field
  266. </summary>
  267. </member>
  268. <member name="M:ServiceStack.Reflection.PropertyAccessor`1.ValueTypedGetPropertyFn``1">
  269. <summary>
  270. Required to cast the return ValueType to an object for caching
  271. </summary>
  272. </member>
  273. <member name="M:ServiceStack.Reflection.PropertyAccessor`1.TypedSetPropertyFn``1">
  274. <summary>
  275. Func to set the Strongly-typed field
  276. </summary>
  277. </member>
  278. <member name="M:ServiceStack.Reflection.PropertyAccessor`1.ValueTypesSetPropertyFn``1">
  279. <summary>
  280. Required to cast the ValueType to an object for caching
  281. </summary>
  282. </member>
  283. <member name="M:ServiceStack.Reflection.PropertyAccessor`1.UnTypedSetPropertyFn``1">
  284. <summary>
  285. Required to cast the ValueType to an object for caching
  286. </summary>
  287. </member>
  288. <member name="M:ServiceStack.Reflection.StaticAccessors`1.TypedGetPropertyFn``1(System.Reflection.PropertyInfo)">
  289. <summary>
  290. Func to get the Strongly-typed field
  291. </summary>
  292. </member>
  293. <member name="M:ServiceStack.Reflection.StaticAccessors`1.ValueUnTypedGetPropertyFn``1(System.Reflection.PropertyInfo)">
  294. <summary>
  295. Required to cast the return ValueType to an object for caching
  296. </summary>
  297. </member>
  298. <member name="M:ServiceStack.Reflection.StaticAccessors`1.TypedSetPropertyFn``1(System.Reflection.PropertyInfo)">
  299. <summary>
  300. Func to set the Strongly-typed field
  301. </summary>
  302. </member>
  303. <member name="M:ServiceStack.Reflection.StaticAccessors`1.ValueUnTypedSetPropertyFn``1(System.Reflection.PropertyInfo)">
  304. <summary>
  305. Required to cast the ValueType to an object for caching
  306. </summary>
  307. </member>
  308. <member name="M:ServiceStack.Reflection.StaticAccessors`1.UnTypedSetPropertyFn``1(System.Reflection.PropertyInfo)">
  309. <summary>
  310. Required to cast the ValueType to an object for caching
  311. </summary>
  312. </member>
  313. <member name="T:ServiceStack.IPAddressExtensions">
  314. <summary>
  315. Useful IPAddressExtensions from:
  316. http://blogs.msdn.com/knom/archive/2008/12/31/ip-address-calculations-with-c-subnetmasks-networks.aspx
  317. </summary>
  318. </member>
  319. <member name="M:ServiceStack.IPAddressExtensions.GetAllNetworkInterfaceIpv4Addresses">
  320. <summary>
  321. Gets the ipv4 addresses from all Network Interfaces that have Subnet masks.
  322. </summary>
  323. <returns></returns>
  324. </member>
  325. <member name="M:ServiceStack.IPAddressExtensions.GetAllNetworkInterfaceIpv6Addresses">
  326. <summary>
  327. Gets the ipv6 addresses from all Network Interfaces.
  328. </summary>
  329. <returns></returns>
  330. </member>
  331. <member name="T:ServiceStack.Support.AdapterBase">
  332. <summary>
  333. Common functionality when creating adapters
  334. </summary>
  335. </member>
  336. <member name="M:ServiceStack.Support.AdapterBase.Execute``1(System.Func{``0})">
  337. <summary>
  338. Executes the specified expression.
  339. </summary>
  340. <typeparam name="T"></typeparam>
  341. <param name="action">The action.</param>
  342. <returns></returns>
  343. </member>
  344. <member name="M:ServiceStack.Support.AdapterBase.Execute(System.Action)">
  345. <summary>
  346. Executes the specified action (for void methods).
  347. </summary>
  348. <param name="action">The action.</param>
  349. </member>
  350. <member name="T:ServiceStack.Support.InMemoryLogFactory">
  351. <summary>
  352. Note: InMemoryLog keeps all logs in memory, so don't use it long running exceptions
  353. Returns a thread-safe InMemoryLog which you can use while *TESTING*
  354. to provide a detailed analysis of your logs.
  355. </summary>
  356. </member>
  357. <member name="T:ServiceStack.UrnId">
  358. <summary>
  359. Creates a Unified Resource Name (URN) with the following formats:
  360. - urn:{TypeName}:{IdFieldValue} e.g. urn:UserSession:1
  361. - urn:{TypeName}:{IdFieldName}:{IdFieldValue} e.g. urn:UserSession:UserId:1
  362. </summary>
  363. </member>
  364. <!-- Badly formed XML comment ignored for member "M:ServiceStack.AssertUtils.AreNotNull(System.Collections.Generic.IDictionary{System.String,System.Object})" -->
  365. <member name="M:ServiceStack.CommandsUtils.ExecuteAsyncCommandExec(System.Collections.Generic.IEnumerable{ServiceStack.Commands.ICommandExec})">
  366. <summary>
  367. Provide the an option for the callee to block until all commands are executed
  368. </summary>
  369. <param name="commands"></param>
  370. <returns></returns>
  371. </member>
  372. <member name="M:ServiceStack.FuncUtils.TryExec(System.Action)">
  373. <summary>
  374. Invokes the action provided and returns true if no excpetion was thrown.
  375. Otherwise logs the exception and returns false if an exception was thrown.
  376. </summary>
  377. <param name="action">The action.</param>
  378. <returns></returns>
  379. </member>
  380. <member name="M:ServiceStack.PerfUtils.MeasureFor(System.Action,System.Int32)">
  381. <summary>
  382. Runs an action for a minimum of runForMs
  383. </summary>
  384. <param name="fn">What to run</param>
  385. <param name="runForMs">Minimum ms to run for</param>
  386. <returns>time elapsed in micro seconds</returns>
  387. </member>
  388. <member name="M:ServiceStack.PerfUtils.Measure(System.Action,System.Int32,System.Int32,System.Action,System.Action,System.Action)">
  389. <summary>
  390. Returns average microseconds an action takes when run for the specified runForMs
  391. </summary>
  392. <param name="fn">What to run</param>
  393. <param name="times">How many times to run for each iteration</param>
  394. <param name="runForMs">Minimum ms to run for</param>
  395. <param name="setup"></param>
  396. <param name="warmup"></param>
  397. <param name="teardown"></param>
  398. <returns></returns>
  399. </member>
  400. </members>
  401. </doc>