jellyfin-server/MediaBrowser.Controller/Net/IHttpServer.cs

62 lines
1.8 KiB
C#
Raw Normal View History

using System;
using System.Collections.Generic;
2013-12-07 15:52:38 +00:00
namespace MediaBrowser.Controller.Net
{
/// <summary>
/// Interface IHttpServer
/// </summary>
public interface IHttpServer : IDisposable
{
/// <summary>
/// Gets the URL prefix.
/// </summary>
/// <value>The URL prefix.</value>
2014-01-09 04:44:51 +00:00
IEnumerable<string> UrlPrefixes { get; }
2015-01-19 04:29:57 +00:00
/// <summary>
/// Gets the certificate path.
/// </summary>
/// <value>The certificate path.</value>
string CertificatePath { get; }
/// <summary>
/// Starts the specified server name.
/// </summary>
2014-01-09 04:44:51 +00:00
/// <param name="urlPrefixes">The URL prefixes.</param>
/// <param name="certificatePath">If an https prefix is specified,
/// the ssl certificate localtion on the file system.</param>
void StartServer(IEnumerable<string> urlPrefixes, string certificatePath);
/// <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>
/// Occurs when [web socket connected].
/// </summary>
event EventHandler<WebSocketConnectEventArgs> WebSocketConnected;
2015-03-08 19:48:30 +00:00
/// <summary>
/// Occurs when [web socket connecting].
/// </summary>
event EventHandler<WebSocketConnectingEventArgs> WebSocketConnecting;
/// <summary>
/// Inits this instance.
/// </summary>
void Init(IEnumerable<IRestfulService> services);
2015-09-13 23:07:54 +00:00
/// <summary>
/// If set, all requests will respond with this message
/// </summary>
string GlobalResponse { get; set; }
}
}