aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Controller/Net/IWebSocketConnection.cs
diff options
context:
space:
mode:
authorJan Müller <github@lonebyte.de>2023-09-16 12:40:05 +0200
committerJan Müller <github@lonebyte.de>2023-09-16 12:40:05 +0200
commitfd022ee6850c364a9f3c2d8de2b06f26ee1b8abf (patch)
treed2aec7c1a9ae2d2b77b5c764a99a4434a6e4a21c /MediaBrowser.Controller/Net/IWebSocketConnection.cs
parent79cff704ff4e00895a8d2b97ecbbea3e2f5f56fc (diff)
parent61155adecd8a69bb476487f9fc81175b0c4185b7 (diff)
Merge branch 'master' into flac-hls-fixes
# Conflicts: # Jellyfin.Api/Controllers/DynamicHlsController.cs
Diffstat (limited to 'MediaBrowser.Controller/Net/IWebSocketConnection.cs')
-rw-r--r--MediaBrowser.Controller/Net/IWebSocketConnection.cs17
1 files changed, 14 insertions, 3 deletions
diff --git a/MediaBrowser.Controller/Net/IWebSocketConnection.cs b/MediaBrowser.Controller/Net/IWebSocketConnection.cs
index 79f0846b4..bba5a6b85 100644
--- a/MediaBrowser.Controller/Net/IWebSocketConnection.cs
+++ b/MediaBrowser.Controller/Net/IWebSocketConnection.cs
@@ -1,5 +1,3 @@
-#pragma warning disable CS1591
-
using System;
using System.Net;
using System.Net.WebSockets;
@@ -9,6 +7,9 @@ using MediaBrowser.Controller.Net.WebSocketMessages;
namespace MediaBrowser.Controller.Net
{
+ /// <summary>
+ /// Interface for WebSocket connections.
+ /// </summary>
public interface IWebSocketConnection : IAsyncDisposable, IDisposable
{
/// <summary>
@@ -41,6 +42,11 @@ namespace MediaBrowser.Controller.Net
WebSocketState State { get; }
/// <summary>
+ /// Gets the authorization information.
+ /// </summary>
+ public AuthorizationInfo AuthorizationInfo { get; }
+
+ /// <summary>
/// Gets the remote end point.
/// </summary>
/// <value>The remote end point.</value>
@@ -65,6 +71,11 @@ namespace MediaBrowser.Controller.Net
/// <exception cref="ArgumentNullException">The message is null.</exception>
Task SendAsync<T>(OutboundWebSocketMessage<T> message, CancellationToken cancellationToken);
- Task ProcessAsync(CancellationToken cancellationToken = default);
+ /// <summary>
+ /// Receives a message asynchronously.
+ /// </summary>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ /// <returns>Task.</returns>
+ Task ReceiveAsync(CancellationToken cancellationToken = default);
}
}