Fix Websocket OpenApi (#9935)

* Further split inbound and outbound messages

* Fix datatype for inbound start messages

* fixes from review
This commit is contained in:
Cody Robibero 2023-06-29 05:44:36 -06:00 committed by GitHub
parent 76939bbd9b
commit b5bbb98175
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
50 changed files with 165 additions and 126 deletions

View File

@ -9,7 +9,7 @@ using System.Threading;
using System.Threading.Tasks; using System.Threading.Tasks;
using Jellyfin.Extensions.Json; using Jellyfin.Extensions.Json;
using MediaBrowser.Controller.Net; using MediaBrowser.Controller.Net;
using MediaBrowser.Model.Net; using MediaBrowser.Controller.Net.WebSocketMessages;
using MediaBrowser.Model.Session; using MediaBrowser.Model.Session;
using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging;
@ -85,6 +85,18 @@ namespace Emby.Server.Implementations.HttpServer
/// <value>The state.</value> /// <value>The state.</value>
public WebSocketState State => _socket.State; public WebSocketState State => _socket.State;
/// <summary>
/// Sends a message asynchronously.
/// </summary>
/// <param name="message">The message.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
public Task SendAsync(WebSocketMessage message, CancellationToken cancellationToken)
{
var json = JsonSerializer.SerializeToUtf8Bytes(message, _jsonOptions);
return _socket.SendAsync(json, WebSocketMessageType.Text, true, cancellationToken);
}
/// <summary> /// <summary>
/// Sends a message asynchronously. /// Sends a message asynchronously.
/// </summary> /// </summary>
@ -224,7 +236,7 @@ namespace Emby.Server.Implementations.HttpServer
{ {
LastKeepAliveDate = DateTime.UtcNow; LastKeepAliveDate = DateTime.UtcNow;
return SendAsync( return SendAsync(
new WebSocketMessage<string> new OutboundWebSocketMessage
{ {
MessageId = Guid.NewGuid(), MessageId = Guid.NewGuid(),
MessageType = SessionMessageType.KeepAlive MessageType = SessionMessageType.KeepAlive

View File

@ -7,8 +7,8 @@ using System.Net.WebSockets;
using System.Threading; using System.Threading;
using System.Threading.Tasks; using System.Threading.Tasks;
using MediaBrowser.Controller.Net; using MediaBrowser.Controller.Net;
using MediaBrowser.Controller.Net.WebSocketMessages;
using MediaBrowser.Controller.Session; using MediaBrowser.Controller.Session;
using MediaBrowser.Model.Net;
using MediaBrowser.Model.Session; using MediaBrowser.Model.Session;
using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging;
@ -77,7 +77,7 @@ namespace Emby.Server.Implementations.Session
} }
return socket.SendAsync( return socket.SendAsync(
new WebSocketMessage<T> new OutboundWebSocketMessage<T>
{ {
Data = data, Data = data,
MessageType = name, MessageType = name,

View File

@ -9,7 +9,7 @@ using System.Linq;
using System.Net.WebSockets; using System.Net.WebSockets;
using System.Threading; using System.Threading;
using System.Threading.Tasks; using System.Threading.Tasks;
using MediaBrowser.Model.Net; using MediaBrowser.Controller.Net.WebSocketMessages;
using MediaBrowser.Model.Session; using MediaBrowser.Model.Session;
using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging;
@ -169,7 +169,7 @@ namespace MediaBrowser.Controller.Net
if (data is not null) if (data is not null)
{ {
await connection.SendAsync( await connection.SendAsync(
new WebSocketMessage<TReturnDataType> new OutboundWebSocketMessage<TReturnDataType>
{ {
MessageId = Guid.NewGuid(), MessageId = Guid.NewGuid(),
MessageType = Type, MessageType = Type,

View File

@ -5,7 +5,6 @@ using System.Net;
using System.Net.WebSockets; using System.Net.WebSockets;
using System.Threading; using System.Threading;
using System.Threading.Tasks; using System.Threading.Tasks;
using MediaBrowser.Model.Net;
namespace MediaBrowser.Controller.Net namespace MediaBrowser.Controller.Net
{ {

View File

@ -1,4 +1,3 @@
using System;
using System.Text.Json.Serialization; using System.Text.Json.Serialization;
using MediaBrowser.Model.Session; using MediaBrowser.Model.Session;
@ -15,11 +14,6 @@ public abstract class WebSocketMessage
/// </summary> /// </summary>
public virtual SessionMessageType MessageType { get; set; } public virtual SessionMessageType MessageType { get; set; }
/// <summary>
/// Gets or sets the message id.
/// </summary>
public Guid MessageId { get; set; }
/// <summary> /// <summary>
/// Gets or sets the server id. /// Gets or sets the server id.
/// </summary> /// </summary>

View File

@ -1,7 +1,5 @@
#nullable disable #nullable disable
using MediaBrowser.Model.Net;
namespace MediaBrowser.Controller.Net namespace MediaBrowser.Controller.Net
{ {
/// <summary> /// <summary>

View File

@ -1,20 +1,20 @@
using System.Collections.Generic;
using System.ComponentModel; using System.ComponentModel;
using MediaBrowser.Model.Activity;
using MediaBrowser.Model.Session; using MediaBrowser.Model.Session;
namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound; namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound;
/// <summary> /// <summary>
/// Activity log entry start message. /// Activity log entry start message.
/// Data is the timing data encoded as "$initialDelay,$interval" in ms.
/// </summary> /// </summary>
public class ActivityLogEntryStartMessage : WebSocketMessage<IReadOnlyCollection<ActivityLogEntry>>, IInboundWebSocketMessage public class ActivityLogEntryStartMessage : InboundWebSocketMessage<string>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="ActivityLogEntryStartMessage"/> class. /// Initializes a new instance of the <see cref="ActivityLogEntryStartMessage"/> class.
/// Data is the timing data encoded as "$initialDelay,$interval" in ms.
/// </summary> /// </summary>
/// <param name="data">Collection of activity log entries.</param> /// <param name="data">The timing data encoded as "$initialDelay,$interval".</param>
public ActivityLogEntryStartMessage(IReadOnlyCollection<ActivityLogEntry> data) public ActivityLogEntryStartMessage(string data)
: base(data) : base(data)
{ {
} }

View File

@ -1,6 +1,4 @@
using System.Collections.Generic;
using System.ComponentModel; using System.ComponentModel;
using MediaBrowser.Model.Activity;
using MediaBrowser.Model.Session; using MediaBrowser.Model.Session;
namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound; namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound;
@ -8,17 +6,8 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound;
/// <summary> /// <summary>
/// Activity log entry stop message. /// Activity log entry stop message.
/// </summary> /// </summary>
public class ActivityLogEntryStopMessage : WebSocketMessage<IReadOnlyCollection<ActivityLogEntry>>, IInboundWebSocketMessage public class ActivityLogEntryStopMessage : InboundWebSocketMessage
{ {
/// <summary>
/// Initializes a new instance of the <see cref="ActivityLogEntryStopMessage"/> class.
/// </summary>
/// <param name="data">Collection of activity log entries.</param>
public ActivityLogEntryStopMessage(IReadOnlyCollection<ActivityLogEntry> data)
: base(data)
{
}
/// <inheritdoc /> /// <inheritdoc />
[DefaultValue(SessionMessageType.ActivityLogEntryStop)] [DefaultValue(SessionMessageType.ActivityLogEntryStop)]
public override SessionMessageType MessageType => SessionMessageType.ActivityLogEntryStop; public override SessionMessageType MessageType => SessionMessageType.ActivityLogEntryStop;

View File

@ -0,0 +1,14 @@
using System.ComponentModel;
using MediaBrowser.Model.Session;
namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound;
/// <summary>
/// Keep alive websocket messages.
/// </summary>
public class InboundKeepAliveMessage : InboundWebSocketMessage
{
/// <inheritdoc />
[DefaultValue(SessionMessageType.KeepAlive)]
public override SessionMessageType MessageType => SessionMessageType.KeepAlive;
}

View File

@ -1,20 +1,19 @@
using System.Collections.Generic;
using System.ComponentModel; using System.ComponentModel;
using MediaBrowser.Model.Session; using MediaBrowser.Model.Session;
using MediaBrowser.Model.Tasks;
namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound; namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound;
/// <summary> /// <summary>
/// Scheduled tasks info start message. /// Scheduled tasks info start message.
/// Data is the timing data encoded as "$initialDelay,$interval" in ms.
/// </summary> /// </summary>
public class ScheduledTasksInfoStartMessage : WebSocketMessage<IReadOnlyCollection<TaskInfo>>, IInboundWebSocketMessage public class ScheduledTasksInfoStartMessage : InboundWebSocketMessage<string>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="ScheduledTasksInfoStartMessage"/> class. /// Initializes a new instance of the <see cref="ScheduledTasksInfoStartMessage"/> class.
/// </summary> /// </summary>
/// <param name="data">Collection of task info.</param> /// <param name="data">The timing data encoded as $initialDelay,$interval.</param>
public ScheduledTasksInfoStartMessage(IReadOnlyCollection<TaskInfo> data) public ScheduledTasksInfoStartMessage(string data)
: base(data) : base(data)
{ {
} }

View File

@ -1,24 +1,13 @@
using System.Collections.Generic;
using System.ComponentModel; using System.ComponentModel;
using MediaBrowser.Model.Session; using MediaBrowser.Model.Session;
using MediaBrowser.Model.Tasks;
namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound; namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound;
/// <summary> /// <summary>
/// Scheduled tasks info stop message. /// Scheduled tasks info stop message.
/// </summary> /// </summary>
public class ScheduledTasksInfoStopMessage : WebSocketMessage<IReadOnlyCollection<TaskInfo>>, IInboundWebSocketMessage public class ScheduledTasksInfoStopMessage : InboundWebSocketMessage
{ {
/// <summary>
/// Initializes a new instance of the <see cref="ScheduledTasksInfoStopMessage"/> class.
/// </summary>
/// <param name="data">Collection of task info.</param>
public ScheduledTasksInfoStopMessage(IReadOnlyCollection<TaskInfo> data)
: base(data)
{
}
/// <inheritdoc /> /// <inheritdoc />
[DefaultValue(SessionMessageType.ScheduledTasksInfoStop)] [DefaultValue(SessionMessageType.ScheduledTasksInfoStop)]
public override SessionMessageType MessageType => SessionMessageType.ScheduledTasksInfoStop; public override SessionMessageType MessageType => SessionMessageType.ScheduledTasksInfoStop;

View File

@ -1,19 +1,19 @@
using System.ComponentModel; using System.ComponentModel;
using MediaBrowser.Controller.Session;
using MediaBrowser.Model.Session; using MediaBrowser.Model.Session;
namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound; namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound;
/// <summary> /// <summary>
/// Sessions start message. /// Sessions start message.
/// Data is the timing data encoded as "$initialDelay,$interval" in ms.
/// </summary> /// </summary>
public class SessionsStartMessage : WebSocketMessage<SessionInfo>, IInboundWebSocketMessage public class SessionsStartMessage : InboundWebSocketMessage<string>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="SessionsStartMessage"/> class. /// Initializes a new instance of the <see cref="SessionsStartMessage"/> class.
/// </summary> /// </summary>
/// <param name="data">Session info.</param> /// <param name="data">The timing data encoded as $initialDelay,$interval.</param>
public SessionsStartMessage(SessionInfo data) public SessionsStartMessage(string data)
: base(data) : base(data)
{ {
} }

View File

@ -1,5 +1,4 @@
using System.ComponentModel; using System.ComponentModel;
using MediaBrowser.Controller.Session;
using MediaBrowser.Model.Session; using MediaBrowser.Model.Session;
namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound; namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound;
@ -7,17 +6,8 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound;
/// <summary> /// <summary>
/// Sessions stop message. /// Sessions stop message.
/// </summary> /// </summary>
public class SessionsStopMessage : WebSocketMessage<SessionInfo>, IInboundWebSocketMessage public class SessionsStopMessage : InboundWebSocketMessage
{ {
/// <summary>
/// Initializes a new instance of the <see cref="SessionsStopMessage"/> class.
/// </summary>
/// <param name="data">Session info.</param>
public SessionsStopMessage(SessionInfo data)
: base(data)
{
}
/// <inheritdoc /> /// <inheritdoc />
[DefaultValue(SessionMessageType.SessionsStop)] [DefaultValue(SessionMessageType.SessionsStop)]
public override SessionMessageType MessageType => SessionMessageType.SessionsStop; public override SessionMessageType MessageType => SessionMessageType.SessionsStop;

View File

@ -1,9 +1,8 @@
namespace MediaBrowser.Controller.Net.WebSocketMessages; namespace MediaBrowser.Controller.Net.WebSocketMessages;
/// <summary> /// <summary>
/// Class representing the list of outbound websocket message types. /// Inbound websocket message.
/// Only used in openapi generation.
/// </summary> /// </summary>
public class InboundWebSocketMessage : WebSocketMessage public class InboundWebSocketMessage : WebSocketMessage, IInboundWebSocketMessage
{ {
} }

View File

@ -0,0 +1,26 @@
#pragma warning disable SA1649 // File name must equal class name.
namespace MediaBrowser.Controller.Net.WebSocketMessages;
/// <summary>
/// Inbound websocket message with data.
/// </summary>
/// <typeparam name="T">The data type.</typeparam>
public class InboundWebSocketMessage<T> : WebSocketMessage<T>, IInboundWebSocketMessage
{
/// <summary>
/// Initializes a new instance of the <see cref="InboundWebSocketMessage{T}"/> class.
/// </summary>
public InboundWebSocketMessage()
{
}
/// <summary>
/// Initializes a new instance of the <see cref="InboundWebSocketMessage{T}"/> class.
/// </summary>
/// <param name="data">The data to send.</param>
protected InboundWebSocketMessage(T data)
{
Data = data;
}
}

View File

@ -8,7 +8,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Activity log created message. /// Activity log created message.
/// </summary> /// </summary>
public class ActivityLogEntryMessage : WebSocketMessage<IReadOnlyList<ActivityLogEntry>>, IOutboundWebSocketMessage public class ActivityLogEntryMessage : OutboundWebSocketMessage<IReadOnlyList<ActivityLogEntry>>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="ActivityLogEntryMessage"/> class. /// Initializes a new instance of the <see cref="ActivityLogEntryMessage"/> class.

View File

@ -6,7 +6,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Force keep alive websocket messages. /// Force keep alive websocket messages.
/// </summary> /// </summary>
public class ForceKeepAliveMessage : WebSocketMessage<int>, IOutboundWebSocketMessage public class ForceKeepAliveMessage : OutboundWebSocketMessage<int>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="ForceKeepAliveMessage"/> class. /// Initializes a new instance of the <see cref="ForceKeepAliveMessage"/> class.

View File

@ -6,7 +6,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// General command websocket message. /// General command websocket message.
/// </summary> /// </summary>
public class GeneralCommandMessage : WebSocketMessage<GeneralCommand>, IOutboundWebSocketMessage public class GeneralCommandMessage : OutboundWebSocketMessage<GeneralCommand>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="GeneralCommandMessage"/> class. /// Initializes a new instance of the <see cref="GeneralCommandMessage"/> class.

View File

@ -7,7 +7,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Library changed message. /// Library changed message.
/// </summary> /// </summary>
public class LibraryChangedMessage : WebSocketMessage<LibraryUpdateInfo>, IOutboundWebSocketMessage public class LibraryChangedMessage : OutboundWebSocketMessage<LibraryUpdateInfo>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="LibraryChangedMessage"/> class. /// Initializes a new instance of the <see cref="LibraryChangedMessage"/> class.

View File

@ -0,0 +1,14 @@
using System.ComponentModel;
using MediaBrowser.Model.Session;
namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary>
/// Keep alive websocket messages.
/// </summary>
public class OutboundKeepAliveMessage : OutboundWebSocketMessage
{
/// <inheritdoc />
[DefaultValue(SessionMessageType.KeepAlive)]
public override SessionMessageType MessageType => SessionMessageType.KeepAlive;
}

View File

@ -6,7 +6,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Play command websocket message. /// Play command websocket message.
/// </summary> /// </summary>
public class PlayMessage : WebSocketMessage<PlayRequest>, IOutboundWebSocketMessage public class PlayMessage : OutboundWebSocketMessage<PlayRequest>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="PlayMessage"/> class. /// Initializes a new instance of the <see cref="PlayMessage"/> class.

View File

@ -6,7 +6,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Playstate message. /// Playstate message.
/// </summary> /// </summary>
public class PlaystateMessage : WebSocketMessage<PlaystateRequest>, IOutboundWebSocketMessage public class PlaystateMessage : OutboundWebSocketMessage<PlaystateRequest>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="PlaystateMessage"/> class. /// Initializes a new instance of the <see cref="PlaystateMessage"/> class.

View File

@ -7,7 +7,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Plugin installation cancelled message. /// Plugin installation cancelled message.
/// </summary> /// </summary>
public class PluginInstallationCancelledMessage : WebSocketMessage<InstallationInfo>, IOutboundWebSocketMessage public class PluginInstallationCancelledMessage : OutboundWebSocketMessage<InstallationInfo>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="PluginInstallationCancelledMessage"/> class. /// Initializes a new instance of the <see cref="PluginInstallationCancelledMessage"/> class.

View File

@ -7,7 +7,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Plugin installation completed message. /// Plugin installation completed message.
/// </summary> /// </summary>
public class PluginInstallationCompletedMessage : WebSocketMessage<InstallationInfo>, IOutboundWebSocketMessage public class PluginInstallationCompletedMessage : OutboundWebSocketMessage<InstallationInfo>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="PluginInstallationCompletedMessage"/> class. /// Initializes a new instance of the <see cref="PluginInstallationCompletedMessage"/> class.

View File

@ -7,7 +7,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Plugin installation failed message. /// Plugin installation failed message.
/// </summary> /// </summary>
public class PluginInstallationFailedMessage : WebSocketMessage<InstallationInfo>, IOutboundWebSocketMessage public class PluginInstallationFailedMessage : OutboundWebSocketMessage<InstallationInfo>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="PluginInstallationFailedMessage"/> class. /// Initializes a new instance of the <see cref="PluginInstallationFailedMessage"/> class.

View File

@ -7,7 +7,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Package installing message. /// Package installing message.
/// </summary> /// </summary>
public class PluginInstallingMessage : WebSocketMessage<InstallationInfo>, IOutboundWebSocketMessage public class PluginInstallingMessage : OutboundWebSocketMessage<InstallationInfo>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="PluginInstallingMessage"/> class. /// Initializes a new instance of the <see cref="PluginInstallingMessage"/> class.

View File

@ -7,7 +7,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Plugin uninstalled message. /// Plugin uninstalled message.
/// </summary> /// </summary>
public class PluginUninstalledMessage : WebSocketMessage<PluginInfo>, IOutboundWebSocketMessage public class PluginUninstalledMessage : OutboundWebSocketMessage<PluginInfo>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="PluginUninstalledMessage"/> class. /// Initializes a new instance of the <see cref="PluginUninstalledMessage"/> class.

View File

@ -7,7 +7,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Refresh progress message. /// Refresh progress message.
/// </summary> /// </summary>
public class RefreshProgressMessage : WebSocketMessage<Dictionary<string, string>>, IOutboundWebSocketMessage public class RefreshProgressMessage : OutboundWebSocketMessage<Dictionary<string, string>>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="RefreshProgressMessage"/> class. /// Initializes a new instance of the <see cref="RefreshProgressMessage"/> class.

View File

@ -6,7 +6,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Restart required. /// Restart required.
/// </summary> /// </summary>
public class RestartRequiredMessage : WebSocketMessage, IOutboundWebSocketMessage public class RestartRequiredMessage : OutboundWebSocketMessage
{ {
/// <inheritdoc /> /// <inheritdoc />
[DefaultValue(SessionMessageType.RestartRequired)] [DefaultValue(SessionMessageType.RestartRequired)]

View File

@ -7,7 +7,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Scheduled task ended message. /// Scheduled task ended message.
/// </summary> /// </summary>
public class ScheduledTaskEndedMessage : WebSocketMessage<TaskResult>, IOutboundWebSocketMessage public class ScheduledTaskEndedMessage : OutboundWebSocketMessage<TaskResult>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="ScheduledTaskEndedMessage"/> class. /// Initializes a new instance of the <see cref="ScheduledTaskEndedMessage"/> class.

View File

@ -8,7 +8,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Scheduled tasks info message. /// Scheduled tasks info message.
/// </summary> /// </summary>
public class ScheduledTasksInfoMessage : WebSocketMessage<IReadOnlyList<TaskInfo>>, IOutboundWebSocketMessage public class ScheduledTasksInfoMessage : OutboundWebSocketMessage<IReadOnlyList<TaskInfo>>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="ScheduledTasksInfoMessage"/> class. /// Initializes a new instance of the <see cref="ScheduledTasksInfoMessage"/> class.

View File

@ -7,7 +7,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Series timer cancelled message. /// Series timer cancelled message.
/// </summary> /// </summary>
public class SeriesTimerCancelledMessage : WebSocketMessage<TimerEventInfo>, IOutboundWebSocketMessage public class SeriesTimerCancelledMessage : OutboundWebSocketMessage<TimerEventInfo>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="SeriesTimerCancelledMessage"/> class. /// Initializes a new instance of the <see cref="SeriesTimerCancelledMessage"/> class.

View File

@ -7,7 +7,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Series timer created message. /// Series timer created message.
/// </summary> /// </summary>
public class SeriesTimerCreatedMessage : WebSocketMessage<TimerEventInfo>, IOutboundWebSocketMessage public class SeriesTimerCreatedMessage : OutboundWebSocketMessage<TimerEventInfo>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="SeriesTimerCreatedMessage"/> class. /// Initializes a new instance of the <see cref="SeriesTimerCreatedMessage"/> class.

View File

@ -6,7 +6,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Server restarting down message. /// Server restarting down message.
/// </summary> /// </summary>
public class ServerRestartingMessage : WebSocketMessage, IOutboundWebSocketMessage public class ServerRestartingMessage : OutboundWebSocketMessage
{ {
/// <inheritdoc /> /// <inheritdoc />
[DefaultValue(SessionMessageType.ServerRestarting)] [DefaultValue(SessionMessageType.ServerRestarting)]

View File

@ -6,7 +6,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Server shutting down message. /// Server shutting down message.
/// </summary> /// </summary>
public class ServerShuttingDownMessage : WebSocketMessage, IOutboundWebSocketMessage public class ServerShuttingDownMessage : OutboundWebSocketMessage
{ {
/// <inheritdoc /> /// <inheritdoc />
[DefaultValue(SessionMessageType.ServerShuttingDown)] [DefaultValue(SessionMessageType.ServerShuttingDown)]

View File

@ -1,3 +1,4 @@
using System.Collections.Generic;
using System.ComponentModel; using System.ComponentModel;
using MediaBrowser.Controller.Session; using MediaBrowser.Controller.Session;
using MediaBrowser.Model.Session; using MediaBrowser.Model.Session;
@ -7,13 +8,13 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Sessions message. /// Sessions message.
/// </summary> /// </summary>
public class SessionsMessage : WebSocketMessage<SessionInfo>, IOutboundWebSocketMessage public class SessionsMessage : OutboundWebSocketMessage<IReadOnlyList<SessionInfo>>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="SessionsMessage"/> class. /// Initializes a new instance of the <see cref="SessionsMessage"/> class.
/// </summary> /// </summary>
/// <param name="data">Session info.</param> /// <param name="data">Session info.</param>
public SessionsMessage(SessionInfo data) public SessionsMessage(IReadOnlyList<SessionInfo> data)
: base(data) : base(data)
{ {
} }

View File

@ -7,7 +7,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Sync play command. /// Sync play command.
/// </summary> /// </summary>
public class SyncPlayCommandMessage : WebSocketMessage<SendCommand>, IOutboundWebSocketMessage public class SyncPlayCommandMessage : OutboundWebSocketMessage<SendCommand>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="SyncPlayCommandMessage"/> class. /// Initializes a new instance of the <see cref="SyncPlayCommandMessage"/> class.

View File

@ -7,7 +7,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Untyped sync play command. /// Untyped sync play command.
/// </summary> /// </summary>
public class SyncPlayGroupUpdateCommandMessage : WebSocketMessage<GroupUpdate>, IOutboundWebSocketMessage public class SyncPlayGroupUpdateCommandMessage : OutboundWebSocketMessage<GroupUpdate>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="SyncPlayGroupUpdateCommandMessage"/> class. /// Initializes a new instance of the <see cref="SyncPlayGroupUpdateCommandMessage"/> class.

View File

@ -8,7 +8,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// Sync play group update command with group info. /// Sync play group update command with group info.
/// GroupUpdateTypes: GroupJoined. /// GroupUpdateTypes: GroupJoined.
/// </summary> /// </summary>
public class SyncPlayGroupUpdateCommandOfGroupInfoMessage : WebSocketMessage<GroupUpdate<GroupInfoDto>>, IOutboundWebSocketMessage public class SyncPlayGroupUpdateCommandOfGroupInfoMessage : OutboundWebSocketMessage<GroupUpdate<GroupInfoDto>>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="SyncPlayGroupUpdateCommandOfGroupInfoMessage"/> class. /// Initializes a new instance of the <see cref="SyncPlayGroupUpdateCommandOfGroupInfoMessage"/> class.

View File

@ -8,7 +8,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// Sync play group update command with group state update. /// Sync play group update command with group state update.
/// GroupUpdateTypes: StateUpdate. /// GroupUpdateTypes: StateUpdate.
/// </summary> /// </summary>
public class SyncPlayGroupUpdateCommandOfGroupStateUpdateMessage : WebSocketMessage<GroupUpdate<GroupStateUpdate>>, IOutboundWebSocketMessage public class SyncPlayGroupUpdateCommandOfGroupStateUpdateMessage : OutboundWebSocketMessage<GroupUpdate<GroupStateUpdate>>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="SyncPlayGroupUpdateCommandOfGroupStateUpdateMessage"/> class. /// Initializes a new instance of the <see cref="SyncPlayGroupUpdateCommandOfGroupStateUpdateMessage"/> class.

View File

@ -8,7 +8,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// Sync play group update command with play queue update. /// Sync play group update command with play queue update.
/// GroupUpdateTypes: PlayQueue. /// GroupUpdateTypes: PlayQueue.
/// </summary> /// </summary>
public class SyncPlayGroupUpdateCommandOfPlayQueueUpdateMessage : WebSocketMessage<GroupUpdate<PlayQueueUpdate>>, IOutboundWebSocketMessage public class SyncPlayGroupUpdateCommandOfPlayQueueUpdateMessage : OutboundWebSocketMessage<GroupUpdate<PlayQueueUpdate>>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="SyncPlayGroupUpdateCommandOfPlayQueueUpdateMessage"/> class. /// Initializes a new instance of the <see cref="SyncPlayGroupUpdateCommandOfPlayQueueUpdateMessage"/> class.

View File

@ -8,7 +8,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// Sync play group update command with string. /// Sync play group update command with string.
/// GroupUpdateTypes: GroupDoesNotExist (error), LibraryAccessDenied (error), NotInGroup (error), GroupLeft (groupId), UserJoined (username), UserLeft (username). /// GroupUpdateTypes: GroupDoesNotExist (error), LibraryAccessDenied (error), NotInGroup (error), GroupLeft (groupId), UserJoined (username), UserLeft (username).
/// </summary> /// </summary>
public class SyncPlayGroupUpdateCommandOfStringMessage : WebSocketMessage<GroupUpdate<string>>, IOutboundWebSocketMessage public class SyncPlayGroupUpdateCommandOfStringMessage : OutboundWebSocketMessage<GroupUpdate<string>>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="SyncPlayGroupUpdateCommandOfStringMessage"/> class. /// Initializes a new instance of the <see cref="SyncPlayGroupUpdateCommandOfStringMessage"/> class.

View File

@ -7,7 +7,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Timer cancelled message. /// Timer cancelled message.
/// </summary> /// </summary>
public class TimerCancelledMessage : WebSocketMessage<TimerEventInfo>, IOutboundWebSocketMessage public class TimerCancelledMessage : OutboundWebSocketMessage<TimerEventInfo>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="TimerCancelledMessage"/> class. /// Initializes a new instance of the <see cref="TimerCancelledMessage"/> class.

View File

@ -7,7 +7,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// Timer created message. /// Timer created message.
/// </summary> /// </summary>
public class TimerCreatedMessage : WebSocketMessage<TimerEventInfo>, IOutboundWebSocketMessage public class TimerCreatedMessage : OutboundWebSocketMessage<TimerEventInfo>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="TimerCreatedMessage"/> class. /// Initializes a new instance of the <see cref="TimerCreatedMessage"/> class.

View File

@ -6,7 +6,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// User data changed message. /// User data changed message.
/// </summary> /// </summary>
public class UserDataChangedMessage : WebSocketMessage<UserDataChangeInfo>, IOutboundWebSocketMessage public class UserDataChangedMessage : OutboundWebSocketMessage<UserDataChangeInfo>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="UserDataChangedMessage"/> class. /// Initializes a new instance of the <see cref="UserDataChangedMessage"/> class.

View File

@ -7,7 +7,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// User deleted message. /// User deleted message.
/// </summary> /// </summary>
public class UserDeletedMessage : WebSocketMessage<Guid>, IOutboundWebSocketMessage public class UserDeletedMessage : OutboundWebSocketMessage<Guid>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="UserDeletedMessage"/> class. /// Initializes a new instance of the <see cref="UserDeletedMessage"/> class.

View File

@ -7,7 +7,7 @@ namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
/// <summary> /// <summary>
/// User updated message. /// User updated message.
/// </summary> /// </summary>
public class UserUpdatedMessage : WebSocketMessage<UserDto>, IOutboundWebSocketMessage public class UserUpdatedMessage : OutboundWebSocketMessage<UserDto>
{ {
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="UserUpdatedMessage"/> class. /// Initializes a new instance of the <see cref="UserUpdatedMessage"/> class.

View File

@ -1,9 +1,14 @@
using System;
namespace MediaBrowser.Controller.Net.WebSocketMessages; namespace MediaBrowser.Controller.Net.WebSocketMessages;
/// <summary> /// <summary>
/// Class representing the list of outbound websocket message types. /// Outbound websocket message.
/// Only used in openapi generation.
/// </summary> /// </summary>
public class OutboundWebSocketMessage : WebSocketMessage public class OutboundWebSocketMessage : WebSocketMessage, IOutboundWebSocketMessage
{ {
/// <summary>
/// Gets or sets the message id.
/// </summary>
public Guid MessageId { get; set; }
} }

View File

@ -0,0 +1,33 @@
#pragma warning disable SA1649 // File name must equal class name.
using System;
namespace MediaBrowser.Controller.Net.WebSocketMessages;
/// <summary>
/// Outbound websocket message with data.
/// </summary>
/// <typeparam name="T">The data type.</typeparam>
public class OutboundWebSocketMessage<T> : WebSocketMessage<T>, IOutboundWebSocketMessage
{
/// <summary>
/// Initializes a new instance of the <see cref="OutboundWebSocketMessage{T}"/> class.
/// </summary>
public OutboundWebSocketMessage()
{
}
/// <summary>
/// Initializes a new instance of the <see cref="OutboundWebSocketMessage{T}"/> class.
/// </summary>
/// <param name="data">The data to send.</param>
protected OutboundWebSocketMessage(T data)
{
Data = data;
}
/// <summary>
/// Gets or sets the message id.
/// </summary>
public Guid MessageId { get; set; }
}

View File

@ -1,23 +0,0 @@
using System.ComponentModel;
using MediaBrowser.Model.Session;
namespace MediaBrowser.Controller.Net.WebSocketMessages.Shared;
/// <summary>
/// Keep alive websocket messages.
/// </summary>
public class KeepAliveMessage : WebSocketMessage<int>, IInboundWebSocketMessage, IOutboundWebSocketMessage
{
/// <summary>
/// Initializes a new instance of the <see cref="KeepAliveMessage"/> class.
/// </summary>
/// <param name="data">The seconds to keep alive for.</param>
public KeepAliveMessage(int data)
: base(data)
{
}
/// <inheritdoc />
[DefaultValue(SessionMessageType.KeepAlive)]
public override SessionMessageType MessageType => SessionMessageType.KeepAlive;
}