mirror of
https://github.com/jellyfin/jellyfin.git
synced 2024-09-05 21:37:10 -04:00
342 lines
10 KiB
C#
342 lines
10 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Globalization;
|
|
using System.Linq;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using MediaBrowser.Controller.Net;
|
|
using MediaBrowser.Model.Logging;
|
|
using MediaBrowser.Model.Net;
|
|
using MediaBrowser.Model.Threading;
|
|
|
|
namespace MediaBrowser.Api
|
|
{
|
|
/// <summary>
|
|
/// Starts sending data over a web socket periodically when a message is received, and then stops when a corresponding stop message is received
|
|
/// </summary>
|
|
/// <typeparam name="TReturnDataType">The type of the T return data type.</typeparam>
|
|
/// <typeparam name="TStateType">The type of the T state type.</typeparam>
|
|
public abstract class BasePeriodicWebSocketListener<TReturnDataType, TStateType> : IWebSocketListener, IDisposable
|
|
where TStateType : WebSocketListenerState, new()
|
|
where TReturnDataType : class
|
|
{
|
|
/// <summary>
|
|
/// The _active connections
|
|
/// </summary>
|
|
protected readonly List<Tuple<IWebSocketConnection, CancellationTokenSource, ITimer, TStateType, SemaphoreSlim>> ActiveConnections =
|
|
new List<Tuple<IWebSocketConnection, CancellationTokenSource, ITimer, TStateType, SemaphoreSlim>>();
|
|
|
|
/// <summary>
|
|
/// Gets the name.
|
|
/// </summary>
|
|
/// <value>The name.</value>
|
|
protected abstract string Name { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the data to send.
|
|
/// </summary>
|
|
/// <param name="state">The state.</param>
|
|
/// <returns>Task{`1}.</returns>
|
|
protected abstract Task<TReturnDataType> GetDataToSend(TStateType state);
|
|
|
|
/// <summary>
|
|
/// The logger
|
|
/// </summary>
|
|
protected ILogger Logger;
|
|
|
|
protected ITimerFactory TimerFactory { get; private set; }
|
|
|
|
protected BasePeriodicWebSocketListener(ILogger logger, ITimerFactory timerFactory)
|
|
{
|
|
if (logger == null)
|
|
{
|
|
throw new ArgumentNullException("logger");
|
|
}
|
|
|
|
Logger = logger;
|
|
TimerFactory = timerFactory;
|
|
}
|
|
|
|
/// <summary>
|
|
/// The null task result
|
|
/// </summary>
|
|
protected Task NullTaskResult = Task.FromResult(true);
|
|
|
|
/// <summary>
|
|
/// Processes the message.
|
|
/// </summary>
|
|
/// <param name="message">The message.</param>
|
|
/// <returns>Task.</returns>
|
|
public Task ProcessMessage(WebSocketMessageInfo message)
|
|
{
|
|
if (message == null)
|
|
{
|
|
throw new ArgumentNullException("message");
|
|
}
|
|
|
|
if (string.Equals(message.MessageType, Name + "Start", StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
Start(message);
|
|
}
|
|
|
|
if (string.Equals(message.MessageType, Name + "Stop", StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
Stop(message);
|
|
}
|
|
|
|
return NullTaskResult;
|
|
}
|
|
|
|
protected readonly CultureInfo UsCulture = new CultureInfo("en-US");
|
|
|
|
protected virtual bool SendOnTimer
|
|
{
|
|
get
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
|
|
protected virtual void ParseMessageParams(string[] values)
|
|
{
|
|
|
|
}
|
|
|
|
/// <summary>
|
|
/// Starts sending messages over a web socket
|
|
/// </summary>
|
|
/// <param name="message">The message.</param>
|
|
private void Start(WebSocketMessageInfo message)
|
|
{
|
|
var vals = message.Data.Split(',');
|
|
|
|
var dueTimeMs = long.Parse(vals[0], UsCulture);
|
|
var periodMs = long.Parse(vals[1], UsCulture);
|
|
|
|
if (vals.Length > 2)
|
|
{
|
|
ParseMessageParams(vals.Skip(2).ToArray());
|
|
}
|
|
|
|
var cancellationTokenSource = new CancellationTokenSource();
|
|
|
|
Logger.Debug("{1} Begin transmitting over websocket to {0}", message.Connection.RemoteEndPoint, GetType().Name);
|
|
|
|
var timer = SendOnTimer ?
|
|
TimerFactory.Create(TimerCallback, message.Connection, Timeout.Infinite, Timeout.Infinite) :
|
|
null;
|
|
|
|
var state = new TStateType
|
|
{
|
|
IntervalMs = periodMs,
|
|
InitialDelayMs = dueTimeMs
|
|
};
|
|
|
|
var semaphore = new SemaphoreSlim(1, 1);
|
|
|
|
lock (ActiveConnections)
|
|
{
|
|
ActiveConnections.Add(new Tuple<IWebSocketConnection, CancellationTokenSource, ITimer, TStateType, SemaphoreSlim>(message.Connection, cancellationTokenSource, timer, state, semaphore));
|
|
}
|
|
|
|
if (timer != null)
|
|
{
|
|
timer.Change(TimeSpan.FromMilliseconds(dueTimeMs), TimeSpan.FromMilliseconds(periodMs));
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Timers the callback.
|
|
/// </summary>
|
|
/// <param name="state">The state.</param>
|
|
private void TimerCallback(object state)
|
|
{
|
|
var connection = (IWebSocketConnection)state;
|
|
|
|
Tuple<IWebSocketConnection, CancellationTokenSource, ITimer, TStateType, SemaphoreSlim> tuple;
|
|
|
|
lock (ActiveConnections)
|
|
{
|
|
tuple = ActiveConnections.FirstOrDefault(c => c.Item1 == connection);
|
|
}
|
|
|
|
if (tuple == null)
|
|
{
|
|
return;
|
|
}
|
|
|
|
if (connection.State != WebSocketState.Open || tuple.Item2.IsCancellationRequested)
|
|
{
|
|
DisposeConnection(tuple);
|
|
return;
|
|
}
|
|
|
|
SendData(tuple);
|
|
}
|
|
|
|
protected void SendData(bool force)
|
|
{
|
|
List<Tuple<IWebSocketConnection, CancellationTokenSource, ITimer, TStateType, SemaphoreSlim>> tuples;
|
|
|
|
lock (ActiveConnections)
|
|
{
|
|
tuples = ActiveConnections
|
|
.Where(c =>
|
|
{
|
|
if (c.Item1.State == WebSocketState.Open && !c.Item2.IsCancellationRequested)
|
|
{
|
|
var state = c.Item4;
|
|
|
|
if (force || (DateTime.UtcNow - state.DateLastSendUtc).TotalMilliseconds >= state.IntervalMs)
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
})
|
|
.ToList();
|
|
}
|
|
|
|
foreach (var tuple in tuples)
|
|
{
|
|
SendData(tuple);
|
|
}
|
|
}
|
|
|
|
private async void SendData(Tuple<IWebSocketConnection, CancellationTokenSource, ITimer, TStateType, SemaphoreSlim> tuple)
|
|
{
|
|
var connection = tuple.Item1;
|
|
|
|
try
|
|
{
|
|
await tuple.Item5.WaitAsync(tuple.Item2.Token).ConfigureAwait(false);
|
|
|
|
var state = tuple.Item4;
|
|
|
|
var data = await GetDataToSend(state).ConfigureAwait(false);
|
|
|
|
if (data != null)
|
|
{
|
|
await connection.SendAsync(new WebSocketMessage<TReturnDataType>
|
|
{
|
|
MessageType = Name,
|
|
Data = data
|
|
|
|
}, tuple.Item2.Token).ConfigureAwait(false);
|
|
|
|
state.DateLastSendUtc = DateTime.UtcNow;
|
|
}
|
|
|
|
tuple.Item5.Release();
|
|
}
|
|
catch (OperationCanceledException)
|
|
{
|
|
if (tuple.Item2.IsCancellationRequested)
|
|
{
|
|
DisposeConnection(tuple);
|
|
}
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
Logger.ErrorException("Error sending web socket message {0}", ex, Name);
|
|
DisposeConnection(tuple);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Stops sending messages over a web socket
|
|
/// </summary>
|
|
/// <param name="message">The message.</param>
|
|
private void Stop(WebSocketMessageInfo message)
|
|
{
|
|
lock (ActiveConnections)
|
|
{
|
|
var connection = ActiveConnections.FirstOrDefault(c => c.Item1 == message.Connection);
|
|
|
|
if (connection != null)
|
|
{
|
|
DisposeConnection(connection);
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Disposes the connection.
|
|
/// </summary>
|
|
/// <param name="connection">The connection.</param>
|
|
private void DisposeConnection(Tuple<IWebSocketConnection, CancellationTokenSource, ITimer, TStateType, SemaphoreSlim> connection)
|
|
{
|
|
Logger.Debug("{1} stop transmitting over websocket to {0}", connection.Item1.RemoteEndPoint, GetType().Name);
|
|
|
|
var timer = connection.Item3;
|
|
|
|
if (timer != null)
|
|
{
|
|
try
|
|
{
|
|
timer.Dispose();
|
|
}
|
|
catch (ObjectDisposedException)
|
|
{
|
|
|
|
}
|
|
}
|
|
|
|
try
|
|
{
|
|
connection.Item2.Cancel();
|
|
connection.Item2.Dispose();
|
|
}
|
|
catch (ObjectDisposedException)
|
|
{
|
|
|
|
}
|
|
|
|
try
|
|
{
|
|
connection.Item5.Dispose();
|
|
}
|
|
catch (ObjectDisposedException)
|
|
{
|
|
|
|
}
|
|
|
|
ActiveConnections.Remove(connection);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Releases unmanaged and - optionally - managed resources.
|
|
/// </summary>
|
|
/// <param name="dispose"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
|
|
protected virtual void Dispose(bool dispose)
|
|
{
|
|
if (dispose)
|
|
{
|
|
lock (ActiveConnections)
|
|
{
|
|
foreach (var connection in ActiveConnections.ToList())
|
|
{
|
|
DisposeConnection(connection);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
|
/// </summary>
|
|
public void Dispose()
|
|
{
|
|
Dispose(true);
|
|
}
|
|
}
|
|
|
|
public class WebSocketListenerState
|
|
{
|
|
public DateTime DateLastSendUtc { get; set; }
|
|
public long InitialDelayMs { get; set; }
|
|
public long IntervalMs { get; set; }
|
|
}
|
|
}
|