forked from ServiceStack/ServiceStack
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathServiceStack.Text.xml
More file actions
2212 lines (2210 loc) · 112 KB
/
ServiceStack.Text.xml
File metadata and controls
2212 lines (2210 loc) · 112 KB
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.Text</name>
</assembly>
<members>
<member name="T:ServiceStack.Text.AssemblyUtils">
<summary>
Utils to load types
</summary>
</member>
<member name="M:ServiceStack.Text.AssemblyUtils.FindType(System.String)">
<summary>
Find the type from the name supplied
</summary>
<param name="typeName">[typeName] or [typeName, assemblyName]</param>
<returns></returns>
</member>
<member name="M:ServiceStack.Text.AssemblyUtils.MainInterface``1">
<summary>
The top-most interface of the given type, if any.
</summary>
</member>
<member name="M:ServiceStack.Text.AssemblyUtils.FindType(System.String,System.String)">
<summary>
Find type if it exists
</summary>
<param name="typeName"></param>
<param name="assemblyName"></param>
<returns>The type if it exists</returns>
</member>
<member name="M:ServiceStack.AutoMappingUtils.PopulateWith(System.Object)">
<summary>
Populate an object with Example data.
</summary>
<param name="obj"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.AutoMappingUtils.PopulateObjectInternal(System.Object,System.Collections.Generic.Dictionary{System.Type,System.Int32})">
<summary>
Populates the object with example data.
</summary>
<param name="obj"></param>
<param name="recursionInfo">Tracks how deeply nested we are</param>
<returns></returns>
</member>
<member name="T:ServiceStack.Text.ConcurrentDictionaryKey`2">
<summary>
Search key structure for <see cref="T:ServiceStack.Text.ConcurrentDictionary`2"/>
</summary>
<typeparam name="TKey">Type of the key.</typeparam>
<typeparam name="TValue">Type of the value.</typeparam>
</member>
<member name="T:ServiceStack.Text.ConcurrentDictionary`2">
<summary>
A Concurrent <see cref="T:System.Collections.Generic.IDictionary`2"/> implementation.
</summary>
<typeparam name="TKey">Type of the keys.</typeparam>
<typeparam name="TValue">Type of the values.</typeparam>
<remarks>
This class is threadsafe and highly concurrent. This means that multiple threads can do lookup and insert operations
on this dictionary simultaneously.
It is not guaranteed that collisions will not occur. The dictionary is partitioned in segments. A segment contains
a set of items based on a hash of those items. The more segments there are and the beter the hash, the fewer collisions will occur.
This means that a nearly empty ConcurrentDictionary is not as concurrent as one containing many items.
</remarks>
</member>
<member name="T:ServiceStack.Text.ConcurrentHashtable`2">
<summary>
Base class for concurrent hashtable implementations
</summary>
<typeparam name="TStored">Type of the items stored in the hashtable.</typeparam>
<typeparam name="TSearch">Type of the key to search with.</typeparam>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.#ctor">
<summary>
Constructor (protected)
</summary>
<remarks>Use Initialize method after construction.</remarks>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.Initialize">
<summary>
Initialize the newly created ConcurrentHashtable. Invoke in final (sealed) constructor
or Create method.
</summary>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.CreateSegmentRange(System.Int32,System.Int32)">
<summary>
Create a segment range
</summary>
<param name="segmentCount">Number of segments in range.</param>
<param name="initialSegmentSize">Number of slots allocated initialy in each segment.</param>
<returns>The created <see cref="T:ServiceStack.Text.Segmentrange`2"/> instance.</returns>
</member>
<member name="F:ServiceStack.Text.ConcurrentHashtable`2._NewRange">
<summary>
While adjusting the segmentation, _NewRange will hold a reference to the new range of segments.
when the adjustment is complete this reference will be copied to _CurrentRange.
</summary>
</member>
<member name="F:ServiceStack.Text.ConcurrentHashtable`2._CurrentRange">
<summary>
Will hold the most current reange of segments. When busy adjusting the segmentation, this
field will hold a reference to the old range.
</summary>
</member>
<member name="F:ServiceStack.Text.ConcurrentHashtable`2._SwitchPoint">
<summary>
While adjusting the segmentation this field will hold a boundary.
Clients accessing items with a key hash value below this boundary (unsigned compared)
will access _NewRange. The others will access _CurrentRange
</summary>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.GetItemHashCode(`0@)">
<summary>
Get a hashcode for given storeable item.
</summary>
<param name="item">Reference to the item to get a hash value for.</param>
<returns>The hash value as an <see cref="T:System.UInt32"/>.</returns>
<remarks>
The hash returned should be properly randomized hash. The standard GetItemHashCode methods are usually not good enough.
A storeable item and a matching search key should return the same hash code.
So the statement <code>ItemEqualsItem(storeableItem, searchKey) ? GetItemHashCode(storeableItem) == GetItemHashCode(searchKey) : true </code> should always be true;
</remarks>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.GetKeyHashCode(`1@)">
<summary>
Get a hashcode for given search key.
</summary>
<param name="key">Reference to the key to get a hash value for.</param>
<returns>The hash value as an <see cref="T:System.UInt32"/>.</returns>
<remarks>
The hash returned should be properly randomized hash. The standard GetItemHashCode methods are usually not good enough.
A storeable item and a matching search key should return the same hash code.
So the statement <code>ItemEqualsItem(storeableItem, searchKey) ? GetItemHashCode(storeableItem) == GetItemHashCode(searchKey) : true </code> should always be true;
</remarks>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.ItemEqualsKey(`0@,`1@)">
<summary>
Compares a storeable item to a search key. Should return true if they match.
</summary>
<param name="item">Reference to the storeable item to compare.</param>
<param name="key">Reference to the search key to compare.</param>
<returns>True if the storeable item and search key match; false otherwise.</returns>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.ItemEqualsItem(`0@,`0@)">
<summary>
Compares two storeable items for equality.
</summary>
<param name="item1">Reference to the first storeable item to compare.</param>
<param name="item2">Reference to the second storeable item to compare.</param>
<returns>True if the two soreable items should be regarded as equal.</returns>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.IsEmpty(`0@)">
<summary>
Indicates if a specific item reference contains a valid item.
</summary>
<param name="item">The storeable item reference to check.</param>
<returns>True if the reference doesn't refer to a valid item; false otherwise.</returns>
<remarks>The statement <code>IsEmpty(default(TStoredI))</code> should always be true.</remarks>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.GetKeyType(`0@)">
<summary>
Returns the type of the key value or object.
</summary>
<param name="item">The stored item to get the type of the key for.</param>
<returns>The actual type of the key or null if it can not be determined.</returns>
<remarks>
Used for diagnostics purposes.
</remarks>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.GetSegment(System.UInt32)">
<summary>
Gets a segment out of either _NewRange or _CurrentRange based on the hash value.
</summary>
<param name="hash"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.GetSegmentLockedForWriting(System.UInt32)">
<summary>
Gets a LOCKED segment out of either _NewRange or _CurrentRange based on the hash value.
Unlock needs to be called on this segment before it can be used by other clients.
</summary>
<param name="hash"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.GetSegmentLockedForReading(System.UInt32)">
<summary>
Gets a LOCKED segment out of either _NewRange or _CurrentRange based on the hash value.
Unlock needs to be called on this segment before it can be used by other clients.
</summary>
<param name="hash"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.FindItem(`1@,`0@)">
<summary>
Finds an item in the table collection that maches the given searchKey
</summary>
<param name="searchKey">The key to the item.</param>
<param name="item">Out reference to a field that will receive the found item.</param>
<returns>A boolean that will be true if an item has been found and false otherwise.</returns>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.GetOldestItem(`0@,`0@)">
<summary>
Looks for an existing item in the table contents using an alternative copy. If it can be found it will be returned.
If not then the alternative copy will be added to the table contents and the alternative copy will be returned.
</summary>
<param name="searchKey">A copy to search an already existing instance with</param>
<param name="item">Out reference to receive the found item or the alternative copy</param>
<returns>A boolean that will be true if an existing copy was found and false otherwise.</returns>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.ReplaceItem(`1@,`0@,`0@,System.Func{`0,System.Boolean})">
<summary>
Replaces and existing item
</summary>
<param name="newItem"></param>
<param name="oldItem"></param>
<param name="sanction"></param>
<returns>true is the existing item was successfully replaced.</returns>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.InsertItem(`0@,`0@)">
<summary>
Inserts an item in the table contents possibly replacing an existing item.
</summary>
<param name="searchKey">The item to insert in the table</param>
<param name="replacedItem">Out reference to a field that will receive any possibly replaced item.</param>
<returns>A boolean that will be true if an existing copy was found and replaced and false otherwise.</returns>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.RemoveItem(`1@,`0@)">
<summary>
Removes an item from the table contents.
</summary>
<param name="searchKey">The key to find the item with.</param>
<param name="removedItem">Out reference to a field that will receive the found and removed item.</param>
<returns>A boolean that will be rue if an item was found and removed and false otherwise.</returns>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.EnumerateAmorphLockedSegments(System.Boolean)">
<summary>
Enumerates all segments in _CurrentRange and locking them before yielding them and resleasing the lock afterwards
The order in which the segments are returned is undefined.
Lock SyncRoot before using this enumerable.
</summary>
<returns></returns>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.Clear">
<summary>
Removes all items from the collection.
Aquires a lock on SyncRoot before it does it's thing.
When this method returns and multiple threads have access to this table it
is not guaranteed that the table is actually empty.
</summary>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.SegmentationAdjustmentNeeded">
<summary>
Determines if a segmentation adjustment is needed.
</summary>
<returns>True</returns>
</member>
<member name="F:ServiceStack.Text.ConcurrentHashtable`2._AssessSegmentationPending">
<summary>
Bool as int (for interlocked functions) that is true if a Segmentation assesment is pending.
</summary>
</member>
<member name="F:ServiceStack.Text.ConcurrentHashtable`2._AllocatedSpace">
<summary>
The total allocated number of item slots. Filled with nonempty items or not.
</summary>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.EffectTotalAllocatedSpace(System.Int32)">
<summary>
When a segment resizes it uses this method to inform the hashtable of the change in allocated space.
</summary>
<param name="effect"></param>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.ScheduleMaintenance">
<summary>
Schedule a call to the AssessSegmentation() method.
</summary>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.AssessSegmentation(System.Object)">
<summary>
Checks if segmentation needs to be adjusted and if so performs the adjustment.
</summary>
<param name="dummy"></param>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.AssessSegmentation">
<summary>
This method is called when a re-segmentation is expected to be needed. It checks if it actually is needed and, if so, performs the re-segementation.
</summary>
</member>
<member name="M:ServiceStack.Text.ConcurrentHashtable`2.SetSegmentation(System.Int32,System.Int32)">
<summary>
Adjusts the segmentation to the new segment count
</summary>
<param name="newSegmentCount">The new number of segments to use. This must be a power of 2.</param>
<param name="segmentSize">The number of item slots to reserve in each segment.</param>
</member>
<member name="P:ServiceStack.Text.ConcurrentHashtable`2.SyncRoot">
<summary>
Returns an object that serves as a lock for range operations
</summary>
<remarks>
Clients use this primarily for enumerating over the Tables contents.
Locking doesn't guarantee that the contents don't change, but prevents operations that would
disrupt the enumeration process.
Operations that use this lock:
Count, Clear, DisposeGarbage and AssessSegmentation.
Keeping this lock will prevent the table from re-segmenting.
</remarks>
</member>
<member name="P:ServiceStack.Text.ConcurrentHashtable`2.Items">
<summary>
Gets an IEnumerable to iterate over all items in all segments.
</summary>
<returns></returns>
<remarks>
A lock should be aquired and held on SyncRoot while this IEnumerable is being used.
The order in which the items are returned is undetermined.
</remarks>
</member>
<member name="P:ServiceStack.Text.ConcurrentHashtable`2.Count">
<summary>
Returns a count of all items in teh collection. This may not be
aqurate when multiple threads are accessing this table.
Aquires a lock on SyncRoot before it does it's thing.
</summary>
</member>
<member name="P:ServiceStack.Text.ConcurrentHashtable`2.MinSegments">
<summary>
Gives the minimum number of segments a hashtable can contain. This should be 1 or more and always a power of 2.
</summary>
</member>
<member name="P:ServiceStack.Text.ConcurrentHashtable`2.MinSegmentAllocatedSpace">
<summary>
Gives the minimum number of allocated item slots per segment. This should be 1 or more, always a power of 2
and less than 1/2 of MeanSegmentAllocatedSpace.
</summary>
</member>
<member name="P:ServiceStack.Text.ConcurrentHashtable`2.MeanSegmentAllocatedSpace">
<summary>
Gives the prefered number of allocated item slots per segment. This should be 4 or more and always a power of 2.
</summary>
</member>
<member name="M:ServiceStack.Text.ConcurrentDictionary`2.#ctor">
<summary>
Constructs a <see cref="T:ServiceStack.Text.ConcurrentDictionary`2"/> instance using the default <see cref="T:System.Collections.Generic.IEqualityComparer`1"/> to compare keys.
</summary>
</member>
<member name="M:ServiceStack.Text.ConcurrentDictionary`2.#ctor(System.Collections.Generic.IEqualityComparer{`0})">
<summary>
Constructs a <see cref="T:ServiceStack.Text.ConcurrentDictionary`2"/> instance using the specified <see cref="T:System.Collections.Generic.IEqualityComparer`1"/> to compare keys.
</summary>
<param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer`1"/> tp compare keys with.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="comparer"/> is null.</exception>
</member>
<member name="M:ServiceStack.Text.ConcurrentDictionary`2.GetItemHashCode(System.Nullable{System.Collections.Generic.KeyValuePair{`0,`1}}@)">
<summary>
Get a hashcode for given storeable item.
</summary>
<param name="item">Reference to the item to get a hash value for.</param>
<returns>The hash value as an <see cref="T:System.UInt32"/>.</returns>
<remarks>
The hash returned should be properly randomized hash. The standard GetItemHashCode methods are usually not good enough.
A storeable item and a matching search key should return the same hash code.
So the statement <code>ItemEqualsItem(storeableItem, searchKey) ? GetItemHashCode(storeableItem) == GetItemHashCode(searchKey) : true </code> should always be true;
</remarks>
</member>
<member name="M:ServiceStack.Text.ConcurrentDictionary`2.GetKeyHashCode(ServiceStack.Text.ConcurrentDictionaryKey{`0,`1}@)">
<summary>
Get a hashcode for given search key.
</summary>
<param name="key">Reference to the key to get a hash value for.</param>
<returns>The hash value as an <see cref="T:System.UInt32"/>.</returns>
<remarks>
The hash returned should be properly randomized hash. The standard GetItemHashCode methods are usually not good enough.
A storeable item and a matching search key should return the same hash code.
So the statement <code>ItemEqualsItem(storeableItem, searchKey) ? GetItemHashCode(storeableItem) == GetItemHashCode(searchKey) : true </code> should always be true;
</remarks>
</member>
<member name="M:ServiceStack.Text.ConcurrentDictionary`2.ItemEqualsKey(System.Nullable{System.Collections.Generic.KeyValuePair{`0,`1}}@,ServiceStack.Text.ConcurrentDictionaryKey{`0,`1}@)">
<summary>
Compares a storeable item to a search key. Should return true if they match.
</summary>
<param name="item">Reference to the storeable item to compare.</param>
<param name="key">Reference to the search key to compare.</param>
<returns>True if the storeable item and search key match; false otherwise.</returns>
</member>
<member name="M:ServiceStack.Text.ConcurrentDictionary`2.ItemEqualsItem(System.Nullable{System.Collections.Generic.KeyValuePair{`0,`1}}@,System.Nullable{System.Collections.Generic.KeyValuePair{`0,`1}}@)">
<summary>
Compares two storeable items for equality.
</summary>
<param name="item1">Reference to the first storeable item to compare.</param>
<param name="item2">Reference to the second storeable item to compare.</param>
<returns>True if the two soreable items should be regarded as equal.</returns>
</member>
<member name="M:ServiceStack.Text.ConcurrentDictionary`2.IsEmpty(System.Nullable{System.Collections.Generic.KeyValuePair{`0,`1}}@)">
<summary>
Indicates if a specific item reference contains a valid item.
</summary>
<param name="item">The storeable item reference to check.</param>
<returns>True if the reference doesn't refer to a valid item; false otherwise.</returns>
<remarks>The statement <code>IsEmpty(default(TStoredI))</code> should always be true.</remarks>
</member>
<member name="M:ServiceStack.Text.ConcurrentDictionary`2.System#Collections#Generic#IDictionary{TKey@TValue}#Add(`0,`1)">
<summary>
Adds an element with the provided key and value to the dictionary.
</summary>
<param name="key">The object to use as the key of the element to add.</param>
<param name="value">The object to use as the value of the element to add.</param>
<exception cref="T:System.ArgumentException">An element with the same key already exists in the dictionary.</exception>
</member>
<member name="M:ServiceStack.Text.ConcurrentDictionary`2.ContainsKey(`0)">
<summary>
Determines whether the dictionary
contains an element with the specified key.
</summary>
<param name="key">The key to locate in the dictionary.</param>
<returns>true if the dictionary contains
an element with the key; otherwise, false.</returns>
</member>
<member name="M:ServiceStack.Text.ConcurrentDictionary`2.System#Collections#Generic#IDictionary{TKey@TValue}#Remove(`0)">
<summary>
Removes the element with the specified key from the dictionary.
</summary>
<param name="key">The key of the element to remove.</param>
<returns>true if the element is successfully removed; otherwise, false. This method
also returns false if key was not found in the original dictionary.</returns>
</member>
<member name="M:ServiceStack.Text.ConcurrentDictionary`2.TryGetValue(`0,`1@)">
<summary>
Gets the value associated with the specified key.
</summary>
<param name="key">The key whose value to get.</param>
<param name="value">
When this method returns, the value associated with the specified key, if
the key is found; otherwise, the default value for the type of the value
parameter. This parameter is passed uninitialized.
</param>
<returns>
true if the dictionary contains an element with the specified key; otherwise, false.
</returns>
</member>
<member name="M:ServiceStack.Text.ConcurrentDictionary`2.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{TKey@TValue}}#Add(System.Collections.Generic.KeyValuePair{`0,`1})">
<summary>
Adds an association to the dictionary.
</summary>
<param name="item">A <see cref="T:System.Collections.Generic.KeyValuePair`2"/> that represents the association to add.</param>
<exception cref="T:System.ArgumentException">An association with an equal key already exists in the dicitonary.</exception>
</member>
<member name="M:ServiceStack.Text.ConcurrentDictionary`2.Clear">
<summary>
Removes all items from the dictionary.
</summary>
<remarks>WHen working with multiple threads, that each can add items to this dictionary, it is not guaranteed that the dictionary will be empty when this method returns.</remarks>
</member>
<member name="M:ServiceStack.Text.ConcurrentDictionary`2.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{TKey@TValue}}#Contains(System.Collections.Generic.KeyValuePair{`0,`1})">
<summary>
Determines whether the specified association exists in the dictionary.
</summary>
<param name="item">The key-value association to search fo in the dicionary.</param>
<returns>True if item is found in the dictionary; otherwise, false.</returns>
<remarks>
This method compares both key and value. It uses the default equality comparer to compare values.
</remarks>
</member>
<member name="M:ServiceStack.Text.ConcurrentDictionary`2.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{TKey@TValue}}#CopyTo(System.Collections.Generic.KeyValuePair{`0,`1}[],System.Int32)">
<summary>
Copies all associations of the dictionary to an
<see cref="T:System.Array"/>, starting at a particular <see cref="T:System.Array"/> index.
</summary>
<param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of the associations
copied from <see cref="T:ServiceStack.Text.ConcurrentDictionaryKey`2"/>. The <see cref="T:System.Array"/> must
have zero-based indexing.</param>
<param name="arrayIndex">The zero-based index in <paramref name="array"/> at which copying begins.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="array"/> is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="arrayIndex"/> is less than 0.</exception>
<exception cref="T:System.ArgumentException"><paramref name="arrayIndex"/> is equal to or greater than the length of <paramref name="array"/>.</exception>
<exception cref="T:System.ArgumentException">The number of associations to be copied
is greater than the available space from <paramref name="arrayIndex"/> to the end of the destination
<paramref name="array"/>.</exception>
</member>
<member name="M:ServiceStack.Text.ConcurrentDictionary`2.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{TKey@TValue}}#Remove(System.Collections.Generic.KeyValuePair{`0,`1})">
<summary>
Removes the specified association from the <see cref="T:ServiceStack.Text.ConcurrentDictionaryKey`2"/>, comparing both key and value.
</summary>
<param name="item">A <see cref="T:System.Collections.Generic.KeyValuePair`2"/> representing the association to remove.</param>
<returns>true if the association was successfully removed from the <see cref="T:ServiceStack.Text.ConcurrentDictionaryKey`2"/>;
otherwise, false. This method also returns false if the association is not found in
the original <see cref="T:ServiceStack.Text.ConcurrentDictionaryKey`2"/>.
</returns>
</member>
<member name="M:ServiceStack.Text.ConcurrentDictionary`2.GetEnumerator">
<summary>
Returns an enumerator that iterates through all associations in the <see cref="T:ServiceStack.Text.ConcurrentDictionaryKey`2"/> at the moment of invocation.
</summary>
<returns>A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the associations.</returns>
</member>
<member name="M:ServiceStack.Text.ConcurrentDictionary`2.System#Collections#IEnumerable#GetEnumerator">
<summary>
Returns an enumerator that iterates through all associations in the <see cref="T:ServiceStack.Text.ConcurrentDictionaryKey`2"/> at the moment of invocation.
</summary>
<returns>A <see cref="T:System.Collections.IEnumerator"/> that can be used to iterate through the associations.</returns>
</member>
<member name="P:ServiceStack.Text.ConcurrentDictionary`2.Comparer">
<summary>
Gives the <see cref="T:System.Collections.Generic.IEqualityComparer`1"/> of TKey that is used to compare keys.
</summary>
</member>
<member name="P:ServiceStack.Text.ConcurrentDictionary`2.Keys">
<summary>
Gets an <see cref="T:System.Collections.Generic.ICollection`1"/> containing the keys of
the dictionary.
</summary>
<returns>An <see cref="T:System.Collections.Generic.ICollection`1"/> containing the keys of the dictionary.</returns>
<remarks>This property takes a snapshot of the current keys collection of the dictionary at the moment of invocation.</remarks>
</member>
<member name="P:ServiceStack.Text.ConcurrentDictionary`2.Values">
<summary>
Gets an <see cref="T:System.Collections.Generic.ICollection`1"/> containing the values in
the dictionary.
</summary>
<returns>
An <see cref="T:System.Collections.Generic.ICollection`1"/> containing the values in the dictionary.
</returns>
<remarks>This property takes a snapshot of the current keys collection of the dictionary at the moment of invocation.</remarks>
</member>
<member name="P:ServiceStack.Text.ConcurrentDictionary`2.Item(`0)">
<summary>
Gets or sets the value associated with the specified key.
</summary>
<param name="key">The key of the value to get or set.</param>
<returns>The value associated with the specified key. If the specified key is not found, a get operation throws a KeyNotFoundException, and a set operation creates a new element with the specified key.</returns>
<remarks>
When working with multiple threads, that can each potentialy remove the searched for item, a <see cref="T:System.Collections.Generic.KeyNotFoundException"/> can always be expected.
</remarks>
</member>
<member name="P:ServiceStack.Text.ConcurrentDictionary`2.Count">
<summary>
Gets the number of elements contained in the <see cref="T:ServiceStack.Text.ConcurrentDictionaryKey`2"/>.
</summary>
</member>
<member name="P:ServiceStack.Text.ConcurrentDictionary`2.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{TKey@TValue}}#IsReadOnly">
<summary>
Gets a value indicating whether the <see cref="T:ServiceStack.Text.ConcurrentDictionaryKey`2"/> is read-only, which is always false.
</summary>
</member>
<member name="M:ServiceStack.Text.Segment`2.Initialize(System.Int32)">
<summary>
Initialize the segment.
</summary>
<param name="initialSize"></param>
</member>
<member name="M:ServiceStack.Text.Segment`2.Welcome(ServiceStack.Text.ConcurrentHashtable{`0,`1})">
<summary>
When segment gets introduced into hashtable then its allocated space should be added to the
total allocated space.
Single threaded access or locking is needed
</summary>
<param name="traits"></param>
</member>
<member name="M:ServiceStack.Text.Segment`2.Bye(ServiceStack.Text.ConcurrentHashtable{`0,`1})">
<summary>
When segment gets removed from hashtable then its allocated space should be subtracted to the
total allocated space.
Single threaded access or locking is needed
</summary>
<param name="traits"></param>
</member>
<member name="F:ServiceStack.Text.Segment`2._List">
<summary>
Array with 'slots'. Each slot can be filled or empty.
</summary>
</member>
<member name="M:ServiceStack.Text.Segment`2.InsertItemAtIndex(System.UInt32,System.UInt32,`0,ServiceStack.Text.ConcurrentHashtable{`0,`1})">
<summary>
Inserts an item into a *not empty* spot given by position i. It moves items forward until an empty spot is found.
</summary>
<param name="mask"></param>
<param name="i"></param>
<param name="itemCopy"></param>
<param name="traits"></param>
</member>
<member name="M:ServiceStack.Text.Segment`2.FindItem(`1@,`0@,ServiceStack.Text.ConcurrentHashtable{`0,`1})">
<summary>
Find item in segment.
</summary>
<param name="key">Reference to the search key to use.</param>
<param name="item">Out reference to store the found item in.</param>
<param name="traits">Object that tells this segment how to treat items and keys.</param>
<returns>True if an item could be found, otherwise false.</returns>
</member>
<member name="M:ServiceStack.Text.Segment`2.GetOldestItem(`0@,`0@,ServiceStack.Text.ConcurrentHashtable{`0,`1})">
<summary>
Find an existing item or, if it can't be found, insert a new item.
</summary>
<param name="key">Reference to the item that will be inserted if an existing item can't be found. It will also be used to search with.</param>
<param name="item">Out reference to store the found item or, if it can not be found, the new inserted item.</param>
<param name="traits">Object that tells this segment how to treat items and keys.</param>
<returns>True if an existing item could be found, otherwise false.</returns>
</member>
<member name="M:ServiceStack.Text.Segment`2.InsertItem(`0@,`0@,ServiceStack.Text.ConcurrentHashtable{`0,`1})">
<summary>
Inserts an item in the segment, possibly replacing an equal existing item.
</summary>
<param name="key">A reference to the item to insert.</param>
<param name="item">An out reference where any replaced item will be written to, if no item was replaced the new item will be written to this reference.</param>
<param name="traits">Object that tells this segment how to treat items and keys.</param>
<returns>True if an existing item could be found and is replaced, otherwise false.</returns>
</member>
<member name="M:ServiceStack.Text.Segment`2.RemoveItem(`1@,`0@,ServiceStack.Text.ConcurrentHashtable{`0,`1})">
<summary>
Removes an item from the segment.
</summary>
<param name="key">A reference to the key to search with.</param>
<param name="item">An out reference where the removed item will be stored or default(<typeparamref name="TStored"/>) if no item to remove can be found.</param>
<param name="traits">Object that tells this segment how to treat items and keys.</param>
<returns>True if an item could be found and is removed, false otherwise.</returns>
</member>
<member name="M:ServiceStack.Text.Segment`2.GetNextItem(System.Int32,`0@,ServiceStack.Text.ConcurrentHashtable{`0,`1})">
<summary>
Iterate over items in the segment.
</summary>
<param name="beyond">Position beyond which the next filled slot will be found and the item in that slot returned. (Starting with -1)</param>
<param name="item">Out reference where the next item will be stored or default if the end of the segment is reached.</param>
<param name="traits">Object that tells this segment how to treat items and keys.</param>
<returns>The index position the next item has been found or -1 otherwise.</returns>
</member>
<member name="F:ServiceStack.Text.Segment`2._Count">
<summary>
Total numer of filled slots in _List.
</summary>
</member>
<member name="M:ServiceStack.Text.Segment`2.Trim(ServiceStack.Text.ConcurrentHashtable{`0,`1})">
<summary>
Remove any excess allocated space
</summary>
<param name="traits"></param>
</member>
<member name="P:ServiceStack.Text.Segment`2.IsAlive">
<summary>
Boolean value indicating if this segment has not been trashed yet.
</summary>
</member>
<member name="M:ServiceStack.Text.TinyReaderWriterLock.ReleaseForReading">
<summary>
Release a reader lock
</summary>
</member>
<member name="M:ServiceStack.Text.TinyReaderWriterLock.ReleaseForWriting">
<summary>
Release a writer lock
</summary>
</member>
<member name="M:ServiceStack.Text.TinyReaderWriterLock.LockForReading">
<summary>
Aquire a reader lock. Wait until lock is aquired.
</summary>
</member>
<member name="M:ServiceStack.Text.TinyReaderWriterLock.LockForReading(System.Boolean)">
<summary>
Aquire a reader lock.
</summary>
<param name="wait">True if to wait until lock aquired, False to return immediately.</param>
<returns>Boolean indicating if lock was successfuly aquired.</returns>
</member>
<member name="M:ServiceStack.Text.TinyReaderWriterLock.LockForWriting">
<summary>
Aquire a writer lock. Wait until lock is aquired.
</summary>
</member>
<member name="M:ServiceStack.Text.TinyReaderWriterLock.LockForWriting(System.Boolean)">
<summary>
Aquire a writer lock.
</summary>
<param name="wait">True if to wait until lock aquired, False to return immediately.</param>
<returns>Boolean indicating if lock was successfuly aquired.</returns>
</member>
<member name="M:ServiceStack.Text.Common.DateTimeSerializer.Prepare(System.DateTime,System.Boolean)">
<summary>
If AlwaysUseUtc is set to true then convert all DateTime to UTC.
</summary>
<param name="dateTime"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Text.Common.DateTimeSerializer.RepairXsdTimeSeparator(System.String)">
<summary>
Repairs an out-of-spec XML date/time string which incorrectly uses a space instead of a 'T' to separate the date from the time.
These string are occasionally generated by SQLite and can cause errors in OrmLite when reading these columns from the DB.
</summary>
<param name="dateTimeStr">The XML date/time string to repair</param>
<returns>The repaired string. If no repairs were made, the original string is returned.</returns>
</member>
<member name="M:ServiceStack.Text.Common.DateTimeSerializer.ParseWcfJsonDateOffset(System.String)">
<summary>
WCF Json format: /Date(unixts+0000)/
</summary>
<param name="wcfJsonDate"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Text.Common.DateTimeSerializer.ParseWcfJsonDate(System.String)">
<summary>
WCF Json format: /Date(unixts+0000)/
</summary>
<param name="wcfJsonDate"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Text.Common.DeserializeTypeUtils.GetTypeStringConstructor(System.Type)">
<summary>
Get the type(string) constructor if exists
</summary>
<param name="type">The type.</param>
<returns></returns>
</member>
<member name="M:ServiceStack.Text.Common.JsWriter.HasAnyEscapeChars(System.String)">
<summary>
micro optimizations: using flags instead of value.IndexOfAny(EscapeChars)
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="T:ServiceStack.Text.Controller.PathInfo">
<summary>
Class to hold
</summary>
</member>
<!-- Badly formed XML comment ignored for member "M:ServiceStack.Text.Controller.PathInfo.Parse(System.String)" -->
<member name="T:ServiceStack.Text.DateTimeExtensions">
<summary>
A fast, standards-based, serialization-issue free DateTime serailizer.
</summary>
</member>
<member name="M:ServiceStack.Text.ITypeSerializer`1.CanCreateFromString(System.Type)">
<summary>
Determines whether this serializer can create the specified type from a string.
</summary>
<param name="type">The type.</param>
<returns>
<c>true</c> if this instance [can create from string] the specified type; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:ServiceStack.Text.ITypeSerializer`1.DeserializeFromString(System.String)">
<summary>
Parses the specified value.
</summary>
<param name="value">The value.</param>
<returns></returns>
</member>
<member name="M:ServiceStack.Text.ITypeSerializer`1.DeserializeFromReader(System.IO.TextReader)">
<summary>
Deserializes from reader.
</summary>
<param name="reader">The reader.</param>
<returns></returns>
</member>
<member name="M:ServiceStack.Text.ITypeSerializer`1.SerializeToString(`0)">
<summary>
Serializes to string.
</summary>
<param name="value">The value.</param>
<returns></returns>
</member>
<member name="M:ServiceStack.Text.ITypeSerializer`1.SerializeToWriter(`0,System.IO.TextWriter)">
<summary>
Serializes to writer.
</summary>
<param name="value">The value.</param>
<param name="writer">The writer.</param>
</member>
<member name="F:ServiceStack.Text.JsConfig.sTimeSpanHandler">
<summary>
Sets which format to use when serializing TimeSpans
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig.sEmitCamelCaseNames">
<summary>
<see langword="true"/> if the <see cref="T:ServiceStack.Text.Common.ITypeSerializer"/> is configured
to take advantage of <see cref="T:System.CLSCompliantAttribute"/> specification,
to support user-friendly serialized formats, ie emitting camelCasing for JSON
and parsing member names and enum values in a case-insensitive manner.
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig.sEmitLowercaseUnderscoreNames">
<summary>
<see langword="true"/> if the <see cref="T:ServiceStack.Text.Common.ITypeSerializer"/> is configured
to support web-friendly serialized formats, ie emitting lowercase_underscore_casing for JSON
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig.sPropertyConvention">
<summary>
Define how property names are mapped during deserialization
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig.sThrowOnDeserializationError">
<summary>
Gets or sets a value indicating if the framework should throw serialization exceptions
or continue regardless of deserialization errors. If <see langword="true"/> the framework
will throw; otherwise, it will parse as many fields as possible. The default is <see langword="false"/>.
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig.sAlwaysUseUtc">
<summary>
Gets or sets a value indicating if the framework should always convert <see cref="T:System.DateTime"/> to UTC format instead of local time.
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig.sAssumeUtc">
<summary>
Gets or sets a value indicating if the framework should always assume <see cref="T:System.DateTime"/> is in UTC format if Kind is Unspecified.
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig.sAppendUtcOffset">
<summary>
Gets or sets whether we should append the Utc offset when we serialize Utc dates. Defaults to no.
Only supported for when the JsConfig.DateHandler == JsonDateHandler.TimestampOffset
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig.sEscapeUnicode">
<summary>
Gets or sets a value indicating if unicode symbols should be serialized as "\uXXXX".
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig.sIncludePublicFields">
<summary>
If set to true, Interface types will be prefered over concrete types when serializing.
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig.sMaxDepth">
<summary>
Sets the maximum depth to avoid circular dependencies
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig.sModelFactory">
<summary>
Set this to enable your own type construction provider.
This is helpful for integration with IoC containers where you need to call the container constructor.
Return null if you don't know how to construct the type and the parameterless constructor will be used.
</summary>
</member>
<member name="P:ServiceStack.Text.JsConfig.PreferInterfaces">
<summary>
If set to true, Interface types will be prefered over concrete types when serializing.
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig`1.IncludeTypeInfo">
<summary>
Always emit type info for this type. Takes precedence over ExcludeTypeInfo
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig`1.ExcludeTypeInfo">
<summary>
Never emit type info for this type
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig`1.EmitCamelCaseNames">
<summary>
<see langword="true"/> if the <see cref="T:ServiceStack.Text.Common.ITypeSerializer"/> is configured
to take advantage of <see cref="T:System.CLSCompliantAttribute"/> specification,
to support user-friendly serialized formats, ie emitting camelCasing for JSON
and parsing member names and enum values in a case-insensitive manner.
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig`1.serializeFn">
<summary>
Define custom serialization fn for BCL Structs
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig`1.rawSerializeFn">
<summary>
Define custom raw serialization fn
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig`1.onSerializingFn">
<summary>
Define custom serialization hook
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig`1.DeSerializeFn">
<summary>
Define custom deserialization fn for BCL Structs
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig`1.RawDeserializeFn">
<summary>
Define custom raw deserialization fn for objects
</summary>
</member>
<member name="F:ServiceStack.Text.JsConfig`1.ExcludePropertyNames">
<summary>
Exclude specific properties of this type from being serialized
</summary>
</member>
<member name="P:ServiceStack.Text.JsConfig`1.TreatValueAsRefType">
<summary>
Opt-in flag to set some Value Types to be treated as a Ref Type
</summary>
</member>
<member name="P:ServiceStack.Text.JsConfig`1.HasSerializeFn">
<summary>
Whether there is a fn (raw or otherwise)
</summary>
</member>
<member name="F:ServiceStack.Text.PropertyConvention.Strict">
<summary>
The property names on target types must match property names in the JSON source
</summary>
</member>
<member name="F:ServiceStack.Text.PropertyConvention.Lenient">
<summary>
The property names on target types may not match the property names in the JSON source
</summary>
</member>
<member name="F:ServiceStack.Text.TimeSpanHandler.DurationFormat">
<summary>
Uses the xsd format like PT15H10M20S
</summary>
</member>
<member name="F:ServiceStack.Text.TimeSpanHandler.StandardFormat">
<summary>
Uses the standard .net ToString method of the TimeSpan class
</summary>
</member>
<member name="M:ServiceStack.Text.JsonExtensions.Get``1(System.Collections.Generic.Dictionary{System.String,System.String},System.String)">
<summary>
Get JSON string value converted to T
</summary>
</member>
<member name="M:ServiceStack.Text.JsonExtensions.Get(System.Collections.Generic.Dictionary{System.String,System.String},System.String)">
<summary>
Get JSON string value
</summary>
</member>
<member name="M:ServiceStack.Text.JsonObject.GetUnescaped(System.String)">
<summary>
Get unescaped string value
</summary>
</member>
<member name="M:ServiceStack.Text.JsonObject.Child(System.String)">
<summary>
Get unescaped string value
</summary>
</member>
<member name="M:ServiceStack.Text.JsonObject.WriteValue(System.IO.TextWriter,System.Object)">
<summary>
Write JSON Array, Object, bool or number values as raw string
</summary>
</member>
<member name="P:ServiceStack.Text.JsonObject.Item(System.String)">
<summary>
Get JSON string value
</summary>
</member>
<member name="T:ServiceStack.Text.JsonSerializer">
<summary>
Creates an instance of a Type from a string value
</summary>
</member>
<member name="M:ServiceStack.Text.JsonSerializer`1.DeserializeFromString(System.String)">
<summary>
Parses the specified value.
</summary>
<param name="value">The value.</param>
<returns></returns>
</member>
<member name="M:ServiceStack.Text.Json.JsonTypeSerializer.WriteRawString(System.IO.TextWriter,System.String)">
<summary>
Shortcut escape when we're sure value doesn't contain any escaped chars
</summary>
<param name="writer"></param>
<param name="value"></param>
</member>
<member name="M:ServiceStack.Text.Json.JsonTypeSerializer.ConvertFromUtf32(System.Int32)">
<summary>
Given a character as utf32, returns the equivalent string provided that the character
is legal json.
</summary>
<param name="utf32"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Text.Json.JsonUtils.HasAnyEscapeChars(System.String)">
<summary>
micro optimizations: using flags instead of value.IndexOfAny(EscapeChars)
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="T:ServiceStack.Text.Json.JsonWriter`1">
<summary>
Implement the serializer using a more static approach
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:ServiceStack.Text.Jsv.JsvWriter`1">
<summary>
Implement the serializer using a more static approach
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:ServiceStack.Licensing">
<summary>
Public Code API to register commercial license for ServiceStack.
</summary>