Class WebSocketConnectionHandler

Namespace

Cratis.Applications.Queries

Assembly

Cratis.Applications.dll

Represents an implementation of IWebSocketConnectionHandler.

public class WebSocketConnectionHandler : IWebSocketConnectionHandler

Inheritance

object

WebSocketConnectionHandler

Implements

IWebSocketConnectionHandler

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

WebSocketConnectionHandler(ILogger<WebSocketConnectionHandler>)

Represents an implementation of IWebSocketConnectionHandler.

public WebSocketConnectionHandler(ILogger<WebSocketConnectionHandler> handlerLogger)

Parameters

handlerLogger ILogger<WebSocketConnectionHandler>

The ILogger.

Methods

HandleIncomingMessages(WebSocket, CancellationToken, ILogger?)

Handles all incoming web messages on the given WebSocket.

public Task HandleIncomingMessages(WebSocket webSocket, CancellationToken token, ILogger? logger = null)

Parameters

webSocket WebSocket

The WebSocket to listen to.

token CancellationToken

The CancellationToken.

logger ILogger

The optional ILogger to use.

Returns

Task

A Task representing the asynchronous action.

SendMessage<TQueryResult>(WebSocket, QueryResult<TQueryResult>, JsonSerializerOptions, CancellationToken, ILogger?)

Sends a message on the WebSocket.

public Task<Exception?> SendMessage<TQueryResult>(WebSocket webSocket, QueryResult<TQueryResult> queryResult, JsonSerializerOptions jsonSerializerOptions, CancellationToken token, ILogger? logger = null)

Parameters

webSocket WebSocket

The WebSocket to listen to.

queryResult QueryResult<TQueryResult>

The QueryResult<T> message to write.

jsonSerializerOptions JsonSerializerOptions

The JsonSerializerOptions.

token CancellationToken

The CancellationToken.

logger ILogger

The optional ILogger to use.

Returns

Task<Exception>

A Task representing the asynchronous action.

Type Parameters

TQueryResult

The Type of the query result.