Interface IProtocolHandler

Namespace

HotChocolate.AspNetCore.Subscriptions.Protocols

Assembly

HotChocolate.AspNetCore.dll

Represents a GraphQL websocket protocol handler.

public interface IProtocolHandler

Properties

Name

Gets the protocol name.

string Name { get; }

Property Value

string

Methods

OnConnectionInitTimeoutAsync(ISocketSession, CancellationToken)

Is invoked by the socket session when the connection initialization timeout is reached and must close the socket connection.

ValueTask OnConnectionInitTimeoutAsync(ISocketSession session, CancellationToken cancellationToken = default)

Parameters

session ISocketSession

The socket session.

cancellationToken CancellationToken

The cancellation token.

Returns

ValueTask

OnReceiveAsync(ISocketSession, ReadOnlySequence<byte>, CancellationToken)

ValueTask OnReceiveAsync(ISocketSession session, ReadOnlySequence<byte> message, CancellationToken cancellationToken = default)

Parameters

session ISocketSession

message ReadOnlySequence<byte>

cancellationToken CancellationToken

Returns

ValueTask

SendCompleteMessageAsync(ISocketSession, string, CancellationToken)

Sends an operation complete message to the client which signals to the client that no more results will be send for the server for the specified operation session.

ValueTask SendCompleteMessageAsync(ISocketSession session, string operationSessionId, CancellationToken cancellationToken = default)

Parameters

session ISocketSession

The socket session.

operationSessionId string

The operation session id.

cancellationToken CancellationToken

The cancellation token.

Returns

ValueTask

SendErrorMessageAsync(ISocketSession, string, IReadOnlyList<IError>, CancellationToken)

Sends a validation error message to the client.

ValueTask SendErrorMessageAsync(ISocketSession session, string operationSessionId, IReadOnlyList<IError> errors, CancellationToken cancellationToken = default)

Parameters

session ISocketSession

The socket session.

operationSessionId string

The operation session id.

errors IReadOnlyList<IError>

The validation or syntax errors.

cancellationToken CancellationToken

The cancellation token.

Returns

ValueTask

SendKeepAliveMessageAsync(ISocketSession, CancellationToken)

Sends a keep alive message to the client.

ValueTask SendKeepAliveMessageAsync(ISocketSession session, CancellationToken cancellationToken = default)

Parameters

session ISocketSession

The socket session.

cancellationToken CancellationToken

The cancellation token.

Returns

ValueTask

SendResultMessageAsync(ISocketSession, string, IQueryResult, CancellationToken)

Sends a query result message to the client.

ValueTask SendResultMessageAsync(ISocketSession session, string operationSessionId, IQueryResult result, CancellationToken cancellationToken = default)

Parameters

session ISocketSession

The socket session.

operationSessionId string

The operation session id.

result IQueryResult

The query result object.

cancellationToken CancellationToken

The cancellation token.

Returns

ValueTask