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.
 
 
 
 
 
 

1601 lines
94 KiB

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>ServiceStack.Redis</name>
  5. </assembly>
  6. <members>
  7. <member name="T:ServiceStack.Redis.BasicRedisClientManager">
  8. <summary>
  9. Provides thread-safe retrievel of redis clients since each client is a new one.
  10. Allows the configuration of different ReadWrite and ReadOnly hosts
  11. </summary>
  12. <summary>
  13. BasicRedisClientManager for ICacheClient
  14. For more interoperabilty I'm also implementing the ICacheClient on
  15. this cache client manager which has the affect of calling
  16. GetCacheClient() for all write operations and GetReadOnlyCacheClient()
  17. for the read ones.
  18. This works well for master-slave replication scenarios where you have
  19. 1 master that replicates to multiple read slaves.
  20. </summary>
  21. </member>
  22. <member name="P:ServiceStack.Redis.BasicRedisClientManager.NamespacePrefix">
  23. <summary>
  24. Gets or sets object key prefix.
  25. </summary>
  26. </member>
  27. <member name="M:ServiceStack.Redis.BasicRedisClientManager.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Int64})">
  28. <summary>
  29. Hosts can be an IP Address or Hostname in the format: host[:port]
  30. e.g. 127.0.0.1:6379
  31. default is: localhost:6379
  32. </summary>
  33. <param name="readWriteHosts">The write hosts.</param>
  34. <param name="readOnlyHosts">The read hosts.</param>
  35. <param name="initalDb"></param>
  36. </member>
  37. <member name="M:ServiceStack.Redis.BasicRedisClientManager.GetClient">
  38. <summary>
  39. Returns a Read/Write client (The default) using the hosts defined in ReadWriteHosts
  40. </summary>
  41. <returns></returns>
  42. </member>
  43. <member name="M:ServiceStack.Redis.BasicRedisClientManager.GetReadOnlyClient">
  44. <summary>
  45. Returns a ReadOnly client using the hosts defined in ReadOnlyHosts.
  46. </summary>
  47. <returns></returns>
  48. </member>
  49. <member name="T:ServiceStack.Redis.BufferPool">
  50. <summary>
  51. Courtesy of @marcgravell
  52. http://code.google.com/p/protobuf-net/source/browse/trunk/protobuf-net/BufferPool.cs
  53. </summary>
  54. </member>
  55. <member name="T:ServiceStack.Redis.IRedisResolver">
  56. <summary>
  57. Resolver strategy for resolving hosts and creating clients
  58. </summary>
  59. </member>
  60. <member name="T:ServiceStack.Redis.RedisManagerPool">
  61. <summary>
  62. Provides thread-safe pooling of redis client connections.
  63. </summary>
  64. </member>
  65. <member name="M:ServiceStack.Redis.RedisManagerPool.GetClient">
  66. <summary>
  67. Returns a Read/Write client (The default) using the hosts defined in ReadWriteHosts
  68. </summary>
  69. <returns></returns>
  70. </member>
  71. <member name="M:ServiceStack.Redis.RedisManagerPool.GetInActiveClient(ServiceStack.Redis.RedisClient@)">
  72. <summary>
  73. Called within a lock
  74. </summary>
  75. <returns></returns>
  76. </member>
  77. <member name="M:ServiceStack.Redis.RedisManagerPool.DisposeWriteClient(ServiceStack.Redis.RedisNativeClient)">
  78. <summary>
  79. Disposes the write client.
  80. </summary>
  81. <param name="client">The client.</param>
  82. </member>
  83. <member name="T:ServiceStack.Redis.RedisClient">
  84. <summary>
  85. The client wraps the native redis operations into a more readable c# API.
  86. Where possible these operations are also exposed in common c# interfaces,
  87. e.g. RedisClient.Lists => IList[string]
  88. RedisClient.Sets => ICollection[string]
  89. </summary>
  90. </member>
  91. <member name="M:ServiceStack.Redis.RedisClient.New">
  92. <summary>
  93. Creates a new instance of the Redis Client from NewFactoryFn.
  94. </summary>
  95. </member>
  96. <member name="M:ServiceStack.Redis.RedisClient.StoreAsHash``1(``0)">
  97. <summary>
  98. Store object fields as a dictionary of values in a Hash value.
  99. Conversion to Dictionary can be customized with RedisClient.ConvertToHashFn
  100. </summary>
  101. </member>
  102. <member name="M:ServiceStack.Redis.RedisClient.UrnKey``1(``0)">
  103. <summary>
  104. Returns key with automatic object id detection in provided value with <typeparam name="T">generic type</typeparam>.
  105. </summary>
  106. <param name="value"></param>
  107. <returns></returns>
  108. </member>
  109. <member name="M:ServiceStack.Redis.RedisClient.UrnKey``1(System.Object)">
  110. <summary>
  111. Returns key with explicit object id.
  112. </summary>
  113. <param name="id"></param>
  114. <returns></returns>
  115. </member>
  116. <member name="M:ServiceStack.Redis.RedisClient.UrnKey(System.Type,System.Object)">
  117. <summary>
  118. Returns key with explicit object type and id.
  119. </summary>
  120. <param name="type"></param>
  121. <param name="id"></param>
  122. <returns></returns>
  123. </member>
  124. <member name="T:ServiceStack.Redis.Generic.QueuedRedisTypedCommand`1">
  125. <summary>
  126. A complete redis command, with method to send command, receive response, and run callback on success or failure
  127. </summary>
  128. </member>
  129. <member name="T:ServiceStack.Redis.Generic.RedisTypedClient`1">
  130. <summary>
  131. Allows you to get Redis value operations to operate against POCO types.
  132. </summary>
  133. <typeparam name="T"></typeparam>
  134. </member>
  135. <member name="M:ServiceStack.Redis.Generic.RedisTypedClient`1.#ctor(ServiceStack.Redis.RedisClient)">
  136. <summary>
  137. Use this to share the same redis connection with another
  138. </summary>
  139. <param name="client">The client.</param>
  140. </member>
  141. <member name="T:ServiceStack.Redis.Generic.RedisTypedCommandQueue`1">
  142. <summary>
  143. Queue of commands for redis typed client
  144. </summary>
  145. <typeparam name="T"></typeparam>
  146. </member>
  147. <member name="T:ServiceStack.Redis.Generic.RedisClientHash`2">
  148. <summary>
  149. Wrap the common redis set operations under a ICollection[string] interface.
  150. </summary>
  151. </member>
  152. <member name="T:ServiceStack.Redis.Generic.RedisTypedTransaction`1">
  153. <summary>
  154. Adds support for Redis Transactions (i.e. MULTI/EXEC/DISCARD operations).
  155. </summary>
  156. </member>
  157. <member name="M:ServiceStack.Redis.Generic.RedisTypedTransaction`1.QueueExpectQueued">
  158. <summary>
  159. Put "QUEUED" messages at back of queue
  160. </summary>
  161. <param name="queued"></param>
  162. </member>
  163. <member name="M:ServiceStack.Redis.Generic.RedisTypedTransaction`1.Exec">
  164. <summary>
  165. Issue exec command (not queued)
  166. </summary>
  167. </member>
  168. <member name="M:ServiceStack.Redis.Generic.RedisTypedTransaction`1.handleMultiDataResultCount(System.Int32)">
  169. <summary>
  170. callback for after result count is read in
  171. </summary>
  172. <param name="count"></param>
  173. </member>
  174. <member name="T:ServiceStack.Redis.Generic.RedisClientSortedSet`1">
  175. <summary>
  176. Wrap the common redis set operations under a ICollection[string] interface.
  177. </summary>
  178. </member>
  179. <member name="T:ServiceStack.Redis.Generic.RedisClientSet`1">
  180. <summary>
  181. Wrap the common redis set operations under a ICollection[string] interface.
  182. </summary>
  183. </member>
  184. <member name="T:ServiceStack.Redis.RedisTypedPipeline`1">
  185. <summary>
  186. Pipeline for redis typed client
  187. </summary>
  188. <typeparam name="T"></typeparam>
  189. </member>
  190. <member name="T:ServiceStack.Redis.RedisClientManagerCacheClient">
  191. <summary>
  192. For interoperabilty GetCacheClient() and GetReadOnlyCacheClient()
  193. return an ICacheClient wrapper around the redis manager which has the affect of calling
  194. GetClient() for all write operations and GetReadOnlyClient() for the read ones.
  195. This works well for master-slave replication scenarios where you have
  196. 1 master that replicates to multiple read slaves.
  197. </summary>
  198. </member>
  199. <member name="M:ServiceStack.Redis.RedisClientManagerCacheClient.Dispose">
  200. <summary>
  201. Ignore dispose on RedisClientsManager, which should be registered as a singleton
  202. </summary>
  203. </member>
  204. <member name="T:ServiceStack.Redis.RedisClientsManagerExtensions">
  205. <summary>
  206. Useful wrapper IRedisClientsManager to cut down the boiler plate of most IRedisClient access
  207. </summary>
  208. </member>
  209. <member name="M:ServiceStack.Redis.RedisClientsManagerExtensions.CreatePubSubServer(ServiceStack.Redis.IRedisClientsManager,System.String,System.Action{System.String,System.String},System.Action{System.Exception},System.Action,System.Action,System.Action)">
  210. <summary>
  211. Creates a PubSubServer that uses a background thread to listen and process for
  212. Redis Pub/Sub messages published to the specified channel.
  213. Use optional callbacks to listen for message, error and life-cycle events.
  214. Callbacks can be assigned later, then call Start() for PubSubServer to start listening for messages
  215. </summary>
  216. </member>
  217. <member name="T:ServiceStack.Redis.Pipeline.QueuedRedisCommand">
  218. <summary>
  219. A complete redis command, with method to send command, receive response, and run callback on success or failure
  220. </summary>
  221. </member>
  222. <member name="T:ServiceStack.Redis.RedisCommand">
  223. <summary>
  224. Redis command that does not get queued
  225. </summary>
  226. </member>
  227. <member name="F:ServiceStack.Redis.RedisConfig.ClientFactory">
  228. <summary>
  229. Factory used to Create `RedisClient` instances
  230. </summary>
  231. </member>
  232. <member name="F:ServiceStack.Redis.RedisConfig.DefaultConnectTimeout">
  233. <summary>
  234. The default RedisClient Socket ConnectTimeout (default -1, None)
  235. </summary>
  236. </member>
  237. <member name="F:ServiceStack.Redis.RedisConfig.DefaultSendTimeout">
  238. <summary>
  239. The default RedisClient Socket SendTimeout (default -1, None)
  240. </summary>
  241. </member>
  242. <member name="F:ServiceStack.Redis.RedisConfig.DefaultReceiveTimeout">
  243. <summary>
  244. The default RedisClient Socket ReceiveTimeout (default -1, None)
  245. </summary>
  246. </member>
  247. <member name="F:ServiceStack.Redis.RedisConfig.DefaultIdleTimeOutSecs">
  248. <summary>
  249. Default Idle TimeOut before a connection is considered to be stale (default 240 secs)
  250. </summary>
  251. </member>
  252. <member name="F:ServiceStack.Redis.RedisConfig.DefaultRetryTimeout">
  253. <summary>
  254. The default RetryTimeout for auto retry of failed operations (default 10,000ms)
  255. </summary>
  256. </member>
  257. <member name="F:ServiceStack.Redis.RedisConfig.DefaultMaxPoolSize">
  258. <summary>
  259. Default Max Pool Size for Pooled Redis Client Managers (default none)
  260. </summary>
  261. </member>
  262. <member name="F:ServiceStack.Redis.RedisConfig.BackOffMultiplier">
  263. <summary>
  264. The BackOff multiplier failed Auto Retries starts from (default 10ms)
  265. </summary>
  266. </member>
  267. <member name="F:ServiceStack.Redis.RedisConfig.BufferLength">
  268. <summary>
  269. The Byte Buffer Size to combine Redis Operations within (default 1450 bytes)
  270. </summary>
  271. </member>
  272. <member name="F:ServiceStack.Redis.RedisConfig.BufferPoolMaxSize">
  273. <summary>
  274. The Byte Buffer Size for Operations to use a byte buffer pool (default 500kb)
  275. </summary>
  276. </member>
  277. <member name="F:ServiceStack.Redis.RedisConfig.VerifyMasterConnections">
  278. <summary>
  279. Whether Connections to Master hosts should be verified they're still master instances (default true)
  280. </summary>
  281. </member>
  282. <member name="F:ServiceStack.Redis.RedisConfig.HostLookupTimeoutMs">
  283. <summary>
  284. The ConnectTimeout on clients used to find the next available host (default 200ms)
  285. </summary>
  286. </member>
  287. <member name="F:ServiceStack.Redis.RedisConfig.AssumeServerVersion">
  288. <summary>
  289. Skip ServerVersion Checks by specifying Min Version number, e.g: 2.8.12 => 2812, 2.9.1 => 2910
  290. </summary>
  291. </member>
  292. <member name="F:ServiceStack.Redis.RedisConfig.DeactivatedClientsExpiry">
  293. <summary>
  294. How long to hold deactivated clients for before disposing their connection (default 1 min)
  295. Dispose of deactivated Clients immediately with TimeSpan.Zero
  296. </summary>
  297. </member>
  298. <member name="F:ServiceStack.Redis.RedisConfig.DisableVerboseLogging">
  299. <summary>
  300. Whether Debug Logging should log detailed Redis operations (default false)
  301. </summary>
  302. </member>
  303. <member name="M:ServiceStack.Redis.RedisConfig.Reset">
  304. <summary>
  305. Resets Redis Config and Redis Stats back to default values
  306. </summary>
  307. </member>
  308. <member name="P:ServiceStack.Redis.RedisSentinel.RedisManagerFactory">
  309. <summary>
  310. Change to use a different IRedisClientsManager
  311. </summary>
  312. </member>
  313. <member name="P:ServiceStack.Redis.RedisSentinel.HostFilter">
  314. <summary>
  315. Configure the Redis Connection String to use for a Redis Client Host
  316. </summary>
  317. </member>
  318. <member name="P:ServiceStack.Redis.RedisSentinel.RedisManager">
  319. <summary>
  320. The configured Redis Client Manager this Sentinel managers
  321. </summary>
  322. </member>
  323. <member name="P:ServiceStack.Redis.RedisSentinel.OnFailover">
  324. <summary>
  325. Fired when Sentinel fails over the Redis Client Manager to a new master
  326. </summary>
  327. </member>
  328. <member name="P:ServiceStack.Redis.RedisSentinel.OnWorkerError">
  329. <summary>
  330. Fired when the Redis Sentinel Worker connection fails
  331. </summary>
  332. </member>
  333. <member name="P:ServiceStack.Redis.RedisSentinel.OnSentinelMessageReceived">
  334. <summary>
  335. Fired when the Sentinel worker receives a message from the Sentinel Subscription
  336. </summary>
  337. </member>
  338. <member name="P:ServiceStack.Redis.RedisSentinel.IpAddressMap">
  339. <summary>
  340. Map the internal IP's returned by Sentinels to its external IP
  341. </summary>
  342. </member>
  343. <member name="P:ServiceStack.Redis.RedisSentinel.ScanForOtherSentinels">
  344. <summary>
  345. Whether to routinely scan for other sentinel hosts (default true)
  346. </summary>
  347. </member>
  348. <member name="P:ServiceStack.Redis.RedisSentinel.RefreshSentinelHostsAfter">
  349. <summary>
  350. What interval to scan for other sentinel hosts (default 10 mins)
  351. </summary>
  352. </member>
  353. <member name="P:ServiceStack.Redis.RedisSentinel.WaitBetweenFailedHosts">
  354. <summary>
  355. How long to wait after failing before connecting to next redis instance (default 250ms)
  356. </summary>
  357. </member>
  358. <member name="P:ServiceStack.Redis.RedisSentinel.MaxWaitBetweenFailedHosts">
  359. <summary>
  360. How long to retry connecting to hosts before throwing (default 60 secs)
  361. </summary>
  362. </member>
  363. <member name="P:ServiceStack.Redis.RedisSentinel.WaitBeforeForcingMasterFailover">
  364. <summary>
  365. How long to wait after consecutive failed connection attempts to master before forcing
  366. a Sentinel to failover the current master (default 60 secs)
  367. </summary>
  368. </member>
  369. <member name="P:ServiceStack.Redis.RedisSentinel.SentinelWorkerConnectTimeoutMs">
  370. <summary>
  371. The Max Connection time for Sentinel Worker (default 100ms)
  372. </summary>
  373. </member>
  374. <member name="P:ServiceStack.Redis.RedisSentinel.SentinelWorkerReceiveTimeoutMs">
  375. <summary>
  376. The Max TCP Socket Receive time for Sentinel Worker (default 100ms)
  377. </summary>
  378. </member>
  379. <member name="P:ServiceStack.Redis.RedisSentinel.SentinelWorkerSendTimeoutMs">
  380. <summary>
  381. The Max TCP Socket Send time for Sentinel Worker (default 100ms)
  382. </summary>
  383. </member>
  384. <member name="P:ServiceStack.Redis.RedisSentinel.ResetWhenSubjectivelyDown">
  385. <summary>
  386. Reset client connections when Sentinel reports redis instance is subjectively down (default true)
  387. </summary>
  388. </member>
  389. <member name="P:ServiceStack.Redis.RedisSentinel.ResetWhenObjectivelyDown">
  390. <summary>
  391. Reset client connections when Sentinel reports redis instance is objectively down (default true)
  392. </summary>
  393. </member>
  394. <member name="M:ServiceStack.Redis.RedisSentinel.Start">
  395. <summary>
  396. Initialize Sentinel Subscription and Configure Redis ClientsManager
  397. </summary>
  398. </member>
  399. <member name="M:ServiceStack.Redis.RedisSentinel.ShouldRetry">
  400. <summary>
  401. Check if GetValidSentinel should try the next sentinel server
  402. </summary>
  403. <returns></returns>
  404. <remarks>This will be true if the failures is less than either RedisSentinel.MaxFailures or the # of sentinels, whatever is greater</remarks>
  405. </member>
  406. <member name="M:ServiceStack.Redis.RedisSentinelWorker.SentinelMessageReceived(System.String,System.String)">
  407. <summary>
  408. Event that is fired when the sentinel subscription raises an event
  409. </summary>
  410. <param name="channel"></param>
  411. <param name="message"></param>
  412. </member>
  413. <member name="T:ServiceStack.Redis.RedisState">
  414. <summary>
  415. Don't immediately kill connections of active clients after failover to give them a chance to dispose gracefully.
  416. Deactivating clients are automatically cleared from the pool.
  417. </summary>
  418. </member>
  419. <member name="P:ServiceStack.Redis.RedisStats.TotalCommandsSent">
  420. <summary>
  421. Total number of commands sent
  422. </summary>
  423. </member>
  424. <member name="P:ServiceStack.Redis.RedisStats.TotalFailovers">
  425. <summary>
  426. Number of times the Redis Client Managers have FailoverTo() either by sentinel or manually
  427. </summary>
  428. </member>
  429. <member name="P:ServiceStack.Redis.RedisStats.TotalDeactivatedClients">
  430. <summary>
  431. Number of times a Client was deactivated from the pool, either by FailoverTo() or exceptions on client
  432. </summary>
  433. </member>
  434. <member name="P:ServiceStack.Redis.RedisStats.TotalFailedSentinelWorkers">
  435. <summary>
  436. Number of times connecting to a Sentinel has failed
  437. </summary>
  438. </member>
  439. <member name="P:ServiceStack.Redis.RedisStats.TotalForcedMasterFailovers">
  440. <summary>
  441. Number of times we've forced Sentinel to failover to another master due to
  442. consecutive errors beyond sentinel.WaitBeforeForcingMasterFailover
  443. </summary>
  444. </member>
  445. <member name="P:ServiceStack.Redis.RedisStats.TotalInvalidMasters">
  446. <summary>
  447. Number of times a connecting to a reported Master wasn't actually a Master
  448. </summary>
  449. </member>
  450. <member name="P:ServiceStack.Redis.RedisStats.TotalNoMastersFound">
  451. <summary>
  452. Number of times no Masters could be found in any of the configured hosts
  453. </summary>
  454. </member>
  455. <member name="P:ServiceStack.Redis.RedisStats.TotalClientsCreated">
  456. <summary>
  457. Number of Redis Client instances created with RedisConfig.ClientFactory
  458. </summary>
  459. </member>
  460. <member name="P:ServiceStack.Redis.RedisStats.TotalClientsCreatedOutsidePool">
  461. <summary>
  462. Number of times a Redis Client was created outside of pool, either due to overflow or reserved slot was overridden
  463. </summary>
  464. </member>
  465. <member name="P:ServiceStack.Redis.RedisStats.TotalSubjectiveServersDown">
  466. <summary>
  467. Number of times Redis Sentinel reported a Subjective Down (sdown)
  468. </summary>
  469. </member>
  470. <member name="P:ServiceStack.Redis.RedisStats.TotalObjectiveServersDown">
  471. <summary>
  472. Number of times Redis Sentinel reported an Objective Down (sdown)
  473. </summary>
  474. </member>
  475. <member name="P:ServiceStack.Redis.RedisStats.TotalRetryCount">
  476. <summary>
  477. Number of times a Redis Request was retried due to Socket or Retryable exception
  478. </summary>
  479. </member>
  480. <member name="P:ServiceStack.Redis.RedisStats.TotalRetrySuccess">
  481. <summary>
  482. Number of times a Request succeeded after it was retried
  483. </summary>
  484. </member>
  485. <member name="P:ServiceStack.Redis.RedisStats.TotalRetryTimedout">
  486. <summary>
  487. Number of times a Retry Request failed after exceeding RetryTimeout
  488. </summary>
  489. </member>
  490. <member name="P:ServiceStack.Redis.RedisStats.TotalPendingDeactivatedClients">
  491. <summary>
  492. Total number of deactivated clients that are pending being disposed
  493. </summary>
  494. </member>
  495. <member name="T:ServiceStack.Redis.ShardedConnectionPool">
  496. <summary>
  497. Provides a redis connection pool that can be sharded
  498. </summary>
  499. </member>
  500. <member name="F:ServiceStack.Redis.ShardedConnectionPool.name">
  501. <summary>
  502. logical name
  503. </summary>
  504. </member>
  505. <member name="F:ServiceStack.Redis.ShardedConnectionPool.weight">
  506. <summary>
  507. An arbitrary weight relative to other nodes
  508. </summary>
  509. </member>
  510. <member name="M:ServiceStack.Redis.ShardedConnectionPool.#ctor(System.String,System.Int32,System.String[])">
  511. <param name="name">logical name</param>
  512. <param name="weight">An arbitrary weight relative to other nodes</param>
  513. <param name="readWriteHosts">redis nodes</param>
  514. </member>
  515. <member name="T:ServiceStack.Redis.ShardedRedisClientManager">
  516. <summary>
  517. Provides sharding of redis client connections.
  518. uses consistent hashing to distribute keys across connection pools
  519. </summary>
  520. </member>
  521. <member name="M:ServiceStack.Redis.ShardedRedisClientManager.GetConnectionPool(System.String)">
  522. <summary>
  523. maps a key to a redis connection pool
  524. </summary>
  525. <param name="key">key to map</param>
  526. <returns>a redis connection pool</returns>
  527. </member>
  528. <member name="M:ServiceStack.Redis.Support.ConsistentHash`1.AddTarget(`0,System.Int32)">
  529. <summary>
  530. Adds a node and maps points across the circle
  531. </summary>
  532. <param name="node"> node to add </param>
  533. <param name="weight"> An arbitrary number, specifies how often it occurs relative to other targets. </param>
  534. </member>
  535. <member name="M:ServiceStack.Redis.Support.ConsistentHash`1.ModifiedBinarySearch(System.UInt64[],System.UInt64)">
  536. <summary>
  537. A variation of Binary Search algorithm. Given a number, matches the next highest number from the sorted array.
  538. If a higher number does not exist, then the first number in the array is returned.
  539. </summary>
  540. <param name="sortedArray"> a sorted array to perform the search </param>
  541. <param name="val"> number to find the next highest number against </param>
  542. <returns> next highest number </returns>
  543. </member>
  544. <member name="M:ServiceStack.Redis.Support.ConsistentHash`1.Md5Hash(System.String)">
  545. <summary>
  546. Given a key, generates an unsigned 64 bit hash code using MD5
  547. </summary>
  548. <param name="key"> </param>
  549. <returns> </returns>
  550. </member>
  551. <member name="T:ServiceStack.Redis.Support.Diagnostic.InvokeEventArgs">
  552. <summary>
  553. Provides access to the method reflection data as part of the before/after event
  554. </summary>
  555. </member>
  556. <member name="T:ServiceStack.Redis.Support.Diagnostic.TrackingFrame">
  557. <summary>
  558. Stores details about the context in which an IRedisClient is allocated.
  559. </summary>
  560. </member>
  561. <!-- Badly formed XML comment ignored for member "T:ServiceStack.Redis.Support.Diagnostic.TrackingRedisClientProxy" -->
  562. <member name="T:ServiceStack.Redis.Support.Diagnostic.TrackingRedisClientsManager">
  563. <summary>
  564. Tracks each IRedisClient instance allocated from the IRedisClientsManager logging when they are allocated and disposed.
  565. Periodically writes the allocated instances to the log for diagnostic purposes.
  566. </summary>
  567. </member>
  568. <member name="T:ServiceStack.Redis.Support.Locking.IDistributedLock">
  569. <summary>
  570. Distributed lock interface
  571. </summary>
  572. </member>
  573. <member name="T:ServiceStack.Redis.Support.Locking.DisposableDistributedLock">
  574. <summary>
  575. distributed lock class that follows the Resource Allocation Is Initialization pattern
  576. </summary>
  577. </member>
  578. <member name="M:ServiceStack.Redis.Support.Locking.DisposableDistributedLock.#ctor(ServiceStack.Redis.IRedisClient,System.String,System.Int32,System.Int32)">
  579. <summary>
  580. Lock
  581. </summary>
  582. <param name="client"></param>
  583. <param name="globalLockKey"></param>
  584. <param name="acquisitionTimeout">in seconds</param>
  585. <param name="lockTimeout">in seconds</param>
  586. </member>
  587. <member name="M:ServiceStack.Redis.Support.Locking.DisposableDistributedLock.Dispose">
  588. <summary>
  589. unlock
  590. </summary>
  591. </member>
  592. <member name="M:ServiceStack.Redis.Support.Locking.DistributedLock.Lock(System.String,System.Int32,System.Int32,System.Int64@,ServiceStack.Redis.IRedisClient)">
  593. <summary>
  594. acquire distributed, non-reentrant lock on key
  595. </summary>
  596. <param name="key">global key for this lock</param>
  597. <param name="acquisitionTimeout">timeout for acquiring lock</param>
  598. <param name="lockTimeout">timeout for lock, in seconds (stored as value against lock key) </param>
  599. <param name="client"></param>
  600. <param name="lockExpire"></param>
  601. </member>
  602. <member name="M:ServiceStack.Redis.Support.Locking.DistributedLock.Unlock(System.String,System.Int64,ServiceStack.Redis.IRedisClient)">
  603. <summary>
  604. unlock key
  605. </summary>
  606. </member>
  607. <member name="M:ServiceStack.Redis.Support.Locking.DistributedLock.CalculateLockExpire(System.TimeSpan,System.Int32)">
  608. <summary>
  609. </summary>
  610. <param name="ts"></param>
  611. <param name="timeout"></param>
  612. <returns></returns>
  613. </member>
  614. <member name="T:ServiceStack.Redis.Support.Locking.ILockingStrategy">
  615. <summary>
  616. Locking strategy interface
  617. </summary>
  618. </member>
  619. <member name="T:ServiceStack.Redis.Support.Locking.ReadLock">
  620. <summary>
  621. This class manages a read lock for a local readers/writer lock,
  622. using the Resource Acquisition Is Initialization pattern
  623. </summary>
  624. </member>
  625. <member name="M:ServiceStack.Redis.Support.Locking.ReadLock.#ctor(System.Threading.ReaderWriterLockSlim)">
  626. <summary>
  627. RAII initialization
  628. </summary>
  629. <param name="lockObject"></param>
  630. </member>
  631. <member name="M:ServiceStack.Redis.Support.Locking.ReadLock.Dispose">
  632. <summary>
  633. RAII disposal
  634. </summary>
  635. </member>
  636. <member name="M:ServiceStack.Redis.Support.Locking.WriteLock.#ctor(System.Threading.ReaderWriterLockSlim)">
  637. <summary>
  638. This class manages a write lock for a local readers/writer lock,
  639. using the Resource Acquisition Is Initialization pattern
  640. </summary>
  641. <param name="lockObject"></param>
  642. </member>
  643. <member name="M:ServiceStack.Redis.Support.Locking.WriteLock.Dispose">
  644. <summary>
  645. RAII disposal
  646. </summary>
  647. </member>
  648. <member name="T:ServiceStack.Redis.Support.OptimizedObjectSerializer">
  649. <summary>
  650. Optimized <see cref="T:ServiceStack.Redis.Support.ISerializer"/> implementation. Primitive types are manually serialized, the rest are serialized using binary serializer />.
  651. </summary>
  652. </member>
  653. <member name="M:ServiceStack.Redis.Support.OptimizedObjectSerializer.Serialize(System.Object)">
  654. <summary>
  655. </summary>
  656. <param name="value"></param>
  657. <returns></returns>
  658. </member>
  659. <member name="M:ServiceStack.Redis.Support.OptimizedObjectSerializer.Deserialize(System.Byte[])">
  660. <summary>
  661. </summary>
  662. <param name="someBytes"></param>
  663. <returns></returns>
  664. </member>
  665. <member name="M:ServiceStack.Redis.Support.OptimizedObjectSerializer.SerializeToWrapper(System.Object)">
  666. <summary>
  667. serialize value and wrap with <see cref="T:ServiceStack.Redis.Support.SerializedObjectWrapper"/>
  668. </summary>
  669. <param name="value"></param>
  670. <returns></returns>
  671. </member>
  672. <member name="M:ServiceStack.Redis.Support.OptimizedObjectSerializer.Unwrap(ServiceStack.Redis.Support.SerializedObjectWrapper)">
  673. <summary>
  674. Unwrap object wrapped in <see cref="T:ServiceStack.Redis.Support.SerializedObjectWrapper"/>
  675. </summary>
  676. <param name="item"></param>
  677. <returns></returns>
  678. </member>
  679. <member name="P:ServiceStack.Redis.Support.Queue.ISequentialData`1.DequeueItems">
  680. <summary>
  681. </summary>
  682. </member>
  683. <member name="M:ServiceStack.Redis.Support.Queue.ISequentialData`1.PopAndUnlock">
  684. <summary>
  685. pop numProcessed items from queue and unlock queue for work item id that dequeued
  686. items are associated with
  687. </summary>
  688. <returns></returns>
  689. </member>
  690. <member name="M:ServiceStack.Redis.Support.Queue.ISequentialData`1.DoneProcessedWorkItem">
  691. <summary>
  692. A dequeued work item has been processed. When all of the dequeued items have been processed,
  693. all items will be popped from the queue,and the queue unlocked for the work item id that
  694. the dequeued items are associated with
  695. </summary>
  696. </member>
  697. <member name="M:ServiceStack.Redis.Support.Queue.ISequentialData`1.UpdateNextUnprocessed(`0)">
  698. <summary>
  699. Update first unprocessed item with new work item.
  700. </summary>
  701. <param name="newWorkItem"></param>
  702. </member>
  703. <member name="T:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1">
  704. <summary>
  705. distributed work item queue. Each message must have an associated
  706. work item id. For a given id, all work items are guaranteed to be processed
  707. in the order in which they are received.
  708. </summary>
  709. <summary>
  710. distributed work item queue. Each message must have an associated
  711. work item id. For a given id, all work items are guaranteed to be processed
  712. in the order in which they are received.
  713. </summary>
  714. </member>
  715. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.DequeueManager.UpdateNextUnprocessed(`0)">
  716. <summary>
  717. </summary>
  718. <param name="newWorkItem"></param>
  719. </member>
  720. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.DequeueManager.PopAndUnlock(System.Int32,ServiceStack.Redis.IRedisClient)">
  721. <summary>
  722. </summary>
  723. <param name="numProcessed"></param>
  724. <param name="client"></param>
  725. <returns></returns>
  726. </member>
  727. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.DequeueManager.PopAndUnlock(System.Int32)">
  728. <summary>
  729. </summary>
  730. <param name="numProcessed"></param>
  731. <returns></returns>
  732. </member>
  733. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.Enqueue(System.String,`0)">
  734. <summary>
  735. Queue incoming messages
  736. </summary>
  737. <param name="workItem"></param>
  738. <param name="workItemId"></param>
  739. </member>
  740. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.PrepareNextWorkItem">
  741. <summary>
  742. Must call this periodically to move work items from priority queue to pending queue
  743. </summary>
  744. </member>
  745. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.Update(System.String,System.Int32,`0)">
  746. <summary>
  747. Replace existing work item in workItemId queue
  748. </summary>
  749. <param name="workItemId"></param>
  750. <param name="index"></param>
  751. <param name="newWorkItem"></param>
  752. </member>
  753. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.Pop(System.String,System.Int32)">
  754. <summary>
  755. Pop items from list
  756. </summary>
  757. <param name="workItemId"></param>
  758. <param name="itemCount"></param>
  759. </member>
  760. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.HarvestZombies">
  761. <summary>
  762. Force release of locks held by crashed servers
  763. </summary>
  764. </member>
  765. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.TryForceReleaseLock(ServiceStack.Redis.Support.Queue.Implementation.SerializingRedisClient,System.String)">
  766. <summary>
  767. release lock held by crashed server
  768. </summary>
  769. <param name="client"></param>
  770. <param name="workItemId"></param>
  771. <returns>true if lock is released, either by this method or by another client; false otherwise</returns>
  772. </member>
  773. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.Unlock(System.String)">
  774. <summary>
  775. Unlock work item id, so other servers can process items for this id
  776. </summary>
  777. <param name="workItemId"></param>
  778. </member>
  779. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.SequentialData`1.PopAndUnlock">
  780. <summary>
  781. pop remaining items that were returned by dequeue, and unlock queue
  782. </summary>
  783. <returns></returns>
  784. </member>
  785. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.SequentialData`1.DoneProcessedWorkItem">
  786. <summary>
  787. indicate that an item has been processed by the caller
  788. </summary>
  789. </member>
  790. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.SequentialData`1.UpdateNextUnprocessed(`0)">
  791. <summary>
  792. Update first unprocessed work item
  793. </summary>
  794. <param name="newWorkItem"></param>
  795. </member>
  796. <member name="T:ServiceStack.Redis.Support.Queue.Implementation.RedisChronologicalWorkQueue`1">
  797. <summary>
  798. distributed work item queue. Messages are processed in chronological order
  799. </summary>
  800. </member>
  801. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisChronologicalWorkQueue`1.Enqueue(System.String,`0,System.Double)">
  802. <summary>
  803. Enqueue incoming messages
  804. </summary>
  805. <param name="workItem"></param>
  806. <param name="workItemId"></param>
  807. <param name="time"></param>
  808. </member>
  809. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisChronologicalWorkQueue`1.Dequeue(System.Double,System.Double,System.Int32)">
  810. <summary>
  811. Dequeue next batch of work items
  812. </summary>
  813. <param name="minTime"></param>
  814. <param name="maxTime"></param>
  815. <param name="maxBatchSize"></param>
  816. <returns></returns>
  817. </member>
  818. <member name="T:ServiceStack.Redis.Support.Queue.Implementation.RedisSimpleWorkQueue`1">
  819. <summary>
  820. simple distributed work item queue
  821. </summary>
  822. </member>
  823. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSimpleWorkQueue`1.Enqueue(`0)">
  824. <summary>
  825. Queue incoming messages
  826. </summary>
  827. <param name="msg"></param>
  828. </member>
  829. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSimpleWorkQueue`1.Dequeue(System.Int32)">
  830. <summary>
  831. Dequeue next batch of work items for processing. After this method is called,
  832. no other work items with same id will be available for
  833. dequeuing until PostDequeue is called
  834. </summary>
  835. <returns>KeyValuePair: key is work item id, and value is list of dequeued items.
  836. </returns>
  837. </member>
  838. <member name="T:ServiceStack.Redis.Support.Queue.Implementation.RedisWorkQueue`1">
  839. <summary>
  840. distributed work item queue
  841. </summary>
  842. </member>
  843. <member name="P:ServiceStack.Redis.Support.Queue.Implementation.SerializingRedisClient.Serializer">
  844. <summary>
  845. customize the client serializer
  846. </summary>
  847. </member>
  848. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.SerializingRedisClient.Serialize(System.Object)">
  849. <summary>
  850. Serialize object to buffer
  851. </summary>
  852. <param name="value">serializable object</param>
  853. <returns></returns>
  854. </member>
  855. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.SerializingRedisClient.Serialize(System.Object[])">
  856. <summary>
  857. </summary>
  858. <param name="values">array of serializable objects</param>
  859. <returns></returns>
  860. </member>
  861. <member name="M:ServiceStack.Redis.Support.Queue.Implementation.SerializingRedisClient.Deserialize(System.Byte[])">
  862. <summary>
  863. Deserialize buffer to object
  864. </summary>
  865. <param name="someBytes">byte array to deserialize</param>
  866. <returns></returns>
  867. </member>
  868. <!-- Badly formed XML comment ignored for member "M:ServiceStack.Redis.Support.Queue.Implementation.SerializingRedisClient.Deserialize(System.Byte[][])" -->
  869. <member name="M:ServiceStack.Redis.Support.Queue.ISequentialWorkQueue`1.Enqueue(System.String,`0)">
  870. <summary>
  871. Enqueue item in priority queue corresponding to workItemId identifier
  872. </summary>
  873. <param name="workItemId"></param>
  874. <param name="workItem"></param>
  875. </member>
  876. <member name="M:ServiceStack.Redis.Support.Queue.ISequentialWorkQueue`1.PrepareNextWorkItem">
  877. <summary>
  878. Preprare next work item id for dequeueing
  879. </summary>
  880. </member>
  881. <member name="M:ServiceStack.Redis.Support.Queue.ISequentialWorkQueue`1.Dequeue(System.Int32)">
  882. <summary>
  883. Dequeue up to maxBatchSize items from queue corresponding to workItemId identifier.
  884. Once this method is called, <see cref="M:ServiceStack.Redis.Support.Queue.ISequentialWorkQueue`1.Dequeue(System.Int32)"/> or <see cref="!:Peek"/> will not
  885. return any items for workItemId until the dequeue lock returned is unlocked.
  886. </summary>
  887. <param name="maxBatchSize"></param>
  888. <param name="defer"></param>
  889. <returns></returns>
  890. </member>
  891. <member name="M:ServiceStack.Redis.Support.Queue.ISequentialWorkQueue`1.Update(System.String,System.Int32,`0)">
  892. <summary>
  893. Replace existing work item in workItemId queue
  894. </summary>
  895. <param name="workItemId"></param>
  896. <param name="index"></param>
  897. <param name="newWorkItem"></param>
  898. </member>
  899. <member name="M:ServiceStack.Redis.Support.Queue.ISimpleWorkQueue`1.Enqueue(`0)">
  900. <summary>
  901. Enqueue item
  902. </summary>
  903. <param name="workItem"></param>
  904. </member>
  905. <member name="M:ServiceStack.Redis.Support.Queue.ISimpleWorkQueue`1.Dequeue(System.Int32)">
  906. <summary>
  907. Dequeue up to maxBatchSize items from queue
  908. </summary>
  909. <param name="maxBatchSize"></param>
  910. <returns></returns>
  911. </member>
  912. <member name="T:ServiceStack.Redis.Support.SerializedObjectWrapper">
  913. <summary>
  914. wraps a serialized representation of an object
  915. </summary>
  916. </member>
  917. <member name="M:ServiceStack.Redis.Support.SerializedObjectWrapper.#ctor(System.UInt16,System.ArraySegment{System.Byte})">
  918. <summary>
  919. Initializes a new instance of <see cref="T:ServiceStack.Redis.Support.SerializedObjectWrapper"/>.
  920. </summary>
  921. <param name="flags">Custom item data.</param>
  922. <param name="data">The serialized item.</param>
  923. </member>
  924. <member name="P:ServiceStack.Redis.Support.SerializedObjectWrapper.Data">
  925. <summary>
  926. The data representing the item being stored/retireved.
  927. </summary>
  928. </member>
  929. <member name="P:ServiceStack.Redis.Support.SerializedObjectWrapper.Flags">
  930. <summary>
  931. Flags set for this instance.
  932. </summary>
  933. </member>
  934. <member name="T:ServiceStack.Redis.Support.IOrderedDictionary`2">
  935. <summary>
  936. Represents a generic collection of key/value pairs that are ordered independently of the key and value.
  937. </summary>
  938. <typeparam name="TKey">The type of the keys in the dictionary</typeparam>
  939. <typeparam name="TValue">The type of the values in the dictionary</typeparam>
  940. </member>
  941. <member name="M:ServiceStack.Redis.Support.IOrderedDictionary`2.Add(`0,`1)">
  942. <summary>
  943. Adds an entry with the specified key and value into the <see cref="T:ServiceStack.Redis.Support.IOrderedDictionary`2">IOrderedDictionary&lt;TKey,TValue&gt;</see> collection with the lowest available index.
  944. </summary>
  945. <param name="key">The key of the entry to add.</param>
  946. <param name="value">The value of the entry to add.</param>
  947. <returns>The index of the newly added entry</returns>
  948. <remarks>
  949. <para>You can also use the <see cref="P:System.Collections.Generic.IDictionary{TKey,TValue}.Item(TKey)"/> property to add new elements by setting the value of a key that does not exist in the <see cref="T:ServiceStack.Redis.Support.IOrderedDictionary`2">IOrderedDictionary&lt;TKey,TValue&gt;</see> collection; however, if the specified key already exists in the <see cref="T:ServiceStack.Redis.Support.IOrderedDictionary`2">IOrderedDictionary&lt;TKey,TValue&gt;</see>, setting the <see cref="P:Item(TKey)"/> property overwrites the old value. In contrast, the <see cref="M:Add"/> method does not modify existing elements.</para></remarks>
  950. <exception cref="T:System.ArgumentException">An element with the same key already exists in the <see cref="T:ServiceStack.Redis.Support.IOrderedDictionary`2">IOrderedDictionary&lt;TKey,TValue&gt;</see></exception>
  951. <exception cref="T:System.NotSupportedException">The <see cref="T:ServiceStack.Redis.Support.IOrderedDictionary`2">IOrderedDictionary&lt;TKey,TValue&gt;</see> is read-only.<br/>
  952. -or-<br/>
  953. The <see cref="T:ServiceStack.Redis.Support.IOrderedDictionary`2">IOrderedDictionary&lt;TKey,TValue&gt;</see> has a fized size.</exception>
  954. </member>
  955. <member name="M:ServiceStack.Redis.Support.IOrderedDictionary`2.Insert(System.Int32,`0,`1)">
  956. <summary>
  957. Inserts a new entry into the <see cref="T:ServiceStack.Redis.Support.IOrderedDictionary`2">IOrderedDictionary&lt;TKey,TValue&gt;</see> collection with the specified key and value at the specified index.
  958. </summary>
  959. <param name="index">The zero-based index at which the element should be inserted.</param>
  960. <param name="key">The key of the entry to add.</param>
  961. <param name="value">The value of the entry to add. The value can be <null/> if the type of the values in the dictionary is a reference type.</param>
  962. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is less than 0.<br/>
  963. -or-<br/>
  964. <paramref name="index"/> is greater than <see cref="P:System.Collections.ICollection.Count"/>.</exception>
  965. <exception cref="T:System.ArgumentException">An element with the same key already exists in the <see cref="T:ServiceStack.Redis.Support.IOrderedDictionary`2">IOrderedDictionary&lt;TKey,TValue&gt;</see>.</exception>
  966. <exception cref="T:System.NotSupportedException">The <see cref="T:ServiceStack.Redis.Support.IOrderedDictionary`2">IOrderedDictionary&lt;TKey,TValue&gt;</see> is read-only.<br/>
  967. -or-<br/>
  968. The <see cref="T:ServiceStack.Redis.Support.IOrderedDictionary`2">IOrderedDictionary&lt;TKey,TValue&gt;</see> has a fized size.</exception>
  969. </member>
  970. <member name="P:ServiceStack.Redis.Support.IOrderedDictionary`2.Item(System.Int32)">
  971. <summary>
  972. Gets or sets the value at the specified index.
  973. </summary>
  974. <param name="index">The zero-based index of the value to get or set.</param>
  975. <value>The value of the item at the specified index.</value>
  976. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is less than 0.<br/>
  977. -or-<br/>
  978. <paramref name="index"/> is equal to or greater than <see cref="P:System.Collections.ICollection.Count"/>.</exception>
  979. </member>
  980. <member name="T:ServiceStack.Redis.Support.OrderedDictionary`2">
  981. <summary>
  982. Represents a generic collection of key/value pairs that are ordered independently of the key and value.
  983. </summary>
  984. <typeparam name="TKey">The type of the keys in the dictionary</typeparam>
  985. <typeparam name="TValue">The type of the values in the dictionary</typeparam>
  986. </member>
  987. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.#ctor">
  988. <summary>
  989. Initializes a new instance of the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> class.
  990. </summary>
  991. </member>
  992. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.#ctor(System.Int32)">
  993. <summary>
  994. Initializes a new instance of the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> class using the specified initial capacity.
  995. </summary>
  996. <param name="capacity">The initial number of elements that the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> can contain.</param>
  997. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="capacity"/> is less than 0</exception>
  998. </member>
  999. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.#ctor(System.Collections.Generic.IEqualityComparer{`0})">
  1000. <summary>
  1001. Initializes a new instance of the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> class using the specified comparer.
  1002. </summary>
  1003. <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer`1">IEqualityComparer&lt;TKey&gt;</see> to use when comparing keys, or <null/> to use the default <see cref="T:System.Collections.Generic.EqualityComparer`1">EqualityComparer&lt;TKey&gt;</see> for the type of the key.</param>
  1004. </member>
  1005. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.#ctor(System.Int32,System.Collections.Generic.IEqualityComparer{`0})">
  1006. <summary>
  1007. Initializes a new instance of the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> class using the specified initial capacity and comparer.
  1008. </summary>
  1009. <param name="capacity">The initial number of elements that the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection can contain.</param>
  1010. <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer`1">IEqualityComparer&lt;TKey&gt;</see> to use when comparing keys, or <null/> to use the default <see cref="T:System.Collections.Generic.EqualityComparer`1">EqualityComparer&lt;TKey&gt;</see> for the type of the key.</param>
  1011. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="capacity"/> is less than 0</exception>
  1012. </member>
  1013. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.ConvertToKeyType(System.Object)">
  1014. <summary>
  1015. Converts the object passed as a key to the key type of the dictionary
  1016. </summary>
  1017. <param name="keyObject">The key object to check</param>
  1018. <returns>The key object, cast as the key type of the dictionary</returns>
  1019. <exception cref="T:System.ArgumentNullException"><paramref name="keyObject"/> is <null/>.</exception>
  1020. <exception cref="T:System.ArgumentException">The key type of the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> is not in the inheritance hierarchy of <paramref name="keyObject"/>.</exception>
  1021. </member>
  1022. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.ConvertToValueType(System.Object)">
  1023. <summary>
  1024. Converts the object passed as a value to the value type of the dictionary
  1025. </summary>
  1026. <param name="value">The object to convert to the value type of the dictionary</param>
  1027. <returns>The value object, converted to the value type of the dictionary</returns>
  1028. <exception cref="T:System.ArgumentNullException"><paramref name="valueObject"/> is <null/>, and the value type of the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> is a value type.</exception>
  1029. <exception cref="T:System.ArgumentException">The value type of the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> is not in the inheritance hierarchy of <paramref name="valueObject"/>.</exception>
  1030. </member>
  1031. <member name="P:ServiceStack.Redis.Support.OrderedDictionary`2.Dictionary">
  1032. <summary>
  1033. Gets the dictionary object that stores the keys and values
  1034. </summary>
  1035. <value>The dictionary object that stores the keys and values for the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see></value>
  1036. <remarks>Accessing this property will create the dictionary object if necessary</remarks>
  1037. </member>
  1038. <member name="P:ServiceStack.Redis.Support.OrderedDictionary`2.List">
  1039. <summary>
  1040. Gets the list object that stores the key/value pairs.
  1041. </summary>
  1042. <value>The list object that stores the key/value pairs for the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see></value>
  1043. <remarks>Accessing this property will create the list object if necessary.</remarks>
  1044. </member>
  1045. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.Insert(System.Int32,`0,`1)">
  1046. <summary>
  1047. Inserts a new entry into the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection with the specified key and value at the specified index.
  1048. </summary>
  1049. <param name="index">The zero-based index at which the element should be inserted.</param>
  1050. <param name="key">The key of the entry to add.</param>
  1051. <param name="value">The value of the entry to add. The value can be <null/> if the type of the values in the dictionary is a reference type.</param>
  1052. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is less than 0.<br/>
  1053. -or-<br/>
  1054. <paramref name="index"/> is greater than <see cref="P:ServiceStack.Redis.Support.OrderedDictionary`2.Count"/>.</exception>
  1055. <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <null/>.</exception>
  1056. <exception cref="T:System.ArgumentException">An element with the same key already exists in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>.</exception>
  1057. </member>
  1058. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.System#Collections#Specialized#IOrderedDictionary#Insert(System.Int32,System.Object,System.Object)">
  1059. <summary>
  1060. Inserts a new entry into the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection with the specified key and value at the specified index.
  1061. </summary>
  1062. <param name="index">The zero-based index at which the element should be inserted.</param>
  1063. <param name="key">The key of the entry to add.</param>
  1064. <param name="value">The value of the entry to add. The value can be <null/> if the type of the values in the dictionary is a reference type.</param>
  1065. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is less than 0.<br/>
  1066. -or-<br/>
  1067. <paramref name="index"/> is greater than <see cref="P:ServiceStack.Redis.Support.OrderedDictionary`2.Count"/>.</exception>
  1068. <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <null/>.<br/>
  1069. -or-<br/>
  1070. <paramref name="value"/> is <null/>, and the value type of the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> is a value type.</exception>
  1071. <exception cref="T:System.ArgumentException">The key type of the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> is not in the inheritance hierarchy of <paramref name="key"/>.<br/>
  1072. -or-<br/>
  1073. The value type of the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> is not in the inheritance hierarchy of <paramref name="value"/>.<br/>
  1074. -or-<br/>
  1075. An element with the same key already exists in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>.</exception>
  1076. </member>
  1077. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.RemoveAt(System.Int32)">
  1078. <summary>
  1079. Removes the entry at the specified index from the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection.
  1080. </summary>
  1081. <param name="index">The zero-based index of the entry to remove.</param>
  1082. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is less than 0.<br/>
  1083. -or-<br/>
  1084. index is equal to or greater than <see cref="P:ServiceStack.Redis.Support.OrderedDictionary`2.Count"/>.</exception>
  1085. </member>
  1086. <member name="P:ServiceStack.Redis.Support.OrderedDictionary`2.Item(System.Int32)">
  1087. <summary>
  1088. Gets or sets the value at the specified index.
  1089. </summary>
  1090. <param name="index">The zero-based index of the value to get or set.</param>
  1091. <value>The value of the item at the specified index.</value>
  1092. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is less than 0.<br/>
  1093. -or-<br/>
  1094. index is equal to or greater than <see cref="P:ServiceStack.Redis.Support.OrderedDictionary`2.Count"/>.</exception>
  1095. </member>
  1096. <member name="P:ServiceStack.Redis.Support.OrderedDictionary`2.System#Collections#Specialized#IOrderedDictionary#Item(System.Int32)">
  1097. <summary>
  1098. Gets or sets the value at the specified index.
  1099. </summary>
  1100. <param name="index">The zero-based index of the value to get or set.</param>
  1101. <value>The value of the item at the specified index.</value>
  1102. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is less than 0.<br/>
  1103. -or-<br/>
  1104. index is equal to or greater than <see cref="P:ServiceStack.Redis.Support.OrderedDictionary`2.Count"/>.</exception>
  1105. <exception cref="T:System.ArgumentNullException"><paramref name="valueObject"/> is a null reference, and the value type of the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> is a value type.</exception>
  1106. <exception cref="T:System.ArgumentException">The value type of the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> is not in the inheritance hierarchy of <paramref name="valueObject"/>.</exception>
  1107. </member>
  1108. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.System#Collections#Generic#IDictionary{TKey,TValue}#Add(`0,`1)">
  1109. <summary>
  1110. Adds an entry with the specified key and value into the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection with the lowest available index.
  1111. </summary>
  1112. <param name="key">The key of the entry to add.</param>
  1113. <param name="value">The value of the entry to add. This value can be <null/>.</param>
  1114. <remarks>A key cannot be <null/>, but a value can be.
  1115. <para>You can also use the <see cref="P:OrderedDictionary{TKey,TValue}.Item(TKey)"/> property to add new elements by setting the value of a key that does not exist in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection; however, if the specified key already exists in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>, setting the <see cref="P:OrderedDictionary{TKey,TValue}.Item(TKey)"/> property overwrites the old value. In contrast, the <see cref="M:Add"/> method does not modify existing elements.</para></remarks>
  1116. <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <null/></exception>
  1117. <exception cref="T:System.ArgumentException">An element with the same key already exists in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see></exception>
  1118. </member>
  1119. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.Add(`0,`1)">
  1120. <summary>
  1121. Adds an entry with the specified key and value into the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection with the lowest available index.
  1122. </summary>
  1123. <param name="key">The key of the entry to add.</param>
  1124. <param name="value">The value of the entry to add. This value can be <null/>.</param>
  1125. <returns>The index of the newly added entry</returns>
  1126. <remarks>A key cannot be <null/>, but a value can be.
  1127. <para>You can also use the <see cref="P:OrderedDictionary{TKey,TValue}.Item(TKey)"/> property to add new elements by setting the value of a key that does not exist in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection; however, if the specified key already exists in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>, setting the <see cref="P:OrderedDictionary{TKey,TValue}.Item(TKey)"/> property overwrites the old value. In contrast, the <see cref="M:Add"/> method does not modify existing elements.</para></remarks>
  1128. <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <null/></exception>
  1129. <exception cref="T:System.ArgumentException">An element with the same key already exists in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see></exception>
  1130. </member>
  1131. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.System#Collections#IDictionary#Add(System.Object,System.Object)">
  1132. <summary>
  1133. Adds an entry with the specified key and value into the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection with the lowest available index.
  1134. </summary>
  1135. <param name="key">The key of the entry to add.</param>
  1136. <param name="value">The value of the entry to add. This value can be <null/>.</param>
  1137. <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <null/>.<br/>
  1138. -or-<br/>
  1139. <paramref name="value"/> is <null/>, and the value type of the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> is a value type.</exception>
  1140. <exception cref="T:System.ArgumentException">The key type of the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> is not in the inheritance hierarchy of <paramref name="key"/>.<br/>
  1141. -or-<br/>
  1142. The value type of the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> is not in the inheritance hierarchy of <paramref name="value"/>.</exception>
  1143. </member>
  1144. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.Clear">
  1145. <summary>
  1146. Removes all elements from the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection.
  1147. </summary>
  1148. <remarks>The capacity is not changed as a result of calling this method.</remarks>
  1149. </member>
  1150. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.ContainsKey(`0)">
  1151. <summary>
  1152. Determines whether the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection contains a specific key.
  1153. </summary>
  1154. <param name="key">The key to locate in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection.</param>
  1155. <returns><see langword="true"/> if the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection contains an element with the specified key; otherwise, <see langword="false"/>.</returns>
  1156. <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <null/></exception>
  1157. </member>
  1158. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.System#Collections#IDictionary#Contains(System.Object)">
  1159. <summary>
  1160. Determines whether the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection contains a specific key.
  1161. </summary>
  1162. <param name="key">The key to locate in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection.</param>
  1163. <returns><see langword="true"/> if the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection contains an element with the specified key; otherwise, <see langword="false"/>.</returns>
  1164. <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <null/></exception>
  1165. <exception cref="T:System.ArgumentException">The key type of the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> is not in the inheritance hierarchy of <paramref name="key"/>.</exception>
  1166. </member>
  1167. <member name="P:ServiceStack.Redis.Support.OrderedDictionary`2.System#Collections#IDictionary#IsFixedSize">
  1168. <summary>
  1169. Gets a value indicating whether the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> has a fixed size.
  1170. </summary>
  1171. <value><see langword="true"/> if the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> has a fixed size; otherwise, <see langword="false"/>. The default is <see langword="false"/>.</value>
  1172. </member>
  1173. <member name="P:ServiceStack.Redis.Support.OrderedDictionary`2.IsReadOnly">
  1174. <summary>
  1175. Gets a value indicating whether the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection is read-only.
  1176. </summary>
  1177. <value><see langword="true"/> if the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> is read-only; otherwise, <see langword="false"/>. The default is <see langword="false"/>.</value>
  1178. <remarks>
  1179. A collection that is read-only does not allow the addition, removal, or modification of elements after the collection is created.
  1180. <para>A collection that is read-only is simply a collection with a wrapper that prevents modification of the collection; therefore, if changes are made to the underlying collection, the read-only collection reflects those changes.</para>
  1181. </remarks>
  1182. </member>
  1183. <member name="P:ServiceStack.Redis.Support.OrderedDictionary`2.System#Collections#IDictionary#Keys">
  1184. <summary>
  1185. Gets an <see cref="T:System.Collections.ICollection"/> object containing the keys in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>.
  1186. </summary>
  1187. <value>An <see cref="T:System.Collections.ICollection"/> object containing the keys in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>.</value>
  1188. <remarks>The returned <see cref="T:System.Collections.ICollection"/> object is not a static copy; instead, the collection refers back to the keys in the original <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>. Therefore, changes to the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> continue to be reflected in the key collection.</remarks>
  1189. </member>
  1190. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.IndexOfKey(`0)">
  1191. <summary>
  1192. Returns the zero-based index of the specified key in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>
  1193. </summary>
  1194. <param name="key">The key to locate in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see></param>
  1195. <returns>The zero-based index of <paramref name="key"/>, if <paramref name="ley"/> is found in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>; otherwise, -1</returns>
  1196. <remarks>This method performs a linear search; therefore it has a cost of O(n) at worst.</remarks>
  1197. </member>
  1198. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.Remove(`0)">
  1199. <summary>
  1200. Removes the entry with the specified key from the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection.
  1201. </summary>
  1202. <param name="key">The key of the entry to remove</param>
  1203. <returns><see langword="true"/> if the key was found and the corresponding element was removed; otherwise, <see langword="false"/></returns>
  1204. </member>
  1205. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.System#Collections#IDictionary#Remove(System.Object)">
  1206. <summary>
  1207. Removes the entry with the specified key from the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection.
  1208. </summary>
  1209. <param name="key">The key of the entry to remove</param>
  1210. </member>
  1211. <member name="P:ServiceStack.Redis.Support.OrderedDictionary`2.System#Collections#IDictionary#Values">
  1212. <summary>
  1213. Gets an <see cref="T:System.Collections.ICollection"/> object containing the values in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection.
  1214. </summary>
  1215. <value>An <see cref="T:System.Collections.ICollection"/> object containing the values in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection.</value>
  1216. <remarks>The returned <see cref="T:System.Collections.ICollection"/> object is not a static copy; instead, the <see cref="T:System.Collections.ICollection"/> refers back to the values in the original <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection. Therefore, changes to the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> continue to be reflected in the <see cref="T:System.Collections.ICollection"/>.</remarks>
  1217. </member>
  1218. <member name="P:ServiceStack.Redis.Support.OrderedDictionary`2.Item(`0)">
  1219. <summary>
  1220. Gets or sets the value with the specified key.
  1221. </summary>
  1222. <param name="key">The key of the value to get or set.</param>
  1223. <value>The value associated with the specified key. If the specified key is not found, attempting to get it returns <null/>, and attempting to set it creates a new element using the specified key.</value>
  1224. </member>
  1225. <member name="P:ServiceStack.Redis.Support.OrderedDictionary`2.System#Collections#IDictionary#Item(System.Object)">
  1226. <summary>
  1227. Gets or sets the value with the specified key.
  1228. </summary>
  1229. <param name="key">The key of the value to get or set.</param>
  1230. <value>The value associated with the specified key. If the specified key is not found, attempting to get it returns <null/>, and attempting to set it creates a new element using the specified key.</value>
  1231. </member>
  1232. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
  1233. <summary>
  1234. Copies the elements of the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> elements to a one-dimensional Array object at the specified index.
  1235. </summary>
  1236. <param name="array">The one-dimensional <see cref="T:System.Array"/> object that is the destination of the <see cref="T:KeyValuePair`2>"/> objects copied from the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>. The <see cref="T:System.Array"/> must have zero-based indexing.</param>
  1237. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  1238. <remarks>The <see cref="M:CopyTo"/> method preserves the order of the elements in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see></remarks>
  1239. </member>
  1240. <member name="P:ServiceStack.Redis.Support.OrderedDictionary`2.Count">
  1241. <summary>
  1242. Gets the number of key/values pairs contained in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection.
  1243. </summary>
  1244. <value>The number of key/value pairs contained in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> collection.</value>
  1245. </member>
  1246. <member name="P:ServiceStack.Redis.Support.OrderedDictionary`2.System#Collections#ICollection#IsSynchronized">
  1247. <summary>
  1248. Gets a value indicating whether access to the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> object is synchronized (thread-safe).
  1249. </summary>
  1250. <value>This method always returns false.</value>
  1251. </member>
  1252. <member name="P:ServiceStack.Redis.Support.OrderedDictionary`2.System#Collections#ICollection#SyncRoot">
  1253. <summary>
  1254. Gets an object that can be used to synchronize access to the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> object.
  1255. </summary>
  1256. <value>An object that can be used to synchronize access to the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> object.</value>
  1257. </member>
  1258. <member name="P:ServiceStack.Redis.Support.OrderedDictionary`2.Keys">
  1259. <summary>
  1260. Gets an <see cref="T:System.Collections.Generic.ICollection{TKey}">ICollection&lt;TKey&gt;</see> object containing the keys in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>.
  1261. </summary>
  1262. <value>An <see cref="T:System.Collections.Generic.ICollection{TKey}">ICollection&lt;TKey&gt;</see> object containing the keys in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>.</value>
  1263. <remarks>The returned <see cref="T:System.Collections.Generic.ICollection{TKey}">ICollection&lt;TKey&gt;</see> object is not a static copy; instead, the collection refers back to the keys in the original <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>. Therefore, changes to the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> continue to be reflected in the key collection.</remarks>
  1264. </member>
  1265. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.TryGetValue(`0,`1@)">
  1266. <summary>
  1267. Gets the value associated with the specified key.
  1268. </summary>
  1269. <param name="key">The key of the value to get.</param>
  1270. <param name="value">When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of <paramref name="value"/>. This parameter can be passed uninitialized.</param>
  1271. <returns><see langword="true"/> if the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> contains an element with the specified key; otherwise, <see langword="false"/>.</returns>
  1272. </member>
  1273. <member name="P:ServiceStack.Redis.Support.OrderedDictionary`2.Values">
  1274. <summary>
  1275. Gets an <see cref="T:ICollection{TValue}">ICollection&lt;TValue&gt;</see> object containing the values in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>.
  1276. </summary>
  1277. <value>An <see cref="T:ICollection{TValue}">ICollection&lt;TValue&gt;</see> object containing the values in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>.</value>
  1278. <remarks>The returned <see cref="T:ICollection{TValue}">ICollection&lt;TKey&gt;</see> object is not a static copy; instead, the collection refers back to the values in the original <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>. Therefore, changes to the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> continue to be reflected in the value collection.</remarks>
  1279. </member>
  1280. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{TKey,TValue}}#Add(System.Collections.Generic.KeyValuePair{`0,`1})">
  1281. <summary>
  1282. Adds the specified value to the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> with the specified key.
  1283. </summary>
  1284. <param name="item">The <see cref="T:KeyValuePair{TKey,TValue}">KeyValuePair&lt;TKey,TValue&gt;</see> structure representing the key and value to add to the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>.</param>
  1285. </member>
  1286. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{TKey,TValue}}#Contains(System.Collections.Generic.KeyValuePair{`0,`1})">
  1287. <summary>
  1288. Determines whether the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> contains a specific key and value.
  1289. </summary>
  1290. <param name="item">The <see cref="T:KeyValuePair{TKey,TValue}">KeyValuePair&lt;TKey,TValue&gt;</see> structure to locate in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>.</param>
  1291. <returns><see langword="true"/> if <paramref name="keyValuePair"/> is found in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>; otherwise, <see langword="false"/>.</returns>
  1292. </member>
  1293. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{TKey,TValue}}#CopyTo(System.Collections.Generic.KeyValuePair{`0,`1}[],System.Int32)">
  1294. <summary>
  1295. Copies the elements of the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see> to an array of type <see cref="T:KeyValuePair`2>"/>, starting at the specified index.
  1296. </summary>
  1297. <param name="array">The one-dimensional array of type <see cref="T:KeyValuePair{TKey,TValue}">KeyValuePair&lt;TKey,TValue&gt;</see> that is the destination of the <see cref="T:KeyValuePair{TKey,TValue}">KeyValuePair&lt;TKey,TValue&gt;</see> elements copied from the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>. The array must have zero-based indexing.</param>
  1298. <param name="arrayIndex">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  1299. </member>
  1300. <member name="M:ServiceStack.Redis.Support.OrderedDictionary`2.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{TKey,TValue}}#Remove(System.Collections.Generic.KeyValuePair{`0,`1})">
  1301. <summary>
  1302. Removes a key and value from the dictionary.
  1303. </summary>
  1304. <param name="item">The <see cref="T:KeyValuePair{TKey,TValue}">KeyValuePair&lt;TKey,TValue&gt;</see> structure representing the key and value to remove from the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>.</param>
  1305. <returns><see langword="true"/> if the key and value represented by <paramref name="keyValuePair"/> is successfully found and removed; otherwise, <see langword="false"/>. This method returns <see langword="false"/> if <paramref name="keyValuePair"/> is not found in the <see cref="T:ServiceStack.Redis.Support.OrderedDictionary`2">OrderedDictionary&lt;TKey,TValue&gt;</see>.</returns>
  1306. </member>
  1307. <member name="T:ServiceStack.Redis.Support.ObjectSerializer">
  1308. <summary>
  1309. serialize/deserialize arbitrary objects
  1310. (objects must be serializable)
  1311. </summary>
  1312. </member>
  1313. <member name="M:ServiceStack.Redis.Support.ObjectSerializer.Serialize(System.Object)">
  1314. <summary>
  1315. Serialize object to buffer
  1316. </summary>
  1317. <param name="value">serializable object</param>
  1318. <returns></returns>
  1319. </member>
  1320. <member name="M:ServiceStack.Redis.Support.ObjectSerializer.Deserialize(System.Byte[])">
  1321. <summary>
  1322. Deserialize buffer to object
  1323. </summary>
  1324. <param name="someBytes">byte array to deserialize</param>
  1325. <returns></returns>
  1326. </member>
  1327. <member name="T:ServiceStack.Redis.Support.RedisNamespace">
  1328. <summary>
  1329. manages a "region" in the redis key space
  1330. namespace can be cleared by incrementing the generation
  1331. </summary>
  1332. </member>
  1333. <member name="P:ServiceStack.Redis.Support.RedisNamespace.LockingStrategy">
  1334. <summary>
  1335. get locking strategy
  1336. </summary>
  1337. </member>
  1338. <member name="M:ServiceStack.Redis.Support.RedisNamespace.GetGeneration">
  1339. <summary>
  1340. get current generation
  1341. </summary>
  1342. <returns></returns>
  1343. </member>
  1344. <member name="M:ServiceStack.Redis.Support.RedisNamespace.SetGeneration(System.Int64)">
  1345. <summary>
  1346. set new generation
  1347. </summary>
  1348. <param name="generation"></param>
  1349. </member>
  1350. <member name="M:ServiceStack.Redis.Support.RedisNamespace.GetGenerationKey">
  1351. <summary>
  1352. redis key for generation
  1353. </summary>
  1354. <returns></returns>
  1355. </member>
  1356. <member name="M:ServiceStack.Redis.Support.RedisNamespace.GetGlobalKeysKey">
  1357. <summary>
  1358. get redis key that holds all namespace keys
  1359. </summary>
  1360. <returns></returns>
  1361. </member>
  1362. <member name="M:ServiceStack.Redis.Support.RedisNamespace.GlobalCacheKey(System.Object)">
  1363. <summary>
  1364. get global cache key
  1365. </summary>
  1366. <param name="key"></param>
  1367. <returns></returns>
  1368. </member>
  1369. <member name="M:ServiceStack.Redis.Support.RedisNamespace.GlobalKey(System.Object,System.Int32)">
  1370. <summary>
  1371. get global key inside of this namespace
  1372. </summary>
  1373. <param name="key"></param>
  1374. <param name="numUniquePrefixes">prefixes can be added for name deconfliction</param>
  1375. <returns></returns>
  1376. </member>
  1377. <member name="M:ServiceStack.Redis.Support.RedisNamespace.Sanitize(System.String)">
  1378. <summary>
  1379. replace UniqueCharacter with its double, to avoid name clash
  1380. </summary>
  1381. <param name="dirtyString"></param>
  1382. <returns></returns>
  1383. </member>
  1384. <member name="M:ServiceStack.Redis.Support.RedisNamespace.Sanitize(System.Object)">
  1385. <summary>
  1386. </summary>
  1387. <param name="dirtyString"></param>
  1388. <returns></returns>
  1389. </member>
  1390. <member name="M:ServiceStack.Redis.RedisAllPurposePipeline.#ctor(ServiceStack.Redis.RedisClient)">
  1391. <summary>
  1392. General purpose pipeline
  1393. </summary>
  1394. <param name="redisClient"></param>
  1395. </member>
  1396. <member name="M:ServiceStack.Redis.RedisAllPurposePipeline.Flush">
  1397. <summary>
  1398. Flush send buffer, and read responses
  1399. </summary>
  1400. </member>
  1401. <member name="T:ServiceStack.Redis.RedisQueueCompletableOperation">
  1402. <summary>
  1403. Redis operation (transaction/pipeline) that allows queued commands to be completed
  1404. </summary>
  1405. </member>
  1406. <member name="T:ServiceStack.Redis.RedisClientHash">
  1407. <summary>
  1408. Wrap the common redis set operations under a ICollection[string] interface.
  1409. </summary>
  1410. </member>
  1411. <member name="T:ServiceStack.Redis.RedisClientSortedSet">
  1412. <summary>
  1413. Wrap the common redis set operations under a ICollection[string] interface.
  1414. </summary>
  1415. </member>
  1416. <member name="T:ServiceStack.Redis.RedisCommandQueue">
  1417. <summary>
  1418. </summary>
  1419. </member>
  1420. <member name="T:ServiceStack.Redis.RedisException">
  1421. <summary>
  1422. Redis-specific exception. Thrown if unable to connect to Redis server due to socket exception, for example.
  1423. </summary>
  1424. </member>
  1425. <member name="T:ServiceStack.Redis.RedisTransaction">
  1426. <summary>
  1427. Adds support for Redis Transactions (i.e. MULTI/EXEC/DISCARD operations).
  1428. </summary>
  1429. </member>
  1430. <member name="M:ServiceStack.Redis.RedisTransaction.QueueExpectQueued">
  1431. <summary>
  1432. Put "QUEUED" messages at back of queue
  1433. </summary>
  1434. <param name="queued"></param>
  1435. </member>
  1436. <member name="M:ServiceStack.Redis.RedisTransaction.Exec">
  1437. <summary>
  1438. Issue exec command (not queued)
  1439. </summary>
  1440. </member>
  1441. <member name="M:ServiceStack.Redis.RedisTransaction.handleMultiDataResultCount(System.Int32)">
  1442. <summary>
  1443. callback for after result count is read in
  1444. </summary>
  1445. <param name="count"></param>
  1446. </member>
  1447. <member name="T:ServiceStack.Redis.RedisClientSet">
  1448. <summary>
  1449. Wrap the common redis set operations under a ICollection[string] interface.
  1450. </summary>
  1451. </member>
  1452. <member name="T:ServiceStack.Redis.RedisNativeClient">
  1453. <summary>
  1454. This class contains all the common operations for the RedisClient.
  1455. The client contains a 1:1 mapping of c# methods to redis operations of the same name.
  1456. Not threadsafe use a pooled manager
  1457. </summary>
  1458. </member>
  1459. <member name="F:ServiceStack.Redis.RedisNativeClient.active">
  1460. <summary>
  1461. Used to manage connection pooling
  1462. </summary>
  1463. </member>
  1464. <member name="P:ServiceStack.Redis.RedisNativeClient.NamespacePrefix">
  1465. <summary>
  1466. Gets or sets object key prefix.
  1467. </summary>
  1468. </member>
  1469. <member name="M:ServiceStack.Redis.RedisNativeClient.Exec">
  1470. <summary>
  1471. Requires custom result parsing
  1472. </summary>
  1473. <returns>Number of results</returns>
  1474. </member>
  1475. <member name="M:ServiceStack.Redis.RedisNativeClient.WriteCommandToSendBuffer(System.Byte[][])">
  1476. <summary>
  1477. Command to set multuple binary safe arguments
  1478. </summary>
  1479. <param name="cmdWithBinaryArgs"></param>
  1480. <returns></returns>
  1481. </member>
  1482. <member name="M:ServiceStack.Redis.RedisNativeClient.SendUnmanagedExpectSuccess(System.Byte[][])">
  1483. <summary>
  1484. Send command outside of managed Write Buffer
  1485. </summary>
  1486. <param name="cmdWithBinaryArgs"></param>
  1487. </member>
  1488. <member name="M:ServiceStack.Redis.RedisNativeClient.ResetSendBuffer">
  1489. <summary>
  1490. reset buffer index in send buffer
  1491. </summary>
  1492. </member>
  1493. <member name="T:ServiceStack.Redis.RedisClientList">
  1494. <summary>
  1495. Wrap the common redis list operations under a IList[string] interface.
  1496. </summary>
  1497. </member>
  1498. <member name="T:ServiceStack.Redis.PooledRedisClientManager">
  1499. <summary>
  1500. Provides thread-safe pooling of redis client connections.
  1501. Allows load-balancing of master-write and read-slave hosts, ideal for
  1502. 1 master and multiple replicated read slaves.
  1503. </summary>
  1504. </member>
  1505. <member name="P:ServiceStack.Redis.PooledRedisClientManager.NamespacePrefix">
  1506. <summary>
  1507. Gets or sets object key prefix.
  1508. </summary>
  1509. </member>
  1510. <member name="M:ServiceStack.Redis.PooledRedisClientManager.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},ServiceStack.Redis.RedisClientManagerConfig)">
  1511. <summary>
  1512. Hosts can be an IP Address or Hostname in the format: host[:port]
  1513. e.g. 127.0.0.1:6379
  1514. default is: localhost:6379
  1515. </summary>
  1516. <param name="readWriteHosts">The write hosts.</param>
  1517. <param name="readOnlyHosts">The read hosts.</param>
  1518. <param name="config">The config.</param>
  1519. </member>
  1520. <member name="M:ServiceStack.Redis.PooledRedisClientManager.GetClient">
  1521. <summary>
  1522. Returns a Read/Write client (The default) using the hosts defined in ReadWriteHosts
  1523. </summary>
  1524. <returns></returns>
  1525. </member>
  1526. <member name="M:ServiceStack.Redis.PooledRedisClientManager.GetInActiveWriteClient(ServiceStack.Redis.RedisClient@)">
  1527. <summary>
  1528. Called within a lock
  1529. </summary>
  1530. <returns></returns>
  1531. </member>
  1532. <member name="M:ServiceStack.Redis.PooledRedisClientManager.GetReadOnlyClient">
  1533. <summary>
  1534. Returns a ReadOnly client using the hosts defined in ReadOnlyHosts.
  1535. </summary>
  1536. <returns></returns>
  1537. </member>
  1538. <member name="M:ServiceStack.Redis.PooledRedisClientManager.GetInActiveReadClient(ServiceStack.Redis.RedisClient@)">
  1539. <summary>
  1540. Called within a lock
  1541. </summary>
  1542. <returns></returns>
  1543. </member>
  1544. <member name="M:ServiceStack.Redis.PooledRedisClientManager.DisposeReadOnlyClient(ServiceStack.Redis.RedisNativeClient)">
  1545. <summary>
  1546. Disposes the read only client.
  1547. </summary>
  1548. <param name="client">The client.</param>
  1549. </member>
  1550. <member name="M:ServiceStack.Redis.PooledRedisClientManager.DisposeWriteClient(ServiceStack.Redis.RedisNativeClient)">
  1551. <summary>
  1552. Disposes the write client.
  1553. </summary>
  1554. <param name="client">The client.</param>
  1555. </member>
  1556. <member name="T:ServiceStack.Redis.PooledRedisClientManager.DisposablePooledClient`1">
  1557. <summary>
  1558. Manage a client acquired from the PooledRedisClientManager
  1559. Dispose method will release the client back to the pool.
  1560. </summary>
  1561. </member>
  1562. <member name="M:ServiceStack.Redis.PooledRedisClientManager.DisposablePooledClient`1.#ctor(ServiceStack.Redis.PooledRedisClientManager)">
  1563. <summary>
  1564. wrap the acquired client
  1565. </summary>
  1566. <param name="clientManager"></param>
  1567. </member>
  1568. <member name="P:ServiceStack.Redis.PooledRedisClientManager.DisposablePooledClient`1.Client">
  1569. <summary>
  1570. access the wrapped client
  1571. </summary>
  1572. </member>
  1573. <member name="M:ServiceStack.Redis.PooledRedisClientManager.DisposablePooledClient`1.Dispose">
  1574. <summary>
  1575. release the wrapped client back to the pool
  1576. </summary>
  1577. </member>
  1578. </members>
  1579. </doc>