WebSocketTransportConfig class
Configuration for the WebSocket transport.
- Implemented types
Constructors
- WebSocketTransportConfig({required Uri hubUri, required HubCredentials credentials, Duration connectTimeout = const Duration(seconds: 10), int maxFrameBytes = WsLimits.defaultMaxFrameBytes})
Properties
- connectTimeout → Duration
-
final
- credentials → HubCredentials
-
The session name and shared secret the hub admits peers with.
final
- description → String
-
Returns a description of the identity.
no setteroverride
- hashCode → int
-
The hash code for this object.
no setteroverride
- hubUri → Uri
-
Where the relay hub is listening, e.g.
ws://127.0.0.1:8080.final - id → String
-
Returns a unique identifier for the identity.
no setteroverride
- maxFrameBytes → int
-
Largest frame this node will send, in bytes.
final
- name → String
-
Returns a human-readable name for the identity.
no setteroverride
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
copyWith(
{Uri? hubUri, HubCredentials? credentials, Duration? connectTimeout, int? maxFrameBytes}) → WebSocketTransportConfig -
Creates a copy with modified values
override
-
createTransport(
) → ITransport< ITransportConfig> -
Builds a transport from this configuration.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
Diagnostics only, and deliberately without the secret.
override
-
toString(
) → String -
A string representation of this object.
inherited
-
validate(
{bool throwOnError = false}) → bool -
Validates the configuration
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override