ClientProtocolVersion enum
Client-to-client protocol version advertised in ParticipantInfo.clientProtocol
and the client_protocol join URL query parameter. Governs peer-to-peer feature
negotiation; distinct from ProtocolVersion, which tracks the signaling protocol.
Each variant's integer wire value is sent on the wire as client_protocol.
- Inheritance
- Implemented types
- Available extensions
Values
- v0 → const ClientProtocolVersion
-
Spec:
CLIENT_PROTOCOL_DEFAULT. Legacy client — only supports RPC v1.const ClientProtocolVersion(0) - v1 → const ClientProtocolVersion
-
Spec:
CLIENT_PROTOCOL_DATA_STREAM_RPC. Supports RPC v2 (data-stream payloads).const ClientProtocolVersion(1)
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- index → int
-
A numeric identifier for the enumerated value.
no setterinherited
- name → String
-
Available on Enum, provided by the EnumName extension
The name of the enum value.no setter - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- wireValue → int
-
Integer value used in
ParticipantInfo.clientProtocoland the join URL.final
Methods
-
compareTo(
ClientProtocolVersion other) → int -
Compares this object to another object.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toIntValue(
) → int -
Available on ClientProtocolVersion, provided by the ClientProtocolVersionExt extension
-
toString(
) → String -
A string representation of this object.
inherited
-
toStringValue(
) → String -
Available on ClientProtocolVersion, provided by the ClientProtocolVersionExt extension
Operators
-
operator <(
ClientProtocolVersion other) → bool -
operator <=(
ClientProtocolVersion other) → bool -
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator >(
ClientProtocolVersion other) → bool -
operator >=(
ClientProtocolVersion other) → bool
Static Methods
-
fromIntValue(
int? value) → ClientProtocolVersion - Maps wire values to the highest protocol version this SDK can use.
Constants
- current → const ClientProtocolVersion
- The highest version this SDK build supports. Used as the default for ConnectOptions.clientProtocolVersion and in tests that need to advertise "the current SDK".
-
values
→ const List<
ClientProtocolVersion> - A constant List of the values in this enum, in order of their declaration.