diff options
Diffstat (limited to 'MediaBrowser.Controller/Net')
| -rw-r--r-- | MediaBrowser.Controller/Net/IHasResultFactory.cs | 18 | ||||
| -rw-r--r-- | MediaBrowser.Controller/Net/IHttpResultFactory.cs | 98 | ||||
| -rw-r--r-- | MediaBrowser.Controller/Net/IHttpServer.cs | 57 | ||||
| -rw-r--r-- | MediaBrowser.Controller/Net/IRestfulService.cs | 11 |
4 files changed, 184 insertions, 0 deletions
diff --git a/MediaBrowser.Controller/Net/IHasResultFactory.cs b/MediaBrowser.Controller/Net/IHasResultFactory.cs new file mode 100644 index 000000000..a87113d1f --- /dev/null +++ b/MediaBrowser.Controller/Net/IHasResultFactory.cs @@ -0,0 +1,18 @@ +using MediaBrowser.Common.Net; +using ServiceStack.Web; + +namespace MediaBrowser.Controller.Net +{ + /// <summary> + /// Interface IHasResultFactory + /// Services that require a ResultFactory should implement this + /// </summary> + public interface IHasResultFactory : IRequiresRequest + { + /// <summary> + /// Gets or sets the result factory. + /// </summary> + /// <value>The result factory.</value> + IHttpResultFactory ResultFactory { get; set; } + } +} diff --git a/MediaBrowser.Controller/Net/IHttpResultFactory.cs b/MediaBrowser.Controller/Net/IHttpResultFactory.cs new file mode 100644 index 000000000..0614db12e --- /dev/null +++ b/MediaBrowser.Controller/Net/IHttpResultFactory.cs @@ -0,0 +1,98 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Threading.Tasks; +using ServiceStack.Web; + +namespace MediaBrowser.Controller.Net +{ + /// <summary> + /// Interface IHttpResultFactory + /// </summary> + public interface IHttpResultFactory + { + /// <summary> + /// Throws the error. + /// </summary> + /// <param name="statusCode">The status code.</param> + /// <param name="errorMessage">The error message.</param> + /// <param name="responseHeaders">The response headers.</param> + void ThrowError(int statusCode, string errorMessage, IDictionary<string, string> responseHeaders = null); + + /// <summary> + /// Gets the result. + /// </summary> + /// <param name="content">The content.</param> + /// <param name="contentType">Type of the content.</param> + /// <param name="responseHeaders">The response headers.</param> + /// <returns>System.Object.</returns> + object GetResult(object content, string contentType, IDictionary<string,string> responseHeaders = null); + + /// <summary> + /// Gets the optimized result. + /// </summary> + /// <typeparam name="T"></typeparam> + /// <param name="requestContext">The request context.</param> + /// <param name="result">The result.</param> + /// <param name="responseHeaders">The response headers.</param> + /// <returns>System.Object.</returns> + object GetOptimizedResult<T>(IRequest requestContext, T result, IDictionary<string, string> responseHeaders = null) + where T : class; + + /// <summary> + /// Gets the optimized result using cache. + /// </summary> + /// <typeparam name="T"></typeparam> + /// <param name="requestContext">The request context.</param> + /// <param name="cacheKey">The cache key.</param> + /// <param name="lastDateModified">The last date modified.</param> + /// <param name="cacheDuration">Duration of the cache.</param> + /// <param name="factoryFn">The factory function that creates the response object.</param> + /// <param name="responseHeaders">The response headers.</param> + /// <returns>System.Object.</returns> + object GetOptimizedResultUsingCache<T>(IRequest requestContext, Guid cacheKey, DateTime lastDateModified, TimeSpan? cacheDuration, Func<T> factoryFn, IDictionary<string, string> responseHeaders = null) + where T : class; + + /// <summary> + /// Gets the cached result. + /// </summary> + /// <typeparam name="T"></typeparam> + /// <param name="requestContext">The request context.</param> + /// <param name="cacheKey">The cache key.</param> + /// <param name="lastDateModified">The last date modified.</param> + /// <param name="cacheDuration">Duration of the cache.</param> + /// <param name="factoryFn">The factory fn.</param> + /// <param name="contentType">Type of the content.</param> + /// <param name="responseHeaders">The response headers.</param> + /// <returns>System.Object.</returns> + object GetCachedResult<T>(IRequest requestContext, Guid cacheKey, DateTime lastDateModified, TimeSpan? cacheDuration, Func<T> factoryFn, string contentType, IDictionary<string, string> responseHeaders = null) + where T : class; + + /// <summary> + /// Gets the static result. + /// </summary> + /// <param name="requestContext">The request context.</param> + /// <param name="cacheKey">The cache key.</param> + /// <param name="lastDateModified">The last date modified.</param> + /// <param name="cacheDuration">Duration of the cache.</param> + /// <param name="contentType">Type of the content.</param> + /// <param name="factoryFn">The factory fn.</param> + /// <param name="responseHeaders">The response headers.</param> + /// <param name="isHeadRequest">if set to <c>true</c> [is head request].</param> + /// <returns>System.Object.</returns> + object GetStaticResult(IRequest requestContext, Guid cacheKey, DateTime? lastDateModified, + TimeSpan? cacheDuration, string contentType, Func<Task<Stream>> factoryFn, + IDictionary<string, string> responseHeaders = null, bool isHeadRequest = false); + + /// <summary> + /// Gets the static file result. + /// </summary> + /// <param name="requestContext">The request context.</param> + /// <param name="path">The path.</param> + /// <param name="fileShare">The file share.</param> + /// <param name="responseHeaders">The response headers.</param> + /// <param name="isHeadRequest">if set to <c>true</c> [is head request].</param> + /// <returns>System.Object.</returns> + object GetStaticFileResult(IRequest requestContext, string path, FileShare fileShare = FileShare.Read, IDictionary<string, string> responseHeaders = null, bool isHeadRequest = false); + } +} diff --git a/MediaBrowser.Controller/Net/IHttpServer.cs b/MediaBrowser.Controller/Net/IHttpServer.cs new file mode 100644 index 000000000..ba2cd0ccc --- /dev/null +++ b/MediaBrowser.Controller/Net/IHttpServer.cs @@ -0,0 +1,57 @@ +using MediaBrowser.Common.Net; +using System; +using System.Collections.Generic; + +namespace MediaBrowser.Controller.Net +{ + /// <summary> + /// Interface IHttpServer + /// </summary> + public interface IHttpServer : IDisposable + { + /// <summary> + /// Gets the URL prefix. + /// </summary> + /// <value>The URL prefix.</value> + string UrlPrefix { get; } + + /// <summary> + /// Starts the specified server name. + /// </summary> + /// <param name="urlPrefix">The URL.</param> + void StartServer(string urlPrefix); + + /// <summary> + /// Gets a value indicating whether [supports web sockets]. + /// </summary> + /// <value><c>true</c> if [supports web sockets]; otherwise, <c>false</c>.</value> + bool SupportsWebSockets { get; } + + /// <summary> + /// Gets the local end points. + /// </summary> + /// <value>The local end points.</value> + IEnumerable<string> LocalEndPoints { get; } + + /// <summary> + /// Stops this instance. + /// </summary> + void Stop(); + + /// <summary> + /// Gets or sets a value indicating whether [enable HTTP request logging]. + /// </summary> + /// <value><c>true</c> if [enable HTTP request logging]; otherwise, <c>false</c>.</value> + bool EnableHttpRequestLogging { get; set; } + + /// <summary> + /// Occurs when [web socket connected]. + /// </summary> + event EventHandler<WebSocketConnectEventArgs> WebSocketConnected; + + /// <summary> + /// Inits this instance. + /// </summary> + void Init(IEnumerable<IRestfulService> services); + } +}
\ No newline at end of file diff --git a/MediaBrowser.Controller/Net/IRestfulService.cs b/MediaBrowser.Controller/Net/IRestfulService.cs new file mode 100644 index 000000000..f55012b73 --- /dev/null +++ b/MediaBrowser.Controller/Net/IRestfulService.cs @@ -0,0 +1,11 @@ +using ServiceStack; + +namespace MediaBrowser.Controller.Net +{ + /// <summary> + /// Interface IRestfulService + /// </summary> + public interface IRestfulService : IService + { + } +} |
