Class ConnectionStatus

Namespace

HotChocolate.AspNetCore.Subscriptions.Protocols

Assembly

HotChocolate.AspNetCore.dll

The socket connection initialization status.

public sealed class ConnectionStatus

Inheritance

object

ConnectionStatus

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Accepted

Specifies if the connection is accepted.

public bool Accepted { get; }

Property Value

bool

Extensions

Custom properties.

public IReadOnlyDictionary<string, object?>? Extensions { get; }

Property Value

IReadOnlyDictionary<string, object>

Message

The connection status message.

public string Message { get; }

Property Value

string

Methods

Accept()

Accepts the socket connection.

public static ConnectionStatus Accept()

Returns

ConnectionStatus

The connection accept status.

Reject()

Reject the socket connection with a custom message.

public static ConnectionStatus Reject()

Returns

ConnectionStatus

The connection reject status.

Reject(IReadOnlyDictionary<string, object?>)

Reject the socket connection with a custom message.

public static ConnectionStatus Reject(IReadOnlyDictionary<string, object?> extensions)

Parameters

extensions IReadOnlyDictionary<string, object>

The custom properties that shall be passed on with the rejection.

Returns

ConnectionStatus

The connection reject status.

Reject(string)

Reject the socket connection with a custom message.

public static ConnectionStatus Reject(string message)

Parameters

message string

The message.

Returns

ConnectionStatus

The connection reject status.

Reject(string, IReadOnlyDictionary<string, object?>?)

Reject the socket connection with a custom message.

public static ConnectionStatus Reject(string message, IReadOnlyDictionary<string, object?>? extensions)

Parameters

message string

The message.

extensions IReadOnlyDictionary<string, object>

The custom properties that shall be passed on with the rejection.

Returns

ConnectionStatus

The connection reject status.