ServiceStack.Common.xml 46 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>ServiceStack.Common</name>
  5. </assembly>
  6. <members>
  7. <member name="T:ServiceStack.Common.CryptUtils">
  8. <summary>
  9. Useful .NET Encryption Utils from:
  10. http://andrewlocatelliwoodcock.com/2011/08/01/implementing-rsa-asymmetric-public-private-key-encryption-in-c-encrypting-under-the-public-key/
  11. </summary>
  12. </member>
  13. <member name="M:ServiceStack.Common.CryptUtils.Encrypt(System.String,System.String,ServiceStack.Common.RsaKeyLengths)">
  14. <summary>
  15. Encrypt an arbitrary string of data under the supplied public key
  16. </summary>
  17. <param name="publicKey">The public key to encrypt under</param>
  18. <param name="data">The data to encrypt</param>
  19. <param name="length">The bit length or strength of the public key: 1024, 2048 or 4096 bits. This must match the
  20. value actually used to create the publicKey</param>
  21. <returns></returns>
  22. </member>
  23. <member name="M:ServiceStack.Common.EnumExtensions.ToDescription(System.Enum)">
  24. <summary>
  25. Gets the textual description of the enum if it has one. e.g.
  26. <code>
  27. enum UserColors
  28. {
  29. [Description("Bright Red")]
  30. BrightRed
  31. }
  32. UserColors.BrightRed.ToDescription();
  33. </code>
  34. </summary>
  35. <param name="enum"></param>
  36. <returns></returns>
  37. </member>
  38. <member name="T:ServiceStack.Common.Extensions.EnumerableExtensions">
  39. <summary>
  40. These extensions have a potential to conflict with the LINQ extensions methods so
  41. leaving the implmentation in the 'Extensions' sub-namespace to force explicit opt-in
  42. </summary>
  43. </member>
  44. <member name="M:ServiceStack.Common.HostContext.TrackDisposable(System.IDisposable)">
  45. <summary>
  46. Track any IDisposable's to dispose of at the end of the request in IAppHost.OnEndRequest()
  47. </summary>
  48. <param name="instance"></param>
  49. </member>
  50. <member name="P:ServiceStack.Common.HostContext.Items">
  51. <summary>
  52. Gets a list of items for this request.
  53. </summary>
  54. <remarks>This list will be cleared on every request and is specific to the original thread that is handling the request.
  55. If a handler uses additional threads, this data will not be available on those threads.
  56. </remarks>
  57. </member>
  58. <member name="T:ServiceStack.Common.Extensions.IPAddressExtensions">
  59. <summary>
  60. Useful IPAddressExtensions from:
  61. http://blogs.msdn.com/knom/archive/2008/12/31/ip-address-calculations-with-c-subnetmasks-networks.aspx
  62. </summary>
  63. </member>
  64. <member name="M:ServiceStack.Common.Extensions.IPAddressExtensions.GetAllNetworkInterfaceIpv4Addresses">
  65. <summary>
  66. Gets the ipv4 addresses from all Network Interfaces that have Subnet masks.
  67. </summary>
  68. <returns></returns>
  69. </member>
  70. <member name="M:ServiceStack.Common.Extensions.IPAddressExtensions.GetAllNetworkInterfaceIpv6Addresses">
  71. <summary>
  72. Gets the ipv6 addresses from all Network Interfaces.
  73. </summary>
  74. <returns></returns>
  75. </member>
  76. <member name="T:ServiceStack.Messaging.IMessageHandler">
  77. <summary>
  78. Single threaded message handler that can process all messages
  79. of a particular message type.
  80. </summary>
  81. </member>
  82. <member name="M:ServiceStack.Messaging.IMessageHandler.Process(ServiceStack.Messaging.IMessageQueueClient)">
  83. <summary>
  84. Process all messages pending
  85. </summary>
  86. <param name="mqClient"></param>
  87. </member>
  88. <member name="M:ServiceStack.Messaging.IMessageHandler.ProcessQueue(ServiceStack.Messaging.IMessageQueueClient,System.String,System.Func{System.Boolean})">
  89. <summary>
  90. Process messages from a single queue.
  91. </summary>
  92. <param name="mqClient"></param>
  93. <param name="queueName">The queue to process</param>
  94. <param name="doNext">A predicate on whether to continue processing the next message if any</param>
  95. <returns></returns>
  96. </member>
  97. <member name="M:ServiceStack.Messaging.IMessageHandler.GetStats">
  98. <summary>
  99. Get Current Stats for this Message Handler
  100. </summary>
  101. <returns></returns>
  102. </member>
  103. <member name="P:ServiceStack.Messaging.IMessageHandler.MessageType">
  104. <summary>
  105. The type of the message this handler processes
  106. </summary>
  107. </member>
  108. <member name="T:ServiceStack.Messaging.IMessageHandlerFactory">
  109. <summary>
  110. Encapsulates creating a new message handler
  111. </summary>
  112. </member>
  113. <member name="T:ServiceStack.Messaging.MessageHandler`1">
  114. <summary>
  115. Processes all messages in a Normal and Priority Queue.
  116. Expects to be called in 1 thread. i.e. Non Thread-Safe.
  117. </summary>
  118. <typeparam name="T"></typeparam>
  119. </member>
  120. <member name="M:ServiceStack.Messaging.MessageQueueClientFactory.GetMessageAsync(System.String)">
  121. <summary>
  122. Returns the next message from queueName or null if no message
  123. </summary>
  124. <param name="queueName"></param>
  125. <returns></returns>
  126. </member>
  127. <member name="T:ServiceStack.Messaging.Rcon.Client">
  128. <summary>
  129. Base rcon class.
  130. </summary>
  131. </member>
  132. <member name="F:ServiceStack.Messaging.Rcon.Client._sock">
  133. <summary>
  134. Rcon connection socket. Always set to null when not connected.
  135. </summary>
  136. </member>
  137. <member name="F:ServiceStack.Messaging.Rcon.Client._sequenceID">
  138. <summary>
  139. Unique ID for each message.
  140. </summary>
  141. </member>
  142. <member name="F:ServiceStack.Messaging.Rcon.Client._registeredCallbacks">
  143. <summary>
  144. Registered callbacks.
  145. </summary>
  146. </member>
  147. <member name="M:ServiceStack.Messaging.Rcon.Client.#ctor(System.Net.IPEndPoint)">
  148. <summary>
  149. Create a new instance of rcon.
  150. </summary>
  151. <param name="rconEndpoint">Endpoint to connect to, usually the game server with query port.</param>
  152. </member>
  153. <member name="M:ServiceStack.Messaging.Rcon.Client.Connect">
  154. <summary>
  155. Attempts to connect to the game server for rcon operations.
  156. </summary>
  157. <returns>True if connection established, false otherwise.</returns>
  158. </member>
  159. <member name="M:ServiceStack.Messaging.Rcon.Client.ProcessPacket(System.Byte[],ServiceStack.Messaging.Rcon.ClientSocketState)">
  160. <summary>
  161. Processes a received packet.
  162. </summary>
  163. <param name="packet">The packet.</param>
  164. </member>
  165. <member name="M:ServiceStack.Messaging.Rcon.Client.Disconnect">
  166. <summary>
  167. Disconnects from rcon.
  168. </summary>
  169. </member>
  170. <member name="M:ServiceStack.Messaging.Rcon.Client.InternalSend(System.Byte[][])">
  171. <summary>
  172. Sends message to the server.
  173. </summary>
  174. <param name="words">Words to send.</param>
  175. </member>
  176. <member name="E:ServiceStack.Messaging.Rcon.Client.OnDisconnected">
  177. <summary>
  178. Disconnected event.
  179. </summary>
  180. </member>
  181. <member name="P:ServiceStack.Messaging.Rcon.Client.Endpoint">
  182. <summary>
  183. Game server endpoint.
  184. </summary>
  185. </member>
  186. <member name="P:ServiceStack.Messaging.Rcon.Client.LastException">
  187. <summary>
  188. Last exception that occured during operation.
  189. </summary>
  190. </member>
  191. <member name="P:ServiceStack.Messaging.Rcon.Client.Connected">
  192. <summary>
  193. Connected?
  194. </summary>
  195. </member>
  196. <member name="P:ServiceStack.Messaging.Rcon.Client.SequenceID">
  197. <summary>
  198. Gets the next unique ID to be used for transmisson. Read this before sending to pair responses to sent messages.
  199. </summary>
  200. </member>
  201. <member name="T:ServiceStack.Messaging.Rcon.Client.OnDisconnectedHandler">
  202. <summary>
  203. Event delegate when disconnected from the server.
  204. </summary>
  205. <param name="rcon"></param>
  206. </member>
  207. <member name="T:ServiceStack.Messaging.Rcon.Client.AsyncCallback">
  208. <summary>
  209. Delegate for async callbacks.
  210. </summary>
  211. <param name="rcon"></param>
  212. <param name="packet"></param>
  213. </member>
  214. <member name="T:ServiceStack.Messaging.Rcon.NotConnectedException">
  215. <summary>
  216. Exception thrown when attempting to send on a non-connected service client.
  217. </summary>
  218. </member>
  219. <member name="P:ServiceStack.Messaging.Rcon.Packet.FromServer">
  220. <summary>
  221. True if the packet originated on the server.
  222. </summary>
  223. </member>
  224. <member name="P:ServiceStack.Messaging.Rcon.Packet.IsResponse">
  225. <summary>
  226. True if the packet is a response from a sent packet.
  227. </summary>
  228. </member>
  229. <member name="P:ServiceStack.Messaging.Rcon.Packet.Sequence">
  230. <summary>
  231. Sequence identifier. Unique to the connection.
  232. </summary>
  233. </member>
  234. <member name="P:ServiceStack.Messaging.Rcon.Packet.Words">
  235. <summary>
  236. Words.
  237. </summary>
  238. </member>
  239. <member name="T:ServiceStack.Messaging.Rcon.PacketCodec">
  240. <summary>
  241. Contains methods required for encoding and decoding rcon packets.
  242. </summary>
  243. </member>
  244. <member name="M:ServiceStack.Messaging.Rcon.PacketCodec.DecodePacket(System.Byte[])">
  245. <summary>
  246. Decodes a packet.
  247. </summary>
  248. <param name="packet">The packet.</param>
  249. <returns>A packet object.</returns>
  250. </member>
  251. <member name="M:ServiceStack.Messaging.Rcon.PacketCodec.DecodeHeader(System.Byte[])">
  252. <summary>
  253. Decodes the packet header.
  254. </summary>
  255. <param name="packet"></param>
  256. <returns></returns>
  257. </member>
  258. <member name="M:ServiceStack.Messaging.Rcon.PacketCodec.DecodeWords(System.Byte[])">
  259. <summary>
  260. Decodes words in a packet.
  261. </summary>
  262. <param name="packet"></param>
  263. <returns></returns>
  264. </member>
  265. <member name="M:ServiceStack.Messaging.Rcon.PacketCodec.EncodePacket(System.Boolean,System.Boolean,System.UInt32,System.Byte[][])">
  266. <summary>
  267. Encodes a packet for transmission to the server.
  268. </summary>
  269. <param name="fromServer"></param>
  270. <param name="isResponse"></param>
  271. <param name="id"></param>
  272. <param name="words"></param>
  273. <returns></returns>
  274. </member>
  275. <member name="M:ServiceStack.Messaging.Rcon.PacketCodec.EncodeHeader(System.Boolean,System.Boolean,System.UInt32)">
  276. <summary>
  277. Encodes a packet header.
  278. </summary>
  279. <param name="fromServer"></param>
  280. <param name="isResponse"></param>
  281. <param name="id"></param>
  282. <returns></returns>
  283. </member>
  284. <member name="M:ServiceStack.Messaging.Rcon.PacketCodec.EncodeWords(System.Byte[][])">
  285. <summary>
  286. Encodes words.
  287. </summary>
  288. <param name="words"></param>
  289. <returns></returns>
  290. </member>
  291. <member name="T:ServiceStack.Messaging.Rcon.ProcessingClient">
  292. <summary>
  293. Processing client used to interface with ServiceStack and allow a message to be processed.
  294. Not an actual client.
  295. </summary>
  296. </member>
  297. <member name="M:ServiceStack.Messaging.Rcon.ProcessingClient.Publish(System.String,System.Byte[])">
  298. <summary>
  299. Publish the specified message into the durable queue @queueName
  300. </summary>
  301. <param name="queueName"></param>
  302. <param name="messageBytes"></param>
  303. </member>
  304. <member name="M:ServiceStack.Messaging.Rcon.ProcessingClient.Notify(System.String,System.Byte[])">
  305. <summary>
  306. Publish the specified message into the transient queue @queueName
  307. </summary>
  308. <param name="queueName"></param>
  309. <param name="messageBytes"></param>
  310. </member>
  311. <member name="M:ServiceStack.Messaging.Rcon.ProcessingClient.Get(System.String,System.Nullable{System.TimeSpan})">
  312. <summary>
  313. Synchronous blocking get.
  314. </summary>
  315. <param name="queueName"></param>
  316. <param name="timeOut"></param>
  317. <returns></returns>
  318. </member>
  319. <member name="M:ServiceStack.Messaging.Rcon.ProcessingClient.GetAsync(System.String)">
  320. <summary>
  321. Non blocking get message
  322. </summary>
  323. <param name="queueName"></param>
  324. <returns></returns>
  325. </member>
  326. <member name="M:ServiceStack.Messaging.Rcon.ProcessingClient.WaitForNotifyOnAny(System.String[])">
  327. <summary>
  328. Blocking wait for notifications on any of the supplied channels
  329. </summary>
  330. <param name="channelNames"></param>
  331. <returns></returns>
  332. </member>
  333. <member name="T:ServiceStack.Messaging.Rcon.Server">
  334. <summary>
  335. Hosting services via a binary-safe TCP-based protocol.
  336. </summary>
  337. </member>
  338. <member name="M:ServiceStack.Messaging.Rcon.Server.RegisterHandler``1(System.Func{ServiceStack.Messaging.IMessage{``0},System.Object})">
  339. <summary>
  340. Register DTOs and hanlders the MQ Host will process
  341. </summary>
  342. <typeparam name="T"></typeparam>
  343. <param name="processMessageFn"></param>
  344. </member>
  345. <member name="M:ServiceStack.Messaging.Rcon.Server.GetStatus">
  346. <summary>
  347. Get Total Current Stats for all Message Handlers
  348. </summary>
  349. <returns></returns>
  350. </member>
  351. <member name="M:ServiceStack.Messaging.Rcon.Server.GetStatsDescription">
  352. <summary>
  353. Get a Stats dump
  354. </summary>
  355. <returns></returns>
  356. </member>
  357. <member name="M:ServiceStack.Messaging.Rcon.Server.Start">
  358. <summary>
  359. Start the MQ Host. Stops the server and restarts if already started.
  360. </summary>
  361. </member>
  362. <member name="M:ServiceStack.Messaging.Rcon.Server.Stop">
  363. <summary>
  364. Stop the MQ Host if not already stopped.
  365. </summary>
  366. </member>
  367. <member name="M:ServiceStack.Messaging.Rcon.Server.ProcessPacket(System.Byte[],System.Net.Sockets.Socket,ServiceStack.Messaging.Rcon.ClientSocketState)">
  368. <summary>
  369. Processes a received packet.
  370. </summary>
  371. <param name="packet">The packet.</param>
  372. </member>
  373. <member name="P:ServiceStack.Messaging.Rcon.Server.MessageFactory">
  374. <summary>
  375. Factory to create consumers and producers that work with this service
  376. </summary>
  377. </member>
  378. <member name="T:ServiceStack.Net30.ExtendTuple">
  379. <summary>
  380. Helper extensions for tuples
  381. </summary>
  382. </member>
  383. <member name="M:ServiceStack.Common.Reflection.PropertyAccessor`1.TypedGetPropertyFn``1">
  384. <summary>
  385. Func to get the Strongly-typed field
  386. </summary>
  387. </member>
  388. <member name="M:ServiceStack.Common.Reflection.PropertyAccessor`1.ValueTypedGetPropertyFn``1">
  389. <summary>
  390. Required to cast the return ValueType to an object for caching
  391. </summary>
  392. </member>
  393. <member name="M:ServiceStack.Common.Reflection.PropertyAccessor`1.TypedSetPropertyFn``1">
  394. <summary>
  395. Func to set the Strongly-typed field
  396. </summary>
  397. </member>
  398. <member name="M:ServiceStack.Common.Reflection.PropertyAccessor`1.ValueTypesSetPropertyFn``1">
  399. <summary>
  400. Required to cast the ValueType to an object for caching
  401. </summary>
  402. </member>
  403. <member name="M:ServiceStack.Common.Reflection.PropertyAccessor`1.UnTypedSetPropertyFn``1">
  404. <summary>
  405. Required to cast the ValueType to an object for caching
  406. </summary>
  407. </member>
  408. <member name="M:ServiceStack.Common.Reflection.StaticAccessors`1.TypedGetPropertyFn``1(System.Reflection.PropertyInfo)">
  409. <summary>
  410. Func to get the Strongly-typed field
  411. </summary>
  412. </member>
  413. <member name="M:ServiceStack.Common.Reflection.StaticAccessors`1.ValueUnTypedGetPropertyFn``1(System.Reflection.PropertyInfo)">
  414. <summary>
  415. Required to cast the return ValueType to an object for caching
  416. </summary>
  417. </member>
  418. <member name="M:ServiceStack.Common.Reflection.StaticAccessors`1.TypedSetPropertyFn``1(System.Reflection.PropertyInfo)">
  419. <summary>
  420. Func to set the Strongly-typed field
  421. </summary>
  422. </member>
  423. <member name="M:ServiceStack.Common.Reflection.StaticAccessors`1.ValueUnTypedSetPropertyFn``1(System.Reflection.PropertyInfo)">
  424. <summary>
  425. Required to cast the ValueType to an object for caching
  426. </summary>
  427. </member>
  428. <member name="M:ServiceStack.Common.Reflection.StaticAccessors`1.UnTypedSetPropertyFn``1(System.Reflection.PropertyInfo)">
  429. <summary>
  430. Required to cast the ValueType to an object for caching
  431. </summary>
  432. </member>
  433. <member name="T:ServiceStack.ServiceClient.Web.AsyncServiceClient">
  434. Need to provide async request options
  435. http://msdn.microsoft.com/en-us/library/86wf6409(VS.71).aspx
  436. </member>
  437. <member name="P:ServiceStack.ServiceClient.Web.AsyncServiceClient.HttpWebRequestFilter">
  438. <summary>
  439. The request filter is called before any request.
  440. This request filter is executed globally.
  441. </summary>
  442. </member>
  443. <member name="P:ServiceStack.ServiceClient.Web.AsyncServiceClient.HttpWebResponseFilter">
  444. <summary>
  445. The response action is called once the server response is available.
  446. It will allow you to access raw response information.
  447. This response action is executed globally.
  448. Note that you should NOT consume the response stream as this is handled by ServiceStack
  449. </summary>
  450. </member>
  451. <member name="P:ServiceStack.ServiceClient.Web.AsyncServiceClient.OnAuthenticationRequired">
  452. <summary>
  453. Called before request resend, when the initial request required authentication
  454. </summary>
  455. </member>
  456. <member name="P:ServiceStack.ServiceClient.Web.AsyncServiceClient.LocalHttpWebRequestFilter">
  457. <summary>
  458. The request filter is called before any request.
  459. This request filter only works with the instance where it was set (not global).
  460. </summary>
  461. </member>
  462. <member name="P:ServiceStack.ServiceClient.Web.AsyncServiceClient.LocalHttpWebResponseFilter">
  463. <summary>
  464. The response action is called once the server response is available.
  465. It will allow you to access raw response information.
  466. Note that you should NOT consume the response stream as this is handled by ServiceStack
  467. </summary>
  468. </member>
  469. <member name="T:ServiceStack.ServiceClient.Web.GenericProxy`1">
  470. <summary>
  471. Generic Proxy for service calls.
  472. </summary>
  473. <typeparam name="T">The service Contract</typeparam>
  474. </member>
  475. <member name="P:ServiceStack.ServiceClient.Web.GenericProxy`1.Proxy">
  476. <summary>
  477. Returns the transparent proxy for the service call
  478. </summary>
  479. </member>
  480. <member name="T:ServiceStack.ServiceClient.Web.ServiceClientBase">
  481. Need to provide async request options
  482. http://msdn.microsoft.com/en-us/library/86wf6409(VS.71).aspx
  483. </member>
  484. <member name="F:ServiceStack.ServiceClient.Web.ServiceClientBase.httpWebRequestFilter">
  485. <summary>
  486. The request filter is called before any request.
  487. This request filter is executed globally.
  488. </summary>
  489. </member>
  490. <member name="F:ServiceStack.ServiceClient.Web.ServiceClientBase.httpWebResponseFilter">
  491. <summary>
  492. The response action is called once the server response is available.
  493. It will allow you to access raw response information.
  494. This response action is executed globally.
  495. Note that you should NOT consume the response stream as this is handled by ServiceStack
  496. </summary>
  497. </member>
  498. <member name="M:ServiceStack.ServiceClient.Web.ServiceClientBase.SetBaseUri(System.String)">
  499. <summary>
  500. Sets all baseUri properties, using the Format property for the SyncReplyBaseUri and AsyncOneWayBaseUri
  501. </summary>
  502. <param name="baseUri">Base URI of the service</param>
  503. </member>
  504. <member name="M:ServiceStack.ServiceClient.Web.ServiceClientBase.SetBaseUri(System.String,System.String)">
  505. <summary>
  506. Sets all baseUri properties allowing for a temporary override of the Format property
  507. </summary>
  508. <param name="baseUri">Base URI of the service</param>
  509. <param name="format">Override of the Format property for the service</param>
  510. </member>
  511. <member name="F:ServiceStack.ServiceClient.Web.ServiceClientBase.disableAutoCompression">
  512. <summary>
  513. Whether to Accept Gzip,Deflate Content-Encoding and to auto decompress responses
  514. </summary>
  515. </member>
  516. <member name="F:ServiceStack.ServiceClient.Web.ServiceClientBase.username">
  517. <summary>
  518. The user name for basic authentication
  519. </summary>
  520. </member>
  521. <member name="F:ServiceStack.ServiceClient.Web.ServiceClientBase.password">
  522. <summary>
  523. The password for basic authentication
  524. </summary>
  525. </member>
  526. <member name="M:ServiceStack.ServiceClient.Web.ServiceClientBase.SetCredentials(System.String,System.String)">
  527. <summary>
  528. Sets the username and the password for basic authentication.
  529. </summary>
  530. </member>
  531. <member name="F:ServiceStack.ServiceClient.Web.ServiceClientBase.alwaysSendBasicAuthHeader">
  532. <summary>
  533. Determines if the basic auth header should be sent with every request.
  534. By default, the basic auth header is only sent when "401 Unauthorized" is returned.
  535. </summary>
  536. </member>
  537. <member name="F:ServiceStack.ServiceClient.Web.ServiceClientBase.storeCookies">
  538. <summary>
  539. Specifies if cookies should be stored
  540. </summary>
  541. </member>
  542. <member name="M:ServiceStack.ServiceClient.Web.ServiceClientBase.HandleResponseException``1(System.Exception,System.Object,System.String,System.Func{System.Net.WebRequest},System.Func{System.Net.WebRequest,System.Net.WebResponse},``0@)">
  543. <summary>
  544. Called by Send method if an exception occurs, for instance a System.Net.WebException because the server
  545. returned an HTTP error code. Override if you want to handle specific exceptions or always want to parse the
  546. response to a custom ErrorResponse DTO type instead of ServiceStack's ErrorResponse class. In case ex is a
  547. <c>System.Net.WebException</c>, do not use
  548. <c>createWebRequest</c>/<c>getResponse</c>/<c>HandleResponse&lt;TResponse&gt;</c> to parse the response
  549. because that will result in the same exception again. Use
  550. <c>ThrowWebServiceException&lt;YourErrorResponseType&gt;</c> to parse the response and to throw a
  551. <c>WebServiceException</c> containing the parsed DTO. Then override Send to handle that exception.
  552. </summary>
  553. </member>
  554. <member name="P:ServiceStack.ServiceClient.Web.ServiceClientBase.Headers">
  555. <summary>
  556. Gets the collection of headers to be added to outgoing requests.
  557. </summary>
  558. </member>
  559. <member name="P:ServiceStack.ServiceClient.Web.ServiceClientBase.Credentials">
  560. <summary>
  561. Gets or sets authentication information for the request.
  562. Warning: It's recommened to use <see cref="P:ServiceStack.ServiceClient.Web.ServiceClientBase.UserName"/> and <see cref="P:ServiceStack.ServiceClient.Web.ServiceClientBase.Password"/> for basic auth.
  563. This property is only used for IIS level authentication.
  564. </summary>
  565. </member>
  566. <member name="P:ServiceStack.ServiceClient.Web.ServiceClientBase.onAuthenticationRequired">
  567. <summary>
  568. Called before request resend, when the initial request required authentication
  569. </summary>
  570. </member>
  571. <member name="P:ServiceStack.ServiceClient.Web.ServiceClientBase.localHttpWebRequestFilter">
  572. <summary>
  573. The request filter is called before any request.
  574. This request filter only works with the instance where it was set (not global).
  575. </summary>
  576. </member>
  577. <member name="P:ServiceStack.ServiceClient.Web.ServiceClientBase.localHttpWebResponseFilter">
  578. <summary>
  579. The response action is called once the server response is available.
  580. It will allow you to access raw response information.
  581. Note that you should NOT consume the response stream as this is handled by ServiceStack
  582. </summary>
  583. </member>
  584. <member name="P:ServiceStack.ServiceClient.Web.WcfServiceClient.StoreCookies">
  585. <summary>
  586. Specifies if cookies should be stored
  587. </summary>
  588. </member>
  589. <member name="T:ServiceStack.ServiceClient.Web.UrlExtensions">
  590. <summary>
  591. Donated by Ivan Korneliuk from his post:
  592. http://korneliuk.blogspot.com/2012/08/servicestack-reusing-dtos.html
  593. Modified to only allow using routes matching the supplied HTTP Verb
  594. </summary>
  595. </member>
  596. <member name="T:ServiceStack.ServiceClient.Web.CookieManagerEndpointBehavior">
  597. <summary>
  598. Adds the singleton instance of <see cref="T:ServiceStack.ServiceClient.Web.CookieManagerMessageInspector"/> to an endpoint on the client.
  599. </summary>
  600. <remarks>
  601. Based on http://megakemp.wordpress.com/2009/02/06/managing-shared-cookies-in-wcf/
  602. </remarks>
  603. </member>
  604. <member name="M:ServiceStack.ServiceClient.Web.CookieManagerEndpointBehavior.ApplyClientBehavior(System.ServiceModel.Description.ServiceEndpoint,System.ServiceModel.Dispatcher.ClientRuntime)">
  605. <summary>
  606. Adds the singleton of the <see cref="!:ClientIdentityMessageInspector"/> class to the client endpoint's message inspectors.
  607. </summary>
  608. <param name="endpoint">The endpoint that is to be customized.</param>
  609. <param name="clientRuntime">The client runtime to be customized.</param>
  610. </member>
  611. <member name="T:ServiceStack.ServiceClient.Web.CookieManagerMessageInspector">
  612. <summary>
  613. Maintains a copy of the cookies contained in the incoming HTTP response received from any service
  614. and appends it to all outgoing HTTP requests.
  615. </summary>
  616. <remarks>
  617. This class effectively allows to send any received HTTP cookies to different services,
  618. reproducing the same functionality available in ASMX Web Services proxies with the <see cref="T:System.Net.CookieContainer"/> class.
  619. Based on http://megakemp.wordpress.com/2009/02/06/managing-shared-cookies-in-wcf/
  620. </remarks>
  621. </member>
  622. <member name="M:ServiceStack.ServiceClient.Web.CookieManagerMessageInspector.#ctor">
  623. <summary>
  624. Initializes a new instance of the <see cref="!:ClientIdentityMessageInspector"/> class.
  625. </summary>
  626. </member>
  627. <member name="M:ServiceStack.ServiceClient.Web.CookieManagerMessageInspector.AfterReceiveReply(System.ServiceModel.Channels.Message@,System.Object)">
  628. <summary>
  629. Inspects a message after a reply message is received but prior to passing it back to the client application.
  630. </summary>
  631. <param name="reply">The message to be transformed into types and handed back to the client application.</param>
  632. <param name="correlationState">Correlation state data.</param>
  633. </member>
  634. <member name="M:ServiceStack.ServiceClient.Web.CookieManagerMessageInspector.BeforeSendRequest(System.ServiceModel.Channels.Message@,System.ServiceModel.IClientChannel)">
  635. <summary>
  636. Inspects a message before a request message is sent to a service.
  637. </summary>
  638. <param name="request">The message to be sent to the service.</param>
  639. <param name="channel">The client object channel.</param>
  640. <returns>
  641. <strong>Null</strong> since no message correlation is used.
  642. </returns>
  643. </member>
  644. <member name="P:ServiceStack.ServiceClient.Web.CookieManagerMessageInspector.Instance">
  645. <summary>
  646. Gets the singleton <see cref="!:ClientIdentityMessageInspector"/> instance.
  647. </summary>
  648. </member>
  649. <member name="F:ServiceStack.ServiceClient.Web.WebRequestUtils.ResponseDtoSuffix">
  650. <summary>
  651. Naming convention for the request's Response DTO
  652. </summary>
  653. </member>
  654. <member name="F:ServiceStack.ServiceModel.Serialization.DataContractDeserializer.quotas">
  655. <summary>
  656. Default MaxStringContentLength is 8k, and throws an exception when reached
  657. </summary>
  658. </member>
  659. <member name="T:ServiceStack.ServiceModel.Serialization.StringMapTypeDeserializer">
  660. <summary>
  661. Serializer cache of delegates required to create a type from a string map (e.g. for REST urls)
  662. </summary>
  663. </member>
  664. <member name="M:ServiceStack.ServiceModel.Support.XmlSerializerWrapper.GetNamespace(System.Type)">
  665. <summary>
  666. Gets the namespace from an attribute marked on the type's definition
  667. </summary>
  668. <param name="type"></param>
  669. <returns>Namespace of type</returns>
  670. </member>
  671. <member name="T:ServiceStack.Validation.ValidationError">
  672. <summary>
  673. The exception which is thrown when a validation error occurred.
  674. This validation is serialized in a extra clean and human-readable way by ServiceStack.
  675. </summary>
  676. </member>
  677. <member name="M:ServiceStack.Validation.ValidationError.ToXml">
  678. <summary>
  679. Used if we need to serialize this exception to XML
  680. </summary>
  681. <returns></returns>
  682. </member>
  683. <member name="P:ServiceStack.Validation.ValidationError.ErrorCode">
  684. <summary>
  685. Returns the first error code
  686. </summary>
  687. <value>The error code.</value>
  688. </member>
  689. <member name="T:ServiceStack.Validation.ValidationErrorResult">
  690. <summary>
  691. Encapsulates a validation result.
  692. </summary>
  693. </member>
  694. <member name="M:ServiceStack.Validation.ValidationErrorResult.#ctor">
  695. <summary>
  696. Constructs a new ValidationResult
  697. </summary>
  698. </member>
  699. <member name="M:ServiceStack.Validation.ValidationErrorResult.#ctor(System.Collections.Generic.IList{ServiceStack.Validation.ValidationErrorField})">
  700. <summary>
  701. Constructs a new ValidationResult
  702. </summary>
  703. <param name="errors">A list of validation results</param>
  704. </member>
  705. <member name="M:ServiceStack.Validation.ValidationErrorResult.#ctor(System.Collections.Generic.IList{ServiceStack.Validation.ValidationErrorField},System.String,System.String)">
  706. <summary>
  707. Initializes a new instance of the <see cref="T:ServiceStack.Validation.ValidationErrorResult"/> class.
  708. </summary>
  709. <param name="errors">The errors.</param>
  710. <param name="successCode">The success code.</param>
  711. <param name="errorCode">The error code.</param>
  712. </member>
  713. <member name="P:ServiceStack.Validation.ValidationErrorResult.SuccessCode">
  714. <summary>
  715. Gets or sets the success code.
  716. </summary>
  717. <value>The success code.</value>
  718. </member>
  719. <member name="P:ServiceStack.Validation.ValidationErrorResult.ErrorCode">
  720. <summary>
  721. Gets or sets the error code.
  722. </summary>
  723. <value>The error code.</value>
  724. </member>
  725. <member name="P:ServiceStack.Validation.ValidationErrorResult.SuccessMessage">
  726. <summary>
  727. Gets or sets the success message.
  728. </summary>
  729. <value>The success message.</value>
  730. </member>
  731. <member name="P:ServiceStack.Validation.ValidationErrorResult.ErrorMessage">
  732. <summary>
  733. Gets or sets the error message.
  734. </summary>
  735. <value>The error message.</value>
  736. </member>
  737. <member name="P:ServiceStack.Validation.ValidationErrorResult.Errors">
  738. <summary>
  739. The errors generated by the validation.
  740. </summary>
  741. </member>
  742. <member name="P:ServiceStack.Validation.ValidationErrorResult.IsValid">
  743. <summary>
  744. Returns True if the validation was successful (errors list is empty).
  745. </summary>
  746. </member>
  747. <member name="M:ServiceStack.Common.StreamExtensions.Compress(System.String,System.String)">
  748. <summary>
  749. Compresses the specified text using the default compression method: Deflate
  750. </summary>
  751. <param name="text">The text.</param>
  752. <param name="compressionType">Type of the compression.</param>
  753. <returns></returns>
  754. </member>
  755. <member name="M:ServiceStack.Common.StreamExtensions.Decompress(System.Byte[],System.String)">
  756. <summary>
  757. Decompresses the specified gz buffer using the default compression method: Inflate
  758. </summary>
  759. <param name="gzBuffer">The gz buffer.</param>
  760. <param name="compressionType">Type of the compression.</param>
  761. <returns></returns>
  762. </member>
  763. <member name="T:ServiceStack.Common.Support.AdapterBase">
  764. <summary>
  765. Common functionality when creating adapters
  766. </summary>
  767. </member>
  768. <member name="M:ServiceStack.Common.Support.AdapterBase.Execute``1(System.Func{``0})">
  769. <summary>
  770. Executes the specified expression.
  771. </summary>
  772. <typeparam name="T"></typeparam>
  773. <param name="action">The action.</param>
  774. <returns></returns>
  775. </member>
  776. <member name="M:ServiceStack.Common.Support.AdapterBase.Execute(System.Action)">
  777. <summary>
  778. Executes the specified action (for void methods).
  779. </summary>
  780. <param name="action">The action.</param>
  781. </member>
  782. <member name="T:ServiceStack.Common.Support.InMemoryLogFactory">
  783. <summary>
  784. Note: InMemoryLog keeps all logs in memory, so don't use it long running exceptions
  785. Returns a thread-safe InMemoryLog which you can use while *TESTING*
  786. to provide a detailed analysis of your logs.
  787. </summary>
  788. </member>
  789. <member name="M:ServiceStack.Common.Support.LogicFacadeBase.Execute``1(ServiceStack.DesignPatterns.Command.ICommand{``0})">
  790. <summary>
  791. Executes the specified action.
  792. </summary>
  793. <typeparam name="T"></typeparam>
  794. <param name="action">The action.</param>
  795. <returns></returns>
  796. </member>
  797. <member name="P:ServiceStack.Common.Support.LogicFacadeBase.CurrentContext">
  798. <summary>
  799. Gets the current context (or null if none).
  800. </summary>
  801. </member>
  802. <member name="P:ServiceStack.Common.Support.LogicFacadeBase.IsCurrentlyInitializeOnly">
  803. <summary>
  804. Checks if the current context is set to "initialize only".
  805. </summary>
  806. </member>
  807. <member name="F:ServiceStack.Common.Support.LogicFacadeBase.InitialisationContext.initOptions">
  808. <summary>
  809. Determines whether this context is initialise only or not
  810. </summary>
  811. </member>
  812. <member name="M:ServiceStack.Common.Support.LogicFacadeBase.InitialisationContext.#ctor(ServiceStack.Common.Support.LogicFacadeBase,ServiceStack.LogicFacade.InitOptions)">
  813. <summary>
  814. Constructs a new InitialiseOnlyContext
  815. </summary>
  816. </member>
  817. <member name="M:ServiceStack.Common.Support.LogicFacadeBase.InitialisationContext.Dispose">
  818. <summary>
  819. Call to remove this current context and reveal the previous context (if any).
  820. </summary>
  821. </member>
  822. <member name="P:ServiceStack.Common.Support.LogicFacadeBase.InitialisationContext.InitialisedObject">
  823. <summary>
  824. Gets or sets the object that has been initialized only.
  825. </summary>
  826. </member>
  827. <member name="T:ServiceStack.Common.UrnId">
  828. <summary>
  829. Creates a Unified Resource Name (URN) with the following formats:
  830. - urn:{TypeName}:{IdFieldValue} e.g. urn:UserSession:1
  831. - urn:{TypeName}:{IdFieldName}:{IdFieldValue} e.g. urn:UserSession:UserId:1
  832. </summary>
  833. </member>
  834. <!-- Badly formed XML comment ignored for member "M:ServiceStack.Common.Utils.AssertUtils.AreNotNull(System.Collections.Generic.IDictionary{System.String,System.Object})" -->
  835. <member name="M:ServiceStack.Common.Utils.CommandsUtils.ExecuteAsyncCommandExec(System.Collections.Generic.IEnumerable{ServiceStack.DesignPatterns.Command.ICommandExec})">
  836. <summary>
  837. Provide the an option for the callee to block until all commands are executed
  838. </summary>
  839. <param name="commands"></param>
  840. <returns></returns>
  841. </member>
  842. <member name="M:ServiceStack.Common.Utils.ResponseStatusUtils.CreateResponseStatus(System.String,System.String,System.Collections.Generic.IEnumerable{ServiceStack.Validation.ValidationErrorField})">
  843. <summary>
  844. Creates the error response from the values provided.
  845. If the errorCode is empty it will use the first validation error code,
  846. if there is none it will throw an error.
  847. </summary>
  848. <param name="errorCode">The error code.</param>
  849. <param name="errorMessage">The error message.</param>
  850. <param name="validationErrors">The validation errors.</param>
  851. <returns></returns>
  852. </member>
  853. <member name="M:ServiceStack.Common.Utils.FuncUtils.TryExec(System.Action)">
  854. <summary>
  855. Invokes the action provided and returns true if no excpetion was thrown.
  856. Otherwise logs the exception and returns false if an exception was thrown.
  857. </summary>
  858. <param name="action">The action.</param>
  859. <returns></returns>
  860. </member>
  861. <member name="M:ServiceStack.Common.Utils.PathUtils.MapProjectPath(System.String)">
  862. <summary>
  863. Maps the path of a file in the context of a VS project
  864. </summary>
  865. <param name="relativePath">the relative path</param>
  866. <returns>the absolute path</returns>
  867. <remarks>Assumes static content is two directories above the /bin/ directory,
  868. eg. in a unit test scenario the assembly would be in /bin/Debug/.</remarks>
  869. </member>
  870. <member name="M:ServiceStack.Common.Utils.PathUtils.MapAbsolutePath(System.String)">
  871. <summary>
  872. Maps the path of a file in a self-hosted scenario
  873. </summary>
  874. <param name="relativePath">the relative path</param>
  875. <returns>the absolute path</returns>
  876. <remarks>Assumes static content is copied to /bin/ folder with the assemblies</remarks>
  877. </member>
  878. <member name="M:ServiceStack.Common.Utils.PathUtils.MapHostAbsolutePath(System.String)">
  879. <summary>
  880. Maps the path of a file in an Asp.Net hosted scenario
  881. </summary>
  882. <param name="relativePath">the relative path</param>
  883. <returns>the absolute path</returns>
  884. <remarks>Assumes static content is in the parent folder of the /bin/ directory</remarks>
  885. </member>
  886. <member name="M:ServiceStack.Common.Utils.ReflectionUtils.PopulateObject(System.Object)">
  887. <summary>
  888. Populate an object with Example data.
  889. </summary>
  890. <param name="obj"></param>
  891. <returns></returns>
  892. </member>
  893. <member name="M:ServiceStack.Common.Utils.ReflectionUtils.PopulateObjectInternal(System.Object,System.Collections.Generic.Dictionary{System.Type,System.Int32})">
  894. <summary>
  895. Populates the object with example data.
  896. </summary>
  897. <param name="obj"></param>
  898. <param name="recursionInfo">Tracks how deeply nested we are</param>
  899. <returns></returns>
  900. </member>
  901. <member name="M:ServiceStack.Common.Web.HttpResultExtensions.ToDto(System.Object)">
  902. <summary>
  903. Shortcut to get the ResponseDTO whether it's bare or inside a IHttpResult
  904. </summary>
  905. <param name="response"></param>
  906. <returns></returns>
  907. </member>
  908. <member name="M:ServiceStack.Common.Web.HttpResultExtensions.ToResponseDto(System.Object)">
  909. <summary>
  910. Alias of ToDto
  911. </summary>
  912. </member>
  913. <member name="M:ServiceStack.Common.Web.HttpResultExtensions.ToDto``1(System.Object)">
  914. <summary>
  915. Shortcut to get the ResponseDTO whether it's bare or inside a IHttpResult
  916. </summary>
  917. <param name="response"></param>
  918. <returns>TResponse if found; otherwise null</returns>
  919. </member>
  920. <member name="M:ServiceStack.Common.Web.HttpResultExtensions.ToResponseDto``1(System.Object)">
  921. <summary>
  922. Alias of ToDto
  923. </summary>
  924. </member>
  925. <member name="M:ServiceStack.Common.Web.HttpResultExtensions.ToResponseStatus(System.Object)">
  926. <summary>
  927. Shortcut to get the ResponseStatus whether it's bare or inside a IHttpResult
  928. </summary>
  929. <param name="response"></param>
  930. <returns></returns>
  931. </member>
  932. <member name="M:ServiceStack.Common.Web.HttpResultExtensions.IsErrorResponse(System.Object)">
  933. <summary>
  934. Whether the response is an IHttpError or Exception
  935. </summary>
  936. </member>
  937. <member name="M:ServiceStack.Common.Web.HttpResultExtensions.ExtractHttpRanges(System.String,System.Int64,System.Int64@,System.Int64@)">
  938. <summary>
  939. rangeHeader should be of the format "bytes=0-" or "bytes=0-12345" or "bytes=123-456"
  940. </summary>
  941. </member>
  942. <member name="M:ServiceStack.Common.Web.HttpResultExtensions.AddHttpRangeResponseHeaders(ServiceStack.ServiceHost.IHttpResponse,System.Int64,System.Int64,System.Int64)">
  943. <summary>
  944. Adds 206 PartialContent Status, Content-Range and Content-Length headers
  945. </summary>
  946. </member>
  947. <member name="M:ServiceStack.Common.Web.HttpResultExtensions.WritePartialTo(System.IO.Stream,System.IO.Stream,System.Int64,System.Int64)">
  948. <summary>
  949. Writes partial range as specified by start-end, from fromStream to toStream.
  950. </summary>
  951. </member>
  952. <member name="M:ServiceStack.Common.RequestContextExtensions.SetItem(ServiceStack.ServiceHost.IRequestContext,System.String,System.Object)">
  953. <summary>
  954. Store an entry in the IHttpRequest.Items Dictionary
  955. </summary>
  956. </member>
  957. <member name="M:ServiceStack.Common.RequestContextExtensions.GetItem(ServiceStack.ServiceHost.IRequestContext,System.String)">
  958. <summary>
  959. Get an entry from the IHttpRequest.Items Dictionary
  960. </summary>
  961. </member>
  962. </members>
  963. </doc>