AlphaXWebSocketCapabilities class final

Capabilities and honest limitations of a WebSocket connector.

A capability describes the connector/provider, not a promise that every server will accept a particular connection. unknown is used where a provider cannot know a limit before connecting.

Constructors

AlphaXWebSocketCapabilities({required String transportName, AlphaXSupport binaryMessages = AlphaXSupport.unknown, AlphaXSupport subprotocolNegotiation = AlphaXSupport.unknown, AlphaXSupport negotiatedSubprotocolReporting = AlphaXSupport.unknown, AlphaXSupport customHeaders = AlphaXSupport.unknown, AlphaXSupport manualPingPong = AlphaXSupport.unknown, AlphaXSupport receivePauseResume = AlphaXSupport.unknown, int? maximumMessageBytes})

Creates a capability description.

const

Properties

binaryMessages → AlphaXSupport

Whether complete binary messages can be sent and received.

final

customHeaders → AlphaXSupport

Whether arbitrary connection request headers are supported.

final

hashCode → int

The hash code for this object.

no setter, inherited

manualPingPong → AlphaXSupport

Whether the caller can manually send or observe ping/pong control frames.

final

maximumMessageBytes → int?

A provider-enforced maximum complete message size, when known.

final

negotiatedSubprotocolReporting → AlphaXSupport

Whether the selected subprotocol is reported by the provider.

final

receivePauseResume → AlphaXSupport

Whether pausing the AlphaX receive stream can pause provider reads.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

subprotocolNegotiation → AlphaXSupport

Whether requested subprotocols can be offered to the peer.

final

transportName → String

Human-readable provider/connector name.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited