You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Sonarr/packages/ServiceStack.Common.3.9.25/lib/sl5/ServiceStack.Interfaces.xml

1344 lines
62 KiB

<?xml version="1.0"?>
<doc>
<assembly>
<name>ServiceStack.Interfaces</name>
</assembly>
<members>
<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.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.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.IHttpResponse">
<summary>
A thin wrapper around ASP.NET or HttpListener's HttpResponse
</summary>
</member>
<member name="M:ServiceStack.ServiceHost.IHttpResponse.Close">
<summary>
Signal that this response has been handled and no more processing should be done.
When used in a request or response filter, no more filters or processing is done on this request.
</summary>
</member>
<member name="M:ServiceStack.ServiceHost.IHttpResponse.End">
<summary>
Calls Response.End() on ASP.NET HttpResponse otherwise is an alias for Close().
Useful when you want to prevent ASP.NET to provide it's own custom error page.
</summary>
</member>
<member name="M:ServiceStack.ServiceHost.IHttpResponse.Flush">
<summary>
Response.Flush() and OutputStream.Flush() seem to have different behaviour in ASP.NET
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IHttpResponse.OriginalResponse">
<summary>
The underlying ASP.NET or HttpListener HttpResponse
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.IHttpResponse.IsClosed">
<summary>
Gets a value indicating whether this instance is closed.
</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.IRedisList`1">
<summary>
Wrap the common redis list operations under a IList[string] interface.
</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.ServiceInterface.ServiceModel.IHasResponseStatus">
<summary>
Contract indication that the Response DTO has a ResponseStatus
</summary>
</member>
<member name="T:ServiceStack.Redis.Pipeline.IRedisQueueableOperation">
<summary>
interface to operation that can queue commands
</summary>
</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.Logging.Support.Logging.ConsoleLogger">
<summary>
Default logger is to Console.WriteLine
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.ConsoleLogger.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:ServiceStack.Logging.Support.Logging.DebugLogger"/> class.
</summary>
<param name="type">The type.</param>
</member>
<member name="M:ServiceStack.Logging.Support.Logging.ConsoleLogger.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:ServiceStack.Logging.Support.Logging.DebugLogger"/> class.
</summary>
<param name="type">The type.</param>
</member>
<member name="M:ServiceStack.Logging.Support.Logging.ConsoleLogger.Log(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.ConsoleLogger.LogFormat(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.ConsoleLogger.Log(System.Object)">
<summary>
Logs the specified message.
</summary>
<param name="message">The message.</param>
</member>
<member name="T:ServiceStack.ServiceHost.IService`1">
<summary>
Base interface all webservices need to implement.
For simplicity this is the only interface you need to implement
</summary>
<typeparam name="T"></typeparam>
</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="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="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.LogicFacade.IServiceModelFinder">
<summary>
The same functionality is on IServiceResolver
</summary>
</member>
<member name="T:ServiceStack.Logging.Support.Logging.ConsoleLogFactory">
<summary>
Creates a Debug Logger, that logs all messages to: System.Diagnostics.Debug
Made public so its testable
</summary>
</member>
<member name="T:ServiceStack.Translators.TranslateExtensionAttribute">
<summary>
This instructs the generator tool to generate translator extension methods for the types supplied.
A {TypeName}.generated.cs static class will be generated that contains the extension methods required
to generate to and from that type.
The source type is what the type the attribute is decorated on which can only be resolved at runtime.
</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.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.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.Redis.Generic.IRedisTypedPipeline`1">
<summary>
Interface to redis typed pipeline
</summary>
</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="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.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="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.ServiceInterface.ServiceModel.ResponseStatus">
<summary>
Common ResponseStatus class that should be present on all response DTO's
</summary>
</member>
<member name="M:ServiceStack.ServiceInterface.ServiceModel.ResponseStatus.#ctor">
<summary>
Initializes a new instance of the <see cref="T:ServiceStack.ServiceInterface.ServiceModel.ResponseStatus"/> class.
A response status without an errorcode == success
</summary>
</member>
<member name="M:ServiceStack.ServiceInterface.ServiceModel.ResponseStatus.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:ServiceStack.ServiceInterface.ServiceModel.ResponseStatus"/> class.
A response status with an errorcode == failure
</summary>
</member>
<member name="M:ServiceStack.ServiceInterface.ServiceModel.ResponseStatus.#ctor(System.String,System.String)">
<summary>
Initializes a new instance of the <see cref="T:ServiceStack.ServiceInterface.ServiceModel.ResponseStatus"/> class.
A response status with an errorcode == failure
</summary>
</member>
<member name="P:ServiceStack.ServiceInterface.ServiceModel.ResponseStatus.ErrorCode">
<summary>
Holds the custom ErrorCode enum if provided in ValidationException
otherwise will hold the name of the Exception type, e.g. typeof(Exception).Name
A value of non-null means the service encountered an error while processing the request.
</summary>
</member>
<member name="P:ServiceStack.ServiceInterface.ServiceModel.ResponseStatus.Message">
<summary>
A human friendly error message
</summary>
</member>
<member name="P:ServiceStack.ServiceInterface.ServiceModel.ResponseStatus.StackTrace">
<summary>
</summary>
</member>
<member name="P:ServiceStack.ServiceInterface.ServiceModel.ResponseStatus.Errors">
<summary>
For multiple detailed validation errors.
Can hold a specific error message for each named field.
</summary>
</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)">
<summary>
Log a request
</summary>
<param name="requestContext"></param>
<param name="requestDto"></param>
</member>
<member name="M:ServiceStack.Redis.IRedisClientCacheManager.GetClient">
<summary>
Returns a Read/Write client (The default) using the hosts defined in ReadWriteHosts
</summary>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.IRedisClientCacheManager.GetReadOnlyClient">
<summary>
Returns a ReadOnly client using the hosts defined in ReadOnlyHosts.
</summary>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.IRedisClientCacheManager.GetCacheClient">
<summary>
Returns a Read/Write ICacheClient (The default) using the hosts defined in ReadWriteHosts
</summary>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.IRedisClientCacheManager.GetReadOnlyCacheClient">
<summary>
Returns a ReadOnly ICacheClient using the hosts defined in ReadOnlyHosts.
</summary>
<returns></returns>
</member>
<member name="T:ServiceStack.Messaging.Message`1">
<summary>
Basic implementation of IMessage[T]
</summary>
<typeparam name="T"></typeparam>
</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="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.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.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>
<member name="M:ServiceStack.CacheAccess.IMemcachedClient.Add(System.String,System.Object,System.DateTime)">
<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>
<param name="expiresAt">The time when the item is invalidated in the cache.</param>
<returns>true if the item was successfully stored in the cache; false otherwise.</returns>
</member>
<member name="M:ServiceStack.CacheAccess.IMemcachedClient.FlushAll">
<summary>
Removes all data from the cache.
</summary>
</member>
<member name="M:ServiceStack.CacheAccess.IMemcachedClient.GetAll(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Retrieves multiple items from the cache.
</summary>
<param name="keys">The list of identifiers for the items to retrieve.</param>
<returns>
a Dictionary holding all items indexed by their key.
</returns>
</member>
<member name="T:ServiceStack.Redis.IRedisTransactionBase">
<summary>
Base transaction interface, shared by typed and non-typed transactions
</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.Logging.Support.Logging.DebugLogger">
<summary>
Default logger is to System.Diagnostics.Debug.WriteLine
Made public so its testable
</summary>
</member>
<member name="M:ServiceStack.Logging.Support.Logging.DebugLogger.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:ServiceStack.Logging.Support.Logging.DebugLogger"/> class.
</summary>
<param name="type">The type.</param>
</member>
<member name="M:ServiceStack.Logging.Support.Logging.DebugLogger.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:ServiceStack.Logging.Support.Logging.DebugLogger"/> class.
</summary>
<param name="type">The type.</param>
</member>
<member name="M:ServiceStack.Logging.Support.Logging.DebugLogger.Log(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.DebugLogger.LogFormat(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.DebugLogger.Log(System.Object)">
<summary>
Logs the specified message.
</summary>
<param name="message">The message.</param>
</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="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.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.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.NullDebugLogger">
<summary>
Default logger is to System.Diagnostics.Debug.Print
Made public so its testable
</summary>
</member>
<member name="M:ServiceStack.Logging.Support.Logging.NullDebugLogger.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:ServiceStack.Logging.Support.Logging.DebugLogger"/> class.
</summary>
<param name="type">The type.</param>
</member>
<member name="M:ServiceStack.Logging.Support.Logging.NullDebugLogger.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:ServiceStack.Logging.Support.Logging.DebugLogger"/> class.
</summary>
<param name="type">The type.</param>
</member>
<member name="M:ServiceStack.Logging.Support.Logging.NullDebugLogger.Log(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.NullDebugLogger.LogFormat(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.NullDebugLogger.Log(System.Object)">
<summary>
Logs the specified message.
</summary>
<param name="message">The message.</param>
</member>
<member name="T:ServiceStack.DataAccess.IPersistenceProviderManager">
<summary>
Manages a connection to a persistance provider
</summary>
</member>
<member name="T:ServiceStack.Translators.TranslateMemberAttribute">
<summary>
This changes the default behaviour for the
</summary>
</member>
<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&amp;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.IRedisTransaction">
<summary>
Interface to redis transaction
</summary>
</member>
<member name="T:ServiceStack.CacheAccess.ICacheClient">
<summary>
A common interface implementation that is implemeneted by most cache providers
</summary>
</member>
<member name="M:ServiceStack.CacheAccess.ICacheClient.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.ICacheClient.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.ICacheClient.Get``1(System.String)">
<summary>
Retrieves the specified item from the cache.
</summary>
<typeparam name="T"></typeparam>
<param name="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.ICacheClient.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.
A non existent value at key starts at 0
</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.ICacheClient.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.
A non existent value at key starts at 0
</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.ICacheClient.Add``1(System.String,``0)">
<summary>
Adds a new item into the cache at the specified cache key only if the cache is empty.
</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>
<member name="M:ServiceStack.CacheAccess.ICacheClient.Set``1(System.String,``0)">
<summary>
Sets an item into the cache at the cache key specified regardless if it already exists or not.
</summary>
</member>
<member name="M:ServiceStack.CacheAccess.ICacheClient.Replace``1(System.String,``0)">
<summary>
Replaces the item at the cachekey specified only if an items exists at the location already.
</summary>
</member>
<member name="M:ServiceStack.CacheAccess.ICacheClient.FlushAll">
<summary>
Invalidates all data on the cache.
</summary>
</member>
<!-- Badly formed XML comment ignored for member "M:ServiceStack.CacheAccess.ICacheClient.GetAll``1(System.Collections.Generic.IEnumerable{System.String})" -->
<member name="M:ServiceStack.CacheAccess.ICacheClient.SetAll``1(System.Collections.Generic.IDictionary{System.String,``0})">
<summary>
Sets multiple items to the cache.
</summary>
<typeparam name="T"></typeparam>
<param name="values">The values.</param>
</member>
<member name="T:ServiceStack.ServiceHost.ServiceAttribute">
<summary>
Used to decorate Request DTO's to alter the behaviour of a service.
</summary>
</member>
<member name="P:ServiceStack.ServiceHost.ServiceAttribute.RestrictAccessTo">
<summary>
Sets a single access restriction
</summary>
<value>The restrict access to.</value>
</member>
<member name="P:ServiceStack.ServiceHost.ServiceAttribute.RestrictAccessToScenarios">
<summary>
Set multiple access scenarios
</summary>
<value>The restrict access to scenarios.</value>
</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.IRedisPipeline">
<summary>
Interface to redis pipeline
</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="M:ServiceStack.Redis.IRedisClientsManager.GetClient">
<summary>
Returns a Read/Write client (The default) using the hosts defined in ReadWriteHosts
</summary>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.IRedisClientsManager.GetReadOnlyClient">
<summary>
Returns a ReadOnly client using the hosts defined in ReadOnlyHosts.
</summary>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.IRedisClientsManager.GetCacheClient">
<summary>
Returns a Read/Write ICacheClient (The default) using the hosts defined in ReadWriteHosts
</summary>
<returns></returns>
</member>
<member name="M:ServiceStack.Redis.IRedisClientsManager.GetReadOnlyCacheClient">
<summary>
Returns a ReadOnly ICacheClient using the hosts defined in ReadOnlyHosts.
</summary>
<returns></returns>
</member>
<member name="T:ServiceStack.Messaging.QueueNames`1">
<summary>
Util static generic class to create unique queue names for types
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:ServiceStack.Messaging.QueueNames">
<summary>
Util class to create unique queue names for runtime types
</summary>
</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.IRequiresRequestContext">
<summary>
Implement on services that need access to the RequestContext
</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.ISession">
<summary>
A Users Session
</summary>
</member>
<member name="M:ServiceStack.CacheAccess.ISession.Set``1(System.String,``0)">
<summary>
Set a typed value at key
</summary>
<typeparam name="T"></typeparam>
<param name="key"></param>
<param name="value"></param>
</member>
<member name="M:ServiceStack.CacheAccess.ISession.Get``1(System.String)">
<summary>
Get a typed value at key
</summary>
<typeparam name="T"></typeparam>
<param name="key"></param>
<returns></returns>
</member>
<member name="P:ServiceStack.CacheAccess.ISession.Item(System.String)">
<summary>
Store any object at key
</summary>
<param name="key"></param>
<returns></returns>
</member>
</members>
</doc>