88 lines
3.6 KiB
C#
88 lines
3.6 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace MediaBrowser.Common.Net
|
|
{
|
|
/// <summary>
|
|
/// Interface IServerManager
|
|
/// </summary>
|
|
public interface IServerManager : IDisposable
|
|
{
|
|
/// <summary>
|
|
/// Gets a value indicating whether [supports web socket].
|
|
/// </summary>
|
|
/// <value><c>true</c> if [supports web socket]; otherwise, <c>false</c>.</value>
|
|
bool SupportsNativeWebSocket { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the web socket port number.
|
|
/// </summary>
|
|
/// <value>The web socket port number.</value>
|
|
int WebSocketPortNumber { get; }
|
|
|
|
/// <summary>
|
|
/// Starts this instance.
|
|
/// </summary>
|
|
/// <param name="urlPrefix">The URL prefix.</param>
|
|
/// <param name="enableHttpLogging">if set to <c>true</c> [enable HTTP logging].</param>
|
|
void Start(string urlPrefix, bool enableHttpLogging);
|
|
|
|
/// <summary>
|
|
/// Starts the web socket server.
|
|
/// </summary>
|
|
void StartWebSocketServer();
|
|
|
|
/// <summary>
|
|
/// Sends a message to all clients currently connected via a web socket
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
/// <param name="messageType">Type of the message.</param>
|
|
/// <param name="data">The data.</param>
|
|
/// <returns>Task.</returns>
|
|
void SendWebSocketMessage<T>(string messageType, T data);
|
|
|
|
/// <summary>
|
|
/// Sends a message to all clients currently connected via a web socket
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
/// <param name="messageType">Type of the message.</param>
|
|
/// <param name="dataFunction">The function that generates the data to send, if there are any connected clients</param>
|
|
void SendWebSocketMessage<T>(string messageType, Func<T> dataFunction);
|
|
|
|
/// <summary>
|
|
/// Sends a message to all clients currently connected via a web socket
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
/// <param name="messageType">Type of the message.</param>
|
|
/// <param name="dataFunction">The function that generates the data to send, if there are any connected clients</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task.</returns>
|
|
/// <exception cref="System.ArgumentNullException">messageType</exception>
|
|
Task SendWebSocketMessageAsync<T>(string messageType, Func<T> dataFunction, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Sends the web socket message async.
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
/// <param name="messageType">Type of the message.</param>
|
|
/// <param name="dataFunction">The data function.</param>
|
|
/// <param name="connections">The connections.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task.</returns>
|
|
Task SendWebSocketMessageAsync<T>(string messageType, Func<T> dataFunction, IEnumerable<IWebSocketConnection> connections, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Adds the web socket listeners.
|
|
/// </summary>
|
|
/// <param name="listeners">The listeners.</param>
|
|
void AddWebSocketListeners(IEnumerable<IWebSocketListener> listeners);
|
|
|
|
/// <summary>
|
|
/// Gets the web socket connections.
|
|
/// </summary>
|
|
/// <value>The web socket connections.</value>
|
|
IEnumerable<IWebSocketConnection> WebSocketConnections { get; }
|
|
}
|
|
} |