Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
 
 
 
 
 
 

6111 linhas
347 KiB

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>StackExchange.Redis</name>
  5. </assembly>
  6. <members>
  7. <member name="T:StackExchange.Redis.Aggregate">
  8. <summary>
  9. Specifies how elements should be aggregated when combining sorted sets
  10. </summary>
  11. </member>
  12. <member name="F:StackExchange.Redis.Aggregate.Sum">
  13. <summary>
  14. The values of the combined elements are added
  15. </summary>
  16. </member>
  17. <member name="F:StackExchange.Redis.Aggregate.Min">
  18. <summary>
  19. The least value of the combined elements is used
  20. </summary>
  21. </member>
  22. <member name="F:StackExchange.Redis.Aggregate.Max">
  23. <summary>
  24. The greatest value of the combined elements is used
  25. </summary>
  26. </member>
  27. <member name="T:StackExchange.Redis.Bitwise">
  28. <summary>
  29. <a href="http://en.wikipedia.org/wiki/Bitwise_operation">Bitwise operators</a>
  30. </summary>
  31. </member>
  32. <member name="F:StackExchange.Redis.Bitwise.And">
  33. <summary>
  34. <a href="http://en.wikipedia.org/wiki/Bitwise_operation#AND">And</a>
  35. </summary>
  36. </member>
  37. <member name="F:StackExchange.Redis.Bitwise.Or">
  38. <summary>
  39. <a href="http://en.wikipedia.org/wiki/Bitwise_operation#OR">Or</a>
  40. </summary>
  41. </member>
  42. <member name="F:StackExchange.Redis.Bitwise.Xor">
  43. <summary>
  44. <a href="http://en.wikipedia.org/wiki/Bitwise_operation#XOR">Xor</a>
  45. </summary>
  46. </member>
  47. <member name="F:StackExchange.Redis.Bitwise.Not">
  48. <summary>
  49. <a href="http://en.wikipedia.org/wiki/Bitwise_operation#NOT">Not</a>
  50. </summary>
  51. </member>
  52. <member name="T:StackExchange.Redis.ClientFlags">
  53. <summary>
  54. The client flags can be a combination of:
  55. O: the client is a slave in MONITOR mode
  56. S: the client is a normal slave server
  57. M: the client is a master
  58. x: the client is in a MULTI/EXEC context
  59. b: the client is waiting in a blocking operation
  60. i: the client is waiting for a VM I/O (deprecated)
  61. d: a watched keys has been modified - EXEC will fail
  62. c: connection to be closed after writing entire reply
  63. u: the client is unblocked
  64. A: connection to be closed ASAP
  65. N: no specific flag set
  66. </summary>
  67. </member>
  68. <member name="F:StackExchange.Redis.ClientFlags.None">
  69. <summary>
  70. no specific flag set
  71. </summary>
  72. </member>
  73. <member name="F:StackExchange.Redis.ClientFlags.SlaveMonitor">
  74. <summary>
  75. the client is a slave in MONITOR mode
  76. </summary>
  77. </member>
  78. <member name="F:StackExchange.Redis.ClientFlags.Slave">
  79. <summary>
  80. the client is a normal slave server
  81. </summary>
  82. </member>
  83. <member name="F:StackExchange.Redis.ClientFlags.Master">
  84. <summary>
  85. the client is a master
  86. </summary>
  87. </member>
  88. <member name="F:StackExchange.Redis.ClientFlags.Transaction">
  89. <summary>
  90. the client is in a MULTI/EXEC context
  91. </summary>
  92. </member>
  93. <member name="F:StackExchange.Redis.ClientFlags.Blocked">
  94. <summary>
  95. the client is waiting in a blocking operation
  96. </summary>
  97. </member>
  98. <member name="F:StackExchange.Redis.ClientFlags.TransactionDoomed">
  99. <summary>
  100. a watched keys has been modified - EXEC will fail
  101. </summary>
  102. </member>
  103. <member name="F:StackExchange.Redis.ClientFlags.Closing">
  104. <summary>
  105. connection to be closed after writing entire reply
  106. </summary>
  107. </member>
  108. <member name="F:StackExchange.Redis.ClientFlags.Unblocked">
  109. <summary>
  110. the client is unblocked
  111. </summary>
  112. </member>
  113. <member name="F:StackExchange.Redis.ClientFlags.CloseASAP">
  114. <summary>
  115. connection to be closed ASAP
  116. </summary>
  117. </member>
  118. <member name="T:StackExchange.Redis.ClientInfo">
  119. <summary>
  120. Represents the state of an individual client connection to redis
  121. </summary>
  122. </member>
  123. <member name="P:StackExchange.Redis.ClientInfo.Address">
  124. <summary>
  125. Address (host and port) of the client
  126. </summary>
  127. </member>
  128. <member name="P:StackExchange.Redis.ClientInfo.AgeSeconds">
  129. <summary>
  130. total duration of the connection in seconds
  131. </summary>
  132. </member>
  133. <member name="P:StackExchange.Redis.ClientInfo.Database">
  134. <summary>
  135. current database ID
  136. </summary>
  137. </member>
  138. <member name="P:StackExchange.Redis.ClientInfo.Flags">
  139. <summary>
  140. The flags associated with this connection
  141. </summary>
  142. </member>
  143. <member name="P:StackExchange.Redis.ClientInfo.FlagsRaw">
  144. <summary>
  145. The client flags can be a combination of:
  146. O: the client is a slave in MONITOR mode
  147. S: the client is a normal slave server
  148. M: the client is a master
  149. x: the client is in a MULTI/EXEC context
  150. b: the client is waiting in a blocking operation
  151. i: the client is waiting for a VM I/O (deprecated)
  152. d: a watched keys has been modified - EXEC will fail
  153. c: connection to be closed after writing entire reply
  154. u: the client is unblocked
  155. A: connection to be closed ASAP
  156. N: no specific flag set
  157. </summary>
  158. </member>
  159. <member name="P:StackExchange.Redis.ClientInfo.Host">
  160. <summary>
  161. The host of the client (typically an IP address)
  162. </summary>
  163. </member>
  164. <member name="P:StackExchange.Redis.ClientInfo.IdleSeconds">
  165. <summary>
  166. idle time of the connection in seconds
  167. </summary>
  168. </member>
  169. <member name="P:StackExchange.Redis.ClientInfo.LastCommand">
  170. <summary>
  171. last command played
  172. </summary>
  173. </member>
  174. <member name="P:StackExchange.Redis.ClientInfo.Name">
  175. <summary>
  176. The name allocated to this connection, if any
  177. </summary>
  178. </member>
  179. <member name="P:StackExchange.Redis.ClientInfo.PatternSubscriptionCount">
  180. <summary>
  181. number of pattern matching subscriptions
  182. </summary>
  183. </member>
  184. <member name="P:StackExchange.Redis.ClientInfo.Port">
  185. <summary>
  186. The port of the client
  187. </summary>
  188. </member>
  189. <member name="P:StackExchange.Redis.ClientInfo.Raw">
  190. <summary>
  191. The raw content from redis
  192. </summary>
  193. </member>
  194. <member name="P:StackExchange.Redis.ClientInfo.SubscriptionCount">
  195. <summary>
  196. number of channel subscriptions
  197. </summary>
  198. </member>
  199. <member name="P:StackExchange.Redis.ClientInfo.TransactionCommandLength">
  200. <summary>
  201. number of commands in a MULTI/EXEC context
  202. </summary>
  203. </member>
  204. <member name="P:StackExchange.Redis.ClientInfo.Id">
  205. <summary>
  206. an unique 64-bit client ID (introduced in Redis 2.8.12).
  207. </summary>
  208. </member>
  209. <member name="M:StackExchange.Redis.ClientInfo.ToString">
  210. <summary>
  211. Format the object as a string
  212. </summary>
  213. </member>
  214. <member name="P:StackExchange.Redis.ClientInfo.ClientType">
  215. <summary>
  216. The class of the connection
  217. </summary>
  218. </member>
  219. <member name="T:StackExchange.Redis.ClientType">
  220. <summary>
  221. The class of the connection
  222. </summary>
  223. </member>
  224. <member name="F:StackExchange.Redis.ClientType.Normal">
  225. <summary>
  226. Regular connections, including MONITOR connections
  227. </summary>
  228. </member>
  229. <member name="F:StackExchange.Redis.ClientType.Slave">
  230. <summary>
  231. Replication connections
  232. </summary>
  233. </member>
  234. <member name="F:StackExchange.Redis.ClientType.PubSub">
  235. <summary>
  236. Subscription connections
  237. </summary>
  238. </member>
  239. <member name="T:StackExchange.Redis.SlotRange">
  240. <summary>
  241. Indicates a range of slots served by a cluster node
  242. </summary>
  243. </member>
  244. <member name="M:StackExchange.Redis.SlotRange.#ctor(System.Int32,System.Int32)">
  245. <summary>
  246. Create a new SlotRange value
  247. </summary>
  248. </member>
  249. <member name="P:StackExchange.Redis.SlotRange.From">
  250. <summary>
  251. The start of the range (inclusive)
  252. </summary>
  253. </member>
  254. <member name="P:StackExchange.Redis.SlotRange.To">
  255. <summary>
  256. The end of the range (inclusive)
  257. </summary>
  258. </member>
  259. <member name="M:StackExchange.Redis.SlotRange.op_Inequality(StackExchange.Redis.SlotRange,StackExchange.Redis.SlotRange)">
  260. <summary>
  261. Indicates whether two ranges are not equal
  262. </summary>
  263. </member>
  264. <member name="M:StackExchange.Redis.SlotRange.op_Equality(StackExchange.Redis.SlotRange,StackExchange.Redis.SlotRange)">
  265. <summary>
  266. Indicates whether two ranges are equal
  267. </summary>
  268. </member>
  269. <member name="M:StackExchange.Redis.SlotRange.TryParse(System.String,StackExchange.Redis.SlotRange@)">
  270. <summary>
  271. Try to parse a string as a range
  272. </summary>
  273. </member>
  274. <member name="M:StackExchange.Redis.SlotRange.CompareTo(StackExchange.Redis.SlotRange)">
  275. <summary>
  276. Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
  277. </summary>
  278. </member>
  279. <member name="M:StackExchange.Redis.SlotRange.Equals(System.Object)">
  280. <summary>
  281. See Object.Equals
  282. </summary>
  283. </member>
  284. <member name="M:StackExchange.Redis.SlotRange.Equals(StackExchange.Redis.SlotRange)">
  285. <summary>
  286. Indicates whether two ranges are equal
  287. </summary>
  288. </member>
  289. <member name="M:StackExchange.Redis.SlotRange.GetHashCode">
  290. <summary>
  291. See Object.GetHashCode()
  292. </summary>
  293. </member>
  294. <member name="M:StackExchange.Redis.SlotRange.ToString">
  295. <summary>
  296. See Object.ToString()
  297. </summary>
  298. </member>
  299. <member name="T:StackExchange.Redis.ClusterConfiguration">
  300. <summary>
  301. Describes the state of the cluster as reported by a single node
  302. </summary>
  303. </member>
  304. <member name="P:StackExchange.Redis.ClusterConfiguration.Nodes">
  305. <summary>
  306. Gets all nodes contained in the configuration
  307. </summary>
  308. <returns></returns>
  309. </member>
  310. <member name="P:StackExchange.Redis.ClusterConfiguration.Origin">
  311. <summary>
  312. The node that was asked for the configuration
  313. </summary>
  314. </member>
  315. <member name="P:StackExchange.Redis.ClusterConfiguration.Item(System.Net.EndPoint)">
  316. <summary>
  317. Obtain the node relating to a specified endpoint
  318. </summary>
  319. </member>
  320. <member name="M:StackExchange.Redis.ClusterConfiguration.GetBySlot(System.Int32)">
  321. <summary>
  322. Gets the node that serves the specified slot
  323. </summary>
  324. </member>
  325. <member name="M:StackExchange.Redis.ClusterConfiguration.GetBySlot(StackExchange.Redis.RedisKey)">
  326. <summary>
  327. Gets the node that serves the specified slot
  328. </summary>
  329. </member>
  330. <member name="T:StackExchange.Redis.ClusterNode">
  331. <summary>
  332. Represents the configuration of a single node in a cluster configuration
  333. </summary>
  334. </member>
  335. <member name="P:StackExchange.Redis.ClusterNode.Children">
  336. <summary>
  337. Gets all child nodes of the current node
  338. </summary>
  339. </member>
  340. <member name="P:StackExchange.Redis.ClusterNode.EndPoint">
  341. <summary>
  342. Gets the endpoint of the current node
  343. </summary>
  344. </member>
  345. <member name="P:StackExchange.Redis.ClusterNode.IsMyself">
  346. <summary>
  347. Gets whether this is the node which responded to the CLUSTER NODES request
  348. </summary>
  349. </member>
  350. <member name="P:StackExchange.Redis.ClusterNode.IsSlave">
  351. <summary>
  352. Gets whether this node is a slave
  353. </summary>
  354. </member>
  355. <member name="P:StackExchange.Redis.ClusterNode.IsNoAddr">
  356. <summary>
  357. Gets whether this node is flagged as noaddr
  358. </summary>
  359. </member>
  360. <member name="P:StackExchange.Redis.ClusterNode.IsConnected">
  361. <summary>
  362. Gets the node's connection status
  363. </summary>
  364. </member>
  365. <member name="P:StackExchange.Redis.ClusterNode.NodeId">
  366. <summary>
  367. Gets the unique node-id of the current node
  368. </summary>
  369. </member>
  370. <member name="P:StackExchange.Redis.ClusterNode.Parent">
  371. <summary>
  372. Gets the parent node of the current node
  373. </summary>
  374. </member>
  375. <member name="P:StackExchange.Redis.ClusterNode.ParentNodeId">
  376. <summary>
  377. Gets the unique node-id of the parent of the current node
  378. </summary>
  379. </member>
  380. <member name="P:StackExchange.Redis.ClusterNode.Raw">
  381. <summary>
  382. The configuration as reported by the server
  383. </summary>
  384. </member>
  385. <member name="P:StackExchange.Redis.ClusterNode.Slots">
  386. <summary>
  387. The slots owned by this server
  388. </summary>
  389. </member>
  390. <member name="M:StackExchange.Redis.ClusterNode.CompareTo(StackExchange.Redis.ClusterNode)">
  391. <summary>
  392. Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
  393. </summary>
  394. </member>
  395. <member name="M:StackExchange.Redis.ClusterNode.Equals(System.Object)">
  396. <summary>
  397. See Object.Equals
  398. </summary>
  399. </member>
  400. <member name="M:StackExchange.Redis.ClusterNode.Equals(StackExchange.Redis.ClusterNode)">
  401. <summary>
  402. Indicates whether two ClusterNode instances are equivalent
  403. </summary>
  404. </member>
  405. <member name="M:StackExchange.Redis.ClusterNode.GetHashCode">
  406. <summary>
  407. See object.GetHashCode()
  408. </summary>
  409. </member>
  410. <member name="M:StackExchange.Redis.ClusterNode.ToString">
  411. <summary>
  412. See Object.ToString()
  413. </summary>
  414. </member>
  415. <member name="T:StackExchange.Redis.CommandFlags">
  416. <summary>
  417. Behaviour markers associated with a given command
  418. </summary>
  419. </member>
  420. <member name="F:StackExchange.Redis.CommandFlags.None">
  421. <summary>
  422. Default behaviour.
  423. </summary>
  424. </member>
  425. <member name="F:StackExchange.Redis.CommandFlags.HighPriority">
  426. <summary>
  427. This command may jump regular-priority commands that have not yet been written to the redis stream.
  428. </summary>
  429. </member>
  430. <member name="F:StackExchange.Redis.CommandFlags.FireAndForget">
  431. <summary>
  432. The caller is not interested in the result; the caller will immediately receive a default-value
  433. of the expected return type (this value is not indicative of anything at the server).
  434. </summary>
  435. </member>
  436. <member name="F:StackExchange.Redis.CommandFlags.PreferMaster">
  437. <summary>
  438. This operation should be performed on the master if it is available, but read operations may
  439. be performed on a slave if no master is available. This is the default option.
  440. </summary>
  441. </member>
  442. <member name="F:StackExchange.Redis.CommandFlags.DemandMaster">
  443. <summary>
  444. This operation should only be performed on the master.
  445. </summary>
  446. </member>
  447. <member name="F:StackExchange.Redis.CommandFlags.PreferSlave">
  448. <summary>
  449. This operation should be performed on the slave if it is available, but will be performed on
  450. a master if no slaves are available. Suitable for read operations only.
  451. </summary>
  452. </member>
  453. <member name="F:StackExchange.Redis.CommandFlags.DemandSlave">
  454. <summary>
  455. This operation should only be performed on a slave. Suitable for read operations only.
  456. </summary>
  457. </member>
  458. <member name="F:StackExchange.Redis.CommandFlags.NoRedirect">
  459. <summary>
  460. Indicates that this operation should not be forwarded to other servers as a result of an ASK or MOVED response
  461. </summary>
  462. </member>
  463. <member name="T:StackExchange.Redis.CommandMap">
  464. <summary>
  465. Represents the commands mapped on a particular configuration
  466. </summary>
  467. </member>
  468. <member name="P:StackExchange.Redis.CommandMap.Default">
  469. <summary>
  470. The default commands specified by redis
  471. </summary>
  472. </member>
  473. <member name="P:StackExchange.Redis.CommandMap.Twemproxy">
  474. <summary>
  475. The commands available to <a href="twemproxy">https://github.com/twitter/twemproxy</a>
  476. </summary>
  477. <remarks>https://github.com/twitter/twemproxy/blob/master/notes/redis.md</remarks>
  478. </member>
  479. <member name="P:StackExchange.Redis.CommandMap.SSDB">
  480. <summary>
  481. The commands available to <a href="ssdb">http://www.ideawu.com/ssdb/</a>
  482. </summary>
  483. <remarks>http://www.ideawu.com/ssdb/docs/redis-to-ssdb.html</remarks>
  484. </member>
  485. <member name="P:StackExchange.Redis.CommandMap.Sentinel">
  486. <summary>
  487. The commands available to <a href="Sentinel">http://redis.io/topics/sentinel</a>
  488. </summary>
  489. <remarks>http://redis.io/topics/sentinel</remarks>
  490. </member>
  491. <member name="M:StackExchange.Redis.CommandMap.Create(System.Collections.Generic.Dictionary{System.String,System.String})">
  492. <summary>
  493. Create a new CommandMap, customizing some commands
  494. </summary>
  495. </member>
  496. <member name="M:StackExchange.Redis.CommandMap.Create(System.Collections.Generic.HashSet{System.String},System.Boolean)">
  497. <summary>
  498. Creates a CommandMap by specifying which commands are available or unavailable
  499. </summary>
  500. </member>
  501. <member name="M:StackExchange.Redis.CommandMap.ToString">
  502. <summary>
  503. See Object.ToString()
  504. </summary>
  505. </member>
  506. <member name="T:StackExchange.Redis.CommandTrace">
  507. <summary>
  508. Represents the information known about long-running commands
  509. </summary>
  510. </member>
  511. <member name="P:StackExchange.Redis.CommandTrace.Arguments">
  512. <summary>
  513. The array composing the arguments of the command.
  514. </summary>
  515. </member>
  516. <member name="P:StackExchange.Redis.CommandTrace.Duration">
  517. <summary>
  518. The amount of time needed for its execution
  519. </summary>
  520. </member>
  521. <member name="P:StackExchange.Redis.CommandTrace.Time">
  522. <summary>
  523. The time at which the logged command was processed.
  524. </summary>
  525. </member>
  526. <member name="P:StackExchange.Redis.CommandTrace.UniqueId">
  527. <summary>
  528. A unique progressive identifier for every slow log entry.
  529. </summary>
  530. <remarks>The entry's unique ID can be used in order to avoid processing slow log entries multiple times (for instance you may have a script sending you an email alert for every new slow log entry). The ID is never reset in the course of the Redis server execution, only a server restart will reset it.</remarks>
  531. </member>
  532. <member name="M:StackExchange.Redis.CommandTrace.GetHelpUrl">
  533. <summary>
  534. Deduces a link to the redis documentation about the specified command
  535. </summary>
  536. </member>
  537. <member name="T:StackExchange.Redis.ProfiledCommandEnumerable">
  538. <summary>
  539. A collection of IProfiledCommands.
  540. This is a very light weight data structure, only supporting enumeration.
  541. While it implements IEnumerable, it there are fewer allocations if one uses
  542. it's explicit GetEnumerator() method. Using `foreach` does this automatically.
  543. This type is not threadsafe.
  544. </summary>
  545. </member>
  546. <member name="T:StackExchange.Redis.ProfiledCommandEnumerable.Enumerator">
  547. <summary>
  548. Implements IEnumerator for ProfiledCommandEnumerable.
  549. This implementation is comparable to List.Enumerator and Dictionary.Enumerator,
  550. and is provided to reduce allocations in the common (ie. foreach) case.
  551. This type is not threadsafe.
  552. </summary>
  553. </member>
  554. <member name="P:StackExchange.Redis.ProfiledCommandEnumerable.Enumerator.Current">
  555. <summary>
  556. The current element.
  557. </summary>
  558. </member>
  559. <member name="M:StackExchange.Redis.ProfiledCommandEnumerable.Enumerator.MoveNext">
  560. <summary>
  561. Advances the enumeration, returning true if there is a new element to consume and false
  562. if enumeration is complete.
  563. </summary>
  564. </member>
  565. <member name="M:StackExchange.Redis.ProfiledCommandEnumerable.Enumerator.Reset">
  566. <summary>
  567. Resets the enumeration.
  568. </summary>
  569. </member>
  570. <member name="M:StackExchange.Redis.ProfiledCommandEnumerable.Enumerator.Dispose">
  571. <summary>
  572. Disposes the enumeration.
  573. subsequent attempts to enumerate results in undefined behavior.
  574. </summary>
  575. </member>
  576. <member name="M:StackExchange.Redis.ProfiledCommandEnumerable.GetEnumerator">
  577. <summary>
  578. Returns an implementor of IEnumerator that, provided it isn't accessed
  579. though an interface, avoids allocations.
  580. `foreach` will automatically use this method.
  581. </summary>
  582. </member>
  583. <member name="T:StackExchange.Redis.ConcurrentProfileStorageCollection">
  584. <summary>
  585. A thread-safe collection tailored to the "always append, with high contention, then enumerate once with no contention"
  586. behavior of our profiling.
  587. Performs better than ConcurrentBag, which is important since profiling code shouldn't impact timings.
  588. </summary>
  589. </member>
  590. <member name="M:StackExchange.Redis.ConcurrentProfileStorageCollection.Add(StackExchange.Redis.ProfileStorage)">
  591. <summary>
  592. This method is thread-safe.
  593. Adds an element to the bag.
  594. Order is not preserved.
  595. The element can only be a member of *one* bag.
  596. </summary>
  597. </member>
  598. <member name="M:StackExchange.Redis.ConcurrentProfileStorageCollection.EnumerateAndReturnForReuse">
  599. <summary>
  600. This method returns an enumerable view of the bag, and returns it to
  601. an internal pool for reuse by GetOrCreate().
  602. It is not thread safe.
  603. It should only be called once the bag is finished being mutated.
  604. </summary>
  605. </member>
  606. <member name="M:StackExchange.Redis.ConcurrentProfileStorageCollection.ReturnForReuse">
  607. <summary>
  608. This returns the ConcurrentProfileStorageCollection to an internal pool for reuse by GetOrCreate().
  609. </summary>
  610. </member>
  611. <member name="M:StackExchange.Redis.ConcurrentProfileStorageCollection.GetOrCreate">
  612. <summary>
  613. Returns a ConcurrentProfileStorageCollection to use.
  614. It *may* have allocated a new one, or it may return one that has previously been released.
  615. To return the collection, call EnumerateAndReturnForReuse()
  616. </summary>
  617. </member>
  618. <member name="T:StackExchange.Redis.Condition">
  619. <summary>
  620. Describes a pre-condition used in a redis transaction
  621. </summary>
  622. </member>
  623. <member name="M:StackExchange.Redis.Condition.HashEqual(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue)">
  624. <summary>
  625. Enforces that the given hash-field must have the specified value
  626. </summary>
  627. </member>
  628. <member name="M:StackExchange.Redis.Condition.HashExists(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue)">
  629. <summary>
  630. Enforces that the given hash-field must exist
  631. </summary>
  632. </member>
  633. <member name="M:StackExchange.Redis.Condition.HashNotEqual(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue)">
  634. <summary>
  635. Enforces that the given hash-field must not have the specified value
  636. </summary>
  637. </member>
  638. <member name="M:StackExchange.Redis.Condition.HashNotExists(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue)">
  639. <summary>
  640. Enforces that the given hash-field must not exist
  641. </summary>
  642. </member>
  643. <member name="M:StackExchange.Redis.Condition.KeyExists(StackExchange.Redis.RedisKey)">
  644. <summary>
  645. Enforces that the given key must exist
  646. </summary>
  647. </member>
  648. <member name="M:StackExchange.Redis.Condition.KeyNotExists(StackExchange.Redis.RedisKey)">
  649. <summary>
  650. Enforces that the given key must not exist
  651. </summary>
  652. </member>
  653. <member name="M:StackExchange.Redis.Condition.ListIndexEqual(StackExchange.Redis.RedisKey,System.Int64,StackExchange.Redis.RedisValue)">
  654. <summary>
  655. Enforces that the given list index must have the specified value
  656. </summary>
  657. </member>
  658. <member name="M:StackExchange.Redis.Condition.ListIndexExists(StackExchange.Redis.RedisKey,System.Int64)">
  659. <summary>
  660. Enforces that the given list index must exist
  661. </summary>
  662. </member>
  663. <member name="M:StackExchange.Redis.Condition.ListIndexNotEqual(StackExchange.Redis.RedisKey,System.Int64,StackExchange.Redis.RedisValue)">
  664. <summary>
  665. Enforces that the given list index must not have the specified value
  666. </summary>
  667. </member>
  668. <member name="M:StackExchange.Redis.Condition.ListIndexNotExists(StackExchange.Redis.RedisKey,System.Int64)">
  669. <summary>
  670. Enforces that the given list index must not exist
  671. </summary>
  672. </member>
  673. <member name="M:StackExchange.Redis.Condition.StringEqual(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue)">
  674. <summary>
  675. Enforces that the given key must have the specified value
  676. </summary>
  677. </member>
  678. <member name="M:StackExchange.Redis.Condition.StringNotEqual(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue)">
  679. <summary>
  680. Enforces that the given key must not have the specified value
  681. </summary>
  682. </member>
  683. <member name="M:StackExchange.Redis.Condition.HashLengthEqual(StackExchange.Redis.RedisKey,System.Int64)">
  684. <summary>
  685. Enforces that the given hash length is a certain value
  686. </summary>
  687. </member>
  688. <member name="M:StackExchange.Redis.Condition.HashLengthLessThan(StackExchange.Redis.RedisKey,System.Int64)">
  689. <summary>
  690. Enforces that the given hash length is less than a certain value
  691. </summary>
  692. </member>
  693. <member name="M:StackExchange.Redis.Condition.HashLengthGreaterThan(StackExchange.Redis.RedisKey,System.Int64)">
  694. <summary>
  695. Enforces that the given hash length is greater than a certain value
  696. </summary>
  697. </member>
  698. <member name="M:StackExchange.Redis.Condition.StringLengthEqual(StackExchange.Redis.RedisKey,System.Int64)">
  699. <summary>
  700. Enforces that the given string length is a certain value
  701. </summary>
  702. </member>
  703. <member name="M:StackExchange.Redis.Condition.StringLengthLessThan(StackExchange.Redis.RedisKey,System.Int64)">
  704. <summary>
  705. Enforces that the given string length is less than a certain value
  706. </summary>
  707. </member>
  708. <member name="M:StackExchange.Redis.Condition.StringLengthGreaterThan(StackExchange.Redis.RedisKey,System.Int64)">
  709. <summary>
  710. Enforces that the given string length is greater than a certain value
  711. </summary>
  712. </member>
  713. <member name="M:StackExchange.Redis.Condition.ListLengthEqual(StackExchange.Redis.RedisKey,System.Int64)">
  714. <summary>
  715. Enforces that the given list length is a certain value
  716. </summary>
  717. </member>
  718. <member name="M:StackExchange.Redis.Condition.ListLengthLessThan(StackExchange.Redis.RedisKey,System.Int64)">
  719. <summary>
  720. Enforces that the given list length is less than a certain value
  721. </summary>
  722. </member>
  723. <member name="M:StackExchange.Redis.Condition.ListLengthGreaterThan(StackExchange.Redis.RedisKey,System.Int64)">
  724. <summary>
  725. Enforces that the given list length is greater than a certain value
  726. </summary>
  727. </member>
  728. <member name="M:StackExchange.Redis.Condition.SetLengthEqual(StackExchange.Redis.RedisKey,System.Int64)">
  729. <summary>
  730. Enforces that the given set cardinality is a certain value
  731. </summary>
  732. </member>
  733. <member name="M:StackExchange.Redis.Condition.SetLengthLessThan(StackExchange.Redis.RedisKey,System.Int64)">
  734. <summary>
  735. Enforces that the given set cardinality is less than a certain value
  736. </summary>
  737. </member>
  738. <member name="M:StackExchange.Redis.Condition.SetLengthGreaterThan(StackExchange.Redis.RedisKey,System.Int64)">
  739. <summary>
  740. Enforces that the given set cardinality is greater than a certain value
  741. </summary>
  742. </member>
  743. <member name="M:StackExchange.Redis.Condition.SortedSetLengthEqual(StackExchange.Redis.RedisKey,System.Int64)">
  744. <summary>
  745. Enforces that the given sorted set cardinality is a certain value
  746. </summary>
  747. </member>
  748. <member name="M:StackExchange.Redis.Condition.SortedSetLengthLessThan(StackExchange.Redis.RedisKey,System.Int64)">
  749. <summary>
  750. Enforces that the given sorted set cardinality is less than a certain value
  751. </summary>
  752. </member>
  753. <member name="M:StackExchange.Redis.Condition.SortedSetLengthGreaterThan(StackExchange.Redis.RedisKey,System.Int64)">
  754. <summary>
  755. Enforces that the given sorted set cardinality is greater than a certain value
  756. </summary>
  757. </member>
  758. <member name="T:StackExchange.Redis.ConditionResult">
  759. <summary>
  760. Indicates the status of a condition as part of a transaction
  761. </summary>
  762. </member>
  763. <member name="P:StackExchange.Redis.ConditionResult.WasSatisfied">
  764. <summary>
  765. Indicates whether the condition was satisfied
  766. </summary>
  767. </member>
  768. <member name="T:StackExchange.Redis.Proxy">
  769. <summary>
  770. Specifies the proxy that is being used to communicate to redis
  771. </summary>
  772. </member>
  773. <member name="F:StackExchange.Redis.Proxy.None">
  774. <summary>
  775. Direct communication to the redis server(s)
  776. </summary>
  777. </member>
  778. <member name="F:StackExchange.Redis.Proxy.Twemproxy">
  779. <summary>
  780. Communication via <a href="https://github.com/twitter/twemproxy">twemproxy</a>
  781. </summary>
  782. </member>
  783. <member name="T:StackExchange.Redis.ConfigurationOptions">
  784. <summary>
  785. The options relevant to a set of redis connections
  786. </summary>
  787. </member>
  788. <member name="E:StackExchange.Redis.ConfigurationOptions.CertificateSelection">
  789. <summary>
  790. A LocalCertificateSelectionCallback delegate responsible for selecting the certificate used for authentication; note
  791. that this cannot be specified in the configuration-string.
  792. </summary>
  793. </member>
  794. <member name="E:StackExchange.Redis.ConfigurationOptions.CertificateValidation">
  795. <summary>
  796. A RemoteCertificateValidationCallback delegate responsible for validating the certificate supplied by the remote party; note
  797. that this cannot be specified in the configuration-string.
  798. </summary>
  799. </member>
  800. <member name="P:StackExchange.Redis.ConfigurationOptions.AbortOnConnectFail">
  801. <summary>
  802. Gets or sets whether connect/configuration timeouts should be explicitly notified via a TimeoutException
  803. </summary>
  804. </member>
  805. <member name="P:StackExchange.Redis.ConfigurationOptions.AllowAdmin">
  806. <summary>
  807. Indicates whether admin operations should be allowed
  808. </summary>
  809. </member>
  810. <member name="P:StackExchange.Redis.ConfigurationOptions.UseSsl">
  811. <summary>
  812. Indicates whether the connection should be encrypted
  813. </summary>
  814. </member>
  815. <member name="P:StackExchange.Redis.ConfigurationOptions.Ssl">
  816. <summary>
  817. Indicates whether the connection should be encrypted
  818. </summary>
  819. </member>
  820. <member name="P:StackExchange.Redis.ConfigurationOptions.ChannelPrefix">
  821. <summary>
  822. Automatically encodes and decodes channels
  823. </summary>
  824. </member>
  825. <member name="P:StackExchange.Redis.ConfigurationOptions.ClientName">
  826. <summary>
  827. The client name to use for all connections
  828. </summary>
  829. </member>
  830. <member name="P:StackExchange.Redis.ConfigurationOptions.ConnectRetry">
  831. <summary>
  832. The number of times to repeat the initial connect cycle if no servers respond promptly
  833. </summary>
  834. </member>
  835. <member name="P:StackExchange.Redis.ConfigurationOptions.CommandMap">
  836. <summary>
  837. The command-map associated with this configuration
  838. </summary>
  839. </member>
  840. <member name="P:StackExchange.Redis.ConfigurationOptions.ConfigurationChannel">
  841. <summary>
  842. Channel to use for broadcasting and listening for configuration change notification
  843. </summary>
  844. </member>
  845. <member name="P:StackExchange.Redis.ConfigurationOptions.ConnectTimeout">
  846. <summary>
  847. Specifies the time in milliseconds that should be allowed for connection (defaults to 5 seconds unless SyncTimeout is higher)
  848. </summary>
  849. </member>
  850. <member name="P:StackExchange.Redis.ConfigurationOptions.DefaultVersion">
  851. <summary>
  852. The server version to assume
  853. </summary>
  854. </member>
  855. <member name="P:StackExchange.Redis.ConfigurationOptions.EndPoints">
  856. <summary>
  857. The endpoints defined for this configuration
  858. </summary>
  859. </member>
  860. <member name="P:StackExchange.Redis.ConfigurationOptions.HighPrioritySocketThreads">
  861. <summary>
  862. Use ThreadPriority.AboveNormal for SocketManager reader and writer threads (true by default). If false, ThreadPriority.Normal will be used.
  863. </summary>
  864. </member>
  865. <member name="P:StackExchange.Redis.ConfigurationOptions.KeepAlive">
  866. <summary>
  867. Specifies the time in seconds at which connections should be pinged to ensure validity
  868. </summary>
  869. </member>
  870. <member name="P:StackExchange.Redis.ConfigurationOptions.Password">
  871. <summary>
  872. The password to use to authenticate with the server
  873. </summary>
  874. </member>
  875. <member name="P:StackExchange.Redis.ConfigurationOptions.Proxy">
  876. <summary>
  877. Indicates whether admin operations should be allowed
  878. </summary>
  879. </member>
  880. <member name="P:StackExchange.Redis.ConfigurationOptions.ResolveDns">
  881. <summary>
  882. Indicates whether endpoints should be resolved via DNS before connecting.
  883. If enabled the ConnectionMultiplexer will not re-resolve DNS
  884. when attempting to re-connect after a connection failure.
  885. </summary>
  886. </member>
  887. <member name="P:StackExchange.Redis.ConfigurationOptions.ServiceName">
  888. <summary>
  889. The service name used to resolve a service via sentinel
  890. </summary>
  891. </member>
  892. <member name="P:StackExchange.Redis.ConfigurationOptions.SocketManager">
  893. <summary>
  894. Gets or sets the SocketManager instance to be used with these options; if this is null a per-multiplexer
  895. SocketManager is created automatically.
  896. </summary>
  897. </member>
  898. <member name="P:StackExchange.Redis.ConfigurationOptions.SslHost">
  899. <summary>
  900. The target-host to use when validating SSL certificate; setting a value here enables SSL mode
  901. </summary>
  902. </member>
  903. <member name="P:StackExchange.Redis.ConfigurationOptions.SyncTimeout">
  904. <summary>
  905. Specifies the time in milliseconds that the system should allow for synchronous operations (defaults to 1 second)
  906. </summary>
  907. </member>
  908. <member name="P:StackExchange.Redis.ConfigurationOptions.ResponseTimeout">
  909. <summary>
  910. Specifies the time in milliseconds that the system should allow for responses before concluding that the socket is unhealthy
  911. (defaults to SyncTimeout)
  912. </summary>
  913. </member>
  914. <member name="P:StackExchange.Redis.ConfigurationOptions.TieBreaker">
  915. <summary>
  916. Tie-breaker used to choose between masters (must match the endpoint exactly)
  917. </summary>
  918. </member>
  919. <member name="P:StackExchange.Redis.ConfigurationOptions.WriteBuffer">
  920. <summary>
  921. The size of the output buffer to use
  922. </summary>
  923. </member>
  924. <member name="P:StackExchange.Redis.ConfigurationOptions.DefaultDatabase">
  925. <summary>
  926. Specifies the default database to be used when calling ConnectionMultiplexer.GetDatabase() without any parameters
  927. </summary>
  928. </member>
  929. <member name="P:StackExchange.Redis.ConfigurationOptions.ConfigCheckSeconds">
  930. <summary>
  931. Check configuration every n seconds (every minute by default)
  932. </summary>
  933. </member>
  934. <member name="M:StackExchange.Redis.ConfigurationOptions.Parse(System.String)">
  935. <summary>
  936. Parse the configuration from a comma-delimited configuration string
  937. </summary>
  938. <exception cref="T:System.ArgumentNullException"><paramref name="configuration"/> is <c>null</c>.</exception>
  939. <exception cref="T:System.ArgumentException"><paramref name="configuration"/> is empty.</exception>
  940. </member>
  941. <member name="M:StackExchange.Redis.ConfigurationOptions.Parse(System.String,System.Boolean)">
  942. <summary>
  943. Parse the configuration from a comma-delimited configuration string
  944. </summary>
  945. <exception cref="T:System.ArgumentNullException"><paramref name="configuration"/> is <c>null</c>.</exception>
  946. <exception cref="T:System.ArgumentException"><paramref name="configuration"/> is empty.</exception>
  947. </member>
  948. <member name="M:StackExchange.Redis.ConfigurationOptions.Clone">
  949. <summary>
  950. Create a copy of the configuration
  951. </summary>
  952. </member>
  953. <member name="M:StackExchange.Redis.ConfigurationOptions.SetDefaultPorts">
  954. <summary>
  955. Resolve the default port for any endpoints that did not have a port explicitly specified
  956. </summary>
  957. </member>
  958. <member name="M:StackExchange.Redis.ConfigurationOptions.ToString">
  959. <summary>
  960. Returns the effective configuration string for this configuration
  961. </summary>
  962. </member>
  963. <member name="T:StackExchange.Redis.ConnectionCounters">
  964. <summary>
  965. Illustrates the counters associated with an individual connection
  966. </summary>
  967. </member>
  968. <member name="P:StackExchange.Redis.ConnectionCounters.CompletedAsynchronously">
  969. <summary>
  970. The number of operations that have been completed asynchronously
  971. </summary>
  972. </member>
  973. <member name="P:StackExchange.Redis.ConnectionCounters.CompletedSynchronously">
  974. <summary>
  975. The number of operations that have been completed synchronously
  976. </summary>
  977. </member>
  978. <member name="P:StackExchange.Redis.ConnectionCounters.ConnectionType">
  979. <summary>
  980. The type of this connection
  981. </summary>
  982. </member>
  983. <member name="P:StackExchange.Redis.ConnectionCounters.FailedAsynchronously">
  984. <summary>
  985. The number of operations that failed to complete asynchronously
  986. </summary>
  987. </member>
  988. <member name="P:StackExchange.Redis.ConnectionCounters.IsEmpty">
  989. <summary>
  990. Indicates if there are any pending items or failures on this connection
  991. </summary>
  992. </member>
  993. <member name="P:StackExchange.Redis.ConnectionCounters.NonPreferredEndpointCount">
  994. <summary>
  995. Indicates the total number of messages despatched to a non-preferred endpoint, for example sent to a master
  996. when the caller stated a preference of slave
  997. </summary>
  998. </member>
  999. <member name="P:StackExchange.Redis.ConnectionCounters.OperationCount">
  1000. <summary>
  1001. The number of operations performed on this connection
  1002. </summary>
  1003. </member>
  1004. <member name="P:StackExchange.Redis.ConnectionCounters.PendingUnsentItems">
  1005. <summary>
  1006. Operations that have been requested, but which have not yet been sent to the server
  1007. </summary>
  1008. </member>
  1009. <member name="P:StackExchange.Redis.ConnectionCounters.ResponsesAwaitingAsyncCompletion">
  1010. <summary>
  1011. Operations for which the response has been processed, but which are awaiting asynchronous completion
  1012. </summary>
  1013. </member>
  1014. <member name="P:StackExchange.Redis.ConnectionCounters.SentItemsAwaitingResponse">
  1015. <summary>
  1016. Operations that have been sent to the server, but which are awaiting a response
  1017. </summary>
  1018. </member>
  1019. <member name="P:StackExchange.Redis.ConnectionCounters.SocketCount">
  1020. <summary>
  1021. The number of sockets used by this logical connection (total, including reconnects)
  1022. </summary>
  1023. </member>
  1024. <member name="P:StackExchange.Redis.ConnectionCounters.Subscriptions">
  1025. <summary>
  1026. The number of subscriptions (with and without patterns) currently held against this connection
  1027. </summary>
  1028. </member>
  1029. <member name="P:StackExchange.Redis.ConnectionCounters.TotalOutstanding">
  1030. <summary>
  1031. Indicates the total number of outstanding items against this connection
  1032. </summary>
  1033. </member>
  1034. <member name="P:StackExchange.Redis.ConnectionCounters.WriterCount">
  1035. <summary>
  1036. Indicates the total number of writers items against this connection
  1037. </summary>
  1038. </member>
  1039. <member name="M:StackExchange.Redis.ConnectionCounters.ToString">
  1040. <summary>
  1041. See Object.ToString()
  1042. </summary>
  1043. </member>
  1044. <member name="T:StackExchange.Redis.ConnectionFailedEventArgs">
  1045. <summary>
  1046. Contains information about a server connection failure
  1047. </summary>
  1048. </member>
  1049. <member name="P:StackExchange.Redis.ConnectionFailedEventArgs.ConnectionType">
  1050. <summary>
  1051. Gets the connection-type of the failing connection
  1052. </summary>
  1053. </member>
  1054. <member name="P:StackExchange.Redis.ConnectionFailedEventArgs.EndPoint">
  1055. <summary>
  1056. Gets the failing server-endpoint
  1057. </summary>
  1058. </member>
  1059. <member name="P:StackExchange.Redis.ConnectionFailedEventArgs.Exception">
  1060. <summary>
  1061. Gets the exception if available (this can be null)
  1062. </summary>
  1063. </member>
  1064. <member name="P:StackExchange.Redis.ConnectionFailedEventArgs.FailureType">
  1065. <summary>
  1066. The type of failure
  1067. </summary>
  1068. </member>
  1069. <member name="T:StackExchange.Redis.ConnectionFailureType">
  1070. <summary>
  1071. The known types of connection failure
  1072. </summary>
  1073. </member>
  1074. <member name="F:StackExchange.Redis.ConnectionFailureType.None">
  1075. <summary>
  1076. This event is not a failure
  1077. </summary>
  1078. </member>
  1079. <member name="F:StackExchange.Redis.ConnectionFailureType.UnableToResolvePhysicalConnection">
  1080. <summary>
  1081. No viable connections were available for this operation
  1082. </summary>
  1083. </member>
  1084. <member name="F:StackExchange.Redis.ConnectionFailureType.SocketFailure">
  1085. <summary>
  1086. The socket for this connection failed
  1087. </summary>
  1088. </member>
  1089. <member name="F:StackExchange.Redis.ConnectionFailureType.AuthenticationFailure">
  1090. <summary>
  1091. Either SSL Stream or Redis authentication failed
  1092. </summary>
  1093. </member>
  1094. <member name="F:StackExchange.Redis.ConnectionFailureType.ProtocolFailure">
  1095. <summary>
  1096. An unexpected response was received from the server
  1097. </summary>
  1098. </member>
  1099. <member name="F:StackExchange.Redis.ConnectionFailureType.InternalFailure">
  1100. <summary>
  1101. An unknown internal error occurred
  1102. </summary>
  1103. </member>
  1104. <member name="F:StackExchange.Redis.ConnectionFailureType.SocketClosed">
  1105. <summary>
  1106. The socket was closed
  1107. </summary>
  1108. </member>
  1109. <member name="F:StackExchange.Redis.ConnectionFailureType.ConnectionDisposed">
  1110. <summary>
  1111. The socket was closed
  1112. </summary>
  1113. </member>
  1114. <member name="F:StackExchange.Redis.ConnectionFailureType.Loading">
  1115. <summary>
  1116. The database is loading and is not available for use
  1117. </summary>
  1118. </member>
  1119. <member name="F:StackExchange.Redis.ConnectionFailureType.UnableToConnect">
  1120. <summary>
  1121. It has not been possible to create an intial connection to the redis server(s)
  1122. </summary>
  1123. </member>
  1124. <member name="T:StackExchange.Redis.ConnectionMultiplexer">
  1125. <summary>
  1126. Represents an inter-related group of connections to redis servers
  1127. </summary>
  1128. </member>
  1129. <member name="P:StackExchange.Redis.ConnectionMultiplexer.Factory">
  1130. <summary>
  1131. Provides a way of overriding the default Task Factory. If not set, it will use the default Task.Factory.
  1132. Useful when top level code sets it's own factory which may interfere with Redis queries.
  1133. </summary>
  1134. </member>
  1135. <member name="M:StackExchange.Redis.ConnectionMultiplexer.GetCounters">
  1136. <summary>
  1137. Get summary statistics associates with this server
  1138. </summary>
  1139. </member>
  1140. <member name="P:StackExchange.Redis.ConnectionMultiplexer.ClientName">
  1141. <summary>
  1142. Gets the client-name that will be used on all new connections
  1143. </summary>
  1144. </member>
  1145. <member name="M:StackExchange.Redis.ConnectionMultiplexer.TryGetAzureRoleInstanceIdNoThrow">
  1146. Tries to get the Roleinstance Id if Microsoft.WindowsAzure.ServiceRuntime is loaded.
  1147. In case of any failure, swallows the exception and returns null
  1148. </member>
  1149. <member name="P:StackExchange.Redis.ConnectionMultiplexer.Configuration">
  1150. <summary>
  1151. Gets the configuration of the connection
  1152. </summary>
  1153. </member>
  1154. <member name="E:StackExchange.Redis.ConnectionMultiplexer.ErrorMessage">
  1155. <summary>
  1156. A server replied with an error message;
  1157. </summary>
  1158. </member>
  1159. <member name="M:StackExchange.Redis.ConnectionMultiplexer.ExportConfiguration(System.IO.Stream,StackExchange.Redis.ExportOptions)">
  1160. <summary>
  1161. Write the configuration of all servers to an output stream
  1162. </summary>
  1163. </member>
  1164. <member name="P:StackExchange.Redis.ConnectionMultiplexer.LogSyncLock">
  1165. <summary>
  1166. Used internally to synchronize loggine without depending on locking the log instance
  1167. </summary>
  1168. </member>
  1169. <member name="E:StackExchange.Redis.ConnectionMultiplexer.ConnectionFailed">
  1170. <summary>
  1171. Raised whenever a physical connection fails
  1172. </summary>
  1173. </member>
  1174. <member name="E:StackExchange.Redis.ConnectionMultiplexer.InternalError">
  1175. <summary>
  1176. Raised whenever an internal error occurs (this is primarily for debugging)
  1177. </summary>
  1178. </member>
  1179. <member name="E:StackExchange.Redis.ConnectionMultiplexer.ConnectionRestored">
  1180. <summary>
  1181. Raised whenever a physical connection is established
  1182. </summary>
  1183. </member>
  1184. <member name="E:StackExchange.Redis.ConnectionMultiplexer.ConfigurationChanged">
  1185. <summary>
  1186. Raised when configuration changes are detected
  1187. </summary>
  1188. </member>
  1189. <member name="E:StackExchange.Redis.ConnectionMultiplexer.ConfigurationChangedBroadcast">
  1190. <summary>
  1191. Raised when nodes are explicitly requested to reconfigure via broadcast;
  1192. this usually means master/slave changes
  1193. </summary>
  1194. </member>
  1195. <member name="P:StackExchange.Redis.ConnectionMultiplexer.TimeoutMilliseconds">
  1196. <summary>
  1197. Gets the timeout associated with the connections
  1198. </summary>
  1199. </member>
  1200. <member name="M:StackExchange.Redis.ConnectionMultiplexer.GetEndPoints(System.Boolean)">
  1201. <summary>
  1202. Gets all endpoints defined on the server
  1203. </summary>
  1204. <returns></returns>
  1205. </member>
  1206. <member name="M:StackExchange.Redis.ConnectionMultiplexer.Wait(System.Threading.Tasks.Task)">
  1207. <summary>
  1208. Wait for a given asynchronous operation to complete (or timeout)
  1209. </summary>
  1210. </member>
  1211. <member name="M:StackExchange.Redis.ConnectionMultiplexer.Wait``1(System.Threading.Tasks.Task{``0})">
  1212. <summary>
  1213. Wait for a given asynchronous operation to complete (or timeout)
  1214. </summary>
  1215. </member>
  1216. <member name="M:StackExchange.Redis.ConnectionMultiplexer.WaitAll(System.Threading.Tasks.Task[])">
  1217. <summary>
  1218. Wait for the given asynchronous operations to complete (or timeout)
  1219. </summary>
  1220. </member>
  1221. <member name="E:StackExchange.Redis.ConnectionMultiplexer.HashSlotMoved">
  1222. <summary>
  1223. Raised when a hash-slot has been relocated
  1224. </summary>
  1225. </member>
  1226. <member name="M:StackExchange.Redis.ConnectionMultiplexer.HashSlot(StackExchange.Redis.RedisKey)">
  1227. <summary>
  1228. Compute the hash-slot of a specified key
  1229. </summary>
  1230. </member>
  1231. <member name="M:StackExchange.Redis.ConnectionMultiplexer.ConnectAsync(System.String,System.IO.TextWriter)">
  1232. <summary>
  1233. Create a new ConnectionMultiplexer instance
  1234. </summary>
  1235. </member>
  1236. <member name="M:StackExchange.Redis.ConnectionMultiplexer.ConnectAsync(StackExchange.Redis.ConfigurationOptions,System.IO.TextWriter)">
  1237. <summary>
  1238. Create a new ConnectionMultiplexer instance
  1239. </summary>
  1240. </member>
  1241. <member name="M:StackExchange.Redis.ConnectionMultiplexer.Connect(System.String,System.IO.TextWriter)">
  1242. <summary>
  1243. Create a new ConnectionMultiplexer instance
  1244. </summary>
  1245. </member>
  1246. <member name="M:StackExchange.Redis.ConnectionMultiplexer.Connect(StackExchange.Redis.ConfigurationOptions,System.IO.TextWriter)">
  1247. <summary>
  1248. Create a new ConnectionMultiplexer instance
  1249. </summary>
  1250. </member>
  1251. <member name="M:StackExchange.Redis.ConnectionMultiplexer.GetSubscriber(System.Object)">
  1252. <summary>
  1253. Obtain a pub/sub subscriber connection to the specified server
  1254. </summary>
  1255. </member>
  1256. <member name="M:StackExchange.Redis.ConnectionMultiplexer.GetDatabase(System.Int32,System.Object)">
  1257. <summary>
  1258. Obtain an interactive connection to a database inside redis
  1259. </summary>
  1260. </member>
  1261. <member name="M:StackExchange.Redis.ConnectionMultiplexer.GetServer(System.String,System.Int32,System.Object)">
  1262. <summary>
  1263. Obtain a configuration API for an individual server
  1264. </summary>
  1265. </member>
  1266. <member name="M:StackExchange.Redis.ConnectionMultiplexer.GetServer(System.String,System.Object)">
  1267. <summary>
  1268. Obtain a configuration API for an individual server
  1269. </summary>
  1270. </member>
  1271. <member name="M:StackExchange.Redis.ConnectionMultiplexer.GetServer(System.Net.IPAddress,System.Int32)">
  1272. <summary>
  1273. Obtain a configuration API for an individual server
  1274. </summary>
  1275. </member>
  1276. <member name="M:StackExchange.Redis.ConnectionMultiplexer.GetServer(System.Net.EndPoint,System.Object)">
  1277. <summary>
  1278. Obtain a configuration API for an individual server
  1279. </summary>
  1280. </member>
  1281. <member name="P:StackExchange.Redis.ConnectionMultiplexer.OperationCount">
  1282. <summary>
  1283. The number of operations that have been performed on all connections
  1284. </summary>
  1285. </member>
  1286. <member name="M:StackExchange.Redis.ConnectionMultiplexer.ConfigureAsync(System.IO.TextWriter)">
  1287. <summary>
  1288. Reconfigure the current connections based on the existing configuration
  1289. </summary>
  1290. </member>
  1291. <member name="M:StackExchange.Redis.ConnectionMultiplexer.Configure(System.IO.TextWriter)">
  1292. <summary>
  1293. Reconfigure the current connections based on the existing configuration
  1294. </summary>
  1295. </member>
  1296. <member name="M:StackExchange.Redis.ConnectionMultiplexer.GetStatus">
  1297. <summary>
  1298. Provides a text overview of the status of all connections
  1299. </summary>
  1300. </member>
  1301. <member name="M:StackExchange.Redis.ConnectionMultiplexer.GetStatus(System.IO.TextWriter)">
  1302. <summary>
  1303. Provides a text overview of the status of all connections
  1304. </summary>
  1305. </member>
  1306. <member name="M:StackExchange.Redis.ConnectionMultiplexer.ToString">
  1307. <summary>
  1308. See Object.ToString()
  1309. </summary>
  1310. </member>
  1311. <member name="P:StackExchange.Redis.ConnectionMultiplexer.PreserveAsyncOrder">
  1312. <summary>
  1313. Gets or sets whether asynchronous operations should be invoked in a way that guarantees their original delivery order
  1314. </summary>
  1315. </member>
  1316. <member name="P:StackExchange.Redis.ConnectionMultiplexer.IsConnected">
  1317. <summary>
  1318. Indicates whether any servers are connected
  1319. </summary>
  1320. </member>
  1321. <member name="M:StackExchange.Redis.ConnectionMultiplexer.Close(System.Boolean)">
  1322. <summary>
  1323. Close all connections and release all resources associated with this object
  1324. </summary>
  1325. </member>
  1326. <member name="M:StackExchange.Redis.ConnectionMultiplexer.CloseAsync(System.Boolean)">
  1327. <summary>
  1328. Close all connections and release all resources associated with this object
  1329. </summary>
  1330. </member>
  1331. <member name="M:StackExchange.Redis.ConnectionMultiplexer.Dispose">
  1332. <summary>
  1333. Release all resources associated with this object
  1334. </summary>
  1335. </member>
  1336. <member name="P:StackExchange.Redis.ConnectionMultiplexer.IncludeDetailInExceptions">
  1337. <summary>
  1338. Should exceptions include identifiable details? (key names, additional .Data annotations)
  1339. </summary>
  1340. </member>
  1341. <member name="P:StackExchange.Redis.ConnectionMultiplexer.StormLogThreshold">
  1342. <summary>
  1343. Limit at which to start recording unusual busy patterns (only one log will be retained at a time;
  1344. set to a negative value to disable this feature)
  1345. </summary>
  1346. </member>
  1347. <member name="M:StackExchange.Redis.ConnectionMultiplexer.GetStormLog">
  1348. <summary>
  1349. Obtains the log of unusual busy patterns
  1350. </summary>
  1351. </member>
  1352. <member name="M:StackExchange.Redis.ConnectionMultiplexer.ResetStormLog">
  1353. <summary>
  1354. Resets the log of unusual busy patterns
  1355. </summary>
  1356. </member>
  1357. <member name="M:StackExchange.Redis.ConnectionMultiplexer.PublishReconfigure(StackExchange.Redis.CommandFlags)">
  1358. <summary>
  1359. Request all compatible clients to reconfigure or reconnect
  1360. </summary>
  1361. <returns>The number of instances known to have received the message (however, the actual number can be higher; returns -1 if the operation is pending)</returns>
  1362. </member>
  1363. <member name="M:StackExchange.Redis.ConnectionMultiplexer.PublishReconfigureAsync(StackExchange.Redis.CommandFlags)">
  1364. <summary>
  1365. Request all compatible clients to reconfigure or reconnect
  1366. </summary>
  1367. <returns>The number of instances known to have received the message (however, the actual number can be higher)</returns>
  1368. </member>
  1369. <member name="M:StackExchange.Redis.ConnectionMultiplexer.RegisterProfiler(StackExchange.Redis.IProfiler)">
  1370. <summary>
  1371. Sets an IProfiler instance for this ConnectionMultiplexer.
  1372. An IProfiler instances is used to determine which context to associate an
  1373. IProfiledCommand with. See BeginProfiling(object) and FinishProfiling(object)
  1374. for more details.
  1375. </summary>
  1376. </member>
  1377. <member name="M:StackExchange.Redis.ConnectionMultiplexer.BeginProfiling(System.Object)">
  1378. <summary>
  1379. Begins profiling for the given context.
  1380. If the same context object is returned by the registered IProfiler, the IProfiledCommands
  1381. will be associated with each other.
  1382. Call FinishProfiling with the same context to get the assocated commands.
  1383. Note that forContext cannot be a WeakReference or a WeakReference&lt;T&gt;
  1384. </summary>
  1385. </member>
  1386. <member name="M:StackExchange.Redis.ConnectionMultiplexer.FinishProfiling(System.Object,System.Boolean)">
  1387. <summary>
  1388. Stops profiling for the given context, returns all IProfiledCommands associated.
  1389. By default this may do a sweep for dead profiling contexts, you can disable this by passing "allowCleanupSweep: false".
  1390. </summary>
  1391. </member>
  1392. <member name="T:StackExchange.Redis.ConnectionType">
  1393. <summary>
  1394. The type of a connection
  1395. </summary>
  1396. </member>
  1397. <member name="F:StackExchange.Redis.ConnectionType.None">
  1398. <summary>
  1399. Not connection-type related
  1400. </summary>
  1401. </member>
  1402. <member name="F:StackExchange.Redis.ConnectionType.Interactive">
  1403. <summary>
  1404. An interactive connection handles request/response commands for accessing data on demand
  1405. </summary>
  1406. </member>
  1407. <member name="F:StackExchange.Redis.ConnectionType.Subscription">
  1408. <summary>
  1409. A subscriber connection recieves unsolicted messages from the server as pub/sub events occur
  1410. </summary>
  1411. </member>
  1412. <member name="T:StackExchange.Redis.CompletionType">
  1413. <summary>
  1414. Completion type for CompletionTypeHelper
  1415. </summary>
  1416. </member>
  1417. <member name="F:StackExchange.Redis.CompletionType.Any">
  1418. <summary>
  1419. Retain original completion type (either sync or async)
  1420. </summary>
  1421. </member>
  1422. <member name="F:StackExchange.Redis.CompletionType.Sync">
  1423. <summary>
  1424. Force sync completion
  1425. </summary>
  1426. </member>
  1427. <member name="F:StackExchange.Redis.CompletionType.Async">
  1428. <summary>
  1429. Force async completion
  1430. </summary>
  1431. </member>
  1432. <member name="T:StackExchange.Redis.EndPointCollection">
  1433. <summary>
  1434. A list of endpoints
  1435. </summary>
  1436. </member>
  1437. <member name="M:StackExchange.Redis.EndPointCollection.#ctor">
  1438. <summary>
  1439. Create a new EndPointCollection
  1440. </summary>
  1441. </member>
  1442. <member name="M:StackExchange.Redis.EndPointCollection.#ctor(System.Collections.Generic.IList{System.Net.EndPoint})">
  1443. <summary>
  1444. Create a new EndPointCollection
  1445. </summary>
  1446. </member>
  1447. <member name="M:StackExchange.Redis.EndPointCollection.ToString(System.Net.EndPoint)">
  1448. <summary>
  1449. Format an endpoint
  1450. </summary>
  1451. </member>
  1452. <member name="M:StackExchange.Redis.EndPointCollection.TryParse(System.String)">
  1453. <summary>
  1454. Attempt to parse a string into an EndPoint
  1455. </summary>
  1456. </member>
  1457. <member name="M:StackExchange.Redis.EndPointCollection.Add(System.String)">
  1458. <summary>
  1459. Adds a new endpoint to the list
  1460. </summary>
  1461. </member>
  1462. <member name="M:StackExchange.Redis.EndPointCollection.Add(System.String,System.Int32)">
  1463. <summary>
  1464. Adds a new endpoint to the list
  1465. </summary>
  1466. </member>
  1467. <member name="M:StackExchange.Redis.EndPointCollection.Add(System.Net.IPAddress,System.Int32)">
  1468. <summary>
  1469. Adds a new endpoint to the list
  1470. </summary>
  1471. </member>
  1472. <member name="M:StackExchange.Redis.EndPointCollection.InsertItem(System.Int32,System.Net.EndPoint)">
  1473. <summary>
  1474. See Collection&lt;T&gt;.InsertItem()
  1475. </summary>
  1476. </member>
  1477. <member name="M:StackExchange.Redis.EndPointCollection.SetItem(System.Int32,System.Net.EndPoint)">
  1478. <summary>
  1479. See Collection&lt;T&gt;.SetItem()
  1480. </summary>
  1481. </member>
  1482. <member name="T:StackExchange.Redis.EndPointEventArgs">
  1483. <summary>
  1484. Event information related to redis endpoints
  1485. </summary>
  1486. </member>
  1487. <member name="P:StackExchange.Redis.EndPointEventArgs.EndPoint">
  1488. <summary>
  1489. The endpoint involved in this event (this can be null)
  1490. </summary>
  1491. </member>
  1492. <member name="T:StackExchange.Redis.Exclude">
  1493. <summary>
  1494. When performing a range query, by default the start / stop limits are inclusive;
  1495. however, both can also be specified separately as exclusive
  1496. </summary>
  1497. </member>
  1498. <member name="F:StackExchange.Redis.Exclude.None">
  1499. <summary>
  1500. Both start and stop are inclusive
  1501. </summary>
  1502. </member>
  1503. <member name="F:StackExchange.Redis.Exclude.Start">
  1504. <summary>
  1505. Start is exclusive, stop is inclusive
  1506. </summary>
  1507. </member>
  1508. <member name="F:StackExchange.Redis.Exclude.Stop">
  1509. <summary>
  1510. Start is inclusive, stop is exclusive
  1511. </summary>
  1512. </member>
  1513. <member name="F:StackExchange.Redis.Exclude.Both">
  1514. <summary>
  1515. Both start and stop are exclusive
  1516. </summary>
  1517. </member>
  1518. <member name="T:StackExchange.Redis.ExportOptions">
  1519. <summary>
  1520. Which settings to export
  1521. </summary>
  1522. </member>
  1523. <member name="F:StackExchange.Redis.ExportOptions.None">
  1524. <summary>
  1525. No options
  1526. </summary>
  1527. </member>
  1528. <member name="F:StackExchange.Redis.ExportOptions.Info">
  1529. <summary>
  1530. The output of INFO
  1531. </summary>
  1532. </member>
  1533. <member name="F:StackExchange.Redis.ExportOptions.Config">
  1534. <summary>
  1535. The output of CONFIG GET *
  1536. </summary>
  1537. </member>
  1538. <member name="F:StackExchange.Redis.ExportOptions.Client">
  1539. <summary>
  1540. The output of CLIENT LIST
  1541. </summary>
  1542. </member>
  1543. <member name="F:StackExchange.Redis.ExportOptions.Cluster">
  1544. <summary>
  1545. The output of CLUSTER NODES
  1546. </summary>
  1547. </member>
  1548. <member name="F:StackExchange.Redis.ExportOptions.All">
  1549. <summary>
  1550. Everything available
  1551. </summary>
  1552. </member>
  1553. <member name="T:StackExchange.Redis.ExtensionMethods">
  1554. <summary>
  1555. Utility methods
  1556. </summary>
  1557. </member>
  1558. <member name="M:StackExchange.Redis.ExtensionMethods.ToStringDictionary(StackExchange.Redis.HashEntry[])">
  1559. <summary>
  1560. Create a dictionary from an array of HashEntry values
  1561. </summary>
  1562. </member>
  1563. <member name="M:StackExchange.Redis.ExtensionMethods.ToDictionary(StackExchange.Redis.HashEntry[])">
  1564. <summary>
  1565. Create a dictionary from an array of HashEntry values
  1566. </summary>
  1567. </member>
  1568. <member name="M:StackExchange.Redis.ExtensionMethods.ToStringDictionary(StackExchange.Redis.SortedSetEntry[])">
  1569. <summary>
  1570. Create a dictionary from an array of SortedSetEntry values
  1571. </summary>
  1572. </member>
  1573. <member name="M:StackExchange.Redis.ExtensionMethods.ToDictionary(StackExchange.Redis.SortedSetEntry[])">
  1574. <summary>
  1575. Create a dictionary from an array of SortedSetEntry values
  1576. </summary>
  1577. </member>
  1578. <member name="M:StackExchange.Redis.ExtensionMethods.ToStringDictionary(System.Collections.Generic.KeyValuePair{StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue}[])">
  1579. <summary>
  1580. Create a dictionary from an array of key/value pairs
  1581. </summary>
  1582. </member>
  1583. <member name="M:StackExchange.Redis.ExtensionMethods.ToDictionary(System.Collections.Generic.KeyValuePair{StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue}[])">
  1584. <summary>
  1585. Create a dictionary from an array of key/value pairs
  1586. </summary>
  1587. </member>
  1588. <member name="M:StackExchange.Redis.ExtensionMethods.ToDictionary(System.Collections.Generic.KeyValuePair{System.String,System.String}[])">
  1589. <summary>
  1590. Create a dictionary from an array of string pairs
  1591. </summary>
  1592. </member>
  1593. <member name="M:StackExchange.Redis.ExtensionMethods.ToStringArray(StackExchange.Redis.RedisValue[])">
  1594. <summary>
  1595. Create an array of strings from an array of values
  1596. </summary>
  1597. </member>
  1598. <member name="T:StackExchange.Redis.HashEntry">
  1599. <summary>
  1600. Describes a hash-field (a name/value pair)
  1601. </summary>
  1602. </member>
  1603. <member name="M:StackExchange.Redis.HashEntry.#ctor(StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue)">
  1604. <summary>
  1605. Initializes a HashEntry value
  1606. </summary>
  1607. </member>
  1608. <member name="P:StackExchange.Redis.HashEntry.Name">
  1609. <summary>
  1610. The name of the hash field
  1611. </summary>
  1612. </member>
  1613. <member name="P:StackExchange.Redis.HashEntry.Value">
  1614. <summary>
  1615. The value of the hash field
  1616. </summary>
  1617. </member>
  1618. <member name="P:StackExchange.Redis.HashEntry.Key">
  1619. <summary>
  1620. The name of the hash field
  1621. </summary>
  1622. </member>
  1623. <member name="M:StackExchange.Redis.HashEntry.op_Implicit(StackExchange.Redis.HashEntry)~System.Collections.Generic.KeyValuePair{StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue}">
  1624. <summary>
  1625. Converts to a key/value pair
  1626. </summary>
  1627. </member>
  1628. <member name="M:StackExchange.Redis.HashEntry.op_Implicit(System.Collections.Generic.KeyValuePair{StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue})~StackExchange.Redis.HashEntry">
  1629. <summary>
  1630. Converts from a key/value pair
  1631. </summary>
  1632. </member>
  1633. <member name="M:StackExchange.Redis.HashEntry.ToString">
  1634. <summary>
  1635. See Object.ToString()
  1636. </summary>
  1637. </member>
  1638. <member name="M:StackExchange.Redis.HashEntry.GetHashCode">
  1639. <summary>
  1640. See Object.GetHashCode()
  1641. </summary>
  1642. </member>
  1643. <member name="M:StackExchange.Redis.HashEntry.Equals(System.Object)">
  1644. <summary>
  1645. Compares two values for equality
  1646. </summary>
  1647. </member>
  1648. <member name="M:StackExchange.Redis.HashEntry.Equals(StackExchange.Redis.HashEntry)">
  1649. <summary>
  1650. Compares two values for equality
  1651. </summary>
  1652. </member>
  1653. <member name="M:StackExchange.Redis.HashEntry.op_Equality(StackExchange.Redis.HashEntry,StackExchange.Redis.HashEntry)">
  1654. <summary>
  1655. Compares two values for equality
  1656. </summary>
  1657. </member>
  1658. <member name="M:StackExchange.Redis.HashEntry.op_Inequality(StackExchange.Redis.HashEntry,StackExchange.Redis.HashEntry)">
  1659. <summary>
  1660. Compares two values for non-equality
  1661. </summary>
  1662. </member>
  1663. <member name="T:StackExchange.Redis.HashSlotMovedEventArgs">
  1664. <summary>
  1665. Contains information about individual hash-slot relocations
  1666. </summary>
  1667. </member>
  1668. <member name="P:StackExchange.Redis.HashSlotMovedEventArgs.HashSlot">
  1669. <summary>
  1670. The hash-slot that was relocated
  1671. </summary>
  1672. </member>
  1673. <member name="P:StackExchange.Redis.HashSlotMovedEventArgs.OldEndPoint">
  1674. <summary>
  1675. The old endpoint for this hash-slot (if known)
  1676. </summary>
  1677. </member>
  1678. <member name="P:StackExchange.Redis.HashSlotMovedEventArgs.NewEndPoint">
  1679. <summary>
  1680. The new endpoint for this hash-slot (if known)
  1681. </summary>
  1682. </member>
  1683. <member name="T:StackExchange.Redis.IBatch">
  1684. <summary>
  1685. Represents a block of operations that will be sent to the server together;
  1686. this can be useful to reduce packet fragmentation on slow connections - it
  1687. can improve the time to get *all* the operations processed, with the trade-off
  1688. of a slower time to get the *first* operation processed; this is usually
  1689. a good thing. Unless this batch is a <b>transaction</b>, there is no guarantee
  1690. that these operations will be processed either contiguously or atomically by the server.
  1691. </summary>
  1692. </member>
  1693. <member name="M:StackExchange.Redis.IBatch.Execute">
  1694. <summary>
  1695. Execute the batch operation, sending all queued commands to the server.
  1696. Note that this operation is neither synchronous nor truly asyncronous - it
  1697. simply enqueues the buffered messages. To check on completion, you should
  1698. check the individual responses.
  1699. </summary>
  1700. </member>
  1701. <member name="T:StackExchange.Redis.IConnectionMultiplexer">
  1702. <summary>
  1703. Represents the abstract multiplexer API
  1704. </summary>
  1705. </member>
  1706. <member name="P:StackExchange.Redis.IConnectionMultiplexer.ClientName">
  1707. <summary>
  1708. Gets the client-name that will be used on all new connections
  1709. </summary>
  1710. </member>
  1711. <member name="P:StackExchange.Redis.IConnectionMultiplexer.Configuration">
  1712. <summary>
  1713. Gets the configuration of the connection
  1714. </summary>
  1715. </member>
  1716. <member name="P:StackExchange.Redis.IConnectionMultiplexer.TimeoutMilliseconds">
  1717. <summary>
  1718. Gets the timeout associated with the connections
  1719. </summary>
  1720. </member>
  1721. <member name="P:StackExchange.Redis.IConnectionMultiplexer.OperationCount">
  1722. <summary>
  1723. The number of operations that have been performed on all connections
  1724. </summary>
  1725. </member>
  1726. <member name="P:StackExchange.Redis.IConnectionMultiplexer.PreserveAsyncOrder">
  1727. <summary>
  1728. Gets or sets whether asynchronous operations should be invoked in a way that guarantees their original delivery order
  1729. </summary>
  1730. </member>
  1731. <member name="P:StackExchange.Redis.IConnectionMultiplexer.IsConnected">
  1732. <summary>
  1733. Indicates whether any servers are connected
  1734. </summary>
  1735. </member>
  1736. <member name="P:StackExchange.Redis.IConnectionMultiplexer.IncludeDetailInExceptions">
  1737. <summary>
  1738. Should exceptions include identifiable details? (key names, additional .Data annotations)
  1739. </summary>
  1740. </member>
  1741. <member name="P:StackExchange.Redis.IConnectionMultiplexer.StormLogThreshold">
  1742. <summary>
  1743. Limit at which to start recording unusual busy patterns (only one log will be retained at a time;
  1744. set to a negative value to disable this feature)
  1745. </summary>
  1746. </member>
  1747. <member name="M:StackExchange.Redis.IConnectionMultiplexer.RegisterProfiler(StackExchange.Redis.IProfiler)">
  1748. <summary>
  1749. Sets an IProfiler instance for this ConnectionMultiplexer.
  1750. An IProfiler instances is used to determine which context to associate an
  1751. IProfiledCommand with. See BeginProfiling(object) and FinishProfiling(object)
  1752. for more details.
  1753. </summary>
  1754. </member>
  1755. <member name="M:StackExchange.Redis.IConnectionMultiplexer.BeginProfiling(System.Object)">
  1756. <summary>
  1757. Begins profiling for the given context.
  1758. If the same context object is returned by the registered IProfiler, the IProfiledCommands
  1759. will be associated with each other.
  1760. Call FinishProfiling with the same context to get the assocated commands.
  1761. Note that forContext cannot be a WeakReference or a WeakReference&lt;T&gt;
  1762. </summary>
  1763. </member>
  1764. <member name="M:StackExchange.Redis.IConnectionMultiplexer.FinishProfiling(System.Object,System.Boolean)">
  1765. <summary>
  1766. Stops profiling for the given context, returns all IProfiledCommands associated.
  1767. By default this may do a sweep for dead profiling contexts, you can disable this by passing "allowCleanupSweep: false".
  1768. </summary>
  1769. </member>
  1770. <member name="M:StackExchange.Redis.IConnectionMultiplexer.GetCounters">
  1771. <summary>
  1772. Get summary statistics associates with this server
  1773. </summary>
  1774. </member>
  1775. <member name="E:StackExchange.Redis.IConnectionMultiplexer.ErrorMessage">
  1776. <summary>
  1777. A server replied with an error message;
  1778. </summary>
  1779. </member>
  1780. <member name="E:StackExchange.Redis.IConnectionMultiplexer.ConnectionFailed">
  1781. <summary>
  1782. Raised whenever a physical connection fails
  1783. </summary>
  1784. </member>
  1785. <member name="E:StackExchange.Redis.IConnectionMultiplexer.InternalError">
  1786. <summary>
  1787. Raised whenever an internal error occurs (this is primarily for debugging)
  1788. </summary>
  1789. </member>
  1790. <member name="E:StackExchange.Redis.IConnectionMultiplexer.ConnectionRestored">
  1791. <summary>
  1792. Raised whenever a physical connection is established
  1793. </summary>
  1794. </member>
  1795. <member name="E:StackExchange.Redis.IConnectionMultiplexer.ConfigurationChanged">
  1796. <summary>
  1797. Raised when configuration changes are detected
  1798. </summary>
  1799. </member>
  1800. <member name="E:StackExchange.Redis.IConnectionMultiplexer.ConfigurationChangedBroadcast">
  1801. <summary>
  1802. Raised when nodes are explicitly requested to reconfigure via broadcast;
  1803. this usually means master/slave changes
  1804. </summary>
  1805. </member>
  1806. <member name="M:StackExchange.Redis.IConnectionMultiplexer.GetEndPoints(System.Boolean)">
  1807. <summary>
  1808. Gets all endpoints defined on the server
  1809. </summary>
  1810. <returns></returns>
  1811. </member>
  1812. <member name="M:StackExchange.Redis.IConnectionMultiplexer.Wait(System.Threading.Tasks.Task)">
  1813. <summary>
  1814. Wait for a given asynchronous operation to complete (or timeout)
  1815. </summary>
  1816. </member>
  1817. <member name="M:StackExchange.Redis.IConnectionMultiplexer.Wait``1(System.Threading.Tasks.Task{``0})">
  1818. <summary>
  1819. Wait for a given asynchronous operation to complete (or timeout)
  1820. </summary>
  1821. </member>
  1822. <member name="M:StackExchange.Redis.IConnectionMultiplexer.WaitAll(System.Threading.Tasks.Task[])">
  1823. <summary>
  1824. Wait for the given asynchronous operations to complete (or timeout)
  1825. </summary>
  1826. </member>
  1827. <member name="E:StackExchange.Redis.IConnectionMultiplexer.HashSlotMoved">
  1828. <summary>
  1829. Raised when a hash-slot has been relocated
  1830. </summary>
  1831. </member>
  1832. <member name="M:StackExchange.Redis.IConnectionMultiplexer.HashSlot(StackExchange.Redis.RedisKey)">
  1833. <summary>
  1834. Compute the hash-slot of a specified key
  1835. </summary>
  1836. </member>
  1837. <member name="M:StackExchange.Redis.IConnectionMultiplexer.GetSubscriber(System.Object)">
  1838. <summary>
  1839. Obtain a pub/sub subscriber connection to the specified server
  1840. </summary>
  1841. </member>
  1842. <member name="M:StackExchange.Redis.IConnectionMultiplexer.GetDatabase(System.Int32,System.Object)">
  1843. <summary>
  1844. Obtain an interactive connection to a database inside redis
  1845. </summary>
  1846. </member>
  1847. <member name="M:StackExchange.Redis.IConnectionMultiplexer.GetServer(System.String,System.Int32,System.Object)">
  1848. <summary>
  1849. Obtain a configuration API for an individual server
  1850. </summary>
  1851. </member>
  1852. <member name="M:StackExchange.Redis.IConnectionMultiplexer.GetServer(System.String,System.Object)">
  1853. <summary>
  1854. Obtain a configuration API for an individual server
  1855. </summary>
  1856. </member>
  1857. <member name="M:StackExchange.Redis.IConnectionMultiplexer.GetServer(System.Net.IPAddress,System.Int32)">
  1858. <summary>
  1859. Obtain a configuration API for an individual server
  1860. </summary>
  1861. </member>
  1862. <member name="M:StackExchange.Redis.IConnectionMultiplexer.GetServer(System.Net.EndPoint,System.Object)">
  1863. <summary>
  1864. Obtain a configuration API for an individual server
  1865. </summary>
  1866. </member>
  1867. <member name="M:StackExchange.Redis.IConnectionMultiplexer.ConfigureAsync(System.IO.TextWriter)">
  1868. <summary>
  1869. Reconfigure the current connections based on the existing configuration
  1870. </summary>
  1871. </member>
  1872. <member name="M:StackExchange.Redis.IConnectionMultiplexer.Configure(System.IO.TextWriter)">
  1873. <summary>
  1874. Reconfigure the current connections based on the existing configuration
  1875. </summary>
  1876. </member>
  1877. <member name="M:StackExchange.Redis.IConnectionMultiplexer.GetStatus">
  1878. <summary>
  1879. Provides a text overview of the status of all connections
  1880. </summary>
  1881. </member>
  1882. <member name="M:StackExchange.Redis.IConnectionMultiplexer.GetStatus(System.IO.TextWriter)">
  1883. <summary>
  1884. Provides a text overview of the status of all connections
  1885. </summary>
  1886. </member>
  1887. <member name="M:StackExchange.Redis.IConnectionMultiplexer.ToString">
  1888. <summary>
  1889. See Object.ToString()
  1890. </summary>
  1891. </member>
  1892. <member name="M:StackExchange.Redis.IConnectionMultiplexer.Close(System.Boolean)">
  1893. <summary>
  1894. Close all connections and release all resources associated with this object
  1895. </summary>
  1896. </member>
  1897. <member name="M:StackExchange.Redis.IConnectionMultiplexer.CloseAsync(System.Boolean)">
  1898. <summary>
  1899. Close all connections and release all resources associated with this object
  1900. </summary>
  1901. </member>
  1902. <member name="M:StackExchange.Redis.IConnectionMultiplexer.Dispose">
  1903. <summary>
  1904. Release all resources associated with this object
  1905. </summary>
  1906. </member>
  1907. <member name="M:StackExchange.Redis.IConnectionMultiplexer.GetStormLog">
  1908. <summary>
  1909. Obtains the log of unusual busy patterns
  1910. </summary>
  1911. </member>
  1912. <member name="M:StackExchange.Redis.IConnectionMultiplexer.ResetStormLog">
  1913. <summary>
  1914. Resets the log of unusual busy patterns
  1915. </summary>
  1916. </member>
  1917. <member name="M:StackExchange.Redis.IConnectionMultiplexer.PublishReconfigure(StackExchange.Redis.CommandFlags)">
  1918. <summary>
  1919. Request all compatible clients to reconfigure or reconnect
  1920. </summary>
  1921. <returns>The number of instances known to have received the message (however, the actual number can be higher; returns -1 if the operation is pending)</returns>
  1922. </member>
  1923. <member name="M:StackExchange.Redis.IConnectionMultiplexer.PublishReconfigureAsync(StackExchange.Redis.CommandFlags)">
  1924. <summary>
  1925. Request all compatible clients to reconfigure or reconnect
  1926. </summary>
  1927. <returns>The number of instances known to have received the message (however, the actual number can be higher)</returns>
  1928. </member>
  1929. <member name="T:StackExchange.Redis.IDatabase">
  1930. <summary>
  1931. Describes functionality that is common to both standalone redis servers and redis clusters
  1932. </summary>
  1933. </member>
  1934. <member name="P:StackExchange.Redis.IDatabase.Database">
  1935. <summary>
  1936. The numeric identifier of this database
  1937. </summary>
  1938. </member>
  1939. <member name="M:StackExchange.Redis.IDatabase.CreateBatch(System.Object)">
  1940. <summary>
  1941. Allows creation of a group of operations that will be sent to the server as a single unit,
  1942. but which may or may not be processed on the server contiguously.
  1943. </summary>
  1944. </member>
  1945. <member name="M:StackExchange.Redis.IDatabase.KeyMigrate(StackExchange.Redis.RedisKey,System.Net.EndPoint,System.Int32,System.Int32,StackExchange.Redis.MigrateOptions,StackExchange.Redis.CommandFlags)">
  1946. <summary>
  1947. Atomically transfer a key from a source Redis instance to a destination Redis instance. On success the key is deleted from the original instance by default, and is guaranteed to exist in the target instance.
  1948. </summary>
  1949. <remarks>http://redis.io/commands/MIGRATE</remarks>
  1950. </member>
  1951. <member name="M:StackExchange.Redis.IDatabase.CreateTransaction(System.Object)">
  1952. <summary>
  1953. Allows creation of a group of operations that will be sent to the server as a single unit,
  1954. and processed on the server as a single unit.
  1955. </summary>
  1956. </member>
  1957. <member name="M:StackExchange.Redis.IDatabase.DebugObject(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  1958. <summary>
  1959. Returns the raw DEBUG OBJECT output for a key; this command is not fully documented and should be avoided unless you have good reason, and then avoided anyway.
  1960. </summary>
  1961. <remarks>http://redis.io/commands/debug-object</remarks>
  1962. </member>
  1963. <member name="M:StackExchange.Redis.IDatabase.HashDecrement(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Int64,StackExchange.Redis.CommandFlags)">
  1964. <summary>
  1965. Decrements the number stored at field in the hash stored at key by decrement. If key does not exist, a new key holding a hash is created. If field does not exist or holds a string that cannot be interpreted as integer, the value is set to 0 before the operation is performed.
  1966. </summary>
  1967. <remarks>The range of values supported by HINCRBY is limited to 64 bit signed integers.</remarks>
  1968. <returns>the value at field after the decrement operation.</returns>
  1969. <remarks>http://redis.io/commands/hincrby</remarks>
  1970. </member>
  1971. <member name="M:StackExchange.Redis.IDatabase.HashDecrement(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Double,StackExchange.Redis.CommandFlags)">
  1972. <summary>
  1973. Decrement the specified field of an hash stored at key, and representing a floating point number, by the specified decrement. If the field does not exist, it is set to 0 before performing the operation.
  1974. </summary>
  1975. <remarks>The precision of the output is fixed at 17 digits after the decimal point regardless of the actual internal precision of the computation.</remarks>
  1976. <returns>the value at field after the decrement operation.</returns>
  1977. <remarks>http://redis.io/commands/hincrbyfloat</remarks>
  1978. </member>
  1979. <member name="M:StackExchange.Redis.IDatabase.HashDelete(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  1980. <summary>
  1981. Removes the specified fields from the hash stored at key. Non-existing fields are ignored. Non-existing keys are treated as empty hashes and this command returns 0.
  1982. </summary>
  1983. <remarks>http://redis.io/commands/hdel</remarks>
  1984. <returns>The number of fields that were removed.</returns>
  1985. </member>
  1986. <member name="M:StackExchange.Redis.IDatabase.HashDelete(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  1987. <summary>
  1988. Removes the specified fields from the hash stored at key. Non-existing fields are ignored. Non-existing keys are treated as empty hashes and this command returns 0.
  1989. </summary>
  1990. <remarks>http://redis.io/commands/hdel</remarks>
  1991. <returns>The number of fields that were removed.</returns>
  1992. </member>
  1993. <member name="M:StackExchange.Redis.IDatabase.HashExists(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  1994. <summary>
  1995. Returns if field is an existing field in the hash stored at key.
  1996. </summary>
  1997. <returns>1 if the hash contains field. 0 if the hash does not contain field, or key does not exist.</returns>
  1998. <remarks>http://redis.io/commands/hexists</remarks>
  1999. </member>
  2000. <member name="M:StackExchange.Redis.IDatabase.HashGet(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2001. <summary>
  2002. Returns the value associated with field in the hash stored at key.
  2003. </summary>
  2004. <returns>the value associated with field, or nil when field is not present in the hash or key does not exist.</returns>
  2005. <remarks>http://redis.io/commands/hget</remarks>
  2006. </member>
  2007. <member name="M:StackExchange.Redis.IDatabase.HashGet(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  2008. <summary>
  2009. Returns the values associated with the specified fields in the hash stored at key.
  2010. For every field that does not exist in the hash, a nil value is returned.Because a non-existing keys are treated as empty hashes, running HMGET against a non-existing key will return a list of nil values.
  2011. </summary>
  2012. <returns>list of values associated with the given fields, in the same order as they are requested.</returns>
  2013. <remarks>http://redis.io/commands/hmget</remarks>
  2014. </member>
  2015. <member name="M:StackExchange.Redis.IDatabase.HashGetAll(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2016. <summary>
  2017. Returns all fields and values of the hash stored at key.
  2018. </summary>
  2019. <returns>list of fields and their values stored in the hash, or an empty list when key does not exist.</returns>
  2020. <remarks>http://redis.io/commands/hgetall</remarks>
  2021. </member>
  2022. <member name="M:StackExchange.Redis.IDatabase.HashIncrement(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Int64,StackExchange.Redis.CommandFlags)">
  2023. <summary>
  2024. Increments the number stored at field in the hash stored at key by increment. If key does not exist, a new key holding a hash is created. If field does not exist or holds a string that cannot be interpreted as integer, the value is set to 0 before the operation is performed.
  2025. </summary>
  2026. <remarks>The range of values supported by HINCRBY is limited to 64 bit signed integers.</remarks>
  2027. <returns>the value at field after the increment operation.</returns>
  2028. <remarks>http://redis.io/commands/hincrby</remarks>
  2029. </member>
  2030. <member name="M:StackExchange.Redis.IDatabase.HashIncrement(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Double,StackExchange.Redis.CommandFlags)">
  2031. <summary>
  2032. Increment the specified field of an hash stored at key, and representing a floating point number, by the specified increment. If the field does not exist, it is set to 0 before performing the operation.
  2033. </summary>
  2034. <remarks>The precision of the output is fixed at 17 digits after the decimal point regardless of the actual internal precision of the computation.</remarks>
  2035. <returns>the value at field after the increment operation.</returns>
  2036. <remarks>http://redis.io/commands/hincrbyfloat</remarks>
  2037. </member>
  2038. <member name="M:StackExchange.Redis.IDatabase.HashKeys(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2039. <summary>
  2040. Returns all field names in the hash stored at key.
  2041. </summary>
  2042. <returns>list of fields in the hash, or an empty list when key does not exist.</returns>
  2043. <remarks>http://redis.io/commands/hkeys</remarks>
  2044. </member>
  2045. <member name="M:StackExchange.Redis.IDatabase.HashLength(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2046. <summary>
  2047. Returns the number of fields contained in the hash stored at key.
  2048. </summary>
  2049. <returns>number of fields in the hash, or 0 when key does not exist.</returns>
  2050. <remarks>http://redis.io/commands/hlen</remarks>
  2051. </member>
  2052. <member name="M:StackExchange.Redis.IDatabase.HashScan(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Int32,StackExchange.Redis.CommandFlags)">
  2053. <summary>
  2054. The HSCAN command is used to incrementally iterate over a hash
  2055. </summary>
  2056. <returns>yields all elements of the hash.</returns>
  2057. <remarks>http://redis.io/commands/hscan</remarks>
  2058. </member>
  2059. <member name="M:StackExchange.Redis.IDatabase.HashScan(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Int32,System.Int64,System.Int32,StackExchange.Redis.CommandFlags)">
  2060. <summary>
  2061. The HSCAN command is used to incrementally iterate over a hash; note: to resume an iteration via <i>cursor</i>, cast the original enumerable or enumerator to <i>IScanningCursor</i>.
  2062. </summary>
  2063. <returns>yields all elements of the hash.</returns>
  2064. <remarks>http://redis.io/commands/hscan</remarks>
  2065. </member>
  2066. <member name="M:StackExchange.Redis.IDatabase.HashSet(StackExchange.Redis.RedisKey,StackExchange.Redis.HashEntry[],StackExchange.Redis.CommandFlags)">
  2067. <summary>
  2068. Sets the specified fields to their respective values in the hash stored at key. This command overwrites any existing fields in the hash. If key does not exist, a new key holding a hash is created.
  2069. </summary>
  2070. <remarks>http://redis.io/commands/hmset</remarks>
  2071. </member>
  2072. <member name="M:StackExchange.Redis.IDatabase.HashSet(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue,StackExchange.Redis.When,StackExchange.Redis.CommandFlags)">
  2073. <summary>
  2074. Sets field in the hash stored at key to value. If key does not exist, a new key holding a hash is created. If field already exists in the hash, it is overwritten.
  2075. </summary>
  2076. <returns>1 if field is a new field in the hash and value was set. 0 if field already exists in the hash and the value was updated.</returns>
  2077. <remarks>http://redis.io/commands/hset</remarks>
  2078. <remarks>http://redis.io/commands/hsetnx</remarks>
  2079. </member>
  2080. <member name="M:StackExchange.Redis.IDatabase.HashValues(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2081. <summary>
  2082. Returns all values in the hash stored at key.
  2083. </summary>
  2084. <returns>list of values in the hash, or an empty list when key does not exist.</returns>
  2085. <remarks>http://redis.io/commands/hvals</remarks>
  2086. </member>
  2087. <member name="M:StackExchange.Redis.IDatabase.HyperLogLogAdd(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2088. <summary>
  2089. Adds the element to the HyperLogLog data structure stored at the variable name specified as first argument.
  2090. </summary>
  2091. <returns>true if at least 1 HyperLogLog internal register was altered. false otherwise.</returns>
  2092. <remarks>http://redis.io/commands/pfadd</remarks>
  2093. </member>
  2094. <member name="M:StackExchange.Redis.IDatabase.HyperLogLogAdd(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  2095. <summary>
  2096. Adds all the element arguments to the HyperLogLog data structure stored at the variable name specified as first argument.
  2097. </summary>
  2098. <returns>true if at least 1 HyperLogLog internal register was altered. false otherwise.</returns>
  2099. <remarks>http://redis.io/commands/pfadd</remarks>
  2100. </member>
  2101. <member name="M:StackExchange.Redis.IDatabase.HyperLogLogLength(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2102. <summary>
  2103. Returns the approximated cardinality computed by the HyperLogLog data structure stored at the specified variable, or 0 if the variable does not exist.
  2104. </summary>
  2105. <returns>The approximated number of unique elements observed via HyperLogLogAdd.</returns>
  2106. <remarks>http://redis.io/commands/pfcount</remarks>
  2107. </member>
  2108. <member name="M:StackExchange.Redis.IDatabase.HyperLogLogLength(StackExchange.Redis.RedisKey[],StackExchange.Redis.CommandFlags)">
  2109. <summary>
  2110. Returns the approximated cardinality of the union of the HyperLogLogs passed, by internally merging the HyperLogLogs stored at the provided keys into a temporary hyperLogLog, or 0 if the variable does not exist.
  2111. </summary>
  2112. <returns>The approximated number of unique elements observed via HyperLogLogAdd.</returns>
  2113. <remarks>http://redis.io/commands/pfcount</remarks>
  2114. </member>
  2115. <member name="M:StackExchange.Redis.IDatabase.HyperLogLogMerge(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2116. <summary>
  2117. Merge multiple HyperLogLog values into an unique value that will approximate the cardinality of the union of the observed Sets of the source HyperLogLog structures.
  2118. </summary>
  2119. <remarks>http://redis.io/commands/pfmerge</remarks>
  2120. </member>
  2121. <member name="M:StackExchange.Redis.IDatabase.HyperLogLogMerge(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey[],StackExchange.Redis.CommandFlags)">
  2122. <summary>
  2123. Merge multiple HyperLogLog values into an unique value that will approximate the cardinality of the union of the observed Sets of the source HyperLogLog structures.
  2124. </summary>
  2125. <remarks>http://redis.io/commands/pfmerge</remarks>
  2126. </member>
  2127. <member name="M:StackExchange.Redis.IDatabase.IdentifyEndpoint(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2128. <summary>
  2129. Inidicate exactly which redis server we are talking to
  2130. </summary>
  2131. </member>
  2132. <member name="M:StackExchange.Redis.IDatabase.KeyDelete(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2133. <summary>
  2134. Removes the specified key. A key is ignored if it does not exist.
  2135. </summary>
  2136. <returns>True if the key was removed.</returns>
  2137. <remarks>http://redis.io/commands/del</remarks>
  2138. </member>
  2139. <member name="M:StackExchange.Redis.IDatabase.KeyDelete(StackExchange.Redis.RedisKey[],StackExchange.Redis.CommandFlags)">
  2140. <summary>
  2141. Removes the specified keys. A key is ignored if it does not exist.
  2142. </summary>
  2143. <returns>The number of keys that were removed.</returns>
  2144. <remarks>http://redis.io/commands/del</remarks>
  2145. </member>
  2146. <member name="M:StackExchange.Redis.IDatabase.KeyDump(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2147. <summary>
  2148. Serialize the value stored at key in a Redis-specific format and return it to the user. The returned value can be synthesized back into a Redis key using the RESTORE command.
  2149. </summary>
  2150. <returns>the serialized value.</returns>
  2151. <remarks>http://redis.io/commands/dump</remarks>
  2152. </member>
  2153. <member name="M:StackExchange.Redis.IDatabase.KeyExists(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2154. <summary>
  2155. Returns if key exists.
  2156. </summary>
  2157. <returns>1 if the key exists. 0 if the key does not exist.</returns>
  2158. <remarks>http://redis.io/commands/exists</remarks>
  2159. </member>
  2160. <member name="M:StackExchange.Redis.IDatabase.KeyExpire(StackExchange.Redis.RedisKey,System.Nullable{System.TimeSpan},StackExchange.Redis.CommandFlags)">
  2161. <summary>
  2162. Set a timeout on key. After the timeout has expired, the key will automatically be deleted. A key with an associated timeout is said to be volatile in Redis terminology.
  2163. </summary>
  2164. <remarks>If key is updated before the timeout has expired, then the timeout is removed as if the PERSIST command was invoked on key.
  2165. For Redis versions &lt; 2.1.3, existing timeouts cannot be overwritten. So, if key already has an associated timeout, it will do nothing and return 0. Since Redis 2.1.3, you can update the timeout of a key. It is also possible to remove the timeout using the PERSIST command. See the page on key expiry for more information.</remarks>
  2166. <returns>1 if the timeout was set. 0 if key does not exist or the timeout could not be set.</returns>
  2167. <remarks>http://redis.io/commands/expire</remarks>
  2168. <remarks>http://redis.io/commands/pexpire</remarks>
  2169. <remarks>http://redis.io/commands/persist</remarks>
  2170. </member>
  2171. <member name="M:StackExchange.Redis.IDatabase.KeyExpire(StackExchange.Redis.RedisKey,System.Nullable{System.DateTime},StackExchange.Redis.CommandFlags)">
  2172. <summary>
  2173. Set a timeout on key. After the timeout has expired, the key will automatically be deleted. A key with an associated timeout is said to be volatile in Redis terminology.
  2174. </summary>
  2175. <remarks>If key is updated before the timeout has expired, then the timeout is removed as if the PERSIST command was invoked on key.
  2176. For Redis versions &lt; 2.1.3, existing timeouts cannot be overwritten. So, if key already has an associated timeout, it will do nothing and return 0. Since Redis 2.1.3, you can update the timeout of a key. It is also possible to remove the timeout using the PERSIST command. See the page on key expiry for more information.</remarks>
  2177. <returns>1 if the timeout was set. 0 if key does not exist or the timeout could not be set.</returns>
  2178. <remarks>http://redis.io/commands/expireat</remarks>
  2179. <remarks>http://redis.io/commands/pexpireat</remarks>
  2180. <remarks>http://redis.io/commands/persist</remarks>
  2181. </member>
  2182. <member name="M:StackExchange.Redis.IDatabase.KeyMove(StackExchange.Redis.RedisKey,System.Int32,StackExchange.Redis.CommandFlags)">
  2183. <summary>
  2184. Move key from the currently selected database (see SELECT) to the specified destination database. When key already exists in the destination database, or it does not exist in the source database, it does nothing. It is possible to use MOVE as a locking primitive because of this.
  2185. </summary>
  2186. <returns>1 if key was moved; 0 if key was not moved.</returns>
  2187. <remarks>http://redis.io/commands/move</remarks>
  2188. </member>
  2189. <member name="M:StackExchange.Redis.IDatabase.KeyPersist(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2190. <summary>Remove the existing timeout on key, turning the key from volatile (a key with an expire set) to persistent (a key that will never expire as no timeout is associated).</summary>
  2191. <returns>1 if the timeout was removed. 0 if key does not exist or does not have an associated timeout.</returns>
  2192. <remarks>http://redis.io/commands/persist</remarks>
  2193. </member>
  2194. <member name="M:StackExchange.Redis.IDatabase.KeyRandom(StackExchange.Redis.CommandFlags)">
  2195. <summary>
  2196. Return a random key from the currently selected database.
  2197. </summary>
  2198. <returns>the random key, or nil when the database is empty.</returns>
  2199. <remarks>http://redis.io/commands/randomkey</remarks>
  2200. </member>
  2201. <member name="M:StackExchange.Redis.IDatabase.KeyRename(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.When,StackExchange.Redis.CommandFlags)">
  2202. <summary>
  2203. Renames key to newkey. It returns an error when the source and destination names are the same, or when key does not exist.
  2204. </summary>
  2205. <returns>http://redis.io/commands/rename</returns>
  2206. <remarks>http://redis.io/commands/renamenx</remarks>
  2207. </member>
  2208. <member name="M:StackExchange.Redis.IDatabase.KeyRestore(StackExchange.Redis.RedisKey,System.Byte[],System.Nullable{System.TimeSpan},StackExchange.Redis.CommandFlags)">
  2209. <summary>
  2210. Create a key associated with a value that is obtained by deserializing the provided serialized value (obtained via DUMP).
  2211. If ttl is 0 the key is created without any expire, otherwise the specified expire time(in milliseconds) is set.
  2212. </summary>
  2213. <remarks>http://redis.io/commands/restore</remarks>
  2214. </member>
  2215. <member name="M:StackExchange.Redis.IDatabase.KeyTimeToLive(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2216. <summary>
  2217. Returns the remaining time to live of a key that has a timeout. This introspection capability allows a Redis client to check how many seconds a given key will continue to be part of the dataset.
  2218. </summary>
  2219. <returns>TTL, or nil when key does not exist or does not have a timeout.</returns>
  2220. <remarks>http://redis.io/commands/ttl</remarks>
  2221. </member>
  2222. <member name="M:StackExchange.Redis.IDatabase.KeyType(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2223. <summary>
  2224. Returns the string representation of the type of the value stored at key. The different types that can be returned are: string, list, set, zset and hash.
  2225. </summary>
  2226. <returns>type of key, or none when key does not exist.</returns>
  2227. <remarks>http://redis.io/commands/type</remarks>
  2228. </member>
  2229. <member name="M:StackExchange.Redis.IDatabase.ListGetByIndex(StackExchange.Redis.RedisKey,System.Int64,StackExchange.Redis.CommandFlags)">
  2230. <summary>
  2231. Returns the element at index index in the list stored at key. The index is zero-based, so 0 means the first element, 1 the second element and so on. Negative indices can be used to designate elements starting at the tail of the list. Here, -1 means the last element, -2 means the penultimate and so forth.
  2232. </summary>
  2233. <returns>the requested element, or nil when index is out of range.</returns>
  2234. <remarks>http://redis.io/commands/lindex</remarks>
  2235. </member>
  2236. <member name="M:StackExchange.Redis.IDatabase.ListInsertAfter(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2237. <summary>
  2238. Inserts value in the list stored at key either before or after the reference value pivot.
  2239. When key does not exist, it is considered an empty list and no operation is performed.
  2240. </summary>
  2241. <returns>the length of the list after the insert operation, or -1 when the value pivot was not found.</returns>
  2242. <remarks>http://redis.io/commands/linsert</remarks>
  2243. </member>
  2244. <member name="M:StackExchange.Redis.IDatabase.ListInsertBefore(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2245. <summary>
  2246. Inserts value in the list stored at key either before or after the reference value pivot.
  2247. When key does not exist, it is considered an empty list and no operation is performed.
  2248. </summary>
  2249. <returns>the length of the list after the insert operation, or -1 when the value pivot was not found.</returns>
  2250. <remarks>http://redis.io/commands/linsert</remarks>
  2251. </member>
  2252. <member name="M:StackExchange.Redis.IDatabase.ListLeftPop(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2253. <summary>
  2254. Removes and returns the first element of the list stored at key.
  2255. </summary>
  2256. <returns>the value of the first element, or nil when key does not exist.</returns>
  2257. <remarks>http://redis.io/commands/lpop</remarks>
  2258. </member>
  2259. <member name="M:StackExchange.Redis.IDatabase.ListLeftPush(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.When,StackExchange.Redis.CommandFlags)">
  2260. <summary>
  2261. Insert the specified value at the head of the list stored at key. If key does not exist, it is created as empty list before performing the push operations.
  2262. </summary>
  2263. <returns>the length of the list after the push operations.</returns>
  2264. <remarks>http://redis.io/commands/lpush</remarks>
  2265. <remarks>http://redis.io/commands/lpushx</remarks>
  2266. </member>
  2267. <member name="M:StackExchange.Redis.IDatabase.ListLeftPush(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  2268. <summary>
  2269. Insert all the specified values at the head of the list stored at key. If key does not exist, it is created as empty list before performing the push operations.
  2270. Elements are inserted one after the other to the head of the list, from the leftmost element to the rightmost element. So for instance the command LPUSH mylist a b c will result into a list containing c as first element, b as second element and a as third element.
  2271. </summary>
  2272. <returns>the length of the list after the push operations.</returns>
  2273. <remarks>http://redis.io/commands/lpush</remarks>
  2274. </member>
  2275. <member name="M:StackExchange.Redis.IDatabase.ListLength(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2276. <summary>
  2277. Returns the length of the list stored at key. If key does not exist, it is interpreted as an empty list and 0 is returned.
  2278. </summary>
  2279. <returns>the length of the list at key.</returns>
  2280. <remarks>http://redis.io/commands/llen</remarks>
  2281. </member>
  2282. <member name="M:StackExchange.Redis.IDatabase.ListRange(StackExchange.Redis.RedisKey,System.Int64,System.Int64,StackExchange.Redis.CommandFlags)">
  2283. <summary>
  2284. Returns the specified elements of the list stored at key. The offsets start and stop are zero-based indexes, with 0 being the first element of the list (the head of the list), 1 being the next element and so on.
  2285. These offsets can also be negative numbers indicating offsets starting at the end of the list.For example, -1 is the last element of the list, -2 the penultimate, and so on.
  2286. Note that if you have a list of numbers from 0 to 100, LRANGE list 0 10 will return 11 elements, that is, the rightmost item is included.
  2287. </summary>
  2288. <returns>list of elements in the specified range.</returns>
  2289. <remarks>http://redis.io/commands/lrange</remarks>
  2290. </member>
  2291. <member name="M:StackExchange.Redis.IDatabase.ListRemove(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Int64,StackExchange.Redis.CommandFlags)">
  2292. <summary>
  2293. Removes the first count occurrences of elements equal to value from the list stored at key. The count argument influences the operation in the following ways:
  2294. count &gt; 0: Remove elements equal to value moving from head to tail.
  2295. count &lt; 0: Remove elements equal to value moving from tail to head.
  2296. count = 0: Remove all elements equal to value.
  2297. </summary>
  2298. <returns>the number of removed elements.</returns>
  2299. <remarks>http://redis.io/commands/lrem</remarks>
  2300. </member>
  2301. <member name="M:StackExchange.Redis.IDatabase.ListRightPop(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2302. <summary>
  2303. Removes and returns the last element of the list stored at key.
  2304. </summary>
  2305. <remarks>http://redis.io/commands/rpop</remarks>
  2306. </member>
  2307. <member name="M:StackExchange.Redis.IDatabase.ListRightPopLeftPush(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2308. <summary>
  2309. Atomically returns and removes the last element (tail) of the list stored at source, and pushes the element at the first element (head) of the list stored at destination.
  2310. </summary>
  2311. <returns>the element being popped and pushed.</returns>
  2312. <remarks>http://redis.io/commands/rpoplpush</remarks>
  2313. </member>
  2314. <member name="M:StackExchange.Redis.IDatabase.ListRightPush(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.When,StackExchange.Redis.CommandFlags)">
  2315. <summary>
  2316. Insert the specified value at the tail of the list stored at key. If key does not exist, it is created as empty list before performing the push operation.
  2317. </summary>
  2318. <returns>the length of the list after the push operation.</returns>
  2319. <remarks>http://redis.io/commands/rpush</remarks>
  2320. <remarks>http://redis.io/commands/rpushx</remarks>
  2321. </member>
  2322. <member name="M:StackExchange.Redis.IDatabase.ListRightPush(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  2323. <summary>
  2324. Insert all the specified values at the tail of the list stored at key. If key does not exist, it is created as empty list before performing the push operation.
  2325. Elements are inserted one after the other to the tail of the list, from the leftmost element to the rightmost element. So for instance the command RPUSH mylist a b c will result into a list containing a as first element, b as second element and c as third element.
  2326. </summary>
  2327. <returns>the length of the list after the push operation.</returns>
  2328. <remarks>http://redis.io/commands/rpush</remarks>
  2329. </member>
  2330. <member name="M:StackExchange.Redis.IDatabase.ListSetByIndex(StackExchange.Redis.RedisKey,System.Int64,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2331. <summary>
  2332. Sets the list element at index to value. For more information on the index argument, see ListGetByIndex. An error is returned for out of range indexes.
  2333. </summary>
  2334. <remarks>http://redis.io/commands/lset</remarks>
  2335. </member>
  2336. <member name="M:StackExchange.Redis.IDatabase.ListTrim(StackExchange.Redis.RedisKey,System.Int64,System.Int64,StackExchange.Redis.CommandFlags)">
  2337. <summary>
  2338. Trim an existing list so that it will contain only the specified range of elements specified. Both start and stop are zero-based indexes, where 0 is the first element of the list (the head), 1 the next element and so on.
  2339. For example: LTRIM foobar 0 2 will modify the list stored at foobar so that only the first three elements of the list will remain.
  2340. start and end can also be negative numbers indicating offsets from the end of the list, where -1 is the last element of the list, -2 the penultimate element and so on.
  2341. </summary>
  2342. <remarks>http://redis.io/commands/ltrim</remarks>
  2343. </member>
  2344. <member name="M:StackExchange.Redis.IDatabase.LockExtend(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.TimeSpan,StackExchange.Redis.CommandFlags)">
  2345. <summary>
  2346. Extends a lock, if the token value is correct
  2347. </summary>
  2348. </member>
  2349. <member name="M:StackExchange.Redis.IDatabase.LockQuery(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2350. <summary>
  2351. Queries the token held against a lock
  2352. </summary>
  2353. </member>
  2354. <member name="M:StackExchange.Redis.IDatabase.LockRelease(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2355. <summary>
  2356. Releases a lock, if the token value is correct
  2357. </summary>
  2358. </member>
  2359. <member name="M:StackExchange.Redis.IDatabase.LockTake(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.TimeSpan,StackExchange.Redis.CommandFlags)">
  2360. <summary>
  2361. Takes a lock (specifying a token value) if it is not already taken
  2362. </summary>
  2363. </member>
  2364. <member name="M:StackExchange.Redis.IDatabase.Publish(StackExchange.Redis.RedisChannel,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2365. <summary>
  2366. Posts a message to the given channel.
  2367. </summary>
  2368. <returns>the number of clients that received the message.</returns>
  2369. <remarks>http://redis.io/commands/publish</remarks>
  2370. </member>
  2371. <member name="M:StackExchange.Redis.IDatabase.ScriptEvaluate(System.String,StackExchange.Redis.RedisKey[],StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  2372. <summary>
  2373. Execute a Lua script against the server
  2374. </summary>
  2375. <remarks>http://redis.io/commands/eval, http://redis.io/commands/evalsha</remarks>
  2376. <returns>A dynamic representation of the script's result</returns>
  2377. </member>
  2378. <member name="M:StackExchange.Redis.IDatabase.ScriptEvaluate(System.Byte[],StackExchange.Redis.RedisKey[],StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  2379. <summary>
  2380. Execute a Lua script against the server using just the SHA1 hash
  2381. </summary>
  2382. <remarks>http://redis.io/commands/evalsha</remarks>
  2383. <returns>A dynamic representation of the script's result</returns>
  2384. </member>
  2385. <member name="M:StackExchange.Redis.IDatabase.ScriptEvaluate(StackExchange.Redis.LuaScript,System.Object,StackExchange.Redis.CommandFlags)">
  2386. <summary>
  2387. Execute a lua script against the server, using previously prepared script.
  2388. Named parameters, if any, are provided by the `parameters` object.
  2389. </summary>
  2390. </member>
  2391. <member name="M:StackExchange.Redis.IDatabase.ScriptEvaluate(StackExchange.Redis.LoadedLuaScript,System.Object,StackExchange.Redis.CommandFlags)">
  2392. <summary>
  2393. Execute a lua script against the server, using previously prepared and loaded script.
  2394. This method sends only the SHA1 hash of the lua script to Redis.
  2395. Named parameters, if any, are provided by the `parameters` object.
  2396. </summary>
  2397. </member>
  2398. <member name="M:StackExchange.Redis.IDatabase.SetAdd(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2399. <summary>
  2400. Add the specified member to the set stored at key. Specified members that are already a member of this set are ignored. If key does not exist, a new set is created before adding the specified members.
  2401. </summary>
  2402. <returns>True if the specified member was not already present in the set, else False</returns>
  2403. <remarks>http://redis.io/commands/sadd</remarks>
  2404. </member>
  2405. <member name="M:StackExchange.Redis.IDatabase.SetAdd(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  2406. <summary>
  2407. Add the specified members to the set stored at key. Specified members that are already a member of this set are ignored. If key does not exist, a new set is created before adding the specified members.
  2408. </summary>
  2409. <returns>the number of elements that were added to the set, not including all the elements already present into the set.</returns>
  2410. <remarks>http://redis.io/commands/sadd</remarks>
  2411. </member>
  2412. <member name="M:StackExchange.Redis.IDatabase.SetCombine(StackExchange.Redis.SetOperation,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2413. <summary>
  2414. Returns the members of the set resulting from the specified operation against the given sets.
  2415. </summary>
  2416. <returns>list with members of the resulting set.</returns>
  2417. <remarks>http://redis.io/commands/sunion</remarks>
  2418. <remarks>http://redis.io/commands/sinter</remarks>
  2419. <remarks>http://redis.io/commands/sdiff</remarks>
  2420. </member>
  2421. <member name="M:StackExchange.Redis.IDatabase.SetCombine(StackExchange.Redis.SetOperation,StackExchange.Redis.RedisKey[],StackExchange.Redis.CommandFlags)">
  2422. <summary>
  2423. Returns the members of the set resulting from the specified operation against the given sets.
  2424. </summary>
  2425. <returns>list with members of the resulting set.</returns>
  2426. <remarks>http://redis.io/commands/sunion</remarks>
  2427. <remarks>http://redis.io/commands/sinter</remarks>
  2428. <remarks>http://redis.io/commands/sdiff</remarks>
  2429. </member>
  2430. <member name="M:StackExchange.Redis.IDatabase.SetCombineAndStore(StackExchange.Redis.SetOperation,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2431. <summary>
  2432. This command is equal to SetCombine, but instead of returning the resulting set, it is stored in destination. If destination already exists, it is overwritten.
  2433. </summary>
  2434. <returns>the number of elements in the resulting set.</returns>
  2435. <remarks>http://redis.io/commands/sunionstore</remarks>
  2436. <remarks>http://redis.io/commands/sinterstore</remarks>
  2437. <remarks>http://redis.io/commands/sdiffstore</remarks>
  2438. </member>
  2439. <member name="M:StackExchange.Redis.IDatabase.SetCombineAndStore(StackExchange.Redis.SetOperation,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey[],StackExchange.Redis.CommandFlags)">
  2440. <summary>
  2441. This command is equal to SetCombine, but instead of returning the resulting set, it is stored in destination. If destination already exists, it is overwritten.
  2442. </summary>
  2443. <returns>the number of elements in the resulting set.</returns>
  2444. <remarks>http://redis.io/commands/sunionstore</remarks>
  2445. <remarks>http://redis.io/commands/sinterstore</remarks>
  2446. <remarks>http://redis.io/commands/sdiffstore</remarks>
  2447. </member>
  2448. <member name="M:StackExchange.Redis.IDatabase.SetContains(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2449. <summary>
  2450. Returns if member is a member of the set stored at key.
  2451. </summary>
  2452. <returns>1 if the element is a member of the set. 0 if the element is not a member of the set, or if key does not exist.</returns>
  2453. <remarks>http://redis.io/commands/sismember</remarks>
  2454. </member>
  2455. <member name="M:StackExchange.Redis.IDatabase.SetLength(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2456. <summary>
  2457. Returns the set cardinality (number of elements) of the set stored at key.
  2458. </summary>
  2459. <returns>the cardinality (number of elements) of the set, or 0 if key does not exist.</returns>
  2460. <remarks>http://redis.io/commands/scard</remarks>
  2461. </member>
  2462. <member name="M:StackExchange.Redis.IDatabase.SetMembers(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2463. <summary>
  2464. Returns all the members of the set value stored at key.
  2465. </summary>
  2466. <returns>all elements of the set.</returns>
  2467. <remarks>http://redis.io/commands/smembers</remarks>
  2468. </member>
  2469. <member name="M:StackExchange.Redis.IDatabase.SetMove(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2470. <summary>
  2471. Move member from the set at source to the set at destination. This operation is atomic. In every given moment the element will appear to be a member of source or destination for other clients.
  2472. When the specified element already exists in the destination set, it is only removed from the source set.
  2473. </summary>
  2474. <returns>1 if the element is moved. 0 if the element is not a member of source and no operation was performed.</returns>
  2475. <remarks>http://redis.io/commands/smove</remarks>
  2476. </member>
  2477. <member name="M:StackExchange.Redis.IDatabase.SetPop(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2478. <summary>
  2479. Removes and returns a random element from the set value stored at key.
  2480. </summary>
  2481. <returns>the removed element, or nil when key does not exist.</returns>
  2482. <remarks>http://redis.io/commands/spop</remarks>
  2483. </member>
  2484. <member name="M:StackExchange.Redis.IDatabase.SetRandomMember(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2485. <summary>
  2486. Return a random element from the set value stored at key.
  2487. </summary>
  2488. <returns>the randomly selected element, or nil when key does not exist</returns>
  2489. <remarks>http://redis.io/commands/srandmember</remarks>
  2490. </member>
  2491. <member name="M:StackExchange.Redis.IDatabase.SetRandomMembers(StackExchange.Redis.RedisKey,System.Int64,StackExchange.Redis.CommandFlags)">
  2492. <summary>
  2493. Return an array of count distinct elements if count is positive. If called with a negative count the behavior changes and the command is allowed to return the same element multiple times.
  2494. In this case the numer of returned elements is the absolute value of the specified count.
  2495. </summary>
  2496. <returns>an array of elements, or an empty array when key does not exist</returns>
  2497. <remarks>http://redis.io/commands/srandmember</remarks>
  2498. </member>
  2499. <member name="M:StackExchange.Redis.IDatabase.SetRemove(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2500. <summary>
  2501. Remove the specified member from the set stored at key. Specified members that are not a member of this set are ignored.
  2502. </summary>
  2503. <returns>True if the specified member was already present in the set, else False</returns>
  2504. <remarks>http://redis.io/commands/srem</remarks>
  2505. </member>
  2506. <member name="M:StackExchange.Redis.IDatabase.SetRemove(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  2507. <summary>
  2508. Remove the specified members from the set stored at key. Specified members that are not a member of this set are ignored.
  2509. </summary>
  2510. <returns>the number of members that were removed from the set, not including non existing members.</returns>
  2511. <remarks>http://redis.io/commands/srem</remarks>
  2512. </member>
  2513. <member name="M:StackExchange.Redis.IDatabase.SetScan(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Int32,StackExchange.Redis.CommandFlags)">
  2514. <summary>
  2515. The SSCAN command is used to incrementally iterate over set
  2516. </summary>
  2517. <returns>yields all elements of the set.</returns>
  2518. <remarks>http://redis.io/commands/sscan</remarks>
  2519. </member>
  2520. <member name="M:StackExchange.Redis.IDatabase.SetScan(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Int32,System.Int64,System.Int32,StackExchange.Redis.CommandFlags)">
  2521. <summary>
  2522. The SSCAN command is used to incrementally iterate over set; note: to resume an iteration via <i>cursor</i>, cast the original enumerable or enumerator to <i>IScanningCursor</i>.
  2523. </summary>
  2524. <returns>yields all elements of the set.</returns>
  2525. <remarks>http://redis.io/commands/sscan</remarks>
  2526. </member>
  2527. <member name="M:StackExchange.Redis.IDatabase.Sort(StackExchange.Redis.RedisKey,System.Int64,System.Int64,StackExchange.Redis.Order,StackExchange.Redis.SortType,StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  2528. <summary>
  2529. Sorts a list, set or sorted set (numerically or alphabetically, ascending by default); By default, the elements themselves are compared, but the values can also be
  2530. used to perform external key-lookups using the <c>by</c> parameter. By default, the elements themselves are returned, but external key-lookups (one or many) can
  2531. be performed instead by specifying the <c>get</c> parameter (note that <c>#</c> specifies the element itself, when used in <c>get</c>).
  2532. Referring to the <a href="http://redis.io/commands/sort">redis SORT documentation </a> for examples is recommended. When used in hashes, <c>by</c> and <c>get</c>
  2533. can be used to specify fields using <c>-&gt;</c> notation (again, refer to redis documentation).
  2534. </summary>
  2535. <remarks>http://redis.io/commands/sort</remarks>
  2536. <returns>Returns the sorted elements, or the external values if <c>get</c> is specified</returns>
  2537. </member>
  2538. <member name="M:StackExchange.Redis.IDatabase.SortAndStore(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,System.Int64,System.Int64,StackExchange.Redis.Order,StackExchange.Redis.SortType,StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  2539. <summary>
  2540. Sorts a list, set or sorted set (numerically or alphabetically, ascending by default); By default, the elements themselves are compared, but the values can also be
  2541. used to perform external key-lookups using the <c>by</c> parameter. By default, the elements themselves are returned, but external key-lookups (one or many) can
  2542. be performed instead by specifying the <c>get</c> parameter (note that <c>#</c> specifies the element itself, when used in <c>get</c>).
  2543. Referring to the <a href="http://redis.io/commands/sort">redis SORT documentation </a> for examples is recommended. When used in hashes, <c>by</c> and <c>get</c>
  2544. can be used to specify fields using <c>-&gt;</c> notation (again, refer to redis documentation).
  2545. </summary>
  2546. <remarks>http://redis.io/commands/sort</remarks>
  2547. <returns>Returns the number of elements stored in the new list</returns>
  2548. </member>
  2549. <member name="M:StackExchange.Redis.IDatabase.SortedSetAdd(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Double,StackExchange.Redis.CommandFlags)">
  2550. <summary>
  2551. Adds the specified member with the specified score to the sorted set stored at key. If the specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.
  2552. </summary>
  2553. <returns>True if the value was added, False if it already existed (the score is still updated)</returns>
  2554. <remarks>http://redis.io/commands/zadd</remarks>
  2555. </member>
  2556. <member name="M:StackExchange.Redis.IDatabase.SortedSetAdd(StackExchange.Redis.RedisKey,StackExchange.Redis.SortedSetEntry[],StackExchange.Redis.CommandFlags)">
  2557. <summary>
  2558. Adds all the specified members with the specified scores to the sorted set stored at key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.
  2559. </summary>
  2560. <returns>The number of elements added to the sorted sets, not including elements already existing for which the score was updated.</returns>
  2561. <remarks>http://redis.io/commands/zadd</remarks>
  2562. </member>
  2563. <member name="M:StackExchange.Redis.IDatabase.SortedSetCombineAndStore(StackExchange.Redis.SetOperation,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.Aggregate,StackExchange.Redis.CommandFlags)">
  2564. <summary>
  2565. Computes a set operation over two sorted sets, and stores the result in destination, optionally performing
  2566. a specific aggregation (defaults to sum)
  2567. </summary>
  2568. <remarks>http://redis.io/commands/zunionstore</remarks>
  2569. <remarks>http://redis.io/commands/zinterstore</remarks>
  2570. <returns>the number of elements in the resulting sorted set at destination</returns>
  2571. </member>
  2572. <member name="M:StackExchange.Redis.IDatabase.SortedSetCombineAndStore(StackExchange.Redis.SetOperation,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey[],System.Double[],StackExchange.Redis.Aggregate,StackExchange.Redis.CommandFlags)">
  2573. <summary>
  2574. Computes a set operation over multiple sorted sets (optionally using per-set weights), and stores the result in destination, optionally performing
  2575. a specific aggregation (defaults to sum)
  2576. </summary>
  2577. <remarks>http://redis.io/commands/zunionstore</remarks>
  2578. <remarks>http://redis.io/commands/zinterstore</remarks>
  2579. <returns>the number of elements in the resulting sorted set at destination</returns>
  2580. </member>
  2581. <member name="M:StackExchange.Redis.IDatabase.SortedSetDecrement(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Double,StackExchange.Redis.CommandFlags)">
  2582. <summary>
  2583. Decrements the score of member in the sorted set stored at key by decrement. If member does not exist in the sorted set, it is added with -decrement as its score (as if its previous score was 0.0).
  2584. </summary>
  2585. <returns>the new score of member</returns>
  2586. <remarks>http://redis.io/commands/zincrby</remarks>
  2587. </member>
  2588. <member name="M:StackExchange.Redis.IDatabase.SortedSetIncrement(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Double,StackExchange.Redis.CommandFlags)">
  2589. <summary>
  2590. Increments the score of member in the sorted set stored at key by increment. If member does not exist in the sorted set, it is added with increment as its score (as if its previous score was 0.0).
  2591. </summary>
  2592. <returns>the new score of member</returns>
  2593. <remarks>http://redis.io/commands/zincrby</remarks>
  2594. </member>
  2595. <member name="M:StackExchange.Redis.IDatabase.SortedSetLength(StackExchange.Redis.RedisKey,System.Double,System.Double,StackExchange.Redis.Exclude,StackExchange.Redis.CommandFlags)">
  2596. <summary>
  2597. Returns the sorted set cardinality (number of elements) of the sorted set stored at key.
  2598. </summary>
  2599. <returns>the cardinality (number of elements) of the sorted set, or 0 if key does not exist.</returns>
  2600. <remarks>http://redis.io/commands/zcard</remarks>
  2601. </member>
  2602. <member name="M:StackExchange.Redis.IDatabase.SortedSetLengthByValue(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue,StackExchange.Redis.Exclude,StackExchange.Redis.CommandFlags)">
  2603. <summary>
  2604. When all the elements in a sorted set are inserted with the same score, in order to force lexicographical ordering, this command returns the number of elements in the sorted set at key with a value between min and max.
  2605. </summary>
  2606. <returns>the number of elements in the specified score range.</returns>
  2607. <remarks>When all the elements in a sorted set are inserted with the same score, in order to force lexicographical ordering, this command returns all the elements in the sorted set at key with a value between min and max.</remarks>
  2608. </member>
  2609. <member name="M:StackExchange.Redis.IDatabase.SortedSetRangeByRank(StackExchange.Redis.RedisKey,System.Int64,System.Int64,StackExchange.Redis.Order,StackExchange.Redis.CommandFlags)">
  2610. <summary>
  2611. Returns the specified range of elements in the sorted set stored at key. By default the elements are considered to be ordered from the lowest to the highest score. Lexicographical order is used for elements with equal score.
  2612. Both start and stop are zero-based indexes, where 0 is the first element, 1 is the next element and so on. They can also be negative numbers indicating offsets from the end of the sorted set, with -1 being the last element of the sorted set, -2 the penultimate element and so on.
  2613. </summary>
  2614. <returns>list of elements in the specified range</returns>
  2615. <remarks>http://redis.io/commands/zrange</remarks>
  2616. <remarks>http://redis.io/commands/zrevrange</remarks>
  2617. </member>
  2618. <member name="M:StackExchange.Redis.IDatabase.SortedSetRangeByRankWithScores(StackExchange.Redis.RedisKey,System.Int64,System.Int64,StackExchange.Redis.Order,StackExchange.Redis.CommandFlags)">
  2619. <summary>
  2620. Returns the specified range of elements in the sorted set stored at key. By default the elements are considered to be ordered from the lowest to the highest score. Lexicographical order is used for elements with equal score.
  2621. Both start and stop are zero-based indexes, where 0 is the first element, 1 is the next element and so on. They can also be negative numbers indicating offsets from the end of the sorted set, with -1 being the last element of the sorted set, -2 the penultimate element and so on.
  2622. </summary>
  2623. <returns>list of elements in the specified range</returns>
  2624. <remarks>http://redis.io/commands/zrange</remarks>
  2625. <remarks>http://redis.io/commands/zrevrange</remarks>
  2626. </member>
  2627. <member name="M:StackExchange.Redis.IDatabase.SortedSetRangeByScore(StackExchange.Redis.RedisKey,System.Double,System.Double,StackExchange.Redis.Exclude,StackExchange.Redis.Order,System.Int64,System.Int64,StackExchange.Redis.CommandFlags)">
  2628. <summary>
  2629. Returns the specified range of elements in the sorted set stored at key. By default the elements are considered to be ordered from the lowest to the highest score. Lexicographical order is used for elements with equal score.
  2630. Start and stop are used to specify the min and max range for score values. Similar to other range methods the values are inclusive.
  2631. </summary>
  2632. <returns>list of elements in the specified score range</returns>
  2633. <remarks>http://redis.io/commands/zrangebyscore</remarks>
  2634. <remarks>http://redis.io/commands/zrevrangebyscore</remarks>
  2635. </member>
  2636. <member name="M:StackExchange.Redis.IDatabase.SortedSetRangeByScoreWithScores(StackExchange.Redis.RedisKey,System.Double,System.Double,StackExchange.Redis.Exclude,StackExchange.Redis.Order,System.Int64,System.Int64,StackExchange.Redis.CommandFlags)">
  2637. <summary>
  2638. Returns the specified range of elements in the sorted set stored at key. By default the elements are considered to be ordered from the lowest to the highest score. Lexicographical order is used for elements with equal score.
  2639. Start and stop are used to specify the min and max range for score values. Similar to other range methods the values are inclusive.
  2640. </summary>
  2641. <returns>list of elements in the specified score range</returns>
  2642. <remarks>http://redis.io/commands/zrangebyscore</remarks>
  2643. <remarks>http://redis.io/commands/zrevrangebyscore</remarks>
  2644. </member>
  2645. <member name="M:StackExchange.Redis.IDatabase.SortedSetRangeByValue(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue,StackExchange.Redis.Exclude,System.Int64,System.Int64,StackExchange.Redis.CommandFlags)">
  2646. <summary>
  2647. When all the elements in a sorted set are inserted with the same score, in order to force lexicographical ordering, this command returns all the elements in the sorted set at key with a value between min and max.
  2648. </summary>
  2649. <remarks>http://redis.io/commands/zrangebylex</remarks>
  2650. <returns>list of elements in the specified score range.</returns>
  2651. </member>
  2652. <member name="M:StackExchange.Redis.IDatabase.SortedSetRank(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.Order,StackExchange.Redis.CommandFlags)">
  2653. <summary>
  2654. Returns the rank of member in the sorted set stored at key, by default with the scores ordered from low to high. The rank (or index) is 0-based, which means that the member with the lowest score has rank 0.
  2655. </summary>
  2656. <returns>If member exists in the sorted set, the rank of member; If member does not exist in the sorted set or key does not exist, null</returns>
  2657. <remarks>http://redis.io/commands/zrank</remarks>
  2658. <remarks>http://redis.io/commands/zrevrank</remarks>
  2659. </member>
  2660. <member name="M:StackExchange.Redis.IDatabase.SortedSetRemove(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2661. <summary>
  2662. Removes the specified member from the sorted set stored at key. Non existing members are ignored.
  2663. </summary>
  2664. <returns>True if the member existed in the sorted set and was removed; False otherwise.</returns>
  2665. <remarks>http://redis.io/commands/zrem</remarks>
  2666. </member>
  2667. <member name="M:StackExchange.Redis.IDatabase.SortedSetRemove(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  2668. <summary>
  2669. Removes the specified members from the sorted set stored at key. Non existing members are ignored.
  2670. </summary>
  2671. <returns>The number of members removed from the sorted set, not including non existing members.</returns>
  2672. <remarks>http://redis.io/commands/zrem</remarks>
  2673. </member>
  2674. <member name="M:StackExchange.Redis.IDatabase.SortedSetRemoveRangeByRank(StackExchange.Redis.RedisKey,System.Int64,System.Int64,StackExchange.Redis.CommandFlags)">
  2675. <summary>
  2676. Removes all elements in the sorted set stored at key with rank between start and stop. Both start and stop are 0 -based indexes with 0 being the element with the lowest score. These indexes can be negative numbers, where they indicate offsets starting at the element with the highest score. For example: -1 is the element with the highest score, -2 the element with the second highest score and so forth.
  2677. </summary>
  2678. <returns> the number of elements removed.</returns>
  2679. <remarks>http://redis.io/commands/zremrangebyrank</remarks>
  2680. </member>
  2681. <member name="M:StackExchange.Redis.IDatabase.SortedSetRemoveRangeByScore(StackExchange.Redis.RedisKey,System.Double,System.Double,StackExchange.Redis.Exclude,StackExchange.Redis.CommandFlags)">
  2682. <summary>
  2683. Removes all elements in the sorted set stored at key with a score between min and max (inclusive by default).
  2684. </summary>
  2685. <returns> the number of elements removed.</returns>
  2686. <remarks>http://redis.io/commands/zremrangebyscore</remarks>
  2687. </member>
  2688. <member name="M:StackExchange.Redis.IDatabase.SortedSetRemoveRangeByValue(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue,StackExchange.Redis.Exclude,StackExchange.Redis.CommandFlags)">
  2689. <summary>
  2690. When all the elements in a sorted set are inserted with the same score, in order to force lexicographical ordering, this command removes all elements in the sorted set stored at key between the lexicographical range specified by min and max.
  2691. </summary>
  2692. <remarks>http://redis.io/commands/zremrangebylex</remarks>
  2693. <returns>the number of elements removed.</returns>
  2694. </member>
  2695. <member name="M:StackExchange.Redis.IDatabase.SortedSetScan(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Int32,StackExchange.Redis.CommandFlags)">
  2696. <summary>
  2697. The ZSCAN command is used to incrementally iterate over a sorted set
  2698. </summary>
  2699. <returns>yields all elements of the sorted set.</returns>
  2700. <remarks>http://redis.io/commands/zscan</remarks>
  2701. </member>
  2702. <member name="M:StackExchange.Redis.IDatabase.SortedSetScan(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Int32,System.Int64,System.Int32,StackExchange.Redis.CommandFlags)">
  2703. <summary>
  2704. The ZSCAN command is used to incrementally iterate over a sorted set; note: to resume an iteration via <i>cursor</i>, cast the original enumerable or enumerator to <i>IScanningCursor</i>.
  2705. </summary>
  2706. <returns>yields all elements of the sorted set.</returns>
  2707. <remarks>http://redis.io/commands/zscan</remarks>
  2708. </member>
  2709. <member name="M:StackExchange.Redis.IDatabase.SortedSetScore(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2710. <summary>
  2711. Returns the score of member in the sorted set at key; If member does not exist in the sorted set, or key does not exist, nil is returned.
  2712. </summary>
  2713. <returns>the score of member</returns>
  2714. <remarks>http://redis.io/commands/zscore</remarks>
  2715. </member>
  2716. <member name="M:StackExchange.Redis.IDatabase.StringAppend(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2717. <summary>
  2718. If key already exists and is a string, this command appends the value at the end of the string. If key does not exist it is created and set as an empty string,
  2719. so APPEND will be similar to SET in this special case.
  2720. </summary>
  2721. <returns>the length of the string after the append operation.</returns>
  2722. <remarks>http://redis.io/commands/append</remarks>
  2723. </member>
  2724. <member name="M:StackExchange.Redis.IDatabase.StringBitCount(StackExchange.Redis.RedisKey,System.Int64,System.Int64,StackExchange.Redis.CommandFlags)">
  2725. <summary>
  2726. Count the number of set bits (population counting) in a string.
  2727. By default all the bytes contained in the string are examined.It is possible to specify the counting operation only in an interval passing the additional arguments start and end.
  2728. Like for the GETRANGE command start and end can contain negative values in order to index bytes starting from the end of the string, where -1 is the last byte, -2 is the penultimate, and so forth.
  2729. </summary>
  2730. <returns>The number of bits set to 1</returns>
  2731. <remarks>http://redis.io/commands/bitcount</remarks>
  2732. </member>
  2733. <member name="M:StackExchange.Redis.IDatabase.StringBitOperation(StackExchange.Redis.Bitwise,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2734. <summary>
  2735. Perform a bitwise operation between multiple keys (containing string values) and store the result in the destination key.
  2736. The BITOP command supports four bitwise operations; note that NOT is a unary operator: the second key should be omitted in this case
  2737. and only the first key will be considered.
  2738. The result of the operation is always stored at destkey.
  2739. </summary>
  2740. <returns>The size of the string stored in the destination key, that is equal to the size of the longest input string.</returns>
  2741. <remarks>http://redis.io/commands/bitop</remarks>
  2742. </member>
  2743. <member name="M:StackExchange.Redis.IDatabase.StringBitOperation(StackExchange.Redis.Bitwise,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey[],StackExchange.Redis.CommandFlags)">
  2744. <summary>
  2745. Perform a bitwise operation between multiple keys (containing string values) and store the result in the destination key.
  2746. The BITOP command supports four bitwise operations; note that NOT is a unary operator.
  2747. The result of the operation is always stored at destkey.
  2748. </summary>
  2749. <returns>The size of the string stored in the destination key, that is equal to the size of the longest input string.</returns>
  2750. <remarks>http://redis.io/commands/bitop</remarks>
  2751. </member>
  2752. <member name="M:StackExchange.Redis.IDatabase.StringBitPosition(StackExchange.Redis.RedisKey,System.Boolean,System.Int64,System.Int64,StackExchange.Redis.CommandFlags)">
  2753. <summary>
  2754. Return the position of the first bit set to 1 or 0 in a string.
  2755. The position is returned thinking at the string as an array of bits from left to right where the first byte most significant bit is at position 0, the second byte most significant bit is at position 8 and so forth.
  2756. An start and end may be specified; these are in bytes, not bits; start and end can contain negative values in order to index bytes starting from the end of the string, where -1 is the last byte, -2 is the penultimate, and so forth.
  2757. </summary>
  2758. <returns>The command returns the position of the first bit set to 1 or 0 according to the request.
  2759. If we look for set bits(the bit argument is 1) and the string is empty or composed of just zero bytes, -1 is returned.</returns>
  2760. <remarks>http://redis.io/commands/bitpos</remarks>
  2761. </member>
  2762. <member name="M:StackExchange.Redis.IDatabase.StringDecrement(StackExchange.Redis.RedisKey,System.Int64,StackExchange.Redis.CommandFlags)">
  2763. <summary>
  2764. Decrements the number stored at key by decrement. If the key does not exist, it is set to 0 before performing the operation.
  2765. An error is returned if the key contains a value of the wrong type or contains a string that is not representable as integer. This operation is limited to 64 bit signed integers.
  2766. </summary>
  2767. <returns> the value of key after the decrement</returns>
  2768. <remarks>http://redis.io/commands/decrby</remarks>
  2769. <remarks>http://redis.io/commands/decr</remarks>
  2770. </member>
  2771. <member name="M:StackExchange.Redis.IDatabase.StringDecrement(StackExchange.Redis.RedisKey,System.Double,StackExchange.Redis.CommandFlags)">
  2772. <summary>
  2773. Decrements the string representing a floating point number stored at key by the specified decrement. If the key does not exist, it is set to 0 before performing the operation. The precision of the output is fixed at 17 digits after the decimal point regardless of the actual internal precision of the computation.
  2774. </summary>
  2775. <returns>the value of key after the decrement</returns>
  2776. <remarks>http://redis.io/commands/incrbyfloat</remarks>
  2777. </member>
  2778. <member name="M:StackExchange.Redis.IDatabase.StringGet(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2779. <summary>
  2780. Get the value of key. If the key does not exist the special value nil is returned. An error is returned if the value stored at key is not a string, because GET only handles string values.
  2781. </summary>
  2782. <returns>the value of key, or nil when key does not exist.</returns>
  2783. <remarks>http://redis.io/commands/get</remarks>
  2784. </member>
  2785. <member name="M:StackExchange.Redis.IDatabase.StringGet(StackExchange.Redis.RedisKey[],StackExchange.Redis.CommandFlags)">
  2786. <summary>
  2787. Returns the values of all specified keys. For every key that does not hold a string value or does not exist, the special value nil is returned.
  2788. </summary>
  2789. <remarks>http://redis.io/commands/mget</remarks>
  2790. </member>
  2791. <member name="M:StackExchange.Redis.IDatabase.StringGetBit(StackExchange.Redis.RedisKey,System.Int64,StackExchange.Redis.CommandFlags)">
  2792. <summary>
  2793. Returns the bit value at offset in the string value stored at key.
  2794. When offset is beyond the string length, the string is assumed to be a contiguous space with 0 bits.
  2795. </summary>
  2796. <returns>the bit value stored at offset.</returns>
  2797. <remarks>http://redis.io/commands/getbit</remarks>
  2798. </member>
  2799. <member name="M:StackExchange.Redis.IDatabase.StringGetRange(StackExchange.Redis.RedisKey,System.Int64,System.Int64,StackExchange.Redis.CommandFlags)">
  2800. <summary>
  2801. Returns the substring of the string value stored at key, determined by the offsets start and end (both are inclusive). Negative offsets can be used in order to provide an offset starting from the end of the string. So -1 means the last character, -2 the penultimate and so forth.
  2802. </summary>
  2803. <returns>the substring of the string value stored at key</returns>
  2804. <remarks>http://redis.io/commands/getrange</remarks>
  2805. </member>
  2806. <member name="M:StackExchange.Redis.IDatabase.StringGetSet(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2807. <summary>
  2808. Atomically sets key to value and returns the old value stored at key.
  2809. </summary>
  2810. <remarks>http://redis.io/commands/getset</remarks>
  2811. <returns> the old value stored at key, or nil when key did not exist.</returns>
  2812. </member>
  2813. <member name="M:StackExchange.Redis.IDatabase.StringGetWithExpiry(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2814. <summary>
  2815. Get the value of key. If the key does not exist the special value nil is returned. An error is returned if the value stored at key is not a string, because GET only handles string values.
  2816. </summary>
  2817. <returns>the value of key, or nil when key does not exist.</returns>
  2818. <remarks>http://redis.io/commands/get</remarks>
  2819. </member>
  2820. <member name="M:StackExchange.Redis.IDatabase.StringIncrement(StackExchange.Redis.RedisKey,System.Int64,StackExchange.Redis.CommandFlags)">
  2821. <summary>
  2822. Increments the number stored at key by increment. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that is not representable as integer. This operation is limited to 64 bit signed integers.
  2823. </summary>
  2824. <returns> the value of key after the increment</returns>
  2825. <remarks>http://redis.io/commands/incrby</remarks>
  2826. <remarks>http://redis.io/commands/incr</remarks>
  2827. </member>
  2828. <member name="M:StackExchange.Redis.IDatabase.StringIncrement(StackExchange.Redis.RedisKey,System.Double,StackExchange.Redis.CommandFlags)">
  2829. <summary>
  2830. Increments the string representing a floating point number stored at key by the specified increment. If the key does not exist, it is set to 0 before performing the operation. The precision of the output is fixed at 17 digits after the decimal point regardless of the actual internal precision of the computation.
  2831. </summary>
  2832. <returns>the value of key after the increment</returns>
  2833. <remarks>http://redis.io/commands/incrbyfloat</remarks>
  2834. </member>
  2835. <member name="M:StackExchange.Redis.IDatabase.StringLength(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2836. <summary>
  2837. Returns the length of the string value stored at key.
  2838. </summary>
  2839. <returns>the length of the string at key, or 0 when key does not exist.</returns>
  2840. <remarks>http://redis.io/commands/strlen</remarks>
  2841. </member>
  2842. <member name="M:StackExchange.Redis.IDatabase.StringSet(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Nullable{System.TimeSpan},StackExchange.Redis.When,StackExchange.Redis.CommandFlags)">
  2843. <summary>
  2844. Set key to hold the string value. If key already holds a value, it is overwritten, regardless of its type.
  2845. </summary>
  2846. <remarks>http://redis.io/commands/set</remarks>
  2847. </member>
  2848. <member name="M:StackExchange.Redis.IDatabase.StringSet(System.Collections.Generic.KeyValuePair{StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue}[],StackExchange.Redis.When,StackExchange.Redis.CommandFlags)">
  2849. <summary>
  2850. Sets the given keys to their respective values. If "not exists" is specified, this will not perform any operation at all even if just a single key already exists.
  2851. </summary>
  2852. <returns>True if the keys were set, else False</returns>
  2853. <remarks>http://redis.io/commands/mset</remarks>
  2854. <remarks>http://redis.io/commands/msetnx</remarks>
  2855. </member>
  2856. <member name="M:StackExchange.Redis.IDatabase.StringSetBit(StackExchange.Redis.RedisKey,System.Int64,System.Boolean,StackExchange.Redis.CommandFlags)">
  2857. <summary>
  2858. Sets or clears the bit at offset in the string value stored at key.
  2859. The bit is either set or cleared depending on value, which can be either 0 or 1. When key does not exist, a new string value is created.The string is grown to make sure it can hold a bit at offset.
  2860. </summary>
  2861. <returns>the original bit value stored at offset.</returns>
  2862. <remarks>http://redis.io/commands/setbit</remarks>
  2863. </member>
  2864. <member name="M:StackExchange.Redis.IDatabase.StringSetRange(StackExchange.Redis.RedisKey,System.Int64,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2865. <summary>
  2866. Overwrites part of the string stored at key, starting at the specified offset, for the entire length of value. If the offset is larger than the current length of the string at key, the string is padded with zero-bytes to make offset fit. Non-existing keys are considered as empty strings, so this command will make sure it holds a string large enough to be able to set value at offset.
  2867. </summary>
  2868. <returns>the length of the string after it was modified by the command.</returns>
  2869. <remarks>http://redis.io/commands/setrange</remarks>
  2870. </member>
  2871. <member name="T:StackExchange.Redis.IDatabaseAsync">
  2872. <summary>
  2873. Describes functionality that is common to both standalone redis servers and redis clusters
  2874. </summary>
  2875. </member>
  2876. <member name="M:StackExchange.Redis.IDatabaseAsync.DebugObjectAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2877. <summary>
  2878. Returns the raw DEBUG OBJECT output for a key; this command is not fully documented and should be avoided unless you have good reason, and then avoided anyway.
  2879. </summary>
  2880. <remarks>http://redis.io/commands/debug-object</remarks>
  2881. </member>
  2882. <member name="M:StackExchange.Redis.IDatabaseAsync.HashDecrementAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Int64,StackExchange.Redis.CommandFlags)">
  2883. <summary>
  2884. Increments the number stored at field in the hash stored at key by increment. If key does not exist, a new key holding a hash is created. If field does not exist or holds a string that cannot be interpreted as integer, the value is set to 0 before the operation is performed.
  2885. </summary>
  2886. <remarks>The range of values supported by HINCRBY is limited to 64 bit signed integers.</remarks>
  2887. <returns>the value at field after the increment operation.</returns>
  2888. <remarks>http://redis.io/commands/hincrby</remarks>
  2889. </member>
  2890. <member name="M:StackExchange.Redis.IDatabaseAsync.HashDecrementAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Double,StackExchange.Redis.CommandFlags)">
  2891. <summary>
  2892. Decrement the specified field of an hash stored at key, and representing a floating point number, by the specified decrement. If the field does not exist, it is set to 0 before performing the operation.
  2893. </summary>
  2894. <remarks>The precision of the output is fixed at 17 digits after the decimal point regardless of the actual internal precision of the computation.</remarks>
  2895. <returns>the value at field after the decrement operation.</returns>
  2896. <remarks>http://redis.io/commands/hincrbyfloat</remarks>
  2897. </member>
  2898. <member name="M:StackExchange.Redis.IDatabaseAsync.HashDeleteAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2899. <summary>
  2900. Removes the specified fields from the hash stored at key. Non-existing fields are ignored. Non-existing keys are treated as empty hashes and this command returns 0.
  2901. </summary>
  2902. <remarks>http://redis.io/commands/hdel</remarks>
  2903. <returns>The number of fields that were removed.</returns>
  2904. </member>
  2905. <member name="M:StackExchange.Redis.IDatabaseAsync.HashDeleteAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  2906. <summary>
  2907. Removes the specified fields from the hash stored at key. Non-existing fields are ignored. Non-existing keys are treated as empty hashes and this command returns 0.
  2908. </summary>
  2909. <remarks>http://redis.io/commands/hdel</remarks>
  2910. <returns>The number of fields that were removed.</returns>
  2911. </member>
  2912. <member name="M:StackExchange.Redis.IDatabaseAsync.HashExistsAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2913. <summary>
  2914. Returns if field is an existing field in the hash stored at key.
  2915. </summary>
  2916. <returns>1 if the hash contains field. 0 if the hash does not contain field, or key does not exist.</returns>
  2917. <remarks>http://redis.io/commands/hexists</remarks>
  2918. </member>
  2919. <member name="M:StackExchange.Redis.IDatabaseAsync.HashGetAllAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2920. <summary>
  2921. Returns all fields and values of the hash stored at key.
  2922. </summary>
  2923. <returns>list of fields and their values stored in the hash, or an empty list when key does not exist.</returns>
  2924. <remarks>http://redis.io/commands/hgetall</remarks>
  2925. </member>
  2926. <member name="M:StackExchange.Redis.IDatabaseAsync.HashGetAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2927. <summary>
  2928. Returns the value associated with field in the hash stored at key.
  2929. </summary>
  2930. <returns>the value associated with field, or nil when field is not present in the hash or key does not exist.</returns>
  2931. <remarks>http://redis.io/commands/hget</remarks>
  2932. </member>
  2933. <member name="M:StackExchange.Redis.IDatabaseAsync.HashGetAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  2934. <summary>
  2935. Returns the values associated with the specified fields in the hash stored at key.
  2936. For every field that does not exist in the hash, a nil value is returned.Because a non-existing keys are treated as empty hashes, running HMGET against a non-existing key will return a list of nil values.
  2937. </summary>
  2938. <returns>list of values associated with the given fields, in the same order as they are requested.</returns>
  2939. <remarks>http://redis.io/commands/hmget</remarks>
  2940. </member>
  2941. <member name="M:StackExchange.Redis.IDatabaseAsync.HashIncrementAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Int64,StackExchange.Redis.CommandFlags)">
  2942. <summary>
  2943. Increments the number stored at field in the hash stored at key by increment. If key does not exist, a new key holding a hash is created. If field does not exist or holds a string that cannot be interpreted as integer, the value is set to 0 before the operation is performed.
  2944. </summary>
  2945. <remarks>The range of values supported by HINCRBY is limited to 64 bit signed integers.</remarks>
  2946. <returns>the value at field after the increment operation.</returns>
  2947. <remarks>http://redis.io/commands/hincrby</remarks>
  2948. </member>
  2949. <member name="M:StackExchange.Redis.IDatabaseAsync.HashIncrementAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Double,StackExchange.Redis.CommandFlags)">
  2950. <summary>
  2951. Increment the specified field of an hash stored at key, and representing a floating point number, by the specified increment. If the field does not exist, it is set to 0 before performing the operation.
  2952. </summary>
  2953. <remarks>The precision of the output is fixed at 17 digits after the decimal point regardless of the actual internal precision of the computation.</remarks>
  2954. <returns>the value at field after the increment operation.</returns>
  2955. <remarks>http://redis.io/commands/hincrbyfloat</remarks>
  2956. </member>
  2957. <member name="M:StackExchange.Redis.IDatabaseAsync.HashKeysAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2958. <summary>
  2959. Returns all field names in the hash stored at key.
  2960. </summary>
  2961. <returns>list of fields in the hash, or an empty list when key does not exist.</returns>
  2962. <remarks>http://redis.io/commands/hkeys</remarks>
  2963. </member>
  2964. <member name="M:StackExchange.Redis.IDatabaseAsync.HashLengthAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2965. <summary>
  2966. Returns the number of fields contained in the hash stored at key.
  2967. </summary>
  2968. <returns>number of fields in the hash, or 0 when key does not exist.</returns>
  2969. <remarks>http://redis.io/commands/hlen</remarks>
  2970. </member>
  2971. <member name="M:StackExchange.Redis.IDatabaseAsync.HashSetAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.HashEntry[],StackExchange.Redis.CommandFlags)">
  2972. <summary>
  2973. Sets the specified fields to their respective values in the hash stored at key. This command overwrites any existing fields in the hash. If key does not exist, a new key holding a hash is created.
  2974. </summary>
  2975. <remarks>http://redis.io/commands/hmset</remarks>
  2976. </member>
  2977. <member name="M:StackExchange.Redis.IDatabaseAsync.HashSetAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue,StackExchange.Redis.When,StackExchange.Redis.CommandFlags)">
  2978. <summary>
  2979. Sets field in the hash stored at key to value. If key does not exist, a new key holding a hash is created. If field already exists in the hash, it is overwritten.
  2980. </summary>
  2981. <returns>1 if field is a new field in the hash and value was set. 0 if field already exists in the hash and the value was updated.</returns>
  2982. <remarks>http://redis.io/commands/hset</remarks>
  2983. <remarks>http://redis.io/commands/hsetnx</remarks>
  2984. </member>
  2985. <member name="M:StackExchange.Redis.IDatabaseAsync.HashValuesAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  2986. <summary>
  2987. Returns all values in the hash stored at key.
  2988. </summary>
  2989. <returns>list of values in the hash, or an empty list when key does not exist.</returns>
  2990. <remarks>http://redis.io/commands/hvals</remarks>
  2991. </member>
  2992. <member name="M:StackExchange.Redis.IDatabaseAsync.HyperLogLogAddAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  2993. <summary>
  2994. Adds the element to the HyperLogLog data structure stored at the variable name specified as first argument.
  2995. </summary>
  2996. <returns>true if at least 1 HyperLogLog internal register was altered. false otherwise.</returns>
  2997. <remarks>http://redis.io/commands/pfadd</remarks>
  2998. </member>
  2999. <member name="M:StackExchange.Redis.IDatabaseAsync.HyperLogLogAddAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  3000. <summary>
  3001. Adds all the element arguments to the HyperLogLog data structure stored at the variable name specified as first argument.
  3002. </summary>
  3003. <returns>true if at least 1 HyperLogLog internal register was altered. false otherwise.</returns>
  3004. <remarks>http://redis.io/commands/pfadd</remarks>
  3005. </member>
  3006. <member name="M:StackExchange.Redis.IDatabaseAsync.HyperLogLogLengthAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3007. <summary>
  3008. Returns the approximated cardinality computed by the HyperLogLog data structure stored at the specified variable, or 0 if the variable does not exist.
  3009. </summary>
  3010. <returns>The approximated number of unique elements observed via HyperLogLogAdd.</returns>
  3011. <remarks>http://redis.io/commands/pfcount</remarks>
  3012. </member>
  3013. <member name="M:StackExchange.Redis.IDatabaseAsync.HyperLogLogLengthAsync(StackExchange.Redis.RedisKey[],StackExchange.Redis.CommandFlags)">
  3014. <summary>
  3015. Returns the approximated cardinality of the union of the HyperLogLogs passed, by internally merging the HyperLogLogs stored at the provided keys into a temporary hyperLogLog, or 0 if the variable does not exist.
  3016. </summary>
  3017. <returns>The approximated number of unique elements observed via HyperLogLogAdd.</returns>
  3018. <remarks>http://redis.io/commands/pfcount</remarks>
  3019. </member>
  3020. <member name="M:StackExchange.Redis.IDatabaseAsync.HyperLogLogMergeAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3021. <summary>
  3022. Merge multiple HyperLogLog values into an unique value that will approximate the cardinality of the union of the observed Sets of the source HyperLogLog structures.
  3023. </summary>
  3024. <remarks>http://redis.io/commands/pfmerge</remarks>
  3025. </member>
  3026. <member name="M:StackExchange.Redis.IDatabaseAsync.HyperLogLogMergeAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey[],StackExchange.Redis.CommandFlags)">
  3027. <summary>
  3028. Merge multiple HyperLogLog values into an unique value that will approximate the cardinality of the union of the observed Sets of the source HyperLogLog structures.
  3029. </summary>
  3030. <remarks>http://redis.io/commands/pfmerge</remarks>
  3031. </member>
  3032. <member name="M:StackExchange.Redis.IDatabaseAsync.IdentifyEndpointAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3033. <summary>
  3034. Inidicate exactly which redis server we are talking to
  3035. </summary>
  3036. </member>
  3037. <member name="M:StackExchange.Redis.IDatabaseAsync.IsConnected(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3038. <summary>
  3039. Indicates whether the instance can communicate with the server (resolved
  3040. using the supplied key and optional flags)
  3041. </summary>
  3042. </member>
  3043. <member name="M:StackExchange.Redis.IDatabaseAsync.KeyDeleteAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3044. <summary>
  3045. Removes the specified key. A key is ignored if it does not exist.
  3046. </summary>
  3047. <returns>True if the key was removed.</returns>
  3048. <remarks>http://redis.io/commands/del</remarks>
  3049. </member>
  3050. <member name="M:StackExchange.Redis.IDatabaseAsync.KeyDeleteAsync(StackExchange.Redis.RedisKey[],StackExchange.Redis.CommandFlags)">
  3051. <summary>
  3052. Removes the specified keys. A key is ignored if it does not exist.
  3053. </summary>
  3054. <returns>The number of keys that were removed.</returns>
  3055. <remarks>http://redis.io/commands/del</remarks>
  3056. </member>
  3057. <member name="M:StackExchange.Redis.IDatabaseAsync.KeyDumpAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3058. <summary>
  3059. Serialize the value stored at key in a Redis-specific format and return it to the user. The returned value can be synthesized back into a Redis key using the RESTORE command.
  3060. </summary>
  3061. <returns>the serialized value.</returns>
  3062. <remarks>http://redis.io/commands/dump</remarks>
  3063. </member>
  3064. <member name="M:StackExchange.Redis.IDatabaseAsync.KeyExistsAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3065. <summary>
  3066. Returns if key exists.
  3067. </summary>
  3068. <returns>1 if the key exists. 0 if the key does not exist.</returns>
  3069. <remarks>http://redis.io/commands/exists</remarks>
  3070. </member>
  3071. <member name="M:StackExchange.Redis.IDatabaseAsync.KeyExpireAsync(StackExchange.Redis.RedisKey,System.Nullable{System.TimeSpan},StackExchange.Redis.CommandFlags)">
  3072. <summary>
  3073. Set a timeout on key. After the timeout has expired, the key will automatically be deleted. A key with an associated timeout is said to be volatile in Redis terminology.
  3074. </summary>
  3075. <remarks>If key is updated before the timeout has expired, then the timeout is removed as if the PERSIST command was invoked on key.
  3076. For Redis versions &lt; 2.1.3, existing timeouts cannot be overwritten. So, if key already has an associated timeout, it will do nothing and return 0. Since Redis 2.1.3, you can update the timeout of a key. It is also possible to remove the timeout using the PERSIST command. See the page on key expiry for more information.</remarks>
  3077. <returns>1 if the timeout was set. 0 if key does not exist or the timeout could not be set.</returns>
  3078. <remarks>http://redis.io/commands/expire</remarks>
  3079. <remarks>http://redis.io/commands/pexpire</remarks>
  3080. <remarks>http://redis.io/commands/persist</remarks>
  3081. </member>
  3082. <member name="M:StackExchange.Redis.IDatabaseAsync.KeyExpireAsync(StackExchange.Redis.RedisKey,System.Nullable{System.DateTime},StackExchange.Redis.CommandFlags)">
  3083. <summary>
  3084. Set a timeout on key. After the timeout has expired, the key will automatically be deleted. A key with an associated timeout is said to be volatile in Redis terminology.
  3085. </summary>
  3086. <remarks>If key is updated before the timeout has expired, then the timeout is removed as if the PERSIST command was invoked on key.
  3087. For Redis versions &lt; 2.1.3, existing timeouts cannot be overwritten. So, if key already has an associated timeout, it will do nothing and return 0. Since Redis 2.1.3, you can update the timeout of a key. It is also possible to remove the timeout using the PERSIST command. See the page on key expiry for more information.</remarks>
  3088. <returns>1 if the timeout was set. 0 if key does not exist or the timeout could not be set.</returns>
  3089. <remarks>http://redis.io/commands/expireat</remarks>
  3090. <remarks>http://redis.io/commands/pexpireat</remarks>
  3091. <remarks>http://redis.io/commands/persist</remarks>
  3092. </member>
  3093. <member name="M:StackExchange.Redis.IDatabaseAsync.KeyMigrateAsync(StackExchange.Redis.RedisKey,System.Net.EndPoint,System.Int32,System.Int32,StackExchange.Redis.MigrateOptions,StackExchange.Redis.CommandFlags)">
  3094. <summary>
  3095. Atomically transfer a key from a source Redis instance to a destination Redis instance. On success the key is deleted from the original instance by default, and is guaranteed to exist in the target instance.
  3096. </summary>
  3097. <remarks>http://redis.io/commands/MIGRATE</remarks>
  3098. </member>
  3099. <member name="M:StackExchange.Redis.IDatabaseAsync.KeyMoveAsync(StackExchange.Redis.RedisKey,System.Int32,StackExchange.Redis.CommandFlags)">
  3100. <summary>
  3101. Move key from the currently selected database (see SELECT) to the specified destination database. When key already exists in the destination database, or it does not exist in the source database, it does nothing. It is possible to use MOVE as a locking primitive because of this.
  3102. </summary>
  3103. <returns>1 if key was moved; 0 if key was not moved.</returns>
  3104. <remarks>http://redis.io/commands/move</remarks>
  3105. </member>
  3106. <member name="M:StackExchange.Redis.IDatabaseAsync.KeyPersistAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3107. <summary>Remove the existing timeout on key, turning the key from volatile (a key with an expire set) to persistent (a key that will never expire as no timeout is associated).</summary>
  3108. <returns>1 if the timeout was removed. 0 if key does not exist or does not have an associated timeout.</returns>
  3109. <remarks>http://redis.io/commands/persist</remarks>
  3110. </member>
  3111. <member name="M:StackExchange.Redis.IDatabaseAsync.KeyRandomAsync(StackExchange.Redis.CommandFlags)">
  3112. <summary>
  3113. Return a random key from the currently selected database.
  3114. </summary>
  3115. <returns>the random key, or nil when the database is empty.</returns>
  3116. <remarks>http://redis.io/commands/randomkey</remarks>
  3117. </member>
  3118. <member name="M:StackExchange.Redis.IDatabaseAsync.KeyRenameAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.When,StackExchange.Redis.CommandFlags)">
  3119. <summary>
  3120. Renames key to newkey. It returns an error when the source and destination names are the same, or when key does not exist.
  3121. </summary>
  3122. <returns>http://redis.io/commands/rename</returns>
  3123. <remarks>http://redis.io/commands/renamenx</remarks>
  3124. </member>
  3125. <member name="M:StackExchange.Redis.IDatabaseAsync.KeyRestoreAsync(StackExchange.Redis.RedisKey,System.Byte[],System.Nullable{System.TimeSpan},StackExchange.Redis.CommandFlags)">
  3126. <summary>
  3127. Create a key associated with a value that is obtained by deserializing the provided serialized value (obtained via DUMP).
  3128. If ttl is 0 the key is created without any expire, otherwise the specified expire time(in milliseconds) is set.
  3129. </summary>
  3130. <remarks>http://redis.io/commands/restore</remarks>
  3131. </member>
  3132. <member name="M:StackExchange.Redis.IDatabaseAsync.KeyTimeToLiveAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3133. <summary>
  3134. Returns the remaining time to live of a key that has a timeout. This introspection capability allows a Redis client to check how many seconds a given key will continue to be part of the dataset.
  3135. </summary>
  3136. <returns>TTL, or nil when key does not exist or does not have a timeout.</returns>
  3137. <remarks>http://redis.io/commands/ttl</remarks>
  3138. </member>
  3139. <member name="M:StackExchange.Redis.IDatabaseAsync.KeyTypeAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3140. <summary>
  3141. Returns the string representation of the type of the value stored at key. The different types that can be returned are: string, list, set, zset and hash.
  3142. </summary>
  3143. <returns>type of key, or none when key does not exist.</returns>
  3144. <remarks>http://redis.io/commands/type</remarks>
  3145. </member>
  3146. <member name="M:StackExchange.Redis.IDatabaseAsync.ListGetByIndexAsync(StackExchange.Redis.RedisKey,System.Int64,StackExchange.Redis.CommandFlags)">
  3147. <summary>
  3148. Returns the element at index index in the list stored at key. The index is zero-based, so 0 means the first element, 1 the second element and so on. Negative indices can be used to designate elements starting at the tail of the list. Here, -1 means the last element, -2 means the penultimate and so forth.
  3149. </summary>
  3150. <returns>the requested element, or nil when index is out of range.</returns>
  3151. <remarks>http://redis.io/commands/lindex</remarks>
  3152. </member>
  3153. <member name="M:StackExchange.Redis.IDatabaseAsync.ListInsertAfterAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  3154. <summary>
  3155. Inserts value in the list stored at key either before or after the reference value pivot.
  3156. When key does not exist, it is considered an empty list and no operation is performed.
  3157. </summary>
  3158. <returns>the length of the list after the insert operation, or -1 when the value pivot was not found.</returns>
  3159. <remarks>http://redis.io/commands/linsert</remarks>
  3160. </member>
  3161. <member name="M:StackExchange.Redis.IDatabaseAsync.ListInsertBeforeAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  3162. <summary>
  3163. Inserts value in the list stored at key either before or after the reference value pivot.
  3164. When key does not exist, it is considered an empty list and no operation is performed.
  3165. </summary>
  3166. <returns>the length of the list after the insert operation, or -1 when the value pivot was not found.</returns>
  3167. <remarks>http://redis.io/commands/linsert</remarks>
  3168. </member>
  3169. <member name="M:StackExchange.Redis.IDatabaseAsync.ListLeftPopAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3170. <summary>
  3171. Removes and returns the first element of the list stored at key.
  3172. </summary>
  3173. <returns>the value of the first element, or nil when key does not exist.</returns>
  3174. <remarks>http://redis.io/commands/lpop</remarks>
  3175. </member>
  3176. <member name="M:StackExchange.Redis.IDatabaseAsync.ListLeftPushAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.When,StackExchange.Redis.CommandFlags)">
  3177. <summary>
  3178. Insert the specified value at the head of the list stored at key. If key does not exist, it is created as empty list before performing the push operations.
  3179. </summary>
  3180. <returns>the length of the list after the push operations.</returns>
  3181. <remarks>http://redis.io/commands/lpush</remarks>
  3182. <remarks>http://redis.io/commands/lpushx</remarks>
  3183. </member>
  3184. <member name="M:StackExchange.Redis.IDatabaseAsync.ListLeftPushAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  3185. <summary>
  3186. Insert all the specified values at the head of the list stored at key. If key does not exist, it is created as empty list before performing the push operations.
  3187. Elements are inserted one after the other to the head of the list, from the leftmost element to the rightmost element. So for instance the command LPUSH mylist a b c will result into a list containing c as first element, b as second element and a as third element.
  3188. </summary>
  3189. <returns>the length of the list after the push operations.</returns>
  3190. <remarks>http://redis.io/commands/lpush</remarks>
  3191. </member>
  3192. <member name="M:StackExchange.Redis.IDatabaseAsync.ListLengthAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3193. <summary>
  3194. Returns the length of the list stored at key. If key does not exist, it is interpreted as an empty list and 0 is returned.
  3195. </summary>
  3196. <returns>the length of the list at key.</returns>
  3197. <remarks>http://redis.io/commands/llen</remarks>
  3198. </member>
  3199. <member name="M:StackExchange.Redis.IDatabaseAsync.ListRangeAsync(StackExchange.Redis.RedisKey,System.Int64,System.Int64,StackExchange.Redis.CommandFlags)">
  3200. <summary>
  3201. Returns the specified elements of the list stored at key. The offsets start and stop are zero-based indexes, with 0 being the first element of the list (the head of the list), 1 being the next element and so on.
  3202. These offsets can also be negative numbers indicating offsets starting at the end of the list.For example, -1 is the last element of the list, -2 the penultimate, and so on.
  3203. Note that if you have a list of numbers from 0 to 100, LRANGE list 0 10 will return 11 elements, that is, the rightmost item is included.
  3204. </summary>
  3205. <returns>list of elements in the specified range.</returns>
  3206. <remarks>http://redis.io/commands/lrange</remarks>
  3207. </member>
  3208. <member name="M:StackExchange.Redis.IDatabaseAsync.ListRemoveAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Int64,StackExchange.Redis.CommandFlags)">
  3209. <summary>
  3210. Removes the first count occurrences of elements equal to value from the list stored at key. The count argument influences the operation in the following ways:
  3211. count &gt; 0: Remove elements equal to value moving from head to tail.
  3212. count &lt; 0: Remove elements equal to value moving from tail to head.
  3213. count = 0: Remove all elements equal to value.
  3214. </summary>
  3215. <returns>the number of removed elements.</returns>
  3216. <remarks>http://redis.io/commands/lrem</remarks>
  3217. </member>
  3218. <member name="M:StackExchange.Redis.IDatabaseAsync.ListRightPopAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3219. <summary>
  3220. Removes and returns the last element of the list stored at key.
  3221. </summary>
  3222. <remarks>http://redis.io/commands/rpop</remarks>
  3223. </member>
  3224. <member name="M:StackExchange.Redis.IDatabaseAsync.ListRightPopLeftPushAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3225. <summary>
  3226. Atomically returns and removes the last element (tail) of the list stored at source, and pushes the element at the first element (head) of the list stored at destination.
  3227. </summary>
  3228. <returns>the element being popped and pushed.</returns>
  3229. <remarks>http://redis.io/commands/rpoplpush</remarks>
  3230. </member>
  3231. <member name="M:StackExchange.Redis.IDatabaseAsync.ListRightPushAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.When,StackExchange.Redis.CommandFlags)">
  3232. <summary>
  3233. Insert the specified value at the tail of the list stored at key. If key does not exist, it is created as empty list before performing the push operation.
  3234. </summary>
  3235. <returns>the length of the list after the push operation.</returns>
  3236. <remarks>http://redis.io/commands/rpush</remarks>
  3237. <remarks>http://redis.io/commands/rpushx</remarks>
  3238. </member>
  3239. <member name="M:StackExchange.Redis.IDatabaseAsync.ListRightPushAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  3240. <summary>
  3241. Insert all the specified values at the tail of the list stored at key. If key does not exist, it is created as empty list before performing the push operation.
  3242. Elements are inserted one after the other to the tail of the list, from the leftmost element to the rightmost element. So for instance the command RPUSH mylist a b c will result into a list containing a as first element, b as second element and c as third element.
  3243. </summary>
  3244. <returns>the length of the list after the push operation.</returns>
  3245. <remarks>http://redis.io/commands/rpush</remarks>
  3246. </member>
  3247. <member name="M:StackExchange.Redis.IDatabaseAsync.ListSetByIndexAsync(StackExchange.Redis.RedisKey,System.Int64,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  3248. <summary>
  3249. Sets the list element at index to value. For more information on the index argument, see ListGetByIndex. An error is returned for out of range indexes.
  3250. </summary>
  3251. <remarks>http://redis.io/commands/lset</remarks>
  3252. </member>
  3253. <member name="M:StackExchange.Redis.IDatabaseAsync.ListTrimAsync(StackExchange.Redis.RedisKey,System.Int64,System.Int64,StackExchange.Redis.CommandFlags)">
  3254. <summary>
  3255. Trim an existing list so that it will contain only the specified range of elements specified. Both start and stop are zero-based indexes, where 0 is the first element of the list (the head), 1 the next element and so on.
  3256. For example: LTRIM foobar 0 2 will modify the list stored at foobar so that only the first three elements of the list will remain.
  3257. start and end can also be negative numbers indicating offsets from the end of the list, where -1 is the last element of the list, -2 the penultimate element and so on.
  3258. </summary>
  3259. <remarks>http://redis.io/commands/ltrim</remarks>
  3260. </member>
  3261. <member name="M:StackExchange.Redis.IDatabaseAsync.LockExtendAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.TimeSpan,StackExchange.Redis.CommandFlags)">
  3262. <summary>
  3263. Extends a lock, if the token value is correct
  3264. </summary>
  3265. </member>
  3266. <member name="M:StackExchange.Redis.IDatabaseAsync.LockQueryAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3267. <summary>
  3268. Queries the token held against a lock
  3269. </summary>
  3270. </member>
  3271. <member name="M:StackExchange.Redis.IDatabaseAsync.LockReleaseAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  3272. <summary>
  3273. Releases a lock, if the token value is correct
  3274. </summary>
  3275. </member>
  3276. <member name="M:StackExchange.Redis.IDatabaseAsync.LockTakeAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.TimeSpan,StackExchange.Redis.CommandFlags)">
  3277. <summary>
  3278. Takes a lock (specifying a token value) if it is not already taken
  3279. </summary>
  3280. </member>
  3281. <member name="M:StackExchange.Redis.IDatabaseAsync.PublishAsync(StackExchange.Redis.RedisChannel,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  3282. <summary>
  3283. Posts a message to the given channel.
  3284. </summary>
  3285. <returns>the number of clients that received the message.</returns>
  3286. <remarks>http://redis.io/commands/publish</remarks>
  3287. </member>
  3288. <member name="M:StackExchange.Redis.IDatabaseAsync.ScriptEvaluateAsync(System.String,StackExchange.Redis.RedisKey[],StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  3289. <summary>
  3290. Execute a Lua script against the server
  3291. </summary>
  3292. <remarks>http://redis.io/commands/eval, http://redis.io/commands/evalsha</remarks>
  3293. <returns>A dynamic representation of the script's result</returns>
  3294. </member>
  3295. <member name="M:StackExchange.Redis.IDatabaseAsync.ScriptEvaluateAsync(System.Byte[],StackExchange.Redis.RedisKey[],StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  3296. <summary>
  3297. Execute a Lua script against the server using just the SHA1 hash
  3298. </summary>
  3299. <remarks>http://redis.io/commands/evalsha</remarks>
  3300. <returns>A dynamic representation of the script's result</returns>
  3301. </member>
  3302. <member name="M:StackExchange.Redis.IDatabaseAsync.ScriptEvaluateAsync(StackExchange.Redis.LuaScript,System.Object,StackExchange.Redis.CommandFlags)">
  3303. <summary>
  3304. Execute a lua script against the server, using previously prepared script.
  3305. Named parameters, if any, are provided by the `parameters` object.
  3306. </summary>
  3307. </member>
  3308. <member name="M:StackExchange.Redis.IDatabaseAsync.ScriptEvaluateAsync(StackExchange.Redis.LoadedLuaScript,System.Object,StackExchange.Redis.CommandFlags)">
  3309. <summary>
  3310. Execute a lua script against the server, using previously prepared and loaded script.
  3311. This method sends only the SHA1 hash of the lua script to Redis.
  3312. Named parameters, if any, are provided by the `parameters` object.
  3313. </summary>
  3314. </member>
  3315. <member name="M:StackExchange.Redis.IDatabaseAsync.SetAddAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  3316. <summary>
  3317. Add the specified member to the set stored at key. Specified members that are already a member of this set are ignored. If key does not exist, a new set is created before adding the specified members.
  3318. </summary>
  3319. <returns>True if the specified member was not already present in the set, else False</returns>
  3320. <remarks>http://redis.io/commands/sadd</remarks>
  3321. </member>
  3322. <member name="M:StackExchange.Redis.IDatabaseAsync.SetAddAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  3323. <summary>
  3324. Add the specified members to the set stored at key. Specified members that are already a member of this set are ignored. If key does not exist, a new set is created before adding the specified members.
  3325. </summary>
  3326. <returns>the number of elements that were added to the set, not including all the elements already present into the set.</returns>
  3327. <remarks>http://redis.io/commands/sadd</remarks>
  3328. </member>
  3329. <member name="M:StackExchange.Redis.IDatabaseAsync.SetCombineAndStoreAsync(StackExchange.Redis.SetOperation,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3330. <summary>
  3331. This command is equal to SetCombine, but instead of returning the resulting set, it is stored in destination. If destination already exists, it is overwritten.
  3332. </summary>
  3333. <returns>the number of elements in the resulting set.</returns>
  3334. <remarks>http://redis.io/commands/sunionstore</remarks>
  3335. <remarks>http://redis.io/commands/sinterstore</remarks>
  3336. <remarks>http://redis.io/commands/sdiffstore</remarks>
  3337. </member>
  3338. <member name="M:StackExchange.Redis.IDatabaseAsync.SetCombineAndStoreAsync(StackExchange.Redis.SetOperation,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey[],StackExchange.Redis.CommandFlags)">
  3339. <summary>
  3340. This command is equal to SetCombine, but instead of returning the resulting set, it is stored in destination. If destination already exists, it is overwritten.
  3341. </summary>
  3342. <returns>the number of elements in the resulting set.</returns>
  3343. <remarks>http://redis.io/commands/sunionstore</remarks>
  3344. <remarks>http://redis.io/commands/sinterstore</remarks>
  3345. <remarks>http://redis.io/commands/sdiffstore</remarks>
  3346. </member>
  3347. <member name="M:StackExchange.Redis.IDatabaseAsync.SetCombineAsync(StackExchange.Redis.SetOperation,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3348. <summary>
  3349. Returns the members of the set resulting from the specified operation against the given sets.
  3350. </summary>
  3351. <returns>list with members of the resulting set.</returns>
  3352. <remarks>http://redis.io/commands/sunion</remarks>
  3353. <remarks>http://redis.io/commands/sinter</remarks>
  3354. <remarks>http://redis.io/commands/sdiff</remarks>
  3355. </member>
  3356. <member name="M:StackExchange.Redis.IDatabaseAsync.SetCombineAsync(StackExchange.Redis.SetOperation,StackExchange.Redis.RedisKey[],StackExchange.Redis.CommandFlags)">
  3357. <summary>
  3358. Returns the members of the set resulting from the specified operation against the given sets.
  3359. </summary>
  3360. <returns>list with members of the resulting set.</returns>
  3361. <remarks>http://redis.io/commands/sunion</remarks>
  3362. <remarks>http://redis.io/commands/sinter</remarks>
  3363. <remarks>http://redis.io/commands/sdiff</remarks>
  3364. </member>
  3365. <member name="M:StackExchange.Redis.IDatabaseAsync.SetContainsAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  3366. <summary>
  3367. Returns if member is a member of the set stored at key.
  3368. </summary>
  3369. <returns>1 if the element is a member of the set. 0 if the element is not a member of the set, or if key does not exist.</returns>
  3370. <remarks>http://redis.io/commands/sismember</remarks>
  3371. </member>
  3372. <member name="M:StackExchange.Redis.IDatabaseAsync.SetLengthAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3373. <summary>
  3374. Returns the set cardinality (number of elements) of the set stored at key.
  3375. </summary>
  3376. <returns>the cardinality (number of elements) of the set, or 0 if key does not exist.</returns>
  3377. <remarks>http://redis.io/commands/scard</remarks>
  3378. </member>
  3379. <member name="M:StackExchange.Redis.IDatabaseAsync.SetMembersAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3380. <summary>
  3381. Returns all the members of the set value stored at key.
  3382. </summary>
  3383. <returns>all elements of the set.</returns>
  3384. <remarks>http://redis.io/commands/smembers</remarks>
  3385. </member>
  3386. <member name="M:StackExchange.Redis.IDatabaseAsync.SetMoveAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  3387. <summary>
  3388. Move member from the set at source to the set at destination. This operation is atomic. In every given moment the element will appear to be a member of source or destination for other clients.
  3389. When the specified element already exists in the destination set, it is only removed from the source set.
  3390. </summary>
  3391. <returns>1 if the element is moved. 0 if the element is not a member of source and no operation was performed.</returns>
  3392. <remarks>http://redis.io/commands/smove</remarks>
  3393. </member>
  3394. <member name="M:StackExchange.Redis.IDatabaseAsync.SetPopAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3395. <summary>
  3396. Removes and returns a random element from the set value stored at key.
  3397. </summary>
  3398. <returns>the removed element, or nil when key does not exist.</returns>
  3399. <remarks>http://redis.io/commands/spop</remarks>
  3400. </member>
  3401. <member name="M:StackExchange.Redis.IDatabaseAsync.SetRandomMemberAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3402. <summary>
  3403. Return a random element from the set value stored at key.
  3404. </summary>
  3405. <returns>the randomly selected element, or nil when key does not exist</returns>
  3406. <remarks>http://redis.io/commands/srandmember</remarks>
  3407. </member>
  3408. <member name="M:StackExchange.Redis.IDatabaseAsync.SetRandomMembersAsync(StackExchange.Redis.RedisKey,System.Int64,StackExchange.Redis.CommandFlags)">
  3409. <summary>
  3410. Return an array of count distinct elements if count is positive. If called with a negative count the behavior changes and the command is allowed to return the same element multiple times.
  3411. In this case the numer of returned elements is the absolute value of the specified count.
  3412. </summary>
  3413. <returns>an array of elements, or an empty array when key does not exist</returns>
  3414. <remarks>http://redis.io/commands/srandmember</remarks>
  3415. </member>
  3416. <member name="M:StackExchange.Redis.IDatabaseAsync.SetRemoveAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  3417. <summary>
  3418. Remove the specified member from the set stored at key. Specified members that are not a member of this set are ignored.
  3419. </summary>
  3420. <returns>True if the specified member was already present in the set, else False</returns>
  3421. <remarks>http://redis.io/commands/srem</remarks>
  3422. </member>
  3423. <member name="M:StackExchange.Redis.IDatabaseAsync.SetRemoveAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  3424. <summary>
  3425. Remove the specified members from the set stored at key. Specified members that are not a member of this set are ignored.
  3426. </summary>
  3427. <returns>the number of members that were removed from the set, not including non existing members.</returns>
  3428. <remarks>http://redis.io/commands/srem</remarks>
  3429. </member>
  3430. <member name="M:StackExchange.Redis.IDatabaseAsync.SortAndStoreAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,System.Int64,System.Int64,StackExchange.Redis.Order,StackExchange.Redis.SortType,StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  3431. <summary>
  3432. Sorts a list, set or sorted set (numerically or alphabetically, ascending by default); By default, the elements themselves are compared, but the values can also be
  3433. used to perform external key-lookups using the <c>by</c> parameter. By default, the elements themselves are returned, but external key-lookups (one or many) can
  3434. be performed instead by specifying the <c>get</c> parameter (note that <c>#</c> specifies the element itself, when used in <c>get</c>).
  3435. Referring to the <a href="http://redis.io/commands/sort">redis SORT documentation </a> for examples is recommended. When used in hashes, <c>by</c> and <c>get</c>
  3436. can be used to specify fields using <c>-&gt;</c> notation (again, refer to redis documentation).
  3437. </summary>
  3438. <remarks>http://redis.io/commands/sort</remarks>
  3439. <returns>Returns the number of elements stored in the new list</returns>
  3440. </member>
  3441. <member name="M:StackExchange.Redis.IDatabaseAsync.SortAsync(StackExchange.Redis.RedisKey,System.Int64,System.Int64,StackExchange.Redis.Order,StackExchange.Redis.SortType,StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  3442. <summary>
  3443. Sorts a list, set or sorted set (numerically or alphabetically, ascending by default); By default, the elements themselves are compared, but the values can also be
  3444. used to perform external key-lookups using the <c>by</c> parameter. By default, the elements themselves are returned, but external key-lookups (one or many) can
  3445. be performed instead by specifying the <c>get</c> parameter (note that <c>#</c> specifies the element itself, when used in <c>get</c>).
  3446. Referring to the <a href="http://redis.io/commands/sort">redis SORT documentation </a> for examples is recommended. When used in hashes, <c>by</c> and <c>get</c>
  3447. can be used to specify fields using <c>-&gt;</c> notation (again, refer to redis documentation).
  3448. </summary>
  3449. <remarks>http://redis.io/commands/sort</remarks>
  3450. <returns>Returns the sorted elements, or the external values if <c>get</c> is specified</returns>
  3451. </member>
  3452. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetAddAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Double,StackExchange.Redis.CommandFlags)">
  3453. <summary>
  3454. Adds the specified member with the specified score to the sorted set stored at key. If the specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.
  3455. </summary>
  3456. <returns>True if the value was added, False if it already existed (the score is still updated)</returns>
  3457. <remarks>http://redis.io/commands/zadd</remarks>
  3458. </member>
  3459. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetAddAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.SortedSetEntry[],StackExchange.Redis.CommandFlags)">
  3460. <summary>
  3461. Adds all the specified members with the specified scores to the sorted set stored at key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.
  3462. </summary>
  3463. <returns>The number of elements added to the sorted sets, not including elements already existing for which the score was updated.</returns>
  3464. <remarks>http://redis.io/commands/zadd</remarks>
  3465. </member>
  3466. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetCombineAndStoreAsync(StackExchange.Redis.SetOperation,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.Aggregate,StackExchange.Redis.CommandFlags)">
  3467. <summary>
  3468. Computes a set operation over two sorted sets, and stores the result in destination, optionally performing
  3469. a specific aggregation (defaults to sum)
  3470. </summary>
  3471. <remarks>http://redis.io/commands/zunionstore</remarks>
  3472. <remarks>http://redis.io/commands/zinterstore</remarks>
  3473. <returns>the number of elements in the resulting sorted set at destination</returns>
  3474. </member>
  3475. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetCombineAndStoreAsync(StackExchange.Redis.SetOperation,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey[],System.Double[],StackExchange.Redis.Aggregate,StackExchange.Redis.CommandFlags)">
  3476. <summary>
  3477. Computes a set operation over multiple sorted sets (optionally using per-set weights), and stores the result in destination, optionally performing
  3478. a specific aggregation (defaults to sum)
  3479. </summary>
  3480. <remarks>http://redis.io/commands/zunionstore</remarks>
  3481. <remarks>http://redis.io/commands/zinterstore</remarks>
  3482. <returns>the number of elements in the resulting sorted set at destination</returns>
  3483. </member>
  3484. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetDecrementAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Double,StackExchange.Redis.CommandFlags)">
  3485. <summary>
  3486. Decrements the score of member in the sorted set stored at key by decrement. If member does not exist in the sorted set, it is added with -decrement as its score (as if its previous score was 0.0).
  3487. </summary>
  3488. <returns>the new score of member</returns>
  3489. <remarks>http://redis.io/commands/zincrby</remarks>
  3490. </member>
  3491. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetIncrementAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Double,StackExchange.Redis.CommandFlags)">
  3492. <summary>
  3493. Increments the score of member in the sorted set stored at key by increment. If member does not exist in the sorted set, it is added with increment as its score (as if its previous score was 0.0).
  3494. </summary>
  3495. <returns>the new score of member</returns>
  3496. <remarks>http://redis.io/commands/zincrby</remarks>
  3497. </member>
  3498. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetLengthAsync(StackExchange.Redis.RedisKey,System.Double,System.Double,StackExchange.Redis.Exclude,StackExchange.Redis.CommandFlags)">
  3499. <summary>
  3500. Returns the sorted set cardinality (number of elements) of the sorted set stored at key.
  3501. </summary>
  3502. <returns>the cardinality (number of elements) of the sorted set, or 0 if key does not exist.</returns>
  3503. <remarks>http://redis.io/commands/zcard</remarks>
  3504. </member>
  3505. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetLengthByValueAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue,StackExchange.Redis.Exclude,StackExchange.Redis.CommandFlags)">
  3506. <summary>
  3507. When all the elements in a sorted set are inserted with the same score, in order to force lexicographical ordering, this command returns the number of elements in the sorted set at key with a value between min and max.
  3508. </summary>
  3509. <returns>the number of elements in the specified score range.</returns>
  3510. <remarks>When all the elements in a sorted set are inserted with the same score, in order to force lexicographical ordering, this command returns all the elements in the sorted set at key with a value between min and max.</remarks>
  3511. </member>
  3512. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetRangeByRankAsync(StackExchange.Redis.RedisKey,System.Int64,System.Int64,StackExchange.Redis.Order,StackExchange.Redis.CommandFlags)">
  3513. <summary>
  3514. Returns the specified range of elements in the sorted set stored at key. By default the elements are considered to be ordered from the lowest to the highest score. Lexicographical order is used for elements with equal score.
  3515. Both start and stop are zero-based indexes, where 0 is the first element, 1 is the next element and so on. They can also be negative numbers indicating offsets from the end of the sorted set, with -1 being the last element of the sorted set, -2 the penultimate element and so on.
  3516. </summary>
  3517. <returns>list of elements in the specified range</returns>
  3518. <remarks>http://redis.io/commands/zrange</remarks>
  3519. <remarks>http://redis.io/commands/zrevrange</remarks>
  3520. </member>
  3521. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetRangeByRankWithScoresAsync(StackExchange.Redis.RedisKey,System.Int64,System.Int64,StackExchange.Redis.Order,StackExchange.Redis.CommandFlags)">
  3522. <summary>
  3523. Returns the specified range of elements in the sorted set stored at key. By default the elements are considered to be ordered from the lowest to the highest score. Lexicographical order is used for elements with equal score.
  3524. Both start and stop are zero-based indexes, where 0 is the first element, 1 is the next element and so on. They can also be negative numbers indicating offsets from the end of the sorted set, with -1 being the last element of the sorted set, -2 the penultimate element and so on.
  3525. </summary>
  3526. <returns>list of elements in the specified range</returns>
  3527. <remarks>http://redis.io/commands/zrange</remarks>
  3528. <remarks>http://redis.io/commands/zrevrange</remarks>
  3529. </member>
  3530. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetRangeByScoreAsync(StackExchange.Redis.RedisKey,System.Double,System.Double,StackExchange.Redis.Exclude,StackExchange.Redis.Order,System.Int64,System.Int64,StackExchange.Redis.CommandFlags)">
  3531. <summary>
  3532. Returns the specified range of elements in the sorted set stored at key. By default the elements are considered to be ordered from the lowest to the highest score. Lexicographical order is used for elements with equal score.
  3533. Start and stop are used to specify the min and max range for score values. Similar to other range methods the values are inclusive.
  3534. </summary>
  3535. <returns>list of elements in the specified score range</returns>
  3536. <remarks>http://redis.io/commands/zrangebyscore</remarks>
  3537. <remarks>http://redis.io/commands/zrevrangebyscore</remarks>
  3538. </member>
  3539. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetRangeByScoreWithScoresAsync(StackExchange.Redis.RedisKey,System.Double,System.Double,StackExchange.Redis.Exclude,StackExchange.Redis.Order,System.Int64,System.Int64,StackExchange.Redis.CommandFlags)">
  3540. <summary>
  3541. Returns the specified range of elements in the sorted set stored at key. By default the elements are considered to be ordered from the lowest to the highest score. Lexicographical order is used for elements with equal score.
  3542. Start and stop are used to specify the min and max range for score values. Similar to other range methods the values are inclusive.
  3543. </summary>
  3544. <returns>list of elements in the specified score range</returns>
  3545. <remarks>http://redis.io/commands/zrangebyscore</remarks>
  3546. <remarks>http://redis.io/commands/zrevrangebyscore</remarks>
  3547. </member>
  3548. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetRangeByValueAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue,StackExchange.Redis.Exclude,System.Int64,System.Int64,StackExchange.Redis.CommandFlags)">
  3549. <summary>
  3550. When all the elements in a sorted set are inserted with the same score, in order to force lexicographical ordering, this command returns all the elements in the sorted set at key with a value between min and max.
  3551. </summary>
  3552. <remarks>http://redis.io/commands/zrangebylex</remarks>
  3553. <returns>list of elements in the specified score range.</returns>
  3554. </member>
  3555. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetRankAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.Order,StackExchange.Redis.CommandFlags)">
  3556. <summary>
  3557. Returns the rank of member in the sorted set stored at key, by default with the scores ordered from low to high. The rank (or index) is 0-based, which means that the member with the lowest score has rank 0.
  3558. </summary>
  3559. <returns>If member exists in the sorted set, the rank of member; If member does not exist in the sorted set or key does not exist, null</returns>
  3560. <remarks>http://redis.io/commands/zrank</remarks>
  3561. <remarks>http://redis.io/commands/zrevrank</remarks>
  3562. </member>
  3563. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetRemoveAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  3564. <summary>
  3565. Removes the specified member from the sorted set stored at key. Non existing members are ignored.
  3566. </summary>
  3567. <returns>True if the member existed in the sorted set and was removed; False otherwise.</returns>
  3568. <remarks>http://redis.io/commands/zrem</remarks>
  3569. </member>
  3570. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetRemoveAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue[],StackExchange.Redis.CommandFlags)">
  3571. <summary>
  3572. Removes the specified members from the sorted set stored at key. Non existing members are ignored.
  3573. </summary>
  3574. <returns>The number of members removed from the sorted set, not including non existing members.</returns>
  3575. <remarks>http://redis.io/commands/zrem</remarks>
  3576. </member>
  3577. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetRemoveRangeByRankAsync(StackExchange.Redis.RedisKey,System.Int64,System.Int64,StackExchange.Redis.CommandFlags)">
  3578. <summary>
  3579. Removes all elements in the sorted set stored at key with rank between start and stop. Both start and stop are 0 -based indexes with 0 being the element with the lowest score. These indexes can be negative numbers, where they indicate offsets starting at the element with the highest score. For example: -1 is the element with the highest score, -2 the element with the second highest score and so forth.
  3580. </summary>
  3581. <returns> the number of elements removed.</returns>
  3582. <remarks>http://redis.io/commands/zremrangebyrank</remarks>
  3583. </member>
  3584. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetRemoveRangeByScoreAsync(StackExchange.Redis.RedisKey,System.Double,System.Double,StackExchange.Redis.Exclude,StackExchange.Redis.CommandFlags)">
  3585. <summary>
  3586. Removes all elements in the sorted set stored at key with a score between min and max (inclusive by default).
  3587. </summary>
  3588. <returns> the number of elements removed.</returns>
  3589. <remarks>http://redis.io/commands/zremrangebyscore</remarks>
  3590. </member>
  3591. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetRemoveRangeByValueAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue,StackExchange.Redis.Exclude,StackExchange.Redis.CommandFlags)">
  3592. <summary>
  3593. When all the elements in a sorted set are inserted with the same score, in order to force lexicographical ordering, this command removes all elements in the sorted set stored at key between the lexicographical range specified by min and max.
  3594. </summary>
  3595. <remarks>http://redis.io/commands/zremrangebylex</remarks>
  3596. <returns>the number of elements removed.</returns>
  3597. </member>
  3598. <member name="M:StackExchange.Redis.IDatabaseAsync.SortedSetScoreAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  3599. <summary>
  3600. Returns the score of member in the sorted set at key; If member does not exist in the sorted set, or key does not exist, nil is returned.
  3601. </summary>
  3602. <returns>the score of member</returns>
  3603. <remarks>http://redis.io/commands/zscore</remarks>
  3604. </member>
  3605. <member name="M:StackExchange.Redis.IDatabaseAsync.StringAppendAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  3606. <summary>
  3607. If key already exists and is a string, this command appends the value at the end of the string. If key does not exist it is created and set as an empty string,
  3608. so APPEND will be similar to SET in this special case.
  3609. </summary>
  3610. <returns>the length of the string after the append operation.</returns>
  3611. <remarks>http://redis.io/commands/append</remarks>
  3612. </member>
  3613. <member name="M:StackExchange.Redis.IDatabaseAsync.StringBitCountAsync(StackExchange.Redis.RedisKey,System.Int64,System.Int64,StackExchange.Redis.CommandFlags)">
  3614. <summary>
  3615. Count the number of set bits (population counting) in a string.
  3616. By default all the bytes contained in the string are examined.It is possible to specify the counting operation only in an interval passing the additional arguments start and end.
  3617. Like for the GETRANGE command start and end can contain negative values in order to index bytes starting from the end of the string, where -1 is the last byte, -2 is the penultimate, and so forth.
  3618. </summary>
  3619. <returns>The number of bits set to 1</returns>
  3620. <remarks>http://redis.io/commands/bitcount</remarks>
  3621. </member>
  3622. <member name="M:StackExchange.Redis.IDatabaseAsync.StringBitOperationAsync(StackExchange.Redis.Bitwise,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3623. <summary>
  3624. Perform a bitwise operation between multiple keys (containing string values) and store the result in the destination key.
  3625. The BITOP command supports four bitwise operations; note that NOT is a unary operator: the second key should be omitted in this case
  3626. and only the first key will be considered.
  3627. The result of the operation is always stored at destkey.
  3628. </summary>
  3629. <returns>The size of the string stored in the destination key, that is equal to the size of the longest input string.</returns>
  3630. <remarks>http://redis.io/commands/bitop</remarks>
  3631. </member>
  3632. <member name="M:StackExchange.Redis.IDatabaseAsync.StringBitOperationAsync(StackExchange.Redis.Bitwise,StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey[],StackExchange.Redis.CommandFlags)">
  3633. <summary>
  3634. Perform a bitwise operation between multiple keys (containing string values) and store the result in the destination key.
  3635. The BITOP command supports four bitwise operations; note that NOT is a unary operator.
  3636. The result of the operation is always stored at destkey.
  3637. </summary>
  3638. <returns>The size of the string stored in the destination key, that is equal to the size of the longest input string.</returns>
  3639. <remarks>http://redis.io/commands/bitop</remarks>
  3640. </member>
  3641. <member name="M:StackExchange.Redis.IDatabaseAsync.StringBitPositionAsync(StackExchange.Redis.RedisKey,System.Boolean,System.Int64,System.Int64,StackExchange.Redis.CommandFlags)">
  3642. <summary>
  3643. Return the position of the first bit set to 1 or 0 in a string.
  3644. The position is returned thinking at the string as an array of bits from left to right where the first byte most significant bit is at position 0, the second byte most significant big is at position 8 and so forth.
  3645. An start and end may be specified; these are in bytes, not bits; start and end can contain negative values in order to index bytes starting from the end of the string, where -1 is the last byte, -2 is the penultimate, and so forth.
  3646. </summary>
  3647. <returns>The command returns the position of the first bit set to 1 or 0 according to the request.
  3648. If we look for set bits(the bit argument is 1) and the string is empty or composed of just zero bytes, -1 is returned.</returns>
  3649. <remarks>http://redis.io/commands/bitpos</remarks>
  3650. </member>
  3651. <member name="M:StackExchange.Redis.IDatabaseAsync.StringDecrementAsync(StackExchange.Redis.RedisKey,System.Int64,StackExchange.Redis.CommandFlags)">
  3652. <summary>
  3653. Decrements the number stored at key by decrement. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that is not representable as integer. This operation is limited to 64 bit signed integers.
  3654. </summary>
  3655. <returns> the value of key after the increment</returns>
  3656. <remarks>http://redis.io/commands/decrby</remarks>
  3657. <remarks>http://redis.io/commands/decr</remarks>
  3658. </member>
  3659. <member name="M:StackExchange.Redis.IDatabaseAsync.StringDecrementAsync(StackExchange.Redis.RedisKey,System.Double,StackExchange.Redis.CommandFlags)">
  3660. <summary>
  3661. Decrements the string representing a floating point number stored at key by the specified increment. If the key does not exist, it is set to 0 before performing the operation. The precision of the output is fixed at 17 digits after the decimal point regardless of the actual internal precision of the computation.
  3662. </summary>
  3663. <returns>the value of key after the increment</returns>
  3664. <remarks>http://redis.io/commands/incrbyfloat</remarks>
  3665. </member>
  3666. <member name="M:StackExchange.Redis.IDatabaseAsync.StringGetAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3667. <summary>
  3668. Get the value of key. If the key does not exist the special value nil is returned. An error is returned if the value stored at key is not a string, because GET only handles string values.
  3669. </summary>
  3670. <returns>the value of key, or nil when key does not exist.</returns>
  3671. <remarks>http://redis.io/commands/get</remarks>
  3672. </member>
  3673. <member name="M:StackExchange.Redis.IDatabaseAsync.StringGetAsync(StackExchange.Redis.RedisKey[],StackExchange.Redis.CommandFlags)">
  3674. <summary>
  3675. Returns the values of all specified keys. For every key that does not hold a string value or does not exist, the special value nil is returned.
  3676. </summary>
  3677. <remarks>http://redis.io/commands/mget</remarks>
  3678. </member>
  3679. <member name="M:StackExchange.Redis.IDatabaseAsync.StringGetBitAsync(StackExchange.Redis.RedisKey,System.Int64,StackExchange.Redis.CommandFlags)">
  3680. <summary>
  3681. Returns the bit value at offset in the string value stored at key.
  3682. When offset is beyond the string length, the string is assumed to be a contiguous space with 0 bits.
  3683. </summary>
  3684. <returns>the bit value stored at offset.</returns>
  3685. <remarks>http://redis.io/commands/getbit</remarks>
  3686. </member>
  3687. <member name="M:StackExchange.Redis.IDatabaseAsync.StringGetRangeAsync(StackExchange.Redis.RedisKey,System.Int64,System.Int64,StackExchange.Redis.CommandFlags)">
  3688. <summary>
  3689. Returns the substring of the string value stored at key, determined by the offsets start and end (both are inclusive). Negative offsets can be used in order to provide an offset starting from the end of the string. So -1 means the last character, -2 the penultimate and so forth.
  3690. </summary>
  3691. <returns>the substring of the string value stored at key</returns>
  3692. <remarks>http://redis.io/commands/getrange</remarks>
  3693. </member>
  3694. <member name="M:StackExchange.Redis.IDatabaseAsync.StringGetSetAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  3695. <summary>
  3696. Atomically sets key to value and returns the old value stored at key.
  3697. </summary>
  3698. <remarks>http://redis.io/commands/getset</remarks>
  3699. <returns> the old value stored at key, or nil when key did not exist.</returns>
  3700. </member>
  3701. <member name="M:StackExchange.Redis.IDatabaseAsync.StringGetWithExpiryAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3702. <summary>
  3703. Get the value of key. If the key does not exist the special value nil is returned. An error is returned if the value stored at key is not a string, because GET only handles string values.
  3704. </summary>
  3705. <returns>the value of key, or nil when key does not exist.</returns>
  3706. <remarks>http://redis.io/commands/get</remarks>
  3707. </member>
  3708. <member name="M:StackExchange.Redis.IDatabaseAsync.StringIncrementAsync(StackExchange.Redis.RedisKey,System.Int64,StackExchange.Redis.CommandFlags)">
  3709. <summary>
  3710. Increments the number stored at key by increment. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that is not representable as integer. This operation is limited to 64 bit signed integers.
  3711. </summary>
  3712. <returns>the value of key after the increment</returns>
  3713. <remarks>http://redis.io/commands/incrby</remarks>
  3714. <remarks>http://redis.io/commands/incr</remarks>
  3715. </member>
  3716. <member name="M:StackExchange.Redis.IDatabaseAsync.StringIncrementAsync(StackExchange.Redis.RedisKey,System.Double,StackExchange.Redis.CommandFlags)">
  3717. <summary>
  3718. Increment the string representing a floating point number stored at key by the specified increment. If the key does not exist, it is set to 0 before performing the operation. The precision of the output is fixed at 17 digits after the decimal point regardless of the actual internal precision of the computation.
  3719. </summary>
  3720. <returns>the value of key after the increment</returns>
  3721. <remarks>http://redis.io/commands/incrbyfloat</remarks>
  3722. </member>
  3723. <member name="M:StackExchange.Redis.IDatabaseAsync.StringLengthAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.CommandFlags)">
  3724. <summary>
  3725. Returns the length of the string value stored at key.
  3726. </summary>
  3727. <returns>the length of the string at key, or 0 when key does not exist.</returns>
  3728. <remarks>http://redis.io/commands/strlen</remarks>
  3729. </member>
  3730. <member name="M:StackExchange.Redis.IDatabaseAsync.StringSetAsync(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue,System.Nullable{System.TimeSpan},StackExchange.Redis.When,StackExchange.Redis.CommandFlags)">
  3731. <summary>
  3732. Set key to hold the string value. If key already holds a value, it is overwritten, regardless of its type.
  3733. </summary>
  3734. <remarks>http://redis.io/commands/set</remarks>
  3735. </member>
  3736. <member name="M:StackExchange.Redis.IDatabaseAsync.StringSetAsync(System.Collections.Generic.KeyValuePair{StackExchange.Redis.RedisKey,StackExchange.Redis.RedisValue}[],StackExchange.Redis.When,StackExchange.Redis.CommandFlags)">
  3737. <summary>
  3738. Sets the given keys to their respective values. If "not exists" is specified, this will not perform any operation at all even if just a single key already exists.
  3739. </summary>
  3740. <returns>True if the keys were set, else False</returns>
  3741. <remarks>http://redis.io/commands/mset</remarks>
  3742. <remarks>http://redis.io/commands/msetnx</remarks>
  3743. </member>
  3744. <member name="M:StackExchange.Redis.IDatabaseAsync.StringSetBitAsync(StackExchange.Redis.RedisKey,System.Int64,System.Boolean,StackExchange.Redis.CommandFlags)">
  3745. <summary>
  3746. Sets or clears the bit at offset in the string value stored at key.
  3747. The bit is either set or cleared depending on value, which can be either 0 or 1. When key does not exist, a new string value is created.The string is grown to make sure it can hold a bit at offset.
  3748. </summary>
  3749. <returns>the original bit value stored at offset.</returns>
  3750. <remarks>http://redis.io/commands/setbit</remarks>
  3751. </member>
  3752. <member name="M:StackExchange.Redis.IDatabaseAsync.StringSetRangeAsync(StackExchange.Redis.RedisKey,System.Int64,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  3753. <summary>
  3754. Overwrites part of the string stored at key, starting at the specified offset, for the entire length of value. If the offset is larger than the current length of the string at key, the string is padded with zero-bytes to make offset fit. Non-existing keys are considered as empty strings, so this command will make sure it holds a string large enough to be able to set value at offset.
  3755. </summary>
  3756. <returns>the length of the string after it was modified by the command.</returns>
  3757. <remarks>http://redis.io/commands/setrange</remarks>
  3758. </member>
  3759. <member name="T:StackExchange.Redis.RedisValueWithExpiry">
  3760. <summary>
  3761. Describes a value/expiry pair
  3762. </summary>
  3763. </member>
  3764. <member name="P:StackExchange.Redis.RedisValueWithExpiry.Expiry">
  3765. <summary>
  3766. The expiry of this record
  3767. </summary>
  3768. </member>
  3769. <member name="P:StackExchange.Redis.RedisValueWithExpiry.Value">
  3770. <summary>
  3771. The value of this record
  3772. </summary>
  3773. </member>
  3774. <member name="T:StackExchange.Redis.InternalErrorEventArgs">
  3775. <summary>
  3776. Describes internal errors (mainly intended for debugging)
  3777. </summary>
  3778. </member>
  3779. <member name="P:StackExchange.Redis.InternalErrorEventArgs.ConnectionType">
  3780. <summary>
  3781. Gets the connection-type of the failing connection
  3782. </summary>
  3783. </member>
  3784. <member name="P:StackExchange.Redis.InternalErrorEventArgs.EndPoint">
  3785. <summary>
  3786. Gets the failing server-endpoint (this can be null)
  3787. </summary>
  3788. </member>
  3789. <member name="P:StackExchange.Redis.InternalErrorEventArgs.Exception">
  3790. <summary>
  3791. Gets the exception if available (this can be null)
  3792. </summary>
  3793. </member>
  3794. <member name="P:StackExchange.Redis.InternalErrorEventArgs.Origin">
  3795. <summary>
  3796. The underlying origin of the error
  3797. </summary>
  3798. </member>
  3799. <member name="T:StackExchange.Redis.RetransmissionReasonType">
  3800. <summary>
  3801. If an IProfiledCommand is a retransmission of a previous command, this enum
  3802. is used to indicate what prompted the retransmission.
  3803. This can be used to distinguish between transient causes (moving hashslots, joining nodes, etc.)
  3804. and incorrect routing.
  3805. </summary>
  3806. </member>
  3807. <member name="F:StackExchange.Redis.RetransmissionReasonType.None">
  3808. <summary>
  3809. No stated reason
  3810. </summary>
  3811. </member>
  3812. <member name="F:StackExchange.Redis.RetransmissionReasonType.Ask">
  3813. <summary>
  3814. Issued to investigate which node owns a key
  3815. </summary>
  3816. </member>
  3817. <member name="F:StackExchange.Redis.RetransmissionReasonType.Moved">
  3818. <summary>
  3819. A node has indicated that it does *not* own the given key
  3820. </summary>
  3821. </member>
  3822. <member name="T:StackExchange.Redis.IProfiledCommand">
  3823. <summary>
  3824. A profiled command against a redis instance.
  3825. TimeSpans returned by this interface use a high precision timer if possible.
  3826. DateTimes returned by this interface are no more precise than DateTime.UtcNow.
  3827. </summary>
  3828. </member>
  3829. <member name="P:StackExchange.Redis.IProfiledCommand.EndPoint">
  3830. <summary>
  3831. The endpoint this command was sent to.
  3832. </summary>
  3833. </member>
  3834. <member name="P:StackExchange.Redis.IProfiledCommand.Db">
  3835. <summary>
  3836. The Db this command was sent to.
  3837. </summary>
  3838. </member>
  3839. <member name="P:StackExchange.Redis.IProfiledCommand.Command">
  3840. <summary>
  3841. The name of this command.
  3842. </summary>
  3843. </member>
  3844. <member name="P:StackExchange.Redis.IProfiledCommand.Flags">
  3845. <summary>
  3846. The CommandFlags the command was submitted with.
  3847. </summary>
  3848. </member>
  3849. <member name="P:StackExchange.Redis.IProfiledCommand.CommandCreated">
  3850. <summary>
  3851. When this command was *created*, will be approximately
  3852. when the paired method of StackExchange.Redis was called but
  3853. before that method returned.
  3854. Note that the resolution of the returned DateTime is limited by DateTime.UtcNow.
  3855. </summary>
  3856. </member>
  3857. <member name="P:StackExchange.Redis.IProfiledCommand.CreationToEnqueued">
  3858. <summary>
  3859. How long this command waited to be added to the queue of pending
  3860. redis commands. A large TimeSpan indicates serious contention for
  3861. the pending queue.
  3862. </summary>
  3863. </member>
  3864. <member name="P:StackExchange.Redis.IProfiledCommand.EnqueuedToSending">
  3865. <summary>
  3866. How long this command spent in the pending queue before being sent to redis.
  3867. A large TimeSpan can indicate a large number of pending events, large pending events,
  3868. or network issues.
  3869. </summary>
  3870. </member>
  3871. <member name="P:StackExchange.Redis.IProfiledCommand.SentToResponse">
  3872. <summary>
  3873. How long before Redis responded to this command and it's response could be handled after it was sent.
  3874. A large TimeSpan can indicate a large response body, an overtaxed redis instance, or network issues.
  3875. </summary>
  3876. </member>
  3877. <member name="P:StackExchange.Redis.IProfiledCommand.ResponseToCompletion">
  3878. <summary>
  3879. How long between Redis responding to this command and awaiting consumers being notified.
  3880. </summary>
  3881. </member>
  3882. <member name="P:StackExchange.Redis.IProfiledCommand.ElapsedTime">
  3883. <summary>
  3884. How long it took this redis command to be processed, from creation to deserializing the final resposne.
  3885. Note that this TimeSpan *does not* include time spent awaiting a Task in consumer code.
  3886. </summary>
  3887. </member>
  3888. <member name="P:StackExchange.Redis.IProfiledCommand.RetransmissionOf">
  3889. <summary>
  3890. If a command has to be resent due to an ASK or MOVED response from redis (in a cluster configuration),
  3891. the second sending of the command will have this property set to the original IProfiledCommand.
  3892. This can only be set if redis is configured as a cluster.
  3893. </summary>
  3894. </member>
  3895. <member name="P:StackExchange.Redis.IProfiledCommand.RetransmissionReason">
  3896. <summary>
  3897. If RetransmissionOf is not null, this property will be set to either Ask or Moved to indicate
  3898. what sort of response triggered the retransmission.
  3899. This can be useful for determining the root cause of extra commands.
  3900. </summary>
  3901. </member>
  3902. <member name="T:StackExchange.Redis.IProfiler">
  3903. <summary>
  3904. Interface for profiling individual commands against an Redis ConnectionMulitplexer.
  3905. </summary>
  3906. </member>
  3907. <member name="M:StackExchange.Redis.IProfiler.GetContext">
  3908. <summary>
  3909. Called to provide a context object.
  3910. This method is called before the method which triggers work against redis (such as StringSet(Async)) returns,
  3911. and will always be called on the same thread as that method.
  3912. Note that GetContext() may be called even if ConnectionMultiplexer.BeginProfiling() has not been called.
  3913. You may return `null` to prevent any tracking of commands.
  3914. </summary>
  3915. </member>
  3916. <member name="T:StackExchange.Redis.IRedis">
  3917. <summary>
  3918. Common operations available to all redis connections
  3919. </summary>
  3920. </member>
  3921. <member name="M:StackExchange.Redis.IRedis.Ping(StackExchange.Redis.CommandFlags)">
  3922. <summary>
  3923. This command is often used to test if a connection is still alive, or to measure latency.
  3924. </summary>
  3925. <returns>The observed latency.</returns>
  3926. <remarks>http://redis.io/commands/ping</remarks>
  3927. </member>
  3928. <member name="T:StackExchange.Redis.IScanningCursor">
  3929. <summary>
  3930. Represents a resumable, cursor-based scanning operation
  3931. </summary>
  3932. </member>
  3933. <member name="P:StackExchange.Redis.IScanningCursor.Cursor">
  3934. <summary>
  3935. Returns the cursor that represents the *active* page of results (not the pending/next page of results as returned by SCAN/HSCAN/ZSCAN/SSCAN)
  3936. </summary>
  3937. </member>
  3938. <member name="P:StackExchange.Redis.IScanningCursor.PageSize">
  3939. <summary>
  3940. The page size of the current operation
  3941. </summary>
  3942. </member>
  3943. <member name="P:StackExchange.Redis.IScanningCursor.PageOffset">
  3944. <summary>
  3945. The offset into the current page
  3946. </summary>
  3947. </member>
  3948. <member name="T:StackExchange.Redis.IRedisAsync">
  3949. <summary>
  3950. Common operations available to all redis connections
  3951. </summary>
  3952. </member>
  3953. <member name="P:StackExchange.Redis.IRedisAsync.Multiplexer">
  3954. <summary>
  3955. Gets the multiplexer that created this instance
  3956. </summary>
  3957. </member>
  3958. <member name="M:StackExchange.Redis.IRedisAsync.PingAsync(StackExchange.Redis.CommandFlags)">
  3959. <summary>
  3960. This command is often used to test if a connection is still alive, or to measure latency.
  3961. </summary>
  3962. <returns>The observed latency.</returns>
  3963. <remarks>http://redis.io/commands/ping</remarks>
  3964. </member>
  3965. <member name="M:StackExchange.Redis.IRedisAsync.TryWait(System.Threading.Tasks.Task)">
  3966. <summary>
  3967. Wait for a given asynchronous operation to complete (or timeout), reporting which
  3968. </summary>
  3969. </member>
  3970. <member name="M:StackExchange.Redis.IRedisAsync.Wait(System.Threading.Tasks.Task)">
  3971. <summary>
  3972. Wait for a given asynchronous operation to complete (or timeout)
  3973. </summary>
  3974. </member>
  3975. <member name="M:StackExchange.Redis.IRedisAsync.Wait``1(System.Threading.Tasks.Task{``0})">
  3976. <summary>
  3977. Wait for a given asynchronous operation to complete (or timeout)
  3978. </summary>
  3979. </member>
  3980. <member name="M:StackExchange.Redis.IRedisAsync.WaitAll(System.Threading.Tasks.Task[])">
  3981. <summary>
  3982. Wait for the given asynchronous operations to complete (or timeout)
  3983. </summary>
  3984. </member>
  3985. <member name="T:StackExchange.Redis.IServer">
  3986. <summary>
  3987. Provides configuration controls of a redis server
  3988. </summary>
  3989. </member>
  3990. <member name="P:StackExchange.Redis.IServer.ClusterConfiguration">
  3991. <summary>
  3992. Gets the cluster configuration associated with this server, if known
  3993. </summary>
  3994. </member>
  3995. <member name="P:StackExchange.Redis.IServer.EndPoint">
  3996. <summary>
  3997. Gets the address of the connected server
  3998. </summary>
  3999. </member>
  4000. <member name="P:StackExchange.Redis.IServer.Features">
  4001. <summary>
  4002. Gets the features available to the connected server
  4003. </summary>
  4004. </member>
  4005. <member name="P:StackExchange.Redis.IServer.IsConnected">
  4006. <summary>
  4007. Gets whether the connection to the server is active and usable
  4008. </summary>
  4009. </member>
  4010. <member name="P:StackExchange.Redis.IServer.IsSlave">
  4011. <summary>
  4012. Gets whether the connected server is a replica / slave
  4013. </summary>
  4014. </member>
  4015. <member name="P:StackExchange.Redis.IServer.AllowSlaveWrites">
  4016. <summary>
  4017. Explicitly opt in for slave writes on writable slaves
  4018. </summary>
  4019. </member>
  4020. <member name="P:StackExchange.Redis.IServer.ServerType">
  4021. <summary>
  4022. Gets the operating mode of the connected server
  4023. </summary>
  4024. </member>
  4025. <member name="P:StackExchange.Redis.IServer.Version">
  4026. <summary>
  4027. Gets the version of the connected server
  4028. </summary>
  4029. </member>
  4030. <member name="M:StackExchange.Redis.IServer.ClientKill(System.Net.EndPoint,StackExchange.Redis.CommandFlags)">
  4031. <summary>
  4032. The CLIENT KILL command closes a given client connection identified by ip:port.
  4033. The ip:port should match a line returned by the CLIENT LIST command.
  4034. Due to the single-treaded nature of Redis, it is not possible to kill a client connection while it is executing a command.From the client point of view, the connection can never be closed in the middle of the execution of a command.However, the client will notice the connection has been closed only when the next command is sent (and results in network error).
  4035. </summary>
  4036. <remarks>http://redis.io/commands/client-kill</remarks>
  4037. </member>
  4038. <member name="M:StackExchange.Redis.IServer.ClientKillAsync(System.Net.EndPoint,StackExchange.Redis.CommandFlags)">
  4039. <summary>
  4040. The CLIENT KILL command closes a given client connection identified by ip:port.
  4041. The ip:port should match a line returned by the CLIENT LIST command.
  4042. Due to the single-treaded nature of Redis, it is not possible to kill a client connection while it is executing a command.From the client point of view, the connection can never be closed in the middle of the execution of a command.However, the client will notice the connection has been closed only when the next command is sent (and results in network error).
  4043. </summary>
  4044. <remarks>http://redis.io/commands/client-kill</remarks>
  4045. </member>
  4046. <member name="M:StackExchange.Redis.IServer.ClientKill(System.Nullable{System.Int64},System.Nullable{StackExchange.Redis.ClientType},System.Net.EndPoint,System.Boolean,StackExchange.Redis.CommandFlags)">
  4047. <summary>
  4048. The CLIENT KILL command closes multiple connections that match the specified filters
  4049. </summary>
  4050. <returns>the number of clients killed.</returns>
  4051. <remarks>http://redis.io/commands/client-kill</remarks>
  4052. </member>
  4053. <member name="M:StackExchange.Redis.IServer.ClientKillAsync(System.Nullable{System.Int64},System.Nullable{StackExchange.Redis.ClientType},System.Net.EndPoint,System.Boolean,StackExchange.Redis.CommandFlags)">
  4054. <summary>
  4055. The CLIENT KILL command closes multiple connections that match the specified filters
  4056. </summary>
  4057. <returns>the number of clients killed.</returns>
  4058. <remarks>http://redis.io/commands/client-kill</remarks>
  4059. </member>
  4060. <member name="M:StackExchange.Redis.IServer.ClientList(StackExchange.Redis.CommandFlags)">
  4061. <summary>
  4062. The CLIENT LIST command returns information and statistics about the client connections server in a mostly human readable format.
  4063. </summary>
  4064. <remarks>http://redis.io/commands/client-list</remarks>
  4065. </member>
  4066. <member name="M:StackExchange.Redis.IServer.ClientListAsync(StackExchange.Redis.CommandFlags)">
  4067. <summary>
  4068. The CLIENT LIST command returns information and statistics about the client connections server in a mostly human readable format.
  4069. </summary>
  4070. <remarks>http://redis.io/commands/client-list</remarks>
  4071. </member>
  4072. <member name="M:StackExchange.Redis.IServer.ClusterNodes(StackExchange.Redis.CommandFlags)">
  4073. <summary>
  4074. Obtains the current CLUSTER NODES output from a cluster server
  4075. </summary>
  4076. </member>
  4077. <member name="M:StackExchange.Redis.IServer.ClusterNodesAsync(StackExchange.Redis.CommandFlags)">
  4078. <summary>
  4079. Obtains the current CLUSTER NODES output from a cluster server
  4080. </summary>
  4081. </member>
  4082. <member name="M:StackExchange.Redis.IServer.ClusterNodesRaw(StackExchange.Redis.CommandFlags)">
  4083. <summary>
  4084. Obtains the current raw CLUSTER NODES output from a cluster server
  4085. </summary>
  4086. </member>
  4087. <member name="M:StackExchange.Redis.IServer.ClusterNodesRawAsync(StackExchange.Redis.CommandFlags)">
  4088. <summary>
  4089. Obtains the current raw CLUSTER NODES output from a cluster server
  4090. </summary>
  4091. </member>
  4092. <member name="M:StackExchange.Redis.IServer.ConfigGet(StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  4093. <summary>
  4094. Get all configuration parameters matching the specified pattern.
  4095. </summary>
  4096. <returns>All matching configuration parameters.</returns>
  4097. <remarks>http://redis.io/commands/config-get</remarks>
  4098. </member>
  4099. <member name="M:StackExchange.Redis.IServer.ConfigGetAsync(StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  4100. <summary>
  4101. Get all configuration parameters matching the specified pattern.
  4102. </summary>
  4103. <returns>All matching configuration parameters.</returns>
  4104. <remarks>http://redis.io/commands/config-get</remarks>
  4105. </member>
  4106. <member name="M:StackExchange.Redis.IServer.ConfigResetStatistics(StackExchange.Redis.CommandFlags)">
  4107. <summary>
  4108. Resets the statistics reported by Redis using the INFO command.
  4109. </summary>
  4110. <remarks>http://redis.io/commands/config-resetstat</remarks>
  4111. </member>
  4112. <member name="M:StackExchange.Redis.IServer.ConfigResetStatisticsAsync(StackExchange.Redis.CommandFlags)">
  4113. <summary>
  4114. Resets the statistics reported by Redis using the INFO command.
  4115. </summary>
  4116. <remarks>http://redis.io/commands/config-resetstat</remarks>
  4117. </member>
  4118. <member name="M:StackExchange.Redis.IServer.ConfigRewrite(StackExchange.Redis.CommandFlags)">
  4119. <summary>
  4120. The CONFIG REWRITE command rewrites the redis.conf file the server was started with, applying the minimal changes needed to make it reflecting the configuration currently used by the server, that may be different compared to the original one because of the use of the CONFIG SET command.
  4121. </summary>
  4122. <remarks>http://redis.io/commands/config-rewrite</remarks>
  4123. </member>
  4124. <member name="M:StackExchange.Redis.IServer.ConfigRewriteAsync(StackExchange.Redis.CommandFlags)">
  4125. <summary>
  4126. The CONFIG REWRITE command rewrites the redis.conf file the server was started with, applying the minimal changes needed to make it reflecting the configuration currently used by the server, that may be different compared to the original one because of the use of the CONFIG SET command.
  4127. </summary>
  4128. <remarks>http://redis.io/commands/config-rewrite</remarks>
  4129. </member>
  4130. <member name="M:StackExchange.Redis.IServer.ConfigSet(StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  4131. <summary>
  4132. The CONFIG SET command is used in order to reconfigure the server at runtime without the need to restart Redis. You can change both trivial parameters or switch from one to another persistence option using this command.
  4133. </summary>
  4134. <remarks>http://redis.io/commands/config-set</remarks>
  4135. </member>
  4136. <member name="M:StackExchange.Redis.IServer.ConfigSetAsync(StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  4137. <summary>
  4138. The CONFIG SET command is used in order to reconfigure the server at runtime without the need to restart Redis. You can change both trivial parameters or switch from one to another persistence option using this command.
  4139. </summary>
  4140. <remarks>http://redis.io/commands/config-set</remarks>
  4141. </member>
  4142. <member name="M:StackExchange.Redis.IServer.DatabaseSize(System.Int32,StackExchange.Redis.CommandFlags)">
  4143. <summary>
  4144. Return the number of keys in the database.
  4145. </summary>
  4146. <remarks>http://redis.io/commands/dbsize</remarks>
  4147. </member>
  4148. <member name="M:StackExchange.Redis.IServer.DatabaseSizeAsync(System.Int32,StackExchange.Redis.CommandFlags)">
  4149. <summary>
  4150. Return the number of keys in the database.
  4151. </summary>
  4152. <remarks>http://redis.io/commands/dbsize</remarks>
  4153. </member>
  4154. <member name="M:StackExchange.Redis.IServer.Echo(StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  4155. <summary>
  4156. Return the same message passed in
  4157. </summary>
  4158. <remarks>http://redis.io/commands/echo</remarks>
  4159. </member>
  4160. <member name="M:StackExchange.Redis.IServer.EchoAsync(StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  4161. <summary>
  4162. Return the same message passed in
  4163. </summary>
  4164. <remarks>http://redis.io/commands/echo</remarks>
  4165. </member>
  4166. <member name="M:StackExchange.Redis.IServer.FlushAllDatabases(StackExchange.Redis.CommandFlags)">
  4167. <summary>
  4168. Delete all the keys of all databases on the server.
  4169. </summary>
  4170. <remarks>http://redis.io/commands/flushall</remarks>
  4171. </member>
  4172. <member name="M:StackExchange.Redis.IServer.FlushAllDatabasesAsync(StackExchange.Redis.CommandFlags)">
  4173. <summary>
  4174. Delete all the keys of all databases on the server.
  4175. </summary>
  4176. <remarks>http://redis.io/commands/flushall</remarks>
  4177. </member>
  4178. <member name="M:StackExchange.Redis.IServer.FlushDatabase(System.Int32,StackExchange.Redis.CommandFlags)">
  4179. <summary>
  4180. Delete all the keys of the database.
  4181. </summary>
  4182. <remarks>http://redis.io/commands/flushdb</remarks>
  4183. </member>
  4184. <member name="M:StackExchange.Redis.IServer.FlushDatabaseAsync(System.Int32,StackExchange.Redis.CommandFlags)">
  4185. <summary>
  4186. Delete all the keys of the database.
  4187. </summary>
  4188. <remarks>http://redis.io/commands/flushdb</remarks>
  4189. </member>
  4190. <member name="M:StackExchange.Redis.IServer.GetCounters">
  4191. <summary>
  4192. Get summary statistics associates with this server
  4193. </summary>
  4194. </member>
  4195. <member name="M:StackExchange.Redis.IServer.Info(StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  4196. <summary>
  4197. The INFO command returns information and statistics about the server in a format that is simple to parse by computers and easy to read by humans.
  4198. </summary>
  4199. <remarks>http://redis.io/commands/info</remarks>
  4200. </member>
  4201. <member name="M:StackExchange.Redis.IServer.InfoAsync(StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  4202. <summary>
  4203. The INFO command returns information and statistics about the server in a format that is simple to parse by computers and easy to read by humans.
  4204. </summary>
  4205. <remarks>http://redis.io/commands/info</remarks>
  4206. </member>
  4207. <member name="M:StackExchange.Redis.IServer.InfoRaw(StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  4208. <summary>
  4209. The INFO command returns information and statistics about the server in a format that is simple to parse by computers and easy to read by humans.
  4210. </summary>
  4211. <remarks>http://redis.io/commands/info</remarks>
  4212. </member>
  4213. <member name="M:StackExchange.Redis.IServer.InfoRawAsync(StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  4214. <summary>
  4215. The INFO command returns information and statistics about the server in a format that is simple to parse by computers and easy to read by humans.
  4216. </summary>
  4217. <remarks>http://redis.io/commands/info</remarks>
  4218. </member>
  4219. <member name="M:StackExchange.Redis.IServer.Keys(System.Int32,StackExchange.Redis.RedisValue,System.Int32,StackExchange.Redis.CommandFlags)">
  4220. <summary>
  4221. Returns all keys matching pattern; the KEYS or SCAN commands will be used based on the server capabilities.
  4222. </summary>
  4223. <remarks>Warning: consider KEYS as a command that should only be used in production environments with extreme care.</remarks>
  4224. <remarks>http://redis.io/commands/keys</remarks>
  4225. <remarks>http://redis.io/commands/scan</remarks>
  4226. </member>
  4227. <member name="M:StackExchange.Redis.IServer.Keys(System.Int32,StackExchange.Redis.RedisValue,System.Int32,System.Int64,System.Int32,StackExchange.Redis.CommandFlags)">
  4228. <summary>
  4229. Returns all keys matching pattern; the KEYS or SCAN commands will be used based on the server capabilities; note: to resume an iteration via <i>cursor</i>, cast the original enumerable or enumerator to <i>IScanningCursor</i>.
  4230. </summary>
  4231. <remarks>Warning: consider KEYS as a command that should only be used in production environments with extreme care.</remarks>
  4232. <remarks>http://redis.io/commands/keys</remarks>
  4233. <remarks>http://redis.io/commands/scan</remarks>
  4234. </member>
  4235. <member name="M:StackExchange.Redis.IServer.LastSave(StackExchange.Redis.CommandFlags)">
  4236. <summary>
  4237. Return the time of the last DB save executed with success. A client may check if a BGSAVE command succeeded reading the LASTSAVE value, then issuing a BGSAVE command and checking at regular intervals every N seconds if LASTSAVE changed.
  4238. </summary>
  4239. <remarks>http://redis.io/commands/lastsave</remarks>
  4240. </member>
  4241. <member name="M:StackExchange.Redis.IServer.LastSaveAsync(StackExchange.Redis.CommandFlags)">
  4242. <summary>
  4243. Return the time of the last DB save executed with success. A client may check if a BGSAVE command succeeded reading the LASTSAVE value, then issuing a BGSAVE command and checking at regular intervals every N seconds if LASTSAVE changed.
  4244. </summary>
  4245. <remarks>http://redis.io/commands/lastsave</remarks>
  4246. </member>
  4247. <member name="M:StackExchange.Redis.IServer.MakeMaster(StackExchange.Redis.ReplicationChangeOptions,System.IO.TextWriter)">
  4248. <summary>
  4249. Promote the selected node to be master
  4250. </summary>
  4251. </member>
  4252. <member name="M:StackExchange.Redis.IServer.Save(StackExchange.Redis.SaveType,StackExchange.Redis.CommandFlags)">
  4253. <summary>
  4254. Explicitly request the database to persist the current state to disk
  4255. </summary>
  4256. <remarks>http://redis.io/commands/bgrewriteaof</remarks>
  4257. <remarks>http://redis.io/commands/bgsave</remarks>
  4258. <remarks>http://redis.io/commands/save</remarks>
  4259. <remarks>http://redis.io/topics/persistence</remarks>
  4260. </member>
  4261. <member name="M:StackExchange.Redis.IServer.SaveAsync(StackExchange.Redis.SaveType,StackExchange.Redis.CommandFlags)">
  4262. <summary>
  4263. Explicitly request the database to persist the current state to disk
  4264. </summary>
  4265. <remarks>http://redis.io/commands/bgrewriteaof</remarks>
  4266. <remarks>http://redis.io/commands/bgsave</remarks>
  4267. <remarks>http://redis.io/commands/save</remarks>
  4268. <remarks>http://redis.io/topics/persistence</remarks>
  4269. </member>
  4270. <member name="M:StackExchange.Redis.IServer.ScriptExists(System.String,StackExchange.Redis.CommandFlags)">
  4271. <summary>
  4272. Inidicates whether the specified script is defined on the server
  4273. </summary>
  4274. </member>
  4275. <member name="M:StackExchange.Redis.IServer.ScriptExists(System.Byte[],StackExchange.Redis.CommandFlags)">
  4276. <summary>
  4277. Inidicates whether the specified script hash is defined on the server
  4278. </summary>
  4279. </member>
  4280. <member name="M:StackExchange.Redis.IServer.ScriptExistsAsync(System.String,StackExchange.Redis.CommandFlags)">
  4281. <summary>
  4282. Inidicates whether the specified script is defined on the server
  4283. </summary>
  4284. </member>
  4285. <member name="M:StackExchange.Redis.IServer.ScriptExistsAsync(System.Byte[],StackExchange.Redis.CommandFlags)">
  4286. <summary>
  4287. Inidicates whether the specified script hash is defined on the server
  4288. </summary>
  4289. </member>
  4290. <member name="M:StackExchange.Redis.IServer.ScriptFlush(StackExchange.Redis.CommandFlags)">
  4291. <summary>
  4292. Removes all cached scripts on this server
  4293. </summary>
  4294. </member>
  4295. <member name="M:StackExchange.Redis.IServer.ScriptFlushAsync(StackExchange.Redis.CommandFlags)">
  4296. <summary>
  4297. Removes all cached scripts on this server
  4298. </summary>
  4299. </member>
  4300. <member name="M:StackExchange.Redis.IServer.ScriptLoad(System.String,StackExchange.Redis.CommandFlags)">
  4301. <summary>
  4302. Explicitly defines a script on the server
  4303. </summary>
  4304. </member>
  4305. <member name="M:StackExchange.Redis.IServer.ScriptLoad(StackExchange.Redis.LuaScript,StackExchange.Redis.CommandFlags)">
  4306. <summary>
  4307. Explicitly defines a script on the server
  4308. </summary>
  4309. </member>
  4310. <member name="M:StackExchange.Redis.IServer.ScriptLoadAsync(System.String,StackExchange.Redis.CommandFlags)">
  4311. <summary>
  4312. Explicitly defines a script on the server
  4313. </summary>
  4314. </member>
  4315. <member name="M:StackExchange.Redis.IServer.ScriptLoadAsync(StackExchange.Redis.LuaScript,StackExchange.Redis.CommandFlags)">
  4316. <summary>
  4317. Explicitly defines a script on the server
  4318. </summary>
  4319. </member>
  4320. <member name="M:StackExchange.Redis.IServer.Shutdown(StackExchange.Redis.ShutdownMode,StackExchange.Redis.CommandFlags)">
  4321. <summary>Asks the redis server to shutdown, killing all connections. Please FULLY read the notes on the SHUTDOWN command.</summary>
  4322. <remarks>http://redis.io/commands/shutdown</remarks>
  4323. </member>
  4324. <member name="M:StackExchange.Redis.IServer.SlaveOf(System.Net.EndPoint,StackExchange.Redis.CommandFlags)">
  4325. <summary>
  4326. The SLAVEOF command can change the replication settings of a slave on the fly. If a Redis server is already acting as slave, specifying a null master will turn off the replication, turning the Redis server into a MASTER. Specifying a non-null master will make the server a slave of another server listening at the specified hostname and port.
  4327. </summary>
  4328. <remarks>http://redis.io/commands/slaveof</remarks>
  4329. </member>
  4330. <member name="M:StackExchange.Redis.IServer.SlaveOfAsync(System.Net.EndPoint,StackExchange.Redis.CommandFlags)">
  4331. <summary>
  4332. The SLAVEOF command can change the replication settings of a slave on the fly. If a Redis server is already acting as slave, specifying a null master will turn off the replication, turning the Redis server into a MASTER. Specifying a non-null master will make the server a slave of another server listening at the specified hostname and port.
  4333. </summary>
  4334. <remarks>http://redis.io/commands/slaveof</remarks>
  4335. </member>
  4336. <member name="M:StackExchange.Redis.IServer.SlowlogGet(System.Int32,StackExchange.Redis.CommandFlags)">
  4337. <summary>
  4338. To read the slow log the SLOWLOG GET command is used, that returns every entry in the slow log. It is possible to return only the N most recent entries passing an additional argument to the command (for instance SLOWLOG GET 10).
  4339. </summary>
  4340. <remarks>http://redis.io/commands/slowlog</remarks>
  4341. </member>
  4342. <member name="M:StackExchange.Redis.IServer.SlowlogGetAsync(System.Int32,StackExchange.Redis.CommandFlags)">
  4343. <summary>
  4344. To read the slow log the SLOWLOG GET command is used, that returns every entry in the slow log. It is possible to return only the N most recent entries passing an additional argument to the command (for instance SLOWLOG GET 10).
  4345. </summary>
  4346. <remarks>http://redis.io/commands/slowlog</remarks>
  4347. </member>
  4348. <member name="M:StackExchange.Redis.IServer.SlowlogReset(StackExchange.Redis.CommandFlags)">
  4349. <summary>
  4350. You can reset the slow log using the SLOWLOG RESET command. Once deleted the information is lost forever.
  4351. </summary>
  4352. <remarks>http://redis.io/commands/slowlog</remarks>
  4353. </member>
  4354. <member name="M:StackExchange.Redis.IServer.SlowlogResetAsync(StackExchange.Redis.CommandFlags)">
  4355. <summary>
  4356. You can reset the slow log using the SLOWLOG RESET command. Once deleted the information is lost forever.
  4357. </summary>
  4358. <remarks>http://redis.io/commands/slowlog</remarks>
  4359. </member>
  4360. <member name="M:StackExchange.Redis.IServer.SubscriptionChannels(StackExchange.Redis.RedisChannel,StackExchange.Redis.CommandFlags)">
  4361. <summary>
  4362. Lists the currently active channels. An active channel is a Pub/Sub channel with one ore more subscribers (not including clients subscribed to patterns).
  4363. </summary>
  4364. <returns> a list of active channels, optionally matching the specified pattern.</returns>
  4365. <remarks>http://redis.io/commands/pubsub</remarks>
  4366. </member>
  4367. <member name="M:StackExchange.Redis.IServer.SubscriptionChannelsAsync(StackExchange.Redis.RedisChannel,StackExchange.Redis.CommandFlags)">
  4368. <summary>
  4369. Lists the currently active channels. An active channel is a Pub/Sub channel with one ore more subscribers (not including clients subscribed to patterns).
  4370. </summary>
  4371. <returns> a list of active channels, optionally matching the specified pattern.</returns>
  4372. <remarks>http://redis.io/commands/pubsub</remarks>
  4373. </member>
  4374. <member name="M:StackExchange.Redis.IServer.SubscriptionPatternCount(StackExchange.Redis.CommandFlags)">
  4375. <summary>
  4376. Returns the number of subscriptions to patterns (that are performed using the PSUBSCRIBE command). Note that this is not just the count of clients subscribed to patterns but the total number of patterns all the clients are subscribed to.
  4377. </summary>
  4378. <returns>the number of patterns all the clients are subscribed to.</returns>
  4379. <remarks>http://redis.io/commands/pubsub</remarks>
  4380. </member>
  4381. <member name="M:StackExchange.Redis.IServer.SubscriptionPatternCountAsync(StackExchange.Redis.CommandFlags)">
  4382. <summary>
  4383. Returns the number of subscriptions to patterns (that are performed using the PSUBSCRIBE command). Note that this is not just the count of clients subscribed to patterns but the total number of patterns all the clients are subscribed to.
  4384. </summary>
  4385. <returns>the number of patterns all the clients are subscribed to.</returns>
  4386. <remarks>http://redis.io/commands/pubsub</remarks>
  4387. </member>
  4388. <member name="M:StackExchange.Redis.IServer.SubscriptionSubscriberCount(StackExchange.Redis.RedisChannel,StackExchange.Redis.CommandFlags)">
  4389. <summary>
  4390. Returns the number of subscribers (not counting clients subscribed to patterns) for the specified channel.
  4391. </summary>
  4392. <remarks>http://redis.io/commands/pubsub</remarks>
  4393. </member>
  4394. <member name="M:StackExchange.Redis.IServer.SubscriptionSubscriberCountAsync(StackExchange.Redis.RedisChannel,StackExchange.Redis.CommandFlags)">
  4395. <summary>
  4396. Returns the number of subscribers (not counting clients subscribed to patterns) for the specified channel.
  4397. </summary>
  4398. <remarks>http://redis.io/commands/pubsub</remarks>
  4399. </member>
  4400. <member name="M:StackExchange.Redis.IServer.Time(StackExchange.Redis.CommandFlags)">
  4401. <summary>
  4402. The TIME command returns the current server time.
  4403. </summary>
  4404. <returns>The server's current time.</returns>
  4405. <remarks>http://redis.io/commands/time</remarks>
  4406. </member>
  4407. <member name="M:StackExchange.Redis.IServer.TimeAsync(StackExchange.Redis.CommandFlags)">
  4408. <summary>
  4409. The TIME command returns the current server time.
  4410. </summary>
  4411. <returns>The server's current time.</returns>
  4412. <remarks>http://redis.io/commands/time</remarks>
  4413. </member>
  4414. <member name="M:StackExchange.Redis.IServer.SentinelGetMasterAddressByName(System.String,StackExchange.Redis.CommandFlags)">
  4415. <summary>
  4416. Returns the ip and port number of the master with that name.
  4417. If a failover is in progress or terminated successfully for this master it returns the address and port of the promoted slave.
  4418. </summary>
  4419. <param name="serviceName">the sentinel service name</param>
  4420. <param name="flags"></param>
  4421. <returns>the master ip and port</returns>
  4422. <remarks>http://redis.io/topics/sentinel</remarks>
  4423. </member>
  4424. <member name="M:StackExchange.Redis.IServer.SentinelGetMasterAddressByNameAsync(System.String,StackExchange.Redis.CommandFlags)">
  4425. <summary>
  4426. Returns the ip and port number of the master with that name.
  4427. If a failover is in progress or terminated successfully for this master it returns the address and port of the promoted slave.
  4428. </summary>
  4429. <param name="serviceName">the sentinel service name</param>
  4430. <param name="flags"></param>
  4431. <returns>the master ip and port</returns>
  4432. <remarks>http://redis.io/topics/sentinel</remarks>
  4433. </member>
  4434. <member name="M:StackExchange.Redis.IServer.SentinelMaster(System.String,StackExchange.Redis.CommandFlags)">
  4435. <summary>
  4436. Show the state and info of the specified master.
  4437. </summary>
  4438. <param name="serviceName">the sentinel service name</param>
  4439. <param name="flags"></param>
  4440. <returns>the master state as KeyValuePairs</returns>
  4441. <remarks>http://redis.io/topics/sentinel</remarks>
  4442. </member>
  4443. <member name="M:StackExchange.Redis.IServer.SentinelMasterAsync(System.String,StackExchange.Redis.CommandFlags)">
  4444. <summary>
  4445. Force a failover as if the master was not reachable, and without asking for agreement to other Sentinels
  4446. (however a new version of the configuration will be published so that the other Sentinels will update their configurations).
  4447. </summary>
  4448. <param name="serviceName">the sentinel service name</param>
  4449. <param name="flags"></param>
  4450. <returns>the master state as KeyValuePairs</returns>
  4451. <remarks>http://redis.io/topics/sentinel</remarks>
  4452. </member>
  4453. <member name="M:StackExchange.Redis.IServer.SentinelMasters(StackExchange.Redis.CommandFlags)">
  4454. <summary>
  4455. Show a list of monitored masters and their state.
  4456. </summary>
  4457. <param name="flags"></param>
  4458. <returns>an array of master state KeyValuePair arrays</returns>
  4459. <remarks>http://redis.io/topics/sentinel</remarks>
  4460. </member>
  4461. <member name="M:StackExchange.Redis.IServer.SentinelMastersAsync(StackExchange.Redis.CommandFlags)">
  4462. <summary>
  4463. Show a list of monitored masters and their state.
  4464. </summary>
  4465. <param name="flags"></param>
  4466. <returns>an array of master state KeyValuePair arrays</returns>
  4467. <remarks>http://redis.io/topics/sentinel</remarks>
  4468. </member>
  4469. <member name="M:StackExchange.Redis.IServer.SentinelSlaves(System.String,StackExchange.Redis.CommandFlags)">
  4470. <summary>
  4471. Show a list of slaves for this master, and their state.
  4472. </summary>
  4473. <param name="serviceName">the sentinel service name</param>
  4474. <param name="flags"></param>
  4475. <returns>an array of slave state KeyValuePair arrays</returns>
  4476. <remarks>http://redis.io/topics/sentinel</remarks>
  4477. </member>
  4478. <member name="M:StackExchange.Redis.IServer.SentinelSlavesAsync(System.String,StackExchange.Redis.CommandFlags)">
  4479. <summary>
  4480. Show a list of slaves for this master, and their state.
  4481. </summary>
  4482. <param name="serviceName">the sentinel service name</param>
  4483. <param name="flags"></param>
  4484. <returns>an array of slave state KeyValuePair arrays</returns>
  4485. <remarks>http://redis.io/topics/sentinel</remarks>
  4486. </member>
  4487. <member name="M:StackExchange.Redis.IServer.SentinelFailover(System.String,StackExchange.Redis.CommandFlags)">
  4488. <summary>
  4489. Force a failover as if the master was not reachable, and without asking for agreement to other Sentinels
  4490. (however a new version of the configuration will be published so that the other Sentinels will update their configurations).
  4491. </summary>
  4492. <param name="serviceName">the sentinel service name</param>
  4493. <param name="flags"></param>
  4494. <remarks>http://redis.io/topics/sentinel</remarks>
  4495. </member>
  4496. <member name="M:StackExchange.Redis.IServer.SentinelFailoverAsync(System.String,StackExchange.Redis.CommandFlags)">
  4497. <summary>
  4498. Force a failover as if the master was not reachable, and without asking for agreement to other Sentinels
  4499. (however a new version of the configuration will be published so that the other Sentinels will update their configurations).
  4500. </summary>
  4501. <param name="serviceName">the sentinel service name</param>
  4502. <param name="flags"></param>
  4503. <remarks>http://redis.io/topics/sentinel</remarks>
  4504. </member>
  4505. <member name="T:StackExchange.Redis.ISubscriber">
  4506. <summary>
  4507. A redis connection used as the subscriber in a pub/sub scenario
  4508. </summary>
  4509. </member>
  4510. <member name="M:StackExchange.Redis.ISubscriber.IdentifyEndpoint(StackExchange.Redis.RedisChannel,StackExchange.Redis.CommandFlags)">
  4511. <summary>
  4512. Inidicate exactly which redis server we are talking to
  4513. </summary>
  4514. </member>
  4515. <member name="M:StackExchange.Redis.ISubscriber.IdentifyEndpointAsync(StackExchange.Redis.RedisChannel,StackExchange.Redis.CommandFlags)">
  4516. <summary>
  4517. Inidicate exactly which redis server we are talking to
  4518. </summary>
  4519. </member>
  4520. <member name="M:StackExchange.Redis.ISubscriber.IsConnected(StackExchange.Redis.RedisChannel)">
  4521. <summary>
  4522. Indicates whether the instance can communicate with the server;
  4523. if a channel is specified, the existing subscription map is queried to
  4524. resolve the server responsible for that subscription - otherwise the
  4525. server is chosen aribtraily from the masters.
  4526. </summary>
  4527. </member>
  4528. <member name="M:StackExchange.Redis.ISubscriber.Publish(StackExchange.Redis.RedisChannel,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  4529. <summary>
  4530. Posts a message to the given channel.
  4531. </summary>
  4532. <returns>the number of clients that received the message.</returns>
  4533. <remarks>http://redis.io/commands/publish</remarks>
  4534. </member>
  4535. <member name="M:StackExchange.Redis.ISubscriber.PublishAsync(StackExchange.Redis.RedisChannel,StackExchange.Redis.RedisValue,StackExchange.Redis.CommandFlags)">
  4536. <summary>
  4537. Posts a message to the given channel.
  4538. </summary>
  4539. <returns>the number of clients that received the message.</returns>
  4540. <remarks>http://redis.io/commands/publish</remarks>
  4541. </member>
  4542. <member name="M:StackExchange.Redis.ISubscriber.Subscribe(StackExchange.Redis.RedisChannel,System.Action{StackExchange.Redis.RedisChannel,StackExchange.Redis.RedisValue},StackExchange.Redis.CommandFlags)">
  4543. <summary>
  4544. Subscribe to perform some operation when a change to the preferred/active node is broadcast.
  4545. </summary>
  4546. <remarks>http://redis.io/commands/subscribe</remarks>
  4547. <remarks>http://redis.io/commands/psubscribe</remarks>
  4548. </member>
  4549. <member name="M:StackExchange.Redis.ISubscriber.SubscribeAsync(StackExchange.Redis.RedisChannel,System.Action{StackExchange.Redis.RedisChannel,StackExchange.Redis.RedisValue},StackExchange.Redis.CommandFlags)">
  4550. <summary>
  4551. Subscribe to perform some operation when a change to the preferred/active node is broadcast.
  4552. </summary>
  4553. <remarks>http://redis.io/commands/subscribe</remarks>
  4554. <remarks>http://redis.io/commands/psubscribe</remarks>
  4555. </member>
  4556. <member name="M:StackExchange.Redis.ISubscriber.SubscribedEndpoint(StackExchange.Redis.RedisChannel)">
  4557. <summary>
  4558. Inidicate to which redis server we are actively subscribed for a given channel; returns null if
  4559. the channel is not actively subscribed
  4560. </summary>
  4561. </member>
  4562. <member name="M:StackExchange.Redis.ISubscriber.Unsubscribe(StackExchange.Redis.RedisChannel,System.Action{StackExchange.Redis.RedisChannel,StackExchange.Redis.RedisValue},StackExchange.Redis.CommandFlags)">
  4563. <summary>
  4564. Unsubscribe from a specified message channel; note; if no handler is specified, the subscription is cancelled regardless
  4565. of the subscribers; if a handler is specified, the subscription is only cancelled if this handler is the
  4566. last handler remaining against the channel
  4567. </summary>
  4568. <remarks>http://redis.io/commands/unsubscribe</remarks>
  4569. <remarks>http://redis.io/commands/punsubscribe</remarks>
  4570. </member>
  4571. <member name="M:StackExchange.Redis.ISubscriber.UnsubscribeAll(StackExchange.Redis.CommandFlags)">
  4572. <summary>
  4573. Unsubscribe all subscriptions on this instance
  4574. </summary>
  4575. <remarks>http://redis.io/commands/unsubscribe</remarks>
  4576. <remarks>http://redis.io/commands/punsubscribe</remarks>
  4577. </member>
  4578. <member name="M:StackExchange.Redis.ISubscriber.UnsubscribeAllAsync(StackExchange.Redis.CommandFlags)">
  4579. <summary>
  4580. Unsubscribe all subscriptions on this instance
  4581. </summary>
  4582. <remarks>http://redis.io/commands/unsubscribe</remarks>
  4583. <remarks>http://redis.io/commands/punsubscribe</remarks>
  4584. </member>
  4585. <member name="M:StackExchange.Redis.ISubscriber.UnsubscribeAsync(StackExchange.Redis.RedisChannel,System.Action{StackExchange.Redis.RedisChannel,StackExchange.Redis.RedisValue},StackExchange.Redis.CommandFlags)">
  4586. <summary>
  4587. Unsubscribe from a specified message channel; note; if no handler is specified, the subscription is cancelled regardless
  4588. of the subscribers; if a handler is specified, the subscription is only cancelled if this handler is the
  4589. last handler remaining against the channel
  4590. </summary>
  4591. <remarks>http://redis.io/commands/unsubscribe</remarks>
  4592. <remarks>http://redis.io/commands/punsubscribe</remarks>
  4593. </member>
  4594. <member name="T:StackExchange.Redis.ITransaction">
  4595. <summary>
  4596. Represents a group of operations that will be sent to the server as a single unit,
  4597. and processed on the server as a single unit. Transactions can also include constraints
  4598. (implemented via WATCH), but note that constraint checking involves will (very briefly)
  4599. block the connection, since the transaction cannot be correctly committed (EXEC),
  4600. aborted (DISCARD) or not applied in the first place (UNWATCH) until the responses from
  4601. the constraint checks have arrived.
  4602. </summary>
  4603. <remarks>http://redis.io/topics/transactions</remarks>
  4604. <remarks>Note that on a cluster, it may be required that all keys involved in the transaction
  4605. (including constraints) are in the same hash-slot</remarks>
  4606. </member>
  4607. <member name="M:StackExchange.Redis.ITransaction.AddCondition(StackExchange.Redis.Condition)">
  4608. <summary>
  4609. Adds a precondition for this transaction
  4610. </summary>
  4611. </member>
  4612. <member name="M:StackExchange.Redis.ITransaction.Execute(StackExchange.Redis.CommandFlags)">
  4613. <summary>
  4614. Execute the batch operation, sending all queued commands to the server.
  4615. </summary>
  4616. </member>
  4617. <member name="M:StackExchange.Redis.ITransaction.ExecuteAsync(StackExchange.Redis.CommandFlags)">
  4618. <summary>
  4619. Execute the batch operation, sending all queued commands to the server.
  4620. </summary>
  4621. </member>
  4622. <member name="T:StackExchange.Redis.LuaScript">
  4623. <summary>
  4624. Represents a Lua script that can be executed on Redis.
  4625. Unlike normal Redis Lua scripts, LuaScript can have named parameters (prefixed by a @).
  4626. Public fields and properties of the passed in object are treated as parameters.
  4627. Parameters of type RedisKey are sent to Redis as KEY (http://redis.io/commands/eval) in addition to arguments,
  4628. so as to play nicely with Redis Cluster.
  4629. All members of this class are thread safe.
  4630. </summary>
  4631. </member>
  4632. <member name="P:StackExchange.Redis.LuaScript.OriginalScript">
  4633. <summary>
  4634. The original Lua script that was used to create this.
  4635. </summary>
  4636. </member>
  4637. <member name="P:StackExchange.Redis.LuaScript.ExecutableScript">
  4638. <summary>
  4639. The Lua script that will actually be sent to Redis for execution.
  4640. All @-prefixed parameter names have been replaced at this point.
  4641. </summary>
  4642. </member>
  4643. <member name="M:StackExchange.Redis.LuaScript.Finalize">
  4644. <summary>
  4645. Finalizer, used to prompt cleanups of the script cache when
  4646. a LuaScript reference goes out of scope.
  4647. </summary>
  4648. </member>
  4649. <member name="M:StackExchange.Redis.LuaScript.PurgeCache">
  4650. <summary>
  4651. Invalidates the internal cache of LuaScript objects.
  4652. Existing LuaScripts will continue to work, but future calls to LuaScript.Prepare
  4653. return a new LuaScript instance.
  4654. </summary>
  4655. </member>
  4656. <member name="M:StackExchange.Redis.LuaScript.GetCachedScriptCount">
  4657. <summary>
  4658. Returns the number of cached LuaScripts.
  4659. </summary>
  4660. </member>
  4661. <member name="M:StackExchange.Redis.LuaScript.Prepare(System.String)">
  4662. <summary>
  4663. Prepares a Lua script with named parameters to be run against any Redis instance.
  4664. </summary>
  4665. </member>
  4666. <member name="M:StackExchange.Redis.LuaScript.Evaluate(StackExchange.Redis.IDatabase,System.Object,System.Nullable{StackExchange.Redis.RedisKey},StackExchange.Redis.CommandFlags)">
  4667. <summary>
  4668. Evaluates this LuaScript against the given database, extracting parameters from the passed in object if any.
  4669. </summary>
  4670. </member>
  4671. <member name="M:StackExchange.Redis.LuaScript.EvaluateAsync(StackExchange.Redis.IDatabaseAsync,System.Object,System.Nullable{StackExchange.Redis.RedisKey},StackExchange.Redis.CommandFlags)">
  4672. <summary>
  4673. Evaluates this LuaScript against the given database, extracting parameters from the passed in object if any.
  4674. </summary>
  4675. </member>
  4676. <member name="M:StackExchange.Redis.LuaScript.Load(StackExchange.Redis.IServer,StackExchange.Redis.CommandFlags)">
  4677. <summary>
  4678. Loads this LuaScript into the given IServer so it can be run with it's SHA1 hash, instead of
  4679. passing the full script on each Evaluate or EvaluateAsync call.
  4680. Note: the FireAndForget command flag cannot be set
  4681. </summary>
  4682. </member>
  4683. <member name="M:StackExchange.Redis.LuaScript.LoadAsync(StackExchange.Redis.IServer,StackExchange.Redis.CommandFlags)">
  4684. <summary>
  4685. Loads this LuaScript into the given IServer so it can be run with it's SHA1 hash, instead of
  4686. passing the full script on each Evaluate or EvaluateAsync call.
  4687. Note: the FireAndForget command flag cannot be set
  4688. </summary>
  4689. </member>
  4690. <member name="T:StackExchange.Redis.LoadedLuaScript">
  4691. <summary>
  4692. Represents a Lua script that can be executed on Redis.
  4693. Unlike LuaScript, LoadedLuaScript sends the hash of it's ExecutableScript to Redis rather than pass
  4694. the whole script on each call. This requires that the script be loaded into Redis before it is used.
  4695. To create a LoadedLuaScript first create a LuaScript via LuaScript.Prepare(string), then
  4696. call Load(IServer, CommandFlags) on the returned LuaScript.
  4697. Unlike normal Redis Lua scripts, LoadedLuaScript can have named parameters (prefixed by a @).
  4698. Public fields and properties of the passed in object are treated as parameters.
  4699. Parameters of type RedisKey are sent to Redis as KEY (http://redis.io/commands/eval) in addition to arguments,
  4700. so as to play nicely with Redis Cluster.
  4701. All members of this class are thread safe.
  4702. </summary>
  4703. </member>
  4704. <member name="P:StackExchange.Redis.LoadedLuaScript.OriginalScript">
  4705. <summary>
  4706. The original script that was used to create this LoadedLuaScript.
  4707. </summary>
  4708. </member>
  4709. <member name="P:StackExchange.Redis.LoadedLuaScript.ExecutableScript">
  4710. <summary>
  4711. The script that will actually be sent to Redis for execution.
  4712. </summary>
  4713. </member>
  4714. <member name="P:StackExchange.Redis.LoadedLuaScript.Hash">
  4715. <summary>
  4716. The SHA1 hash of ExecutableScript.
  4717. This is sent to Redis instead of ExecutableScript during Evaluate and EvaluateAsync calls.
  4718. </summary>
  4719. </member>
  4720. <member name="M:StackExchange.Redis.LoadedLuaScript.Evaluate(StackExchange.Redis.IDatabase,System.Object,System.Nullable{StackExchange.Redis.RedisKey},StackExchange.Redis.CommandFlags)">
  4721. <summary>
  4722. Evaluates this LoadedLuaScript against the given database, extracting parameters for the passed in object if any.
  4723. This method sends the SHA1 hash of the ExecutableScript instead of the script itself. If the script has not
  4724. been loaded into the passed Redis instance it will fail.
  4725. </summary>
  4726. </member>
  4727. <member name="M:StackExchange.Redis.LoadedLuaScript.EvaluateAsync(StackExchange.Redis.IDatabaseAsync,System.Object,System.Nullable{StackExchange.Redis.RedisKey},StackExchange.Redis.CommandFlags)">
  4728. <summary>
  4729. Evaluates this LoadedLuaScript against the given database, extracting parameters for the passed in object if any.
  4730. This method sends the SHA1 hash of the ExecutableScript instead of the script itself. If the script has not
  4731. been loaded into the passed Redis instance it will fail.
  4732. </summary>
  4733. </member>
  4734. <member name="T:StackExchange.Redis.RedisCommandException">
  4735. <summary>
  4736. Indicates that a command was illegal and was not sent to the server
  4737. </summary>
  4738. </member>
  4739. <member name="T:StackExchange.Redis.RedisConnectionException">
  4740. <summary>
  4741. Indicates a connection fault when communicating with redis
  4742. </summary>
  4743. </member>
  4744. <member name="P:StackExchange.Redis.RedisConnectionException.FailureType">
  4745. <summary>
  4746. The type of connection failure
  4747. </summary>
  4748. </member>
  4749. <member name="T:StackExchange.Redis.RedisException">
  4750. <summary>
  4751. Indicates an issue communicating with redis
  4752. </summary>
  4753. </member>
  4754. <member name="M:StackExchange.Redis.RedisException.#ctor(System.String)">
  4755. <summary>
  4756. Deserialization constructor; not intended for general usage
  4757. </summary>
  4758. </member>
  4759. <member name="T:StackExchange.Redis.RedisServerException">
  4760. <summary>
  4761. Indicates an exception raised by a redis server
  4762. </summary>
  4763. </member>
  4764. <member name="P:StackExchange.Redis.Message.IsAdmin">
  4765. <summary>
  4766. Things with the potential to cause harm, or to reveal configuration information
  4767. </summary>
  4768. </member>
  4769. <member name="M:StackExchange.Redis.Message.SetInternalCall">
  4770. <summary>
  4771. This does a few important things:
  4772. 1: it suppresses error events for commands that the user isn't interested in
  4773. (i.e. "why does my standalone server keep saying ERR unknown command 'cluster' ?")
  4774. 2: it allows the initial PING and GET (during connect) to get queued rather
  4775. than be rejected as no-server-available (note that this doesn't apply to
  4776. handshake messages, as they bypass the queue completely)
  4777. 3: it disables non-pref logging, as it is usually server-targeted
  4778. </summary>
  4779. </member>
  4780. <member name="M:StackExchange.Redis.MessageQueue.DequeueUnsentPing(System.Int32@)">
  4781. <summary>
  4782. Checks both high-pri and regular queues to see if the next item is a PING, and if so: dequeues it and returns it
  4783. </summary>
  4784. </member>
  4785. <member name="T:StackExchange.Redis.MigrateOptions">
  4786. <summary>
  4787. Additional options for the MIGRATE command
  4788. </summary>
  4789. </member>
  4790. <member name="F:StackExchange.Redis.MigrateOptions.None">
  4791. <summary>
  4792. No options specified
  4793. </summary>
  4794. </member>
  4795. <member name="F:StackExchange.Redis.MigrateOptions.Copy">
  4796. <summary>
  4797. Do not remove the key from the local instance.
  4798. </summary>
  4799. </member>
  4800. <member name="F:StackExchange.Redis.MigrateOptions.Replace">
  4801. <summary>
  4802. Replace existing key on the remote instance.
  4803. </summary>
  4804. </member>
  4805. <member name="T:StackExchange.Redis.Order">
  4806. <summary>
  4807. The direction in which to sequence elements
  4808. </summary>
  4809. </member>
  4810. <member name="F:StackExchange.Redis.Order.Ascending">
  4811. <summary>
  4812. Ordered from low values to high values
  4813. </summary>
  4814. </member>
  4815. <member name="F:StackExchange.Redis.Order.Descending">
  4816. <summary>
  4817. Ordered from high values to low values
  4818. </summary>
  4819. </member>
  4820. <member name="M:StackExchange.Redis.PhysicalBridge.WriteMessageDirect(StackExchange.Redis.PhysicalConnection,StackExchange.Redis.Message)">
  4821. <summary>
  4822. This writes a message **directly** to the output stream; note
  4823. that this ignores the queue, so should only be used *either*
  4824. from the regular dequeue loop, *or* from the "I've just
  4825. connected" handshake (when there is no dequeue loop) - otherwise,
  4826. you can pretty much assume you're going to destroy the stream
  4827. </summary>
  4828. </member>
  4829. <member name="T:StackExchange.Redis.ProfileContextTracker">
  4830. <summary>
  4831. Big ol' wrapper around most of the profiling storage logic, 'cause it got too big to just live in ConnectionMultiplexer.
  4832. </summary>
  4833. </member>
  4834. <member name="T:StackExchange.Redis.ProfileContextTracker.ProfileContextCell">
  4835. <summary>
  4836. Necessary, because WeakReference can't be readily comparable (since the reference is... weak).
  4837. This lets us detect leaks* with some reasonable confidence, and cleanup periodically.
  4838. Some calisthenics are done to avoid allocating WeakReferences for no reason, as often
  4839. we're just looking up ProfileStorage.
  4840. * Somebody starts profiling, but for whatever reason never *stops* with a context object
  4841. </summary>
  4842. </member>
  4843. <member name="M:StackExchange.Redis.ProfileContextTracker.ProfileContextCell.ToStoreUnder(System.Object)">
  4844. <summary>
  4845. Suitable for use as a key into something.
  4846. This instance **WILL NOT** keep forObj alive, so it can
  4847. be copied out of the calling method's scope.
  4848. </summary>
  4849. </member>
  4850. <member name="M:StackExchange.Redis.ProfileContextTracker.ProfileContextCell.ToLookupBy(System.Object)">
  4851. <summary>
  4852. Only suitable for looking up.
  4853. This instance **ABSOLUTELY WILL** keep forObj alive, so this
  4854. had better not be copied into anything outside the scope of the
  4855. calling method.
  4856. </summary>
  4857. </member>
  4858. <member name="M:StackExchange.Redis.ProfileContextTracker.TryCreate(System.Object)">
  4859. <summary>
  4860. Registers the passed context with a collection that can be retried with subsequent calls to TryGetValue.
  4861. Returns false if the passed context object is already registered.
  4862. </summary>
  4863. </member>
  4864. <member name="M:StackExchange.Redis.ProfileContextTracker.TryGetValue(System.Object,StackExchange.Redis.ConcurrentProfileStorageCollection@)">
  4865. <summary>
  4866. Returns true and sets val to the tracking collection associated with the given context if the context
  4867. was registered with TryCreate.
  4868. Otherwise returns false and sets val to null.
  4869. </summary>
  4870. </member>
  4871. <member name="M:StackExchange.Redis.ProfileContextTracker.TryRemove(System.Object,StackExchange.Redis.ProfiledCommandEnumerable@)">
  4872. <summary>
  4873. Removes a context, setting all commands to a (non-thread safe) enumerable of
  4874. all the commands attached to that context.
  4875. If the context was never registered, will return false and set commands to null.
  4876. Subsequent calls to TryRemove with the same context will return false unless it is
  4877. re-registered with TryCreate.
  4878. </summary>
  4879. </member>
  4880. <member name="M:StackExchange.Redis.ProfileContextTracker.TryCleanup">
  4881. <summary>
  4882. If enough time has passed (1 minute) since the last call, this does walk of all contexts
  4883. and removes those that the GC has collected.
  4884. </summary>
  4885. </member>
  4886. <member name="T:StackExchange.Redis.RedisChannel">
  4887. <summary>
  4888. Represents a pub/sub channel name
  4889. </summary>
  4890. </member>
  4891. <member name="M:StackExchange.Redis.RedisChannel.#ctor(System.Byte[],StackExchange.Redis.RedisChannel.PatternMode)">
  4892. <summary>
  4893. Create a new redis channel from a buffer, explicitly controlling the pattern mode
  4894. </summary>
  4895. </member>
  4896. <member name="M:StackExchange.Redis.RedisChannel.#ctor(System.String,StackExchange.Redis.RedisChannel.PatternMode)">
  4897. <summary>
  4898. Create a new redis channel from a string, explicitly controlling the pattern mode
  4899. </summary>
  4900. </member>
  4901. <member name="P:StackExchange.Redis.RedisChannel.IsNullOrEmpty">
  4902. <summary>
  4903. Indicates whether the channel-name is either null or a zero-length value
  4904. </summary>
  4905. </member>
  4906. <member name="M:StackExchange.Redis.RedisChannel.op_Inequality(StackExchange.Redis.RedisChannel,StackExchange.Redis.RedisChannel)">
  4907. <summary>
  4908. Indicate whether two channel names are not equal
  4909. </summary>
  4910. </member>
  4911. <member name="M:StackExchange.Redis.RedisChannel.op_Inequality(System.String,StackExchange.Redis.RedisChannel)">
  4912. <summary>
  4913. Indicate whether two channel names are not equal
  4914. </summary>
  4915. </member>
  4916. <member name="M:StackExchange.Redis.RedisChannel.op_Inequality(System.Byte[],StackExchange.Redis.RedisChannel)">
  4917. <summary>
  4918. Indicate whether two channel names are not equal
  4919. </summary>
  4920. </member>
  4921. <member name="M:StackExchange.Redis.RedisChannel.op_Inequality(StackExchange.Redis.RedisChannel,System.String)">
  4922. <summary>
  4923. Indicate whether two channel names are not equal
  4924. </summary>
  4925. </member>
  4926. <member name="M:StackExchange.Redis.RedisChannel.op_Inequality(StackExchange.Redis.RedisChannel,System.Byte[])">
  4927. <summary>
  4928. Indicate whether two channel names are not equal
  4929. </summary>
  4930. </member>
  4931. <member name="M:StackExchange.Redis.RedisChannel.op_Equality(StackExchange.Redis.RedisChannel,StackExchange.Redis.RedisChannel)">
  4932. <summary>
  4933. Indicate whether two channel names are equal
  4934. </summary>
  4935. </member>
  4936. <member name="M:StackExchange.Redis.RedisChannel.op_Equality(System.String,StackExchange.Redis.RedisChannel)">
  4937. <summary>
  4938. Indicate whether two channel names are equal
  4939. </summary>
  4940. </member>
  4941. <member name="M:StackExchange.Redis.RedisChannel.op_Equality(System.Byte[],StackExchange.Redis.RedisChannel)">
  4942. <summary>
  4943. Indicate whether two channel names are equal
  4944. </summary>
  4945. </member>
  4946. <member name="M:StackExchange.Redis.RedisChannel.op_Equality(StackExchange.Redis.RedisChannel,System.String)">
  4947. <summary>
  4948. Indicate whether two channel names are equal
  4949. </summary>
  4950. </member>
  4951. <member name="M:StackExchange.Redis.RedisChannel.op_Equality(StackExchange.Redis.RedisChannel,System.Byte[])">
  4952. <summary>
  4953. Indicate whether two channel names are equal
  4954. </summary>
  4955. </member>
  4956. <member name="M:StackExchange.Redis.RedisChannel.Equals(System.Object)">
  4957. <summary>
  4958. See Object.Equals
  4959. </summary>
  4960. </member>
  4961. <member name="M:StackExchange.Redis.RedisChannel.Equals(StackExchange.Redis.RedisChannel)">
  4962. <summary>
  4963. Indicate whether two channel names are equal
  4964. </summary>
  4965. </member>
  4966. <member name="M:StackExchange.Redis.RedisChannel.GetHashCode">
  4967. <summary>
  4968. See Object.GetHashCode
  4969. </summary>
  4970. </member>
  4971. <member name="M:StackExchange.Redis.RedisChannel.ToString">
  4972. <summary>
  4973. Obtains a string representation of the channel name
  4974. </summary>
  4975. </member>
  4976. <member name="T:StackExchange.Redis.RedisChannel.PatternMode">
  4977. <summary>
  4978. The matching pattern for this channel
  4979. </summary>
  4980. </member>
  4981. <member name="F:StackExchange.Redis.RedisChannel.PatternMode.Auto">
  4982. <summary>
  4983. Will be treated as a pattern if it includes *
  4984. </summary>
  4985. </member>
  4986. <member name="F:StackExchange.Redis.RedisChannel.PatternMode.Literal">
  4987. <summary>
  4988. Never a pattern
  4989. </summary>
  4990. </member>
  4991. <member name="F:StackExchange.Redis.RedisChannel.PatternMode.Pattern">
  4992. <summary>
  4993. Always a pattern
  4994. </summary>
  4995. </member>
  4996. <member name="M:StackExchange.Redis.RedisChannel.op_Implicit(System.String)~StackExchange.Redis.RedisChannel">
  4997. <summary>
  4998. Create a channel name from a String
  4999. </summary>
  5000. </member>
  5001. <member name="M:StackExchange.Redis.RedisChannel.op_Implicit(System.Byte[])~StackExchange.Redis.RedisChannel">
  5002. <summary>
  5003. Create a channel name from a Byte[]
  5004. </summary>
  5005. </member>
  5006. <member name="M:StackExchange.Redis.RedisChannel.op_Implicit(StackExchange.Redis.RedisChannel)~System.Byte[]">
  5007. <summary>
  5008. Obtain the channel name as a Byte[]
  5009. </summary>
  5010. </member>
  5011. <member name="M:StackExchange.Redis.RedisChannel.op_Implicit(StackExchange.Redis.RedisChannel)~System.String">
  5012. <summary>
  5013. Obtain the channel name as a String
  5014. </summary>
  5015. </member>
  5016. <member name="T:StackExchange.Redis.RedisErrorEventArgs">
  5017. <summary>
  5018. Notification of errors from the redis server
  5019. </summary>
  5020. </member>
  5021. <member name="P:StackExchange.Redis.RedisErrorEventArgs.EndPoint">
  5022. <summary>
  5023. The origin of the message
  5024. </summary>
  5025. </member>
  5026. <member name="P:StackExchange.Redis.RedisErrorEventArgs.Message">
  5027. <summary>
  5028. The message from the server
  5029. </summary>
  5030. </member>
  5031. <member name="T:StackExchange.Redis.RedisFeatures">
  5032. <summary>
  5033. Provides basic information about the features available on a particular version of Redis
  5034. </summary>
  5035. </member>
  5036. <member name="M:StackExchange.Redis.RedisFeatures.#ctor(System.Version)">
  5037. <summary>
  5038. Create a new RedisFeatures instance for the given version
  5039. </summary>
  5040. </member>
  5041. <member name="P:StackExchange.Redis.RedisFeatures.BitwiseOperations">
  5042. <summary>
  5043. Does BITOP / BITCOUNT exist?
  5044. </summary>
  5045. </member>
  5046. <member name="P:StackExchange.Redis.RedisFeatures.ClientName">
  5047. <summary>
  5048. Is CLIENT SETNAME available?
  5049. </summary>
  5050. </member>
  5051. <member name="P:StackExchange.Redis.RedisFeatures.ExecAbort">
  5052. <summary>
  5053. Does EXEC support EXECABORT if there are errors?
  5054. </summary>
  5055. </member>
  5056. <member name="P:StackExchange.Redis.RedisFeatures.ExpireOverwrite">
  5057. <summary>
  5058. Can EXPIRE be used to set expiration on a key that is already volatile (i.e. has an expiration)?
  5059. </summary>
  5060. </member>
  5061. <member name="P:StackExchange.Redis.RedisFeatures.HashVaradicDelete">
  5062. <summary>
  5063. Does HDEL support varadic usage?
  5064. </summary>
  5065. </member>
  5066. <member name="P:StackExchange.Redis.RedisFeatures.IncrementFloat">
  5067. <summary>
  5068. Does INCRBYFLOAT / HINCRBYFLOAT exist?
  5069. </summary>
  5070. </member>
  5071. <member name="P:StackExchange.Redis.RedisFeatures.InfoSections">
  5072. <summary>
  5073. Does INFO support sections?
  5074. </summary>
  5075. </member>
  5076. <member name="P:StackExchange.Redis.RedisFeatures.ListInsert">
  5077. <summary>
  5078. Is LINSERT available?
  5079. </summary>
  5080. </member>
  5081. <member name="P:StackExchange.Redis.RedisFeatures.MillisecondExpiry">
  5082. <summary>
  5083. Indicates whether PEXPIRE and PTTL are supported
  5084. </summary>
  5085. </member>
  5086. <member name="P:StackExchange.Redis.RedisFeatures.MultipleRandom">
  5087. <summary>
  5088. Does SRANDMEMBER support "count"?
  5089. </summary>
  5090. </member>
  5091. <member name="P:StackExchange.Redis.RedisFeatures.Persist">
  5092. <summary>
  5093. Is the PERSIST operation supported?
  5094. </summary>
  5095. </member>
  5096. <member name="P:StackExchange.Redis.RedisFeatures.PushIfNotExists">
  5097. <summary>
  5098. Is RPUSHX and LPUSHX available?
  5099. </summary>
  5100. </member>
  5101. <member name="P:StackExchange.Redis.RedisFeatures.Scan">
  5102. <summary>
  5103. Are cursor-based scans available?
  5104. </summary>
  5105. </member>
  5106. <member name="P:StackExchange.Redis.RedisFeatures.Scripting">
  5107. <summary>
  5108. Does EVAL / EVALSHA / etc exist?
  5109. </summary>
  5110. </member>
  5111. <member name="P:StackExchange.Redis.RedisFeatures.SetConditional">
  5112. <summary>
  5113. Does SET have the EX|PX|NX|XX extensions?
  5114. </summary>
  5115. </member>
  5116. <member name="P:StackExchange.Redis.RedisFeatures.SetVaradicAddRemove">
  5117. <summary>
  5118. Does SADD support varadic usage?
  5119. </summary>
  5120. </member>
  5121. <member name="P:StackExchange.Redis.RedisFeatures.StringLength">
  5122. <summary>
  5123. Is STRLEN available?
  5124. </summary>
  5125. </member>
  5126. <member name="P:StackExchange.Redis.RedisFeatures.StringSetRange">
  5127. <summary>
  5128. Is SETRANGE available?
  5129. </summary>
  5130. </member>
  5131. <member name="P:StackExchange.Redis.RedisFeatures.Time">
  5132. <summary>
  5133. Does TIME exist?
  5134. </summary>
  5135. </member>
  5136. <member name="P:StackExchange.Redis.RedisFeatures.ScriptingDatabaseSafe">
  5137. <summary>
  5138. Are Lua changes to the calling database transparent to the calling client?
  5139. </summary>
  5140. </member>
  5141. <member name="P:StackExchange.Redis.RedisFeatures.HyperLogLogCountSlaveSafe">
  5142. <summary>
  5143. Is PFCOUNT supported on slaves?
  5144. </summary>
  5145. </member>
  5146. <member name="P:StackExchange.Redis.RedisFeatures.Version">
  5147. <summary>
  5148. The Redis version of the server
  5149. </summary>
  5150. </member>
  5151. <member name="M:StackExchange.Redis.RedisFeatures.ToString">
  5152. <summary>
  5153. Create a string representation of the available features
  5154. </summary>
  5155. </member>
  5156. <member name="T:StackExchange.Redis.RedisKey">
  5157. <summary>
  5158. Represents a key that can be stored in redis
  5159. </summary>
  5160. </member>
  5161. <member name="M:StackExchange.Redis.RedisKey.op_Inequality(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey)">
  5162. <summary>
  5163. Indicate whether two keys are not equal
  5164. </summary>
  5165. </member>
  5166. <member name="M:StackExchange.Redis.RedisKey.op_Inequality(System.String,StackExchange.Redis.RedisKey)">
  5167. <summary>
  5168. Indicate whether two keys are not equal
  5169. </summary>
  5170. </member>
  5171. <member name="M:StackExchange.Redis.RedisKey.op_Inequality(System.Byte[],StackExchange.Redis.RedisKey)">
  5172. <summary>
  5173. Indicate whether two keys are not equal
  5174. </summary>
  5175. </member>
  5176. <member name="M:StackExchange.Redis.RedisKey.op_Inequality(StackExchange.Redis.RedisKey,System.String)">
  5177. <summary>
  5178. Indicate whether two keys are not equal
  5179. </summary>
  5180. </member>
  5181. <member name="M:StackExchange.Redis.RedisKey.op_Inequality(StackExchange.Redis.RedisKey,System.Byte[])">
  5182. <summary>
  5183. Indicate whether two keys are not equal
  5184. </summary>
  5185. </member>
  5186. <member name="M:StackExchange.Redis.RedisKey.op_Equality(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey)">
  5187. <summary>
  5188. Indicate whether two keys are equal
  5189. </summary>
  5190. </member>
  5191. <member name="M:StackExchange.Redis.RedisKey.op_Equality(System.String,StackExchange.Redis.RedisKey)">
  5192. <summary>
  5193. Indicate whether two keys are equal
  5194. </summary>
  5195. </member>
  5196. <member name="M:StackExchange.Redis.RedisKey.op_Equality(System.Byte[],StackExchange.Redis.RedisKey)">
  5197. <summary>
  5198. Indicate whether two keys are equal
  5199. </summary>
  5200. </member>
  5201. <member name="M:StackExchange.Redis.RedisKey.op_Equality(StackExchange.Redis.RedisKey,System.String)">
  5202. <summary>
  5203. Indicate whether two keys are equal
  5204. </summary>
  5205. </member>
  5206. <member name="M:StackExchange.Redis.RedisKey.op_Equality(StackExchange.Redis.RedisKey,System.Byte[])">
  5207. <summary>
  5208. Indicate whether two keys are equal
  5209. </summary>
  5210. </member>
  5211. <member name="M:StackExchange.Redis.RedisKey.Equals(System.Object)">
  5212. <summary>
  5213. See Object.Equals
  5214. </summary>
  5215. </member>
  5216. <member name="M:StackExchange.Redis.RedisKey.Equals(StackExchange.Redis.RedisKey)">
  5217. <summary>
  5218. Indicate whether two keys are equal
  5219. </summary>
  5220. </member>
  5221. <member name="M:StackExchange.Redis.RedisKey.GetHashCode">
  5222. <summary>
  5223. See Object.GetHashCode
  5224. </summary>
  5225. </member>
  5226. <member name="M:StackExchange.Redis.RedisKey.ToString">
  5227. <summary>
  5228. Obtains a string representation of the key
  5229. </summary>
  5230. </member>
  5231. <member name="M:StackExchange.Redis.RedisKey.op_Implicit(System.String)~StackExchange.Redis.RedisKey">
  5232. <summary>
  5233. Create a key from a String
  5234. </summary>
  5235. </member>
  5236. <member name="M:StackExchange.Redis.RedisKey.op_Implicit(System.Byte[])~StackExchange.Redis.RedisKey">
  5237. <summary>
  5238. Create a key from a Byte[]
  5239. </summary>
  5240. </member>
  5241. <member name="M:StackExchange.Redis.RedisKey.op_Implicit(StackExchange.Redis.RedisKey)~System.Byte[]">
  5242. <summary>
  5243. Obtain the key as a Byte[]
  5244. </summary>
  5245. </member>
  5246. <member name="M:StackExchange.Redis.RedisKey.op_Implicit(StackExchange.Redis.RedisKey)~System.String">
  5247. <summary>
  5248. Obtain the key as a String
  5249. </summary>
  5250. </member>
  5251. <member name="M:StackExchange.Redis.RedisKey.op_Addition(StackExchange.Redis.RedisKey,StackExchange.Redis.RedisKey)">
  5252. <summary>
  5253. Concatenate two keys
  5254. </summary>
  5255. </member>
  5256. <member name="M:StackExchange.Redis.RedisKey.Prepend(StackExchange.Redis.RedisKey)">
  5257. <summary>
  5258. Prepends p to this RedisKey, returning a new RedisKey.
  5259. Avoids some allocations if possible, repeated Prepend/Appends make
  5260. it less possible.
  5261. </summary>
  5262. </member>
  5263. <member name="M:StackExchange.Redis.RedisKey.Append(StackExchange.Redis.RedisKey)">
  5264. <summary>
  5265. Appends p to this RedisKey, returning a new RedisKey.
  5266. Avoids some allocations if possible, repeated Prepend/Appends make
  5267. it less possible.
  5268. </summary>
  5269. </member>
  5270. <member name="T:StackExchange.Redis.RedisResult">
  5271. <summary>
  5272. Represents a general-purpose result from redis, that may be cast into various anticipated types
  5273. </summary>
  5274. </member>
  5275. <member name="M:StackExchange.Redis.RedisResult.Create(StackExchange.Redis.RedisValue)">
  5276. <summary>
  5277. Create a new RedisResult.
  5278. </summary>
  5279. <returns></returns>
  5280. </member>
  5281. <member name="P:StackExchange.Redis.RedisResult.IsNull">
  5282. <summary>
  5283. Indicates whether this result was a null result
  5284. </summary>
  5285. </member>
  5286. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~System.String">
  5287. <summary>
  5288. Interprets the result as a String
  5289. </summary>
  5290. </member>
  5291. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~System.Byte[]">
  5292. <summary>
  5293. Interprets the result as a Byte[]
  5294. </summary>
  5295. </member>
  5296. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~System.Double">
  5297. <summary>
  5298. Interprets the result as a Double
  5299. </summary>
  5300. </member>
  5301. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~System.Int64">
  5302. <summary>
  5303. Interprets the result as an Int64
  5304. </summary>
  5305. </member>
  5306. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~System.Int32">
  5307. <summary>
  5308. Interprets the result as an Int32
  5309. </summary>
  5310. </member>
  5311. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~System.Boolean">
  5312. <summary>
  5313. Interprets the result as a Boolean
  5314. </summary>
  5315. </member>
  5316. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~StackExchange.Redis.RedisValue">
  5317. <summary>
  5318. Interprets the result as a RedisValue
  5319. </summary>
  5320. </member>
  5321. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~StackExchange.Redis.RedisKey">
  5322. <summary>
  5323. Interprets the result as a RedisKey
  5324. </summary>
  5325. </member>
  5326. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~System.Nullable{System.Double}">
  5327. <summary>
  5328. Interprets the result as a Nullable Double
  5329. </summary>
  5330. </member>
  5331. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~System.Nullable{System.Int64}">
  5332. <summary>
  5333. Interprets the result as a Nullable Int64
  5334. </summary>
  5335. </member>
  5336. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~System.Nullable{System.Int32}">
  5337. <summary>
  5338. Interprets the result as a Nullable Int32
  5339. </summary>
  5340. </member>
  5341. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~System.Nullable{System.Boolean}">
  5342. <summary>
  5343. Interprets the result as a Nullable Boolean
  5344. </summary>
  5345. </member>
  5346. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~System.String[]">
  5347. <summary>
  5348. Interprets the result as an array of String
  5349. </summary>
  5350. </member>
  5351. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~System.Byte[][]">
  5352. <summary>
  5353. Interprets the result as an array of Byte[]
  5354. </summary>
  5355. </member>
  5356. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~System.Double[]">
  5357. <summary>
  5358. Interprets the result as an array of Double
  5359. </summary>
  5360. </member>
  5361. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~System.Int64[]">
  5362. <summary>
  5363. Interprets the result as an array of Int64
  5364. </summary>
  5365. </member>
  5366. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~System.Int32[]">
  5367. <summary>
  5368. Interprets the result as an array of Int32
  5369. </summary>
  5370. </member>
  5371. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~System.Boolean[]">
  5372. <summary>
  5373. Interprets the result as an array of Boolean
  5374. </summary>
  5375. </member>
  5376. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~StackExchange.Redis.RedisValue[]">
  5377. <summary>
  5378. Interprets the result as an array of RedisValue
  5379. </summary>
  5380. </member>
  5381. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~StackExchange.Redis.RedisKey[]">
  5382. <summary>
  5383. Interprets the result as an array of RedisKey
  5384. </summary>
  5385. </member>
  5386. <member name="M:StackExchange.Redis.RedisResult.op_Explicit(StackExchange.Redis.RedisResult)~StackExchange.Redis.RedisResult[]">
  5387. <summary>
  5388. Interprets the result as an array of RedisResult
  5389. </summary>
  5390. </member>
  5391. <member name="T:StackExchange.Redis.RedisType">
  5392. <summary>
  5393. The intrinsinc data-types supported by redis
  5394. </summary>
  5395. <remarks>http://redis.io/topics/data-types</remarks>
  5396. </member>
  5397. <member name="F:StackExchange.Redis.RedisType.None">
  5398. <summary>
  5399. The specified key does not exist
  5400. </summary>
  5401. </member>
  5402. <member name="F:StackExchange.Redis.RedisType.String">
  5403. <summary>
  5404. Strings are the most basic kind of Redis value. Redis Strings are binary safe, this means that a Redis string can contain any kind of data, for instance a JPEG image or a serialized Ruby object.
  5405. A String value can be at max 512 Megabytes in length.
  5406. </summary>
  5407. <remarks>http://redis.io/commands#string</remarks>
  5408. </member>
  5409. <member name="F:StackExchange.Redis.RedisType.List">
  5410. <summary>
  5411. Redis Lists are simply lists of strings, sorted by insertion order. It is possible to add elements to a Redis List pushing new elements on the head (on the left) or on the tail (on the right) of the list.
  5412. </summary>
  5413. <remarks>http://redis.io/commands#list</remarks>
  5414. </member>
  5415. <member name="F:StackExchange.Redis.RedisType.Set">
  5416. <summary>
  5417. Redis Sets are an unordered collection of Strings. It is possible to add, remove, and test for existence of members in O(1) (constant time regardless of the number of elements contained inside the Set).
  5418. Redis Sets have the desirable property of not allowing repeated members. Adding the same element multiple times will result in a set having a single copy of this element. Practically speaking this means that adding a member does not require a check if exists then add operation.
  5419. </summary>
  5420. <remarks>http://redis.io/commands#set</remarks>
  5421. </member>
  5422. <member name="F:StackExchange.Redis.RedisType.SortedSet">
  5423. <summary>
  5424. Redis Sorted Sets are, similarly to Redis Sets, non repeating collections of Strings. The difference is that every member of a Sorted Set is associated with score, that is used in order to take the sorted set ordered, from the smallest to the greatest score. While members are unique, scores may be repeated.
  5425. </summary>
  5426. <remarks>http://redis.io/commands#sorted_set</remarks>
  5427. </member>
  5428. <member name="F:StackExchange.Redis.RedisType.Hash">
  5429. <summary>
  5430. Redis Hashes are maps between string fields and string values, so they are the perfect data type to represent objects (eg: A User with a number of fields like name, surname, age, and so forth)
  5431. </summary>
  5432. <remarks>http://redis.io/commands#hash</remarks>
  5433. </member>
  5434. <member name="F:StackExchange.Redis.RedisType.Unknown">
  5435. <summary>
  5436. The data-type was not recognised by the client library
  5437. </summary>
  5438. </member>
  5439. <member name="T:StackExchange.Redis.RedisValue">
  5440. <summary>
  5441. Represents values that can be stored in redis
  5442. </summary>
  5443. </member>
  5444. <member name="P:StackExchange.Redis.RedisValue.EmptyString">
  5445. <summary>
  5446. Represents the string <c>""</c>
  5447. </summary>
  5448. </member>
  5449. <member name="P:StackExchange.Redis.RedisValue.Null">
  5450. <summary>
  5451. A null value
  5452. </summary>
  5453. </member>
  5454. <member name="P:StackExchange.Redis.RedisValue.IsInteger">
  5455. <summary>
  5456. Indicates whether the value is a primitive integer
  5457. </summary>
  5458. </member>
  5459. <member name="P:StackExchange.Redis.RedisValue.IsNull">
  5460. <summary>
  5461. Indicates whether the value should be considered a null value
  5462. </summary>
  5463. </member>
  5464. <member name="P:StackExchange.Redis.RedisValue.IsNullOrEmpty">
  5465. <summary>
  5466. Indicates whether the value is either null or a zero-length value
  5467. </summary>
  5468. </member>
  5469. <member name="P:StackExchange.Redis.RedisValue.HasValue">
  5470. <summary>
  5471. Indicates whether the value is greater than zero-length
  5472. </summary>
  5473. </member>
  5474. <member name="M:StackExchange.Redis.RedisValue.op_Inequality(StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue)">
  5475. <summary>
  5476. Indicates whether two RedisValue values are equivalent
  5477. </summary>
  5478. </member>
  5479. <member name="M:StackExchange.Redis.RedisValue.op_Equality(StackExchange.Redis.RedisValue,StackExchange.Redis.RedisValue)">
  5480. <summary>
  5481. Indicates whether two RedisValue values are equivalent
  5482. </summary>
  5483. </member>
  5484. <member name="M:StackExchange.Redis.RedisValue.Equals(System.Object)">
  5485. <summary>
  5486. See Object.Equals()
  5487. </summary>
  5488. </member>
  5489. <member name="M:StackExchange.Redis.RedisValue.Equals(StackExchange.Redis.RedisValue)">
  5490. <summary>
  5491. Indicates whether two RedisValue values are equivalent
  5492. </summary>
  5493. </member>
  5494. <member name="M:StackExchange.Redis.RedisValue.GetHashCode">
  5495. <summary>
  5496. See Object.GetHashCode()
  5497. </summary>
  5498. </member>
  5499. <member name="M:StackExchange.Redis.RedisValue.ToString">
  5500. <summary>
  5501. Returns a string representation of the value
  5502. </summary>
  5503. </member>
  5504. <member name="M:StackExchange.Redis.RedisValue.CompareTo(StackExchange.Redis.RedisValue)">
  5505. <summary>
  5506. Compare against a RedisValue for relative order
  5507. </summary>
  5508. </member>
  5509. <member name="M:StackExchange.Redis.RedisValue.op_Implicit(System.Int32)~StackExchange.Redis.RedisValue">
  5510. <summary>
  5511. Creates a new RedisValue from an Int32
  5512. </summary>
  5513. </member>
  5514. <member name="M:StackExchange.Redis.RedisValue.op_Implicit(System.Nullable{System.Int32})~StackExchange.Redis.RedisValue">
  5515. <summary>
  5516. Creates a new RedisValue from a nullable Int32
  5517. </summary>
  5518. </member>
  5519. <member name="M:StackExchange.Redis.RedisValue.op_Implicit(System.Int64)~StackExchange.Redis.RedisValue">
  5520. <summary>
  5521. Creates a new RedisValue from an Int64
  5522. </summary>
  5523. </member>
  5524. <member name="M:StackExchange.Redis.RedisValue.op_Implicit(System.Nullable{System.Int64})~StackExchange.Redis.RedisValue">
  5525. <summary>
  5526. Creates a new RedisValue from a nullable Int64
  5527. </summary>
  5528. </member>
  5529. <member name="M:StackExchange.Redis.RedisValue.op_Implicit(System.Double)~StackExchange.Redis.RedisValue">
  5530. <summary>
  5531. Creates a new RedisValue from a Double
  5532. </summary>
  5533. </member>
  5534. <member name="M:StackExchange.Redis.RedisValue.op_Implicit(System.Nullable{System.Double})~StackExchange.Redis.RedisValue">
  5535. <summary>
  5536. Creates a new RedisValue from a nullable Double
  5537. </summary>
  5538. </member>
  5539. <member name="M:StackExchange.Redis.RedisValue.op_Implicit(System.String)~StackExchange.Redis.RedisValue">
  5540. <summary>
  5541. Creates a new RedisValue from a String
  5542. </summary>
  5543. </member>
  5544. <member name="M:StackExchange.Redis.RedisValue.op_Implicit(System.Byte[])~StackExchange.Redis.RedisValue">
  5545. <summary>
  5546. Creates a new RedisValue from a Byte[]
  5547. </summary>
  5548. </member>
  5549. <member name="M:StackExchange.Redis.RedisValue.op_Implicit(System.Boolean)~StackExchange.Redis.RedisValue">
  5550. <summary>
  5551. Creates a new RedisValue from a Boolean
  5552. </summary>
  5553. </member>
  5554. <member name="M:StackExchange.Redis.RedisValue.op_Implicit(System.Nullable{System.Boolean})~StackExchange.Redis.RedisValue">
  5555. <summary>
  5556. Creates a new RedisValue from a nullable Boolean
  5557. </summary>
  5558. </member>
  5559. <member name="M:StackExchange.Redis.RedisValue.op_Explicit(StackExchange.Redis.RedisValue)~System.Boolean">
  5560. <summary>
  5561. Converts the value to a Boolean
  5562. </summary>
  5563. </member>
  5564. <member name="M:StackExchange.Redis.RedisValue.op_Explicit(StackExchange.Redis.RedisValue)~System.Int32">
  5565. <summary>
  5566. Converts the value to an Int32
  5567. </summary>
  5568. </member>
  5569. <member name="M:StackExchange.Redis.RedisValue.op_Explicit(StackExchange.Redis.RedisValue)~System.Int64">
  5570. <summary>
  5571. Converts the value to an Int64
  5572. </summary>
  5573. </member>
  5574. <member name="M:StackExchange.Redis.RedisValue.op_Explicit(StackExchange.Redis.RedisValue)~System.Double">
  5575. <summary>
  5576. Converts the value to a Double
  5577. </summary>
  5578. </member>
  5579. <member name="M:StackExchange.Redis.RedisValue.op_Explicit(StackExchange.Redis.RedisValue)~System.Nullable{System.Double}">
  5580. <summary>
  5581. Converts the value to a nullable Double
  5582. </summary>
  5583. </member>
  5584. <member name="M:StackExchange.Redis.RedisValue.op_Explicit(StackExchange.Redis.RedisValue)~System.Nullable{System.Int64}">
  5585. <summary>
  5586. Converts the value to a nullable Int64
  5587. </summary>
  5588. </member>
  5589. <member name="M:StackExchange.Redis.RedisValue.op_Explicit(StackExchange.Redis.RedisValue)~System.Nullable{System.Int32}">
  5590. <summary>
  5591. Converts the value to a nullable Int32
  5592. </summary>
  5593. </member>
  5594. <member name="M:StackExchange.Redis.RedisValue.op_Explicit(StackExchange.Redis.RedisValue)~System.Nullable{System.Boolean}">
  5595. <summary>
  5596. Converts the value to a nullable Boolean
  5597. </summary>
  5598. </member>
  5599. <member name="M:StackExchange.Redis.RedisValue.op_Implicit(StackExchange.Redis.RedisValue)~System.String">
  5600. <summary>
  5601. Converts the value to a String
  5602. </summary>
  5603. </member>
  5604. <member name="M:StackExchange.Redis.RedisValue.op_Implicit(StackExchange.Redis.RedisValue)~System.Byte[]">
  5605. <summary>
  5606. Converts the value to a byte[]
  5607. </summary>
  5608. </member>
  5609. <member name="M:StackExchange.Redis.RedisValue.TryParse(System.Int64@)">
  5610. <summary>
  5611. Convert to a long if possible, returning true.
  5612. Returns false otherwise.
  5613. </summary>
  5614. </member>
  5615. <member name="M:StackExchange.Redis.RedisValue.TryParse(System.Int32@)">
  5616. <summary>
  5617. Convert to a int if possible, returning true.
  5618. Returns false otherwise.
  5619. </summary>
  5620. </member>
  5621. <member name="M:StackExchange.Redis.RedisValue.TryParse(System.Double@)">
  5622. <summary>
  5623. Convert to a double if possible, returning true.
  5624. Returns false otherwise.
  5625. </summary>
  5626. </member>
  5627. <member name="T:StackExchange.Redis.ReplicationChangeOptions">
  5628. <summary>
  5629. Additional operations to perform when making a server a master
  5630. </summary>
  5631. </member>
  5632. <member name="F:StackExchange.Redis.ReplicationChangeOptions.None">
  5633. <summary>
  5634. No additional operations
  5635. </summary>
  5636. </member>
  5637. <member name="F:StackExchange.Redis.ReplicationChangeOptions.SetTiebreaker">
  5638. <summary>
  5639. Set the tie-breaker key on all available masters, to specify this server
  5640. </summary>
  5641. </member>
  5642. <member name="F:StackExchange.Redis.ReplicationChangeOptions.Broadcast">
  5643. <summary>
  5644. Broadcast to the pub-sub channel to listening clients to reconfigure themselves
  5645. </summary>
  5646. </member>
  5647. <member name="F:StackExchange.Redis.ReplicationChangeOptions.EnslaveSubordinates">
  5648. <summary>
  5649. Issue a SLAVEOF to all other known nodes, making this this master of all
  5650. </summary>
  5651. </member>
  5652. <member name="F:StackExchange.Redis.ReplicationChangeOptions.All">
  5653. <summary>
  5654. All additional operations
  5655. </summary>
  5656. </member>
  5657. <member name="T:StackExchange.Redis.SaveType">
  5658. <summary>
  5659. The type of save operation to perform
  5660. </summary>
  5661. </member>
  5662. <member name="F:StackExchange.Redis.SaveType.BackgroundRewriteAppendOnlyFile">
  5663. <summary>
  5664. Instruct Redis to start an Append Only File rewrite process. The rewrite will create a small optimized version of the current Append Only File.
  5665. </summary>
  5666. <remarks>http://redis.io/commands/bgrewriteaof</remarks>
  5667. </member>
  5668. <member name="F:StackExchange.Redis.SaveType.BackgroundSave">
  5669. <summary>
  5670. Save the DB in background. The OK code is immediately returned. Redis forks, the parent continues to serve the clients, the child saves the DB on disk then exits. A client my be able to check if the operation succeeded using the LASTSAVE command.
  5671. </summary>
  5672. <remarks>http://redis.io/commands/bgsave</remarks>
  5673. </member>
  5674. <member name="F:StackExchange.Redis.SaveType.ForegroundSave">
  5675. <summary>
  5676. Save the DB in foreground. This is almost never a good thing to do, and could cause significant blocking. Only do this if you know you need to save
  5677. </summary>
  5678. <remarks>http://redis.io/commands/save</remarks>
  5679. </member>
  5680. <member name="M:StackExchange.Redis.ScriptParameterMapper.PrepareScript(System.String)">
  5681. <summary>
  5682. Turns a script with @namedParameters into a LuaScript that can be executed
  5683. against a given IDatabase(Async) object
  5684. </summary>
  5685. </member>
  5686. <member name="M:StackExchange.Redis.ScriptParameterMapper.IsValidParameterHash(System.Type,StackExchange.Redis.LuaScript,System.String@,System.String@)">
  5687. <summary>
  5688. Determines whether or not the given type can be used to provide parameters for the given LuaScript.
  5689. </summary>
  5690. </member>
  5691. <member name="M:StackExchange.Redis.ScriptParameterMapper.GetParameterExtractor(System.Type,StackExchange.Redis.LuaScript)">
  5692. <summary>
  5693. Creates a Func that extracts parameters from the given type for use by a LuaScript.
  5694. Members that are RedisKey's get extracted to be passed in as keys to redis; all members that
  5695. appear in the script get extracted as RedisValue arguments to be sent up as args.
  5696. We send all values as arguments so we don't have to prepare the same script for different parameter
  5697. types.
  5698. The created Func takes a RedisKey, which will be prefixed to all keys (and arguments of type RedisKey) for
  5699. keyspace isolation.
  5700. </summary>
  5701. </member>
  5702. <member name="T:StackExchange.Redis.ServerCounters">
  5703. <summary>
  5704. Illustrates the queues associates with this server
  5705. </summary>
  5706. </member>
  5707. <member name="P:StackExchange.Redis.ServerCounters.EndPoint">
  5708. <summary>
  5709. The endpoint to which this data relates (this can be null if the data represents all servers)
  5710. </summary>
  5711. </member>
  5712. <member name="P:StackExchange.Redis.ServerCounters.Interactive">
  5713. <summary>
  5714. Counters associated with the interactive (non pub-sub) connection
  5715. </summary>
  5716. </member>
  5717. <member name="P:StackExchange.Redis.ServerCounters.Other">
  5718. <summary>
  5719. Counters associated with other ambient activity
  5720. </summary>
  5721. </member>
  5722. <member name="P:StackExchange.Redis.ServerCounters.Subscription">
  5723. <summary>
  5724. Counters associated with the subscription (pub-sub) connection
  5725. </summary>
  5726. </member>
  5727. <member name="P:StackExchange.Redis.ServerCounters.TotalOutstanding">
  5728. <summary>
  5729. Indicates the total number of outstanding items against this server
  5730. </summary>
  5731. </member>
  5732. <member name="M:StackExchange.Redis.ServerCounters.ToString">
  5733. <summary>
  5734. See Object.ToString();
  5735. </summary>
  5736. </member>
  5737. <member name="M:StackExchange.Redis.ServerSelectionStrategy.HashSlot(StackExchange.Redis.RedisKey)">
  5738. <summary>
  5739. Computes the hash-slot that would be used by the given key
  5740. </summary>
  5741. </member>
  5742. <member name="T:StackExchange.Redis.ServerType">
  5743. <summary>
  5744. Indicates the flavor of a particular redis server
  5745. </summary>
  5746. </member>
  5747. <member name="F:StackExchange.Redis.ServerType.Standalone">
  5748. <summary>
  5749. Classic redis-server server
  5750. </summary>
  5751. </member>
  5752. <member name="F:StackExchange.Redis.ServerType.Sentinel">
  5753. <summary>
  5754. Monitoring/configuration redis-sentinel server
  5755. </summary>
  5756. </member>
  5757. <member name="F:StackExchange.Redis.ServerType.Cluster">
  5758. <summary>
  5759. Distributed redis-cluster server
  5760. </summary>
  5761. </member>
  5762. <member name="F:StackExchange.Redis.ServerType.Twemproxy">
  5763. <summary>
  5764. Distributed redis installation via <a href="https://github.com/twitter/twemproxy">twemproxy</a>
  5765. </summary>
  5766. </member>
  5767. <member name="T:StackExchange.Redis.SetOperation">
  5768. <summary>
  5769. Describes an algebraic set operation that can be performed to combine multiple sets
  5770. </summary>
  5771. </member>
  5772. <member name="F:StackExchange.Redis.SetOperation.Union">
  5773. <summary>
  5774. Returns the members of the set resulting from the union of all the given sets.
  5775. </summary>
  5776. </member>
  5777. <member name="F:StackExchange.Redis.SetOperation.Intersect">
  5778. <summary>
  5779. Returns the members of the set resulting from the intersection of all the given sets.
  5780. </summary>
  5781. </member>
  5782. <member name="F:StackExchange.Redis.SetOperation.Difference">
  5783. <summary>
  5784. Returns the members of the set resulting from the difference between the first set and all the successive sets.
  5785. </summary>
  5786. </member>
  5787. <member name="T:StackExchange.Redis.ShutdownMode">
  5788. <summary>
  5789. Defines the persistence behaviour of the server during shutdown
  5790. </summary>
  5791. </member>
  5792. <member name="F:StackExchange.Redis.ShutdownMode.Default">
  5793. <summary>
  5794. The data is persisted if save points are configured
  5795. </summary>
  5796. </member>
  5797. <member name="F:StackExchange.Redis.ShutdownMode.Never">
  5798. <summary>
  5799. The data is NOT persisted even if save points are configured
  5800. </summary>
  5801. </member>
  5802. <member name="F:StackExchange.Redis.ShutdownMode.Always">
  5803. <summary>
  5804. The data is persisted even if save points are NOT configured
  5805. </summary>
  5806. </member>
  5807. <member name="T:StackExchange.Redis.ISocketCallback">
  5808. <summary>
  5809. Allows callbacks from SocketManager as work is discovered
  5810. </summary>
  5811. </member>
  5812. <member name="M:StackExchange.Redis.ISocketCallback.Connected(System.IO.Stream,System.IO.TextWriter)">
  5813. <summary>
  5814. Indicates that a socket has connected
  5815. </summary>
  5816. </member>
  5817. <member name="M:StackExchange.Redis.ISocketCallback.Error">
  5818. <summary>
  5819. Indicates that the socket has signalled an error condition
  5820. </summary>
  5821. </member>
  5822. <member name="M:StackExchange.Redis.ISocketCallback.Read">
  5823. <summary>
  5824. Indicates that data is available on the socket, and that the consumer should read synchronously from the socket while there is data
  5825. </summary>
  5826. </member>
  5827. <member name="M:StackExchange.Redis.ISocketCallback.StartReading">
  5828. <summary>
  5829. Indicates that we cannot know whether data is available, and that the consume should commence reading asynchronously
  5830. </summary>
  5831. </member>
  5832. <member name="T:StackExchange.Redis.SocketManager">
  5833. <summary>
  5834. A SocketManager monitors multiple sockets for availability of data; this is done using
  5835. the Socket.Select API and a dedicated reader-thread, which allows for fast responses
  5836. even when the system is under ambient load.
  5837. </summary>
  5838. </member>
  5839. <member name="M:StackExchange.Redis.SocketManager.#ctor(System.String)">
  5840. <summary>
  5841. Creates a new (optionally named) SocketManager instance
  5842. </summary>
  5843. </member>
  5844. <member name="M:StackExchange.Redis.SocketManager.#ctor(System.String,System.Boolean)">
  5845. <summary>
  5846. Creates a new SocketManager instance
  5847. </summary>
  5848. </member>
  5849. <member name="P:StackExchange.Redis.SocketManager.Name">
  5850. <summary>
  5851. Gets the name of this SocketManager instance
  5852. </summary>
  5853. </member>
  5854. <member name="M:StackExchange.Redis.SocketManager.Dispose">
  5855. <summary>
  5856. Releases all resources associated with this instance
  5857. </summary>
  5858. </member>
  5859. <member name="T:StackExchange.Redis.SortedSetEntry">
  5860. <summary>
  5861. Describes a sorted-set element with the corresponding value
  5862. </summary>
  5863. </member>
  5864. <member name="M:StackExchange.Redis.SortedSetEntry.#ctor(StackExchange.Redis.RedisValue,System.Double)">
  5865. <summary>
  5866. Initializes a SortedSetEntry value
  5867. </summary>
  5868. </member>
  5869. <member name="P:StackExchange.Redis.SortedSetEntry.Element">
  5870. <summary>
  5871. The unique element stored in the sorted set
  5872. </summary>
  5873. </member>
  5874. <member name="P:StackExchange.Redis.SortedSetEntry.Score">
  5875. <summary>
  5876. The score against the element
  5877. </summary>
  5878. </member>
  5879. <member name="P:StackExchange.Redis.SortedSetEntry.Value">
  5880. <summary>
  5881. The score against the element
  5882. </summary>
  5883. </member>
  5884. <member name="P:StackExchange.Redis.SortedSetEntry.Key">
  5885. <summary>
  5886. The unique element stored in the sorted set
  5887. </summary>
  5888. </member>
  5889. <member name="M:StackExchange.Redis.SortedSetEntry.op_Implicit(StackExchange.Redis.SortedSetEntry)~System.Collections.Generic.KeyValuePair{StackExchange.Redis.RedisValue,System.Double}">
  5890. <summary>
  5891. Converts to a key/value pair
  5892. </summary>
  5893. </member>
  5894. <member name="M:StackExchange.Redis.SortedSetEntry.op_Implicit(System.Collections.Generic.KeyValuePair{StackExchange.Redis.RedisValue,System.Double})~StackExchange.Redis.SortedSetEntry">
  5895. <summary>
  5896. Converts from a key/value pair
  5897. </summary>
  5898. </member>
  5899. <member name="M:StackExchange.Redis.SortedSetEntry.ToString">
  5900. <summary>
  5901. See Object.ToString()
  5902. </summary>
  5903. </member>
  5904. <member name="M:StackExchange.Redis.SortedSetEntry.GetHashCode">
  5905. <summary>
  5906. See Object.GetHashCode()
  5907. </summary>
  5908. </member>
  5909. <member name="M:StackExchange.Redis.SortedSetEntry.Equals(System.Object)">
  5910. <summary>
  5911. Compares two values for equality
  5912. </summary>
  5913. </member>
  5914. <member name="M:StackExchange.Redis.SortedSetEntry.Equals(StackExchange.Redis.SortedSetEntry)">
  5915. <summary>
  5916. Compares two values for equality
  5917. </summary>
  5918. </member>
  5919. <member name="M:StackExchange.Redis.SortedSetEntry.CompareTo(StackExchange.Redis.SortedSetEntry)">
  5920. <summary>
  5921. Compares two values by score
  5922. </summary>
  5923. </member>
  5924. <member name="M:StackExchange.Redis.SortedSetEntry.CompareTo(System.Object)">
  5925. <summary>
  5926. Compares two values by score
  5927. </summary>
  5928. </member>
  5929. <member name="M:StackExchange.Redis.SortedSetEntry.op_Equality(StackExchange.Redis.SortedSetEntry,StackExchange.Redis.SortedSetEntry)">
  5930. <summary>
  5931. Compares two values for equality
  5932. </summary>
  5933. </member>
  5934. <member name="M:StackExchange.Redis.SortedSetEntry.op_Inequality(StackExchange.Redis.SortedSetEntry,StackExchange.Redis.SortedSetEntry)">
  5935. <summary>
  5936. Compares two values for non-equality
  5937. </summary>
  5938. </member>
  5939. <member name="T:StackExchange.Redis.SortType">
  5940. <summary>
  5941. Specifies how to compare elements for sorting
  5942. </summary>
  5943. </member>
  5944. <member name="F:StackExchange.Redis.SortType.Numeric">
  5945. <summary>
  5946. Elements are interpreted as a double-precision floating point number and sorted numerically
  5947. </summary>
  5948. </member>
  5949. <member name="F:StackExchange.Redis.SortType.Alphabetic">
  5950. <summary>
  5951. Elements are sorted using their alphabetic form (Redis is UTF-8 aware as long as the !LC_COLLATE environment variable is set at the server)
  5952. </summary>
  5953. </member>
  5954. <member name="T:StackExchange.Redis.TaskSource">
  5955. <summary>
  5956. We want to prevent callers hijacking the reader thread; this is a bit nasty, but works;
  5957. see http://stackoverflow.com/a/22588431/23354 for more information; a huge
  5958. thanks to Eli Arbel for spotting this (even though it is pure evil; it is *my kind of evil*)
  5959. </summary>
  5960. </member>
  5961. <member name="F:StackExchange.Redis.TaskSource.IsSyncSafe">
  5962. <summary>
  5963. Indicates whether the specified task will not hijack threads when results are set
  5964. </summary>
  5965. </member>
  5966. <member name="M:StackExchange.Redis.TaskSource.Create``1(System.Object)">
  5967. <summary>
  5968. Create a new TaskCompletion source
  5969. </summary>
  5970. </member>
  5971. <member name="M:StackExchange.Redis.TaskSource.CreateDenyExecSync``1(System.Object)">
  5972. <summary>
  5973. Create a new TaskCompletionSource that will not allow result-setting threads to be hijacked
  5974. </summary>
  5975. </member>
  5976. <member name="T:StackExchange.Redis.When">
  5977. <summary>
  5978. Indicates when this operation should be performed (only some variations are legal in a given context)
  5979. </summary>
  5980. </member>
  5981. <member name="F:StackExchange.Redis.When.Always">
  5982. <summary>
  5983. The operation should occur whether or not there is an existing value
  5984. </summary>
  5985. </member>
  5986. <member name="F:StackExchange.Redis.When.Exists">
  5987. <summary>
  5988. The operation should only occur when there is an existing value
  5989. </summary>
  5990. </member>
  5991. <member name="F:StackExchange.Redis.When.NotExists">
  5992. <summary>
  5993. The operation should only occur when there is not an existing value
  5994. </summary>
  5995. </member>
  5996. <member name="T:StackExchange.Redis.ConvertHelper">
  5997. <summary>
  5998. Helper for Array.ConvertAll() as it's missing on .Net Core.
  5999. </summary>
  6000. </member>
  6001. <member name="M:StackExchange.Redis.ConvertHelper.ConvertAll``2(``0[],System.Func{``0,``1})">
  6002. <summary>
  6003. Converts array of one type to an array of another type.
  6004. </summary>
  6005. <typeparam name="TInput">Input type</typeparam>
  6006. <typeparam name="TOutput">Output type</typeparam>
  6007. <param name="source">source</param>
  6008. <param name="selector">selector</param>
  6009. <returns></returns>
  6010. </member>
  6011. <member name="T:StackExchange.Redis.KeyspaceIsolation.DatabaseExtensions">
  6012. <summary>
  6013. Provides the <see cref="M:StackExchange.Redis.KeyspaceIsolation.DatabaseExtensions.WithKeyPrefix(StackExchange.Redis.IDatabase,StackExchange.Redis.RedisKey)"/> extension method to <see cref="T:StackExchange.Redis.IDatabase"/>.
  6014. </summary>
  6015. </member>
  6016. <member name="M:StackExchange.Redis.KeyspaceIsolation.DatabaseExtensions.WithKeyPrefix(StackExchange.Redis.IDatabase,StackExchange.Redis.RedisKey)">
  6017. <summary>
  6018. Creates a new <see cref="T:StackExchange.Redis.IDatabase"/> instance that provides an isolated key space
  6019. of the specified underyling database instance.
  6020. </summary>
  6021. <param name="database">
  6022. The underlying database instance that the returned instance shall use.
  6023. </param>
  6024. <param name="keyPrefix">
  6025. The prefix that defines a key space isolation for the returned database instance.
  6026. </param>
  6027. <returns>
  6028. A new <see cref="T:StackExchange.Redis.IDatabase"/> instance that invokes the specified underlying
  6029. <paramref name="database"/> but prepends the specified <paramref name="keyPrefix"/>
  6030. to all key paramters and thus forms a logical key space isolation.
  6031. </returns>
  6032. <remarks>
  6033. <para>
  6034. The following methods are not supported in a key space isolated database and
  6035. will throw an <see cref="T:System.NotSupportedException"/> when invoked:
  6036. </para>
  6037. <list type="bullet">
  6038. <item><see cref="M:StackExchange.Redis.IDatabaseAsync.KeyRandomAsync(StackExchange.Redis.CommandFlags)"/></item>
  6039. <item><see cref="M:StackExchange.Redis.IDatabase.KeyRandom(StackExchange.Redis.CommandFlags)"/></item>
  6040. </list>
  6041. <para>
  6042. Please notice that keys passed to a script are prefixed (as normal) but care must
  6043. be taken when a script returns the name of a key as that will (currently) not be
  6044. "unprefixed".
  6045. </para>
  6046. </remarks>
  6047. </member>
  6048. </members>
  6049. </doc>