-
Notifications
You must be signed in to change notification settings - Fork 0
/
ServiceStack.Interfaces.xml
1535 lines (1516 loc) · 70.4 KB
/
ServiceStack.Interfaces.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.Interfaces</name>
</assembly>
<members>
<member name="T:ServiceStack.ServiceHost.RestServiceAttribute">
<summary>
Used to decorate Request DTO's to associate a RESTful request
path mapping with a service. Multiple attributes can be applied to
each request DTO, to map multiple paths to the service.
</summary>
</member>
<member name="M:ServiceStack.ServiceHost.RestServiceAttribute.#ctor(System.String)">
<summary>
<para>Initializes an instance of the <see cref="T:ServiceStack.ServiceHost.RestServiceAttribute"/> class.</para>
</summary>
<param name="path">
<para>The path template to map to the request. See
<see cref="P:ServiceStack.ServiceHost.RestServiceAttribute.Path">RestServiceAttribute.Path</see>
for details on the correct format.</para>
</param>
</member>
<member name="M:ServiceStack.ServiceHost.RestServiceAttribute.#ctor(System.String,System.String)">
<summary>
<para>Initializes an instance of the <see cref="T:ServiceStack.ServiceHost.RestServiceAttribute"/> class.</para>
</summary>
<param name="path">
<para>The path template to map to the request. See
<see cref="P:ServiceStack.ServiceHost.RestServiceAttribute.Path">RestServiceAttribute.Path</see>
for details on the correct format.</para>
</param>
<param name="verbs">A comma-delimited list of HTTP verbs supported by the
service. If unspecified, all verbs are assumed to be supported.</param>
</member>
<member name="M:ServiceStack.ServiceHost.RestServiceAttribute.#ctor(System.String,System.String,System.String)">
<summary>
<para>Initializes an instance of the <see cref="T:ServiceStack.ServiceHost.RestServiceAttribute"/> class.</para>
</summary>
<param name="path">
<para>The path template to map to the request. See
<see cref="P:ServiceStack.ServiceHost.RestServiceAttribute.Path">RestServiceAttribute.Path</see>
for details on the correct format.</para>
</param>
<param name="verbs">A comma-delimited list of HTTP verbs supported by the
service. If unspecified, all verbs are assumed to be supported.</param>
<param name="defaultContentType">The default MIME type in which the response
object returned to the client is formatted, if formatting hints are unspecified
in the URL. Specify <see langword="null"/> or empty to require formatting
hints from the client.</param>
</member>
<member name="P:ServiceStack.ServiceHost.RestServiceAttribute.Path">
<summary>
Gets or sets the path template to be mapped to the request.
</summary>
<value>
A <see cref="T:System.String"/> value providing the path mapped to
the request. Never <see langword="null"/>.
</value>
<remarks>
<para>Some examples of valid paths are:</para>
<list>
<item>"/Inventory"</item>
<item>"/Inventory/{Category}/{ItemId}"</item>
<item>"/Inventory/{ItemPath*}"</item>
</list>
<para>Variables are specified within "{}"
brackets. Each variable in the path is mapped to the same-named property
on the request DTO. At runtime, ServiceStack will parse the
request URL, extract the variable values, instantiate the request DTO,
and assign the variable values into the corresponding request properties,
prior to passing the request DTO to the service object for processing.</para>
<para>It is not necessary to specify all request properties as
variables in the path. For unspecified properties, callers may provide
values in the query string. For example: the URL
"http://services/Inventory?Category=Books&ItemId=12345" causes the same
request DTO to be processed as "http://services/Inventory/Books/12345",
provided that the paths "/Inventory" (which supports the first URL) and
"/Inventory/{Category}/{ItemId}" (which supports the second URL)
are both mapped to the request DTO.</para>
<para>Please note that while it is possible to specify property values
in the query string, it is generally considered to be less RESTful and
less desirable than to specify them as variables in the path. Using the
query string to specify property values may also interfere with HTTP
caching.</para>
<para>The final variable in the path may contain a "*" suffix
to grab all remaining segments in the path portion of the request URL and assign
them to a single property on the request DTO.
For example, if the path "/Inventory/{ItemPath*}" is mapped to the request DTO,
then the request URL "http://services/Inventory/Books/12345" will result
in a request DTO whose ItemPath property contains "Books/12345".
You may only specify one such variable in the path, and it must be positioned at
the end of the path.</para>
</remarks>
</member>
<member name="P:ServiceStack.ServiceHost.RestServiceAttribute.Verbs">
<summary>
Gets or sets a comma-delimited list of HTTP verbs supported by the service, such as
"GET,PUT,POST,DELETE".
</summary>
<value>
A <see cref="T:System.String"/> providing a comma-delimited list of HTTP verbs supported
by the service, <see langword="null"/> or empty if all verbs are supported.
</value>
</member>
<member name="P:ServiceStack.ServiceHost.RestServiceAttribute.DefaultContentType">
<summary>
Gets or sets the default MIME type in which the response
object returned to the client is formatted, when format hints
are not provided in the URI. Some valid examples are such as
"application/json", or "application/xml".
</summary>
<value>
A <see cref="T:System.String"/> providing the default MIME type of the response;
<see langword="null"/> or empty if formatting hints are required
from the client.
</value>
</member>
<member name="T:ServiceStack.Redis.Generic.IRedisTypedQueueableOperation`1">
<summary>
interface to queueable operation using typed redis client
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:ServiceStack.DataAccess.IBasicPersistenceProvider`1">
<summary>
For providers that want a cleaner API with a little more perf
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="M:ServiceStack.Messaging.IMessageQueueClient.Publish(System.String,System.Byte[])">
<summary>
Publish the specified message into the durable queue @queueName
</summary>
<param name="queueName"></param>
<param name="messageBytes"></param>
</member>
<member name="M:ServiceStack.Messaging.IMessageQueueClient.Notify(System.String,System.Byte[])">
<summary>
Publish the specified message into the transient queue @queueName
</summary>
<param name="queueName"></param>
<param name="messageBytes"></param>
</member>
<member name="M:ServiceStack.Messaging.IMessageQueueClient.Get(System.String,System.Nullable{System.TimeSpan})">
<summary>
Synchronous blocking get.
</summary>
<param name="queueName"></param>
<param name="timeOut"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Messaging.IMessageQueueClient.GetAsync(System.String)">
<summary>
Non blocking get message
</summary>
<param name="queueName"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Messaging.IMessageQueueClient.WaitForNotifyOnAny(System.String[])">
<summary>
Blocking wait for notifications on any of the supplied channels
</summary>
<param name="channelNames"></param>
<returns></returns>
</member>
<member name="T:ServiceStack.ServiceHost.IRestPutService`1">
<summary>
If the Service also implements this interface,
IRestPutService.Put() will be used instead of IService.Execute() for
EndpointAttributes.HttpPut requests
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:ServiceStack.ServiceHost.IHttpRequest">
<summary>
A thin wrapper around ASP.NET or HttpListener's HttpRequest
</summary>
</member>
<member name="M:ServiceStack.ServiceHost.IResolver.TryResolve``1">
<summary>
Resolve a dependency from the AppHost's IOC
</summary>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:ServiceStack.ServiceHost.IHttpRequest.GetRawBody">
<summary>
The entire string contents of Request.InputStream
</summary>
<returns></returns>
</member>
<member name="P:ServiceStack.ServiceHost.IHttpRequest.OriginalRequest">
<summary>
The underlying ASP.NET or HttpListener HttpRequest
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IHttpRequest.OperationName">
<summary>
The name of the service being called (e.g. Request DTO Name)
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IHttpRequest.ContentType">
<summary>
The request ContentType
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IHttpRequest.ResponseContentType">
<summary>
The expected Response ContentType for this request
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IHttpRequest.Items">
<summary>
Attach any data to this request that all filters and services can access.
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IHttpRequest.IsSecureConnection">
<summary>
e.g. is https or not
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IHttpRequest.Files">
<summary>
Access to the multi-part/formdata files posted on this request
</summary>
</member>
<member name="M:ServiceStack.Redis.IRedisSubscription.SubscribeToChannels(System.String[])">
<summary>
Subscribe to channels by name
</summary>
<param name="channels"></param>
</member>
<member name="M:ServiceStack.Redis.IRedisSubscription.SubscribeToChannelsMatching(System.String[])">
<summary>
Subscribe to channels matching the supplied patterns
</summary>
<param name="patterns"></param>
</member>
<member name="P:ServiceStack.Redis.IRedisSubscription.SubscriptionCount">
<summary>
The number of active subscriptions this client has
</summary>
</member>
<member name="P:ServiceStack.Redis.IRedisSubscription.OnSubscribe">
<summary>
Registered handler called after client *Subscribes* to each new channel
</summary>
</member>
<member name="P:ServiceStack.Redis.IRedisSubscription.OnMessage">
<summary>
Registered handler called when each message is received
</summary>
</member>
<member name="P:ServiceStack.Redis.IRedisSubscription.OnUnSubscribe">
<summary>
Registered handler called when each channel is unsubscribed
</summary>
</member>
<member name="T:ServiceStack.Redis.Generic.IRedisTypedTransaction`1">
<summary>
Redis transaction for typed client
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:ServiceStack.ServiceHost.IRestPatchService`1">
<summary>
If the Service also implements this interface,
IRestPutService.Patch() will be used instead of IService.Execute() for
EndpointAttributes.HttpPatch requests
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:ServiceStack.ServiceHost.IRequestLogger">
<summary>
Log every service request
</summary>
</member>
<member name="M:ServiceStack.ServiceHost.IRequestLogger.Log(ServiceStack.ServiceHost.IRequestContext,System.Object,System.Object,System.TimeSpan)">
<summary>
Log a request
</summary>
<param name="requestContext">The RequestContext</param>
<param name="requestDto">Request DTO</param>
<param name="response">Response DTO or Exception</param>
<param name="elapsed">How long did the Request take</param>
</member>
<member name="M:ServiceStack.ServiceHost.IRequestLogger.GetLatestLogs(System.Nullable{System.Int32})">
<summary>
View the most recent logs
</summary>
<param name="take"></param>
<returns></returns>
</member>
<member name="P:ServiceStack.ServiceHost.IRequestLogger.EnableSessionTracking">
<summary>
Turn On/Off Session Tracking
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IRequestLogger.EnableResponseTracking">
<summary>
Turn On/Off Tracking of Responses
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IRequestLogger.EnableErrorTracking">
<summary>
Turn On/Off Tracking of Exceptions
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IRequestLogger.RequiredRoles">
<summary>
Limit access to /requestlogs service to role
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IRequestLogger.ExcludeRequestDtoTypes">
<summary>
Don't log requests of these types.
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IRequestLogger.HideRequestBodyForRequestDtoTypes">
<summary>
Don't log request bodys for services with sensitive information.
By default Auth and Registration requests are hidden.
</summary>
</member>
<member name="T:ServiceStack.ServiceHost.IHasRequestFilter">
<summary>
This interface can be implemented by an attribute
which adds an request filter for the specific request DTO the attribute marked.
</summary>
</member>
<member name="M:ServiceStack.ServiceHost.IHasRequestFilter.RequestFilter(ServiceStack.ServiceHost.IHttpRequest,ServiceStack.ServiceHost.IHttpResponse,System.Object)">
<summary>
The request filter is executed before the service.
</summary>
<param name="req">The http request wrapper</param>
<param name="res">The http response wrapper</param>
<param name="requestDto">The request DTO</param>
</member>
<member name="M:ServiceStack.ServiceHost.IHasRequestFilter.Copy">
<summary>
A new shallow copy of this filter is used on every request.
</summary>
<returns></returns>
</member>
<member name="P:ServiceStack.ServiceHost.IHasRequestFilter.Priority">
<summary>
Order in which Request Filters are executed.
<0 Executed before global request filters
>0 Executed after global request filters
</summary>
</member>
<member name="T:ServiceStack.Logging.Support.Logging.TestLogger">
<summary>
Tests logger which stores all log messages in a member list which can be examined later
Made public so its testable
</summary>
</member>
<member name="T:ServiceStack.Logging.ILog">
<summary>
Logs a message in a running application
</summary>
</member>
<member name="M:ServiceStack.Logging.ILog.Debug(System.Object)">
<summary>
Logs a Debug message.
</summary>
<param name="message">The message.</param>
</member>
<member name="M:ServiceStack.Logging.ILog.Debug(System.Object,System.Exception)">
<summary>
Logs a Debug message and exception.
</summary>
<param name="message">The message.</param>
<param name="exception">The exception.</param>
</member>
<member name="M:ServiceStack.Logging.ILog.DebugFormat(System.String,System.Object[])">
<summary>
Logs a Debug format message.
</summary>
<param name="format">The format.</param>
<param name="args">The args.</param>
</member>
<member name="M:ServiceStack.Logging.ILog.Error(System.Object)">
<summary>
Logs a Error message.
</summary>
<param name="message">The message.</param>
</member>
<member name="M:ServiceStack.Logging.ILog.Error(System.Object,System.Exception)">
<summary>
Logs a Error message and exception.
</summary>
<param name="message">The message.</param>
<param name="exception">The exception.</param>
</member>
<member name="M:ServiceStack.Logging.ILog.ErrorFormat(System.String,System.Object[])">
<summary>
Logs a Error format message.
</summary>
<param name="format">The format.</param>
<param name="args">The args.</param>
</member>
<member name="M:ServiceStack.Logging.ILog.Fatal(System.Object)">
<summary>
Logs a Fatal message.
</summary>
<param name="message">The message.</param>
</member>
<member name="M:ServiceStack.Logging.ILog.Fatal(System.Object,System.Exception)">
<summary>
Logs a Fatal message and exception.
</summary>
<param name="message">The message.</param>
<param name="exception">The exception.</param>
</member>
<member name="M:ServiceStack.Logging.ILog.FatalFormat(System.String,System.Object[])">
<summary>
Logs a Error format message.
</summary>
<param name="format">The format.</param>
<param name="args">The args.</param>
</member>
<member name="M:ServiceStack.Logging.ILog.Info(System.Object)">
<summary>
Logs an Info message and exception.
</summary>
<param name="message">The message.</param>
</member>
<member name="M:ServiceStack.Logging.ILog.Info(System.Object,System.Exception)">
<summary>
Logs an Info message and exception.
</summary>
<param name="message">The message.</param>
<param name="exception">The exception.</param>
</member>
<member name="M:ServiceStack.Logging.ILog.InfoFormat(System.String,System.Object[])">
<summary>
Logs an Info format message.
</summary>
<param name="format">The format.</param>
<param name="args">The args.</param>
</member>
<member name="M:ServiceStack.Logging.ILog.Warn(System.Object)">
<summary>
Logs a Warning message.
</summary>
<param name="message">The message.</param>
</member>
<member name="M:ServiceStack.Logging.ILog.Warn(System.Object,System.Exception)">
<summary>
Logs a Warning message and exception.
</summary>
<param name="message">The message.</param>
<param name="exception">The exception.</param>
</member>
<member name="M:ServiceStack.Logging.ILog.WarnFormat(System.String,System.Object[])">
<summary>
Logs a Warning format message.
</summary>
<param name="format">The format.</param>
<param name="args">The args.</param>
</member>
<member name="P:ServiceStack.Logging.ILog.IsDebugEnabled">
<summary>
Gets or sets a value indicating whether this instance is debug enabled.
</summary>
<value>
<c>true</c> if this instance is debug enabled; otherwise, <c>false</c>.
</value>
</member>
<member name="M:ServiceStack.Logging.Support.Logging.TestLogger.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:ServiceStack.Logging.Support.Logging.TestLogger"/> class.
</summary>
<param name="type">The type.</param>
</member>
<member name="M:ServiceStack.Logging.Support.Logging.TestLogger.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:ServiceStack.Logging.Support.Logging.TestLogger"/> class.
</summary>
<param name="type">The type.</param>
</member>
<member name="M:ServiceStack.Logging.Support.Logging.TestLogger.Log(ServiceStack.Logging.Support.Logging.TestLogger.Levels,System.Object,System.Exception)">
<summary>
Logs the specified message.
</summary>
<param name="message">The message.</param>
<param name="exception">The exception.</param>
</member>
<member name="M:ServiceStack.Logging.Support.Logging.TestLogger.LogFormat(ServiceStack.Logging.Support.Logging.TestLogger.Levels,System.Object,System.Object[])">
<summary>
Logs the format.
</summary>
<param name="message">The message.</param>
<param name="args">The args.</param>
</member>
<member name="M:ServiceStack.Logging.Support.Logging.TestLogger.Log(ServiceStack.Logging.Support.Logging.TestLogger.Levels,System.Object)">
<summary>
Logs the specified message.
</summary>
<param name="message">The message.</param>
</member>
<member name="T:ServiceStack.Translators.TranslateAttribute">
<summary>
This instructs the generator tool to generate translator methods for the types supplied.
A {TypeName}.generated.cs partial class will be generated that contains the methods required
to generate to and from that type.
</summary>
</member>
<member name="T:ServiceStack.ServiceInterface.ServiceModel.RequestLogEntry">
<summary>
A log entry added by the IRequestLogger
</summary>
</member>
<member name="T:ServiceStack.ServiceHost.IServiceRoutes">
<summary>
Allow the registration of user-defined routes for services
</summary>
</member>
<member name="M:ServiceStack.ServiceHost.IServiceRoutes.Add``1(System.String)">
<summary>
Maps the specified REST path to the specified request DTO.
</summary>
<typeparam name="TRequest">The type of request DTO to map
the path to.</typeparam>
<param name="restPath">The path to map the request DTO to.
See <see cref="P:ServiceStack.ServiceHost.RestServiceAttribute.Path">RestServiceAttribute.Path</see>
for details on the correct format.</param>
<returns>The same <see cref="T:ServiceStack.ServiceHost.IServiceRoutes"/> instance;
never <see langword="null"/>.</returns>
</member>
<member name="M:ServiceStack.ServiceHost.IServiceRoutes.Add``1(System.String,System.String)">
<summary>
Maps the specified REST path to the specified request DTO, and
specifies the HTTP verbs supported by the path.
</summary>
<typeparam name="TRequest">The type of request DTO to map
the path to.</typeparam>
<param name="restPath">The path to map the request DTO to.
See <see cref="P:ServiceStack.ServiceHost.RestServiceAttribute.Path">RestServiceAttribute.Path</see>
for details on the correct format.</param>
<param name="verbs">
The comma-delimited list of HTTP verbs supported by the path,
such as "GET,PUT,DELETE". Specify empty or <see langword="null"/>
to indicate that all verbs are supported.
</param>
<returns>The same <see cref="T:ServiceStack.ServiceHost.IServiceRoutes"/> instance;
never <see langword="null"/>.</returns>
</member>
<member name="M:ServiceStack.ServiceHost.IServiceRoutes.Add``1(System.String,System.String,System.String)">
<summary>
Maps the specified REST path to the specified request DTO,
specifies the HTTP verbs supported by the path, and indicates
the default MIME type of the returned response.
</summary>
<typeparam name="TRequest">The type of request DTO to map
the path to.</typeparam>
<param name="restPath">The path to map the request DTO to.
See <see cref="P:ServiceStack.ServiceHost.RestServiceAttribute.Path">RestServiceAttribute.Path</see>
for details on the correct format.</param>
<param name="verbs">
The comma-delimited list of HTTP verbs supported by the path,
such as "GET,PUT,DELETE".
</param>
<param name="defaultContentType">
The default MIME type in which the response object returned to the client
is formatted, if formatting hints are not provided by the client.
Specify <see langword="null"/> or empty to require formatting hints from
the client.
</param>
<returns>The same <see cref="T:ServiceStack.ServiceHost.IServiceRoutes"/> instance;
never <see langword="null"/>.</returns>
</member>
<member name="M:ServiceStack.ServiceHost.IServiceRoutes.Add(System.Type,System.String,System.String,System.String)">
<summary>
Maps the specified REST path to the specified request DTO,
specifies the HTTP verbs supported by the path, and indicates
the default MIME type of the returned response.
</summary>
<param name="requestType">
The type of request DTO to map the path to.
</param>
<param name="restPath">The path to map the request DTO to.
See <see cref="P:ServiceStack.ServiceHost.RestServiceAttribute.Path">RestServiceAttribute.Path</see>
for details on the correct format.</param>
<param name="verbs">
The comma-delimited list of HTTP verbs supported by the path,
such as "GET,PUT,DELETE".
</param>
<param name="defaultContentType">
The default MIME type in which the response object returned to the client
is formatted, if formatting hints are not provided by the client.
Specify <see langword="null"/> or empty to require formatting hints from
the client.
</param>
<returns>The same <see cref="T:ServiceStack.ServiceHost.IServiceRoutes"/> instance;
never <see langword="null"/>.</returns>
</member>
<member name="T:ServiceStack.ServiceHost.IServiceController">
<summary>
Responsible for executing the operation within the specified context.
</summary>
<value>The operation types.</value>
</member>
<member name="M:ServiceStack.ServiceHost.IServiceController.GetRestPathForRequest(System.String,System.String)">
<summary>
Returns the first matching RestPath
</summary>
<param name="httpMethod"></param>
<param name="pathInfo"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.ServiceHost.IServiceController.Execute(System.Object,ServiceStack.ServiceHost.IRequestContext)">
<summary>
Executes the DTO request under the supplied requestContext.
</summary>
<param name="request"></param>
<param name="requestContext"></param>
<returns></returns>
</member>
<member name="P:ServiceStack.ServiceHost.IServiceController.OperationTypes">
<summary>
Returns a list of operation types available in this service
</summary>
<value>The operation types.</value>
</member>
<member name="P:ServiceStack.ServiceHost.IServiceController.AllOperationTypes">
<summary>
Returns a list of ALL operation types available in this service
</summary>
<value>The operation types.</value>
</member>
<member name="P:ServiceStack.ServiceHost.IServiceController.Routes">
<summary>
Allow the registration of custom routes
</summary>
</member>
<member name="T:ServiceStack.ServiceHost.IRestDeleteService`1">
<summary>
If the Service also implements this interface,
IRestDeleteService.Delete() will be used instead of IService.Execute() for
EndpointAttributes.HttpDelete requests
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:ServiceStack.ServiceHost.IRequiresRequestContext">
<summary>
Implement on services that need access to the RequestContext
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IHttpResult.StatusCode">
<summary>
The HTTP Response Status Code
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IHttpResult.StatusDescription">
<summary>
The HTTP Status Description
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IHttpResult.ContentType">
<summary>
The HTTP Response ContentType
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IHttpResult.Headers">
<summary>
Additional HTTP Headers
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IHttpResult.Response">
<summary>
Response DTO
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IHttpResult.TemplateName">
<summary>
A specific template, if not the default (for HTML, Markdown, etc. ContentTypes)
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IHttpResult.ResponseFilter">
<summary>
if not provided, get's injected by ServiceStack
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IHttpResult.RequestContext">
<summary>
Holds the request call context
</summary>
</member>
<member name="T:ServiceStack.Redis.Generic.IRedisTypedPipeline`1">
<summary>
Interface to redis typed pipeline
</summary>
</member>
<member name="T:ServiceStack.Redis.Pipeline.IRedisPipelineShared">
<summary>
Pipeline interface shared by typed and non-typed pipelines
</summary>
</member>
<member name="T:ServiceStack.Redis.Pipeline.IRedisQueueCompletableOperation">
<summary>
Interface to operations that allow queued commands to be completed
</summary>
</member>
<member name="T:ServiceStack.Redis.Generic.IRedisList`1">
<summary>
Wrap the common redis list operations under a IList[string] interface.
</summary>
</member>
<member name="T:ServiceStack.Messaging.MessageError">
<summary>
An Error Message Type that can be easily serialized
</summary>
</member>
<member name="T:ServiceStack.Messaging.IMessageService">
<summary>
Simple definition of an MQ Host
</summary>
</member>
<member name="M:ServiceStack.Messaging.IMessageService.RegisterHandler``1(System.Func{ServiceStack.Messaging.IMessage{``0},System.Object})">
<summary>
Register DTOs and hanlders the MQ Host will process
</summary>
<typeparam name="T"></typeparam>
<param name="processMessageFn"></param>
</member>
<member name="M:ServiceStack.Messaging.IMessageService.RegisterHandler``1(System.Func{ServiceStack.Messaging.IMessage{``0},System.Object},System.Action{ServiceStack.Messaging.IMessage{``0},System.Exception})">
<summary>
Register DTOs and hanlders the MQ Host will process
</summary>
<typeparam name="T"></typeparam>
<param name="processMessageFn"></param>
<param name="processExceptionEx"></param>
</member>
<member name="M:ServiceStack.Messaging.IMessageService.GetStats">
<summary>
Get Total Current Stats for all Message Handlers
</summary>
<returns></returns>
</member>
<member name="M:ServiceStack.Messaging.IMessageService.GetStatus">
<summary>
Get the status of the service. Potential Statuses: Disposed, Stopped, Stopping, Starting, Started
</summary>
<returns></returns>
</member>
<member name="M:ServiceStack.Messaging.IMessageService.GetStatsDescription">
<summary>
Get a Stats dump
</summary>
<returns></returns>
</member>
<member name="M:ServiceStack.Messaging.IMessageService.Start">
<summary>
Start the MQ Host if not already started.
</summary>
</member>
<member name="M:ServiceStack.Messaging.IMessageService.Stop">
<summary>
Stop the MQ Host if not already stopped.
</summary>
</member>
<member name="P:ServiceStack.Messaging.IMessageService.MessageFactory">
<summary>
Factory to create consumers and producers that work with this service
</summary>
</member>
<member name="T:ServiceStack.Logging.Support.Logging.DebugLogFactory">
<summary>
Creates a Debug Logger, that logs all messages to: System.Diagnostics.Debug
Made public so its testable
</summary>
</member>
<member name="T:ServiceStack.Logging.ILogFactory">
<summary>
Factory to create ILog instances
</summary>
</member>
<member name="M:ServiceStack.Logging.ILogFactory.GetLogger(System.Type)">
<summary>
Gets the logger.
</summary>
<param name="type">The type.</param>
<returns></returns>
</member>
<member name="M:ServiceStack.Logging.ILogFactory.GetLogger(System.String)">
<summary>
Gets the logger.
</summary>
<param name="typeName">Name of the type.</param>
<returns></returns>
</member>
<member name="T:ServiceStack.DataAccess.IPersistenceProviderManager">
<summary>
Manages a connection to a persistance provider
</summary>
</member>
<member name="M:ServiceStack.Service.IReplyClient.Send``1(System.Object)">
<summary>
Sends the specified request.
</summary>
<param name="request">The request.</param>
<returns></returns>
</member>
<member name="T:ServiceStack.Messaging.UnRetryableMessagingException">
<summary>
For messaging exceptions that should by-pass the messaging service's configured
retry attempts and store the message straight into the DLQ
</summary>
</member>
<member name="T:ServiceStack.Messaging.MessagingException">
<summary>
Base Exception for all ServiceStack.Messaging exceptions
</summary>
</member>
<member name="T:ServiceStack.Configuration.IContainerAdapter">
<summary>
Allow delegation of dependencies to other IOC's
</summary>
</member>
<member name="M:ServiceStack.Configuration.IContainerAdapter.TryResolve``1">
<summary>
Resolve Property Dependency
</summary>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:ServiceStack.Configuration.IContainerAdapter.Resolve``1">
<summary>
Resolve Constructor Dependency
</summary>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="T:ServiceStack.ServiceHost.IAsyncService`1">
<summary>
If the Service also implements this interface,
IAsyncService.ExecuteAsync() will be used instead of IService.Execute() for
EndpointAttributes.AsyncOneWay requests
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:ServiceStack.Redis.Pipeline.IRedisQueueableOperation">
<summary>
interface to operation that can queue commands
</summary>
</member>
<member name="T:ServiceStack.Logging.Support.Logging.NullLogFactory">
<summary>
Creates a Debug Logger, that logs all messages to: System.Diagnostics.Debug
Made public so its testable
</summary>
</member>
<member name="T:ServiceStack.ServiceInterface.ServiceModel.ResponseError">
<summary>
Error information pertaining to a particular named field.
Used for returning multiple field validation errors.s
</summary>
</member>
<member name="T:ServiceStack.ServiceHost.IRestService`1">
<summary>
Utility interface that implements all Rest operations
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:ServiceStack.ServiceHost.IRestGetService`1">
<summary>
If the Service also implements this interface,
IRestGetService.Get() will be used instead of IService.Execute() for
EndpointAttributes.HttpGet requests
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:ServiceStack.ServiceHost.IRestPostService`1">
<summary>
If the Service also implements this interface,
IRestPostService.Post() will be used instead of IService.Execute() for
EndpointAttributes.HttpPost requests
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:ServiceStack.Logging.LogManager">
<summary>
Logging API for this library. You can inject your own implementation otherwise
will use the DebugLogFactory to write to System.Diagnostics.Debug
</summary>
</member>
<member name="M:ServiceStack.Logging.LogManager.GetLogger(System.Type)">
<summary>
Gets the logger.
</summary>
<param name="type">The type.</param>
<returns></returns>
</member>
<member name="M:ServiceStack.Logging.LogManager.GetLogger(System.String)">
<summary>
Gets the logger.
</summary>
<param name="typeName">Name of the type.</param>
<returns></returns>
</member>
<member name="P:ServiceStack.Logging.LogManager.LogFactory">
<summary>
Gets or sets the log factory.
Use this to override the factory that is used to create loggers
</summary>
<value>The log factory.</value>
</member>
<member name="T:ServiceStack.Translators.TranslateMemberAttribute">
<summary>
This changes the default behaviour for the
</summary>
</member>
<member name="T:ServiceStack.Redis.Pipeline.IRedisPipeline">
<summary>
Interface to redis pipeline
</summary>
</member>
<member name="T:ServiceStack.Logging.Support.Logging.TestLogFactory">
<summary>
Creates a test Logger, that stores all log messages in a member list
</summary>
</member>
<member name="T:ServiceStack.CacheAccess.IMemcachedClient">
<summary>
A light interface over a cache client.
This interface was inspired by Enyim.Caching.MemcachedClient
Only the methods that are intended to be used are required, if you require
extra functionality you can uncomment the unused methods below as they have been
implemented in DdnMemcachedClient
</summary>
</member>
<member name="M:ServiceStack.CacheAccess.IMemcachedClient.Remove(System.String)">
<summary>
Removes the specified item from the cache.
</summary>
<param name="key">The identifier for the item to delete.</param>
<returns>
true if the item was successfully removed from the cache; false otherwise.
</returns>
</member>
<member name="M:ServiceStack.CacheAccess.IMemcachedClient.RemoveAll(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Removes the cache for all the keys provided.
</summary>
<param name="keys">The keys.</param>
</member>
<member name="M:ServiceStack.CacheAccess.IMemcachedClient.Get(System.String)">
<summary>
Retrieves the specified item from the cache.
</summary>
<param ICTname="key">The identifier for the item to retrieve.</param>
<returns>
The retrieved item, or <value>null</value> if the key was not found.
</returns>
</member>
<member name="M:ServiceStack.CacheAccess.IMemcachedClient.Increment(System.String,System.UInt32)">
<summary>
Increments the value of the specified key by the given amount. The operation is atomic and happens on the server.
</summary>
<param name="key">The identifier for the item to increment.</param>
<param name="amount">The amount by which the client wants to increase the item.</param>
<returns>
The new value of the item or -1 if not found.
</returns>
<remarks>The item must be inserted into the cache before it can be changed. The item must be inserted as a <see cref="T:System.String"/>. The operation only works with <see cref="T:System.UInt32"/> values, so -1 always indicates that the item was not found.</remarks>
</member>
<member name="M:ServiceStack.CacheAccess.IMemcachedClient.Decrement(System.String,System.UInt32)">
<summary>
Increments the value of the specified key by the given amount. The operation is atomic and happens on the server.
</summary>
<param name="key">The identifier for the item to increment.</param>
<param name="amount">The amount by which the client wants to decrease the item.</param>
<returns>
The new value of the item or -1 if not found.
</returns>
<remarks>The item must be inserted into the cache before it can be changed. The item must be inserted as a <see cref="T:System.String"/>. The operation only works with <see cref="T:System.UInt32"/> values, so -1 always indicates that the item was not found.</remarks>
</member>
<member name="M:ServiceStack.CacheAccess.IMemcachedClient.Add(System.String,System.Object)">
<summary>
Inserts an item into the cache with a cache key to reference its location.
</summary>
<param name="key">The key used to reference the item.</param>
<param name="value">The object to be inserted into the cache.</param>
<returns>
true if the item was successfully stored in the cache; false otherwise.
</returns>
<remarks>The item does not expire unless it is removed due memory pressure.</remarks>
</member>