Interface IOperationSession

Namespace

HotChocolate.AspNetCore.Subscriptions

Assembly

HotChocolate.AspNetCore.dll

Represents a session with an execution engine subscription. A subscription session is created within a ISocketSession. Each socket session can have multiple subscription sessions open.

public interface IOperationSession : IDisposable

Inherited Members

IDisposable.Dispose()

Properties

Id

Gets the subscription id that the client has provided.

string Id { get; }

Property Value

string

IsCompleted

Specifies if this session is completed and will yield no further results.

bool IsCompleted { get; }

Property Value

bool

Methods

BeginExecute(GraphQLRequest, CancellationToken)

Starts executing the operation.

void BeginExecute(GraphQLRequest request, CancellationToken cancellationToken)

Parameters

request GraphQLRequest

The graphql request.

cancellationToken CancellationToken

The cancellation token.

Events

Completed

An event that indicates that the underlying subscription has completed.

event EventHandler? Completed

Event Type

EventHandler