aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Controller/Net/IHttpServer.cs
blob: 97c5dd31b6164aa03d2c21d3663b67b669a3668d (plain)
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
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>
        IEnumerable<string> UrlPrefixes { get; }

        /// <summary>
        /// Gets the certificate path.
        /// </summary>
        /// <value>The certificate path.</value>
        string CertificatePath { get; }

        /// <summary>
        /// Starts the specified server name.
        /// </summary>
        /// <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>
        /// Stops this instance.
        /// </summary>
        void Stop();

        /// <summary>
        /// Occurs when [web socket connected].
        /// </summary>
        event EventHandler<WebSocketConnectEventArgs> WebSocketConnected;

        /// <summary>
        /// Occurs when [web socket connecting].
        /// </summary>
        event EventHandler<WebSocketConnectingEventArgs> WebSocketConnecting;

        /// <summary>
        /// Inits this instance.
        /// </summary>
        void Init(IEnumerable<IRestfulService> services);

        /// <summary>
        /// If set, all requests will respond with this message
        /// </summary>
        string GlobalResponse { get; set; }
    }
}