forked from ServiceStack/ServiceStack
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathServiceStack.Redis.XML
1478 lines (1436 loc) · 89.1 KB
/
ServiceStack.Redis.XML
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>ServiceStack.Redis</name>
</assembly>
<members>
<member name="T:ServiceStack.Redis.RedisNativeClient">
<summary>
This class contains all the common operations for the RedisClient.
The client contains a 1:1 mapping of c# methods to redis operations of the same name.
Not threadsafe use a pooled manager
</summary>
</member>
<member name="M:ServiceStack.Redis.RedisNativeClient.Exec">
<summary>
Requires custom result parsing
</summary>
<returns>Number of results</returns>
</member>
<member name="M:ServiceStack.Redis.RedisNativeClient.SendCommand(System.Byte[][])">
<summary>
Command to set multuple binary safe arguments
</summary>
<param name="cmdWithBinaryArgs"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.RedisNativeClient.ResetSendBuffer">
<summary>
reset buffer index in send buffer
</summary>
</member>
<member name="P:ServiceStack.Redis.RedisNativeClient.Active">
<summary>
Used to manage connection pooling
</summary>
</member>
<member name="P:ServiceStack.Redis.RedisNativeClient.NamespacePrefix">
<summary>
Gets or sets object key prefix.
</summary>
</member>
<member name="T:ServiceStack.Redis.RedisNativeClient.AlchemyNativeClient">
<summary>
Interface to Alchemy DB
http://code.google.com/p/alchemydatabase/
</summary>
</member>
<member name="T:ServiceStack.Redis.Alchemy.IAlchemyNativeClient">
<summary>
Native interface to Alchemy DB
</summary>
</member>
<member name="M:ServiceStack.Redis.RedisNativeClient.AlchemyNativeClient.CreateTable(System.Byte[],System.Byte[])">
<summary>
</summary>
<param name="tablename"></param>
<param name="columnDefinitions"></param>
</member>
<member name="M:ServiceStack.Redis.RedisNativeClient.AlchemyNativeClient.DropTable(System.Byte[])">
<summary>
</summary>
<param name="tablename"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.RedisNativeClient.AlchemyNativeClient.CreateIndex(System.Byte[],System.Byte[],System.Byte[])">
<summary>
</summary>
<param name="indexname"></param>
<param name="tablename"></param>
<param name="column"></param>
</member>
<member name="M:ServiceStack.Redis.RedisNativeClient.AlchemyNativeClient.DropIndex(System.Byte[])">
<summary>
</summary>
<param name="indexname"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.RedisNativeClient.AlchemyNativeClient.Desc(System.Byte[])">
<summary>
</summary>
<param name="tablename"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.RedisNativeClient.AlchemyNativeClient.Dump(System.Byte[])">
<summary>
</summary>
<param name="tablename"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.RedisNativeClient.AlchemyNativeClient.DumpToMysql(System.Byte[],System.Byte[])">
<summary>
</summary>
<param name="tablename"></param>
<param name="mysqlTablename"></param>
</member>
<member name="M:ServiceStack.Redis.RedisNativeClient.AlchemyNativeClient.DumpToFile(System.Byte[],System.Byte[])">
<summary>
</summary>
<param name="tablename"></param>
<param name="fileName"></param>
</member>
<member name="M:ServiceStack.Redis.RedisNativeClient.AlchemyNativeClient.Insert(System.Byte[],System.Byte[])">
<summary>
</summary>
<param name="tablename"></param>
<param name="valuesList"></param>
</member>
<member name="M:ServiceStack.Redis.RedisNativeClient.AlchemyNativeClient.InsertReturnSize(System.Byte[],System.Byte[])">
<summary>
</summary>
<param name="tablename"></param>
<param name="valuesList"></param>
</member>
<member name="M:ServiceStack.Redis.RedisNativeClient.AlchemyNativeClient.Select(System.Byte[],System.Byte[],System.Byte[])">
<summary>
</summary>
<param name="columnList"></param>
<param name="tablename"></param>
<param name="whereClause"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.RedisNativeClient.AlchemyNativeClient.ScanSelect(System.Byte[],System.Byte[],System.Byte[])">
<summary>
</summary>
<param name="columnList"></param>
<param name="tablename"></param>
<param name="whereClause"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.RedisNativeClient.AlchemyNativeClient.Update(System.Byte[],System.Byte[],System.Byte[])">
<summary>
</summary>
<param name="tablename"></param>
<param name="updateList"></param>
<param name="whereClause"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.RedisNativeClient.AlchemyNativeClient.Delete(System.Byte[],System.Byte[])">
<summary>
</summary>
<param name="tablename"></param>
<param name="whereClause"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.RedisNativeClient.AlchemyNativeClient.Lua(System.Byte[])">
<summary>
</summary>
<param name="command"></param>
</member>
<member name="T:ServiceStack.Redis.BasicRedisClientManager">
<summary>
Provides thread-safe retrievel of redis clients since each client is a new one.
Allows the configuration of different ReadWrite and ReadOnly hosts
</summary>
<summary>
BasicRedisClientManager for ICacheClient
For more interoperabilty I'm also implementing the ICacheClient on
this cache client manager which has the affect of calling
GetCacheClient() for all write operations and GetReadOnlyCacheClient()
for the read ones.
This works well for master-slave replication scenarios where you have
1 master that replicates to multiple read slaves.
</summary>
</member>
<member name="M:ServiceStack.Redis.BasicRedisClientManager.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String})">
<summary>
Hosts can be an IP Address or Hostname in the format: host[:port]
e.g. 127.0.0.1:6379
default is: localhost:6379
</summary>
<param name="readWriteHosts">The write hosts.</param>
<param name="readOnlyHosts">The read hosts.</param>
</member>
<member name="M:ServiceStack.Redis.BasicRedisClientManager.GetClient">
<summary>
Returns a Read/Write client (The default) using the hosts defined in ReadWriteHosts
</summary>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.BasicRedisClientManager.GetReadOnlyClient">
<summary>
Returns a ReadOnly client using the hosts defined in ReadOnlyHosts.
</summary>
<returns></returns>
</member>
<member name="P:ServiceStack.Redis.BasicRedisClientManager.NamespacePrefix">
<summary>
Gets or sets object key prefix.
</summary>
</member>
<member name="T:ServiceStack.Redis.BufferPool">
<summary>
Courtesy of @marcgravell
http://code.google.com/p/protobuf-net/source/browse/trunk/protobuf-net/BufferPool.cs
</summary>
</member>
<member name="T:ServiceStack.Redis.Generic.QueuedRedisTypedCommand`1">
<summary>
A complete redis command, with method to send command, receive response, and run callback on success or failure
</summary>
</member>
<member name="T:ServiceStack.Redis.Generic.RedisTypedClient`1">
<summary>
Allows you to get Redis value operations to operate against POCO types.
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="M:ServiceStack.Redis.Generic.RedisTypedClient`1.#ctor(ServiceStack.Redis.RedisClient)">
<summary>
Use this to share the same redis connection with another
</summary>
<param name="client">The client.</param>
</member>
<member name="T:ServiceStack.Redis.RedisTypedPipeline`1">
<summary>
Pipeline for redis typed client
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:ServiceStack.Redis.Generic.RedisTypedCommandQueue`1">
<summary>
Queue of commands for redis typed client
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:ServiceStack.Redis.RedisQueueCompletableOperation">
<summary>
Redis operation (transaction/pipeline) that allows queued commands to be completed
</summary>
</member>
<member name="T:ServiceStack.Redis.Messaging.RedisMqHost">
<summary>
Creates an MQ Host that processes all messages on a single background thread.
i.e. If you register 3 handlers it will only create 1 background thread.
The same background thread that listens to the Redis MQ Subscription for new messages
also cycles through each registered handler processing all pending messages one-at-a-time:
first in the message PriorityQ, then in the normal message InQ.
The Start/Stop methods are idempotent i.e. It's safe to call them repeatedly on multiple threads
and the Redis MQ Host will only have Started/Stopped once.
</summary>
</member>
<member name="P:ServiceStack.Redis.Messaging.RedisMqHost.ReplyClientFactory">
<summary>
Inject your own Reply Client Factory to handle custom Message.ReplyTo urls.
</summary>
</member>
<member name="T:ServiceStack.Redis.Messaging.RedisMqServer">
<summary>
Creates a Redis MQ Server that processes each message on its own background thread.
i.e. if you register 3 handlers it will create 7 background threads:
- 1 listening to the Redis MQ Subscription, getting notified of each new message
- 3x1 Normal InQ for each message handler
- 3x1 PriorityQ for each message handler
When RedisMqServer Starts it creates a background thread subscribed to the Redis MQ Topic that
listens for new incoming messages. It also starts 2 background threads for each message type:
- 1 for processing the services Priority Queue and 1 processing the services normal Inbox Queue.
Priority Queue's can be enabled on a message-per-message basis by specifying types in the
OnlyEnablePriortyQueuesForTypes property. The DisableAllPriorityQueues property disables all Queues.
The Start/Stop methods are idempotent i.e. It's safe to call them repeatedly on multiple threads
and the Redis MQ Server will only have Started or Stopped once.
</summary>
</member>
<member name="P:ServiceStack.Redis.Messaging.RedisMqServer.RequestFilter">
<summary>
Execute global transformation or custom logic before a request is processed.
Must be thread-safe.
</summary>
</member>
<member name="P:ServiceStack.Redis.Messaging.RedisMqServer.ResponseFilter">
<summary>
Execute global transformation or custom logic on the response.
Must be thread-safe.
</summary>
</member>
<member name="P:ServiceStack.Redis.Messaging.RedisMqServer.ErrorHandler">
<summary>
Execute global error handler logic. Must be thread-safe.
</summary>
</member>
<member name="P:ServiceStack.Redis.Messaging.RedisMqServer.OnlyEnablePriortyQueuesForTypes">
<summary>
If you only want to enable priority queue handlers (and threads) for specific msg types
</summary>
</member>
<member name="P:ServiceStack.Redis.Messaging.RedisMqServer.DisableAllPriorityQueues">
<summary>
Don't listen on any Priority Queues
</summary>
</member>
<member name="M:ServiceStack.Redis.RedisClientManagerCacheClient.Dispose">
<summary>
Ignore dispose on RedisClientsManager, which should be registered as a singleton
</summary>
</member>
<member name="T:ServiceStack.Redis.RedisClientsManagerExtensions">
<summary>
Useful wrapper IRedisClientsManager to cut down the boiler plat of most IRedisClient access
</summary>
</member>
<member name="T:ServiceStack.Redis.Pipeline.QueuedRedisCommand">
<summary>
A complete redis command, with method to send command, receive response, and run callback on success or failure
</summary>
</member>
<member name="T:ServiceStack.Redis.RedisCommand">
<summary>
Redis command that does not get queued
</summary>
</member>
<member name="T:ServiceStack.Redis.RedisClient">
<summary>
The client wraps the native redis operations into a more readable c# API.
Where possible these operations are also exposed in common c# interfaces,
e.g. RedisClient.Lists => IList[string]
RedisClient.Sets => ICollection[string]
</summary>
</member>
<member name="M:ServiceStack.Redis.RedisClient.New">
<summary>
Creates a new instance of the Redis Client from NewFactoryFn.
</summary>
</member>
<member name="M:ServiceStack.Redis.RedisClient.UrnKey``1(``0)">
<summary>
Returns key with automatic object id detection in provided value with <typeparam name="T">generic type</typeparam>.
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.RedisClient.UrnKey``1(System.Object)">
<summary>
Returns key with explicit object id.
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.RedisClient.UrnKey(System.Type,System.Object)">
<summary>
Returns key with explicit object type and id.
</summary>
<param name="type"></param>
<param name="id"></param>
<returns></returns>
</member>
<member name="T:ServiceStack.Redis.ShardedConnectionPool">
<summary>
Provides a redis connection pool that can be sharded
</summary>
</member>
<member name="T:ServiceStack.Redis.PooledRedisClientManager">
<summary>
For interoperabilty GetCacheClient() and GetReadOnlyCacheClient()
return an ICacheClient wrapper around the redis manager which has the affect of calling
GetClient() for all write operations and GetReadOnlyClient() for the read ones.
This works well for master-slave replication scenarios where you have
1 master that replicates to multiple read slaves.
</summary>
<summary>
Provides thread-safe pooling of redis client connections.
Allows load-balancing of master-write and read-slave hosts, ideal for
1 master and multiple replicated read slaves.
</summary>
</member>
<member name="M:ServiceStack.Redis.PooledRedisClientManager.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},ServiceStack.Redis.RedisClientManagerConfig)">
<summary>
Hosts can be an IP Address or Hostname in the format: host[:port]
e.g. 127.0.0.1:6379
default is: localhost:6379
</summary>
<param name="readWriteHosts">The write hosts.</param>
<param name="readOnlyHosts">The read hosts.</param>
<param name="config">The config.</param>
</member>
<member name="M:ServiceStack.Redis.PooledRedisClientManager.GetClient">
<summary>
Returns a Read/Write client (The default) using the hosts defined in ReadWriteHosts
</summary>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.PooledRedisClientManager.GetInActiveWriteClient">
<summary>
Called within a lock
</summary>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.PooledRedisClientManager.GetReadOnlyClient">
<summary>
Returns a ReadOnly client using the hosts defined in ReadOnlyHosts.
</summary>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.PooledRedisClientManager.GetInActiveReadClient">
<summary>
Called within a lock
</summary>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.PooledRedisClientManager.DisposeReadOnlyClient(ServiceStack.Redis.RedisNativeClient)">
<summary>
Disposes the read only client.
</summary>
<param name="client">The client.</param>
</member>
<member name="M:ServiceStack.Redis.PooledRedisClientManager.DisposeWriteClient(ServiceStack.Redis.RedisNativeClient)">
<summary>
Disposes the write client.
</summary>
<param name="client">The client.</param>
</member>
<member name="P:ServiceStack.Redis.PooledRedisClientManager.NamespacePrefix">
<summary>
Gets or sets object key prefix.
</summary>
</member>
<member name="T:ServiceStack.Redis.PooledRedisClientManager.DisposablePooledClient`1">
<summary>
Manage a client acquired from the PooledRedisClientManager
Dispose method will release the client back to the pool.
</summary>
</member>
<member name="M:ServiceStack.Redis.PooledRedisClientManager.DisposablePooledClient`1.#ctor(ServiceStack.Redis.PooledRedisClientManager)">
<summary>
wrap the acquired client
</summary>
<param name="clientManager"></param>
</member>
<member name="M:ServiceStack.Redis.PooledRedisClientManager.DisposablePooledClient`1.Dispose">
<summary>
release the wrapped client back to the pool
</summary>
</member>
<member name="P:ServiceStack.Redis.PooledRedisClientManager.DisposablePooledClient`1.Client">
<summary>
access the wrapped client
</summary>
</member>
<member name="F:ServiceStack.Redis.ShardedConnectionPool.name">
<summary>
logical name
</summary>
</member>
<member name="F:ServiceStack.Redis.ShardedConnectionPool.weight">
<summary>
An arbitrary weight relative to other nodes
</summary>
</member>
<member name="M:ServiceStack.Redis.ShardedConnectionPool.#ctor(System.String,System.Int32,System.String[])">
<param name="name">logical name</param>
<param name="weight">An arbitrary weight relative to other nodes</param>
<param name="readWriteHosts">redis nodes</param>
</member>
<member name="T:ServiceStack.Redis.ShardedRedisClientManager">
<summary>
Provides sharding of redis client connections.
uses consistent hashing to distribute keys across connection pools
</summary>
</member>
<member name="M:ServiceStack.Redis.ShardedRedisClientManager.GetConnectionPool(System.String)">
<summary>
maps a key to a redis connection pool
</summary>
<param name="key">key to map</param>
<returns>a redis connection pool</returns>
</member>
<member name="M:ServiceStack.Redis.Support.ConsistentHash`1.AddTarget(`0,System.Int32)">
<summary>
Adds a node and maps points across the circle
</summary>
<param name="node"> node to add </param>
<param name="weight"> An arbitrary number, specifies how often it occurs relative to other targets. </param>
</member>
<member name="M:ServiceStack.Redis.Support.ConsistentHash`1.ModifiedBinarySearch(System.UInt64[],System.UInt64)">
<summary>
A variation of Binary Search algorithm. Given a number, matches the next highest number from the sorted array.
If a higher number does not exist, then the first number in the array is returned.
</summary>
<param name="sortedArray"> a sorted array to perform the search </param>
<param name="val"> number to find the next highest number against </param>
<returns> next highest number </returns>
</member>
<member name="M:ServiceStack.Redis.Support.ConsistentHash`1.Md5Hash(System.String)">
<summary>
Given a key, generates an unsigned 64 bit hash code using MD5
</summary>
<param name="key"> </param>
<returns> </returns>
</member>
<member name="T:ServiceStack.Redis.Support.Locking.IDistributedLock">
<summary>
Distributed lock interface
</summary>
</member>
<member name="T:ServiceStack.Redis.Support.OptimizedObjectSerializer">
<summary>
Optimized <see cref="T:ServiceStack.Redis.Support.ISerializer"/> implementation. Primitive types are manually serialized, the rest are serialized using binary serializer />.
</summary>
</member>
<member name="T:ServiceStack.Redis.Support.ObjectSerializer">
<summary>
serialize/deserialize arbitrary objects
(objects must be serializable)
</summary>
</member>
<member name="M:ServiceStack.Redis.Support.ObjectSerializer.Serialize(System.Object)">
<summary>
Serialize object to buffer
</summary>
<param name="value">serializable object</param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.Support.ObjectSerializer.Deserialize(System.Byte[])">
<summary>
Deserialize buffer to object
</summary>
<param name="someBytes">byte array to deserialize</param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.Support.OptimizedObjectSerializer.Serialize(System.Object)">
<summary>
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.Support.OptimizedObjectSerializer.Deserialize(System.Byte[])">
<summary>
</summary>
<param name="someBytes"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.Support.OptimizedObjectSerializer.SerializeToWrapper(System.Object)">
<summary>
serialize value and wrap with <see cref="T:ServiceStack.Redis.Support.SerializedObjectWrapper"/>
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.Support.OptimizedObjectSerializer.Unwrap(ServiceStack.Redis.Support.SerializedObjectWrapper)">
<summary>
Unwrap object wrapped in <see cref="T:ServiceStack.Redis.Support.SerializedObjectWrapper"/>
</summary>
<param name="item"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.ISequentialData`1.PopAndUnlock">
<summary>
pop numProcessed items from queue and unlock queue for work item id that dequeued
items are associated with
</summary>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.ISequentialData`1.DoneProcessedWorkItem">
<summary>
A dequeued work item has been processed. When all of the dequeued items have been processed,
all items will be popped from the queue,and the queue unlocked for the work item id that
the dequeued items are associated with
</summary>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.ISequentialData`1.UpdateNextUnprocessed(`0)">
<summary>
Update first unprocessed item with new work item.
</summary>
<param name="newWorkItem"></param>
</member>
<member name="P:ServiceStack.Redis.Support.Queue.ISequentialData`1.DequeueItems">
<summary>
</summary>
</member>
<member name="T:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1">
<summary>
distributed work item queue. Each message must have an associated
work item id. For a given id, all work items are guaranteed to be processed
in the order in which they are received.
</summary>
<summary>
distributed work item queue. Each message must have an associated
work item id. For a given id, all work items are guaranteed to be processed
in the order in which they are received.
</summary>
</member>
<member name="T:ServiceStack.Redis.Support.Queue.Implementation.RedisWorkQueue`1">
<summary>
distributed work item queue
</summary>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.ISequentialWorkQueue`1.Enqueue(System.String,`0)">
<summary>
Enqueue item in priority queue corresponding to workItemId identifier
</summary>
<param name="workItemId"></param>
<param name="workItem"></param>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.ISequentialWorkQueue`1.PrepareNextWorkItem">
<summary>
Preprare next work item id for dequeueing
</summary>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.ISequentialWorkQueue`1.Dequeue(System.Int32)">
<summary>
Dequeue up to maxBatchSize items from queue corresponding to workItemId identifier.
Once this method is called, <see cref="M:ServiceStack.Redis.Support.Queue.ISequentialWorkQueue`1.Dequeue(System.Int32)"/> or <see cref="!:Peek"/> will not
return any items for workItemId until the dequeue lock returned is unlocked.
</summary>
<param name="maxBatchSize"></param>
<param name="defer"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.ISequentialWorkQueue`1.Update(System.String,System.Int32,`0)">
<summary>
Replace existing work item in workItemId queue
</summary>
<param name="workItemId"></param>
<param name="index"></param>
<param name="newWorkItem"></param>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.Enqueue(System.String,`0)">
<summary>
Queue incoming messages
</summary>
<param name="workItem"></param>
<param name="workItemId"></param>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.PrepareNextWorkItem">
<summary>
Must call this periodically to move work items from priority queue to pending queue
</summary>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.Update(System.String,System.Int32,`0)">
<summary>
Replace existing work item in workItemId queue
</summary>
<param name="workItemId"></param>
<param name="index"></param>
<param name="newWorkItem"></param>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.Pop(System.String,System.Int32)">
<summary>
Pop items from list
</summary>
<param name="workItemId"></param>
<param name="itemCount"></param>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.HarvestZombies">
<summary>
Force release of locks held by crashed servers
</summary>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.TryForceReleaseLock(ServiceStack.Redis.Support.Queue.Implementation.SerializingRedisClient,System.String)">
<summary>
release lock held by crashed server
</summary>
<param name="client"></param>
<param name="workItemId"></param>
<returns>true if lock is released, either by this method or by another client; false otherwise</returns>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.Unlock(System.String)">
<summary>
Unlock work item id, so other servers can process items for this id
</summary>
<param name="workItemId"></param>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.DequeueManager.UpdateNextUnprocessed(`0)">
<summary>
</summary>
<param name="newWorkItem"></param>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.DequeueManager.PopAndUnlock(System.Int32,ServiceStack.Redis.IRedisClient)">
<summary>
</summary>
<param name="numProcessed"></param>
<param name="client"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSequentialWorkQueue`1.DequeueManager.PopAndUnlock(System.Int32)">
<summary>
</summary>
<param name="numProcessed"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.SequentialData`1.PopAndUnlock">
<summary>
pop remaining items that were returned by dequeue, and unlock queue
</summary>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.SequentialData`1.DoneProcessedWorkItem">
<summary>
indicate that an item has been processed by the caller
</summary>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.SequentialData`1.UpdateNextUnprocessed(`0)">
<summary>
Update first unprocessed work item
</summary>
<param name="newWorkItem"></param>
</member>
<member name="T:ServiceStack.Redis.Support.SerializedObjectWrapper">
<summary>
wraps a serialized representation of an object
</summary>
</member>
<member name="M:ServiceStack.Redis.Support.SerializedObjectWrapper.#ctor(System.UInt16,System.ArraySegment{System.Byte})">
<summary>
Initializes a new instance of <see cref="T:ServiceStack.Redis.Support.SerializedObjectWrapper"/>.
</summary>
<param name="flags">Custom item data.</param>
<param name="data">The serialized item.</param>
</member>
<member name="P:ServiceStack.Redis.Support.SerializedObjectWrapper.Data">
<summary>
The data representing the item being stored/retireved.
</summary>
</member>
<member name="P:ServiceStack.Redis.Support.SerializedObjectWrapper.Flags">
<summary>
Flags set for this instance.
</summary>
</member>
<member name="T:ServiceStack.Redis.Support.Locking.DisposableDistributedLock">
<summary>
distributed lock class that follows the Resource Allocation Is Initialization pattern
</summary>
</member>
<member name="M:ServiceStack.Redis.Support.Locking.DisposableDistributedLock.#ctor(ServiceStack.Redis.IRedisClient,System.String,System.Int32,System.Int32)">
<summary>
Lock
</summary>
<param name="client"></param>
<param name="globalLockKey"></param>
<param name="acquisitionTimeout">in seconds</param>
<param name="lockTimeout">in seconds</param>
</member>
<member name="M:ServiceStack.Redis.Support.Locking.DisposableDistributedLock.Dispose">
<summary>
unlock
</summary>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.ISimpleWorkQueue`1.Enqueue(`0)">
<summary>
Enqueue item
</summary>
<param name="workItem"></param>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.ISimpleWorkQueue`1.Dequeue(System.Int32)">
<summary>
Dequeue up to maxBatchSize items from queue
</summary>
<param name="maxBatchSize"></param>
<returns></returns>
</member>
<member name="T:ServiceStack.Redis.Support.Queue.Implementation.RedisChronologicalWorkQueue`1">
<summary>
distributed work item queue. Messages are processed in chronological order
</summary>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisChronologicalWorkQueue`1.Enqueue(System.String,`0,System.Double)">
<summary>
Enqueue incoming messages
</summary>
<param name="workItem"></param>
<param name="workItemId"></param>
<param name="time"></param>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisChronologicalWorkQueue`1.Dequeue(System.Double,System.Double,System.Int32)">
<summary>
Dequeue next batch of work items
</summary>
<param name="minTime"></param>
<param name="maxTime"></param>
<param name="maxBatchSize"></param>
<returns></returns>
</member>
<member name="T:ServiceStack.Redis.Support.Queue.Implementation.RedisSimpleWorkQueue`1">
<summary>
simple distributed work item queue
</summary>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSimpleWorkQueue`1.Enqueue(`0)">
<summary>
Queue incoming messages
</summary>
<param name="msg"></param>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.RedisSimpleWorkQueue`1.Dequeue(System.Int32)">
<summary>
Dequeue next batch of work items for processing. After this method is called,
no other work items with same id will be available for
dequeuing until PostDequeue is called
</summary>
<returns>KeyValuePair: key is work item id, and value is list of dequeued items.
</returns>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.SerializingRedisClient.Serialize(System.Object)">
<summary>
Serialize object to buffer
</summary>
<param name="value">serializable object</param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.SerializingRedisClient.Serialize(System.Object[])">
<summary>
</summary>
<param name="values">array of serializable objects</param>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.Support.Queue.Implementation.SerializingRedisClient.Deserialize(System.Byte[])">
<summary>
Deserialize buffer to object
</summary>
<param name="someBytes">byte array to deserialize</param>
<returns></returns>
</member>
<!-- Badly formed XML comment ignored for member "M:ServiceStack.Redis.Support.Queue.Implementation.SerializingRedisClient.Deserialize(System.Byte[][])" -->
<member name="P:ServiceStack.Redis.Support.Queue.Implementation.SerializingRedisClient.Serializer">
<summary>
customize the client serializer
</summary>
</member>
<member name="T:ServiceStack.Redis.Support.Queue.Implementation.SerializingRedisClientFactory">
<summary>
Factory to create SerializingRedisClient objects
</summary>
</member>
<member name="T:ServiceStack.Redis.RedisCommandQueue">
<summary>
</summary>
</member>
<member name="M:ServiceStack.Redis.RedisAllPurposePipeline.#ctor(ServiceStack.Redis.RedisClient)">
<summary>
General purpose pipeline
</summary>
<param name="redisClient"></param>
</member>
<member name="M:ServiceStack.Redis.RedisAllPurposePipeline.Flush">
<summary>
Flush send buffer, and read responses
</summary>
</member>
<member name="T:ServiceStack.Redis.Generic.RedisClientHash`2">
<summary>
Wrap the common redis set operations under a ICollection[string] interface.
</summary>
</member>
<member name="T:ServiceStack.Redis.Generic.RedisTypedTransaction`1">
<summary>
Adds support for Redis Transactions (i.e. MULTI/EXEC/DISCARD operations).
</summary>
</member>
<member name="M:ServiceStack.Redis.Generic.RedisTypedTransaction`1.QueueExpectQueued">
<summary>
Put "QUEUED" messages at back of queue
</summary>
<param name="queued"></param>
</member>
<member name="M:ServiceStack.Redis.Generic.RedisTypedTransaction`1.Exec">
<summary>
Issue exec command (not queued)
</summary>
</member>
<member name="M:ServiceStack.Redis.Generic.RedisTypedTransaction`1.handleMultiDataResultCount(System.Int32)">
<summary>
callback for after result count is read in
</summary>
<param name="count"></param>
</member>
<member name="T:ServiceStack.Redis.Generic.RedisClientSortedSet`1">
<summary>
Wrap the common redis set operations under a ICollection[string] interface.
</summary>
</member>
<member name="T:ServiceStack.Redis.RedisClientHash">
<summary>
Wrap the common redis set operations under a ICollection[string] interface.
</summary>
</member>
<member name="T:ServiceStack.Redis.RedisClientSortedSet">
<summary>
Wrap the common redis set operations under a ICollection[string] interface.
</summary>
</member>
<member name="T:ServiceStack.Redis.Messaging.RedisTransientMessageFactory">
<summary>
Transient message queues are a one-pass message queue service that starts
processing messages when Start() is called. Any subsequent Start() calls
while the service is running is ignored.
The transient service will continue to run until all messages have been
processed after which time it will shutdown all processing until Start() is called again.
</summary>
</member>
<member name="T:ServiceStack.Redis.RedisException">
<summary>
Redis-specific exception. Thrown if unable to connect to Redis server due to socket exception, for example.
</summary>
</member>
<member name="T:ServiceStack.Redis.RedisTransaction">
<summary>
Adds support for Redis Transactions (i.e. MULTI/EXEC/DISCARD operations).
</summary>
</member>
<member name="M:ServiceStack.Redis.RedisTransaction.QueueExpectQueued">
<summary>
Put "QUEUED" messages at back of queue
</summary>
<param name="queued"></param>
</member>
<member name="M:ServiceStack.Redis.RedisTransaction.Exec">
<summary>
Issue exec command (not queued)
</summary>
</member>
<member name="M:ServiceStack.Redis.RedisTransaction.handleMultiDataResultCount(System.Int32)">
<summary>
callback for after result count is read in
</summary>
<param name="count"></param>
</member>
<member name="T:ServiceStack.Redis.RedisClientFactory">
<summary>
Provide the default factory implementation for creating a RedisClient that
can be mocked and used by different 'Redis Client Managers'
</summary>
</member>
<member name="T:ServiceStack.Redis.Generic.RedisClientSet`1">
<summary>
Wrap the common redis set operations under a ICollection[string] interface.
</summary>
</member>
<member name="T:ServiceStack.Redis.RedisCacheClientFactory">
<summary>
Provide the factory implementation for creating a RedisCacheClient that
can be mocked and used by different 'Redis Client Managers'
</summary>
</member>
<member name="T:ServiceStack.Redis.RedisClientSet">
<summary>
Wrap the common redis set operations under a ICollection[string] interface.
</summary>
</member>
<member name="T:ServiceStack.Redis.RedisClientList">
<summary>
Wrap the common redis list operations under a IList[string] interface.
</summary>
</member>
<member name="T:ServiceStack.Redis.Support.IOrderedDictionary`2">
<summary>
Represents a generic collection of key/value pairs that are ordered independently of the key and value.
</summary>
<typeparam name="TKey">The type of the keys in the dictionary</typeparam>
<typeparam name="TValue">The type of the values in the dictionary</typeparam>
</member>
<member name="M:ServiceStack.Redis.Support.IOrderedDictionary`2.Add(`0,`1)">
<summary>
Adds an entry with the specified key and value into the <see cref="T:ServiceStack.Redis.Support.IOrderedDictionary`2">IOrderedDictionary<TKey,TValue></see> collection with the lowest available index.
</summary>
<param name="key">The key of the entry to add.</param>
<param name="value">The value of the entry to add.</param>
<returns>The index of the newly added entry</returns>
<remarks>
<para>You can also use the <see cref="P:System.Collections.Generic.IDictionary{TKey,TValue}.Item(TKey)"/> property to add new elements by setting the value of a key that does not exist in the <see cref="T:ServiceStack.Redis.Support.IOrderedDictionary`2">IOrderedDictionary<TKey,TValue></see> collection; however, if the specified key already exists in the <see cref="T:ServiceStack.Redis.Support.IOrderedDictionary`2">IOrderedDictionary<TKey,TValue></see>, setting the <see cref="P:Item(TKey)"/> property overwrites the old value. In contrast, the <see cref="M:Add"/> method does not modify existing elements.</para></remarks>
<exception cref="T:System.ArgumentException">An element with the same key already exists in the <see cref="T:ServiceStack.Redis.Support.IOrderedDictionary`2">IOrderedDictionary<TKey,TValue></see></exception>
<exception cref="T:System.NotSupportedException">The <see cref="T:ServiceStack.Redis.Support.IOrderedDictionary`2">IOrderedDictionary<TKey,TValue></see> is read-only.<br/>