Struct ClientConfig 

pub struct ClientConfig {

    pub server_url: String,
    pub transport: TransportProtocol,
    pub transports: Option<Vec<TransportProtocol>>,
    pub protocol_urls: Option<HashMap<TransportProtocol, String>>,
    pub race_timeout: Option<Duration>,
    pub serialization_format: SerializationFormat,
    pub compression: CompressionAlgorithm,
    pub force_serialization_format: Option<SerializationFormat>,
    pub force_compression: Option<CompressionAlgorithm>,
    pub connect_timeout: Duration,
    pub reconnect_interval: Duration,
    pub max_reconnect_attempts: Option<u32>,
    pub heartbeat: HeartbeatConfig,
    pub tls: TlsConfig,
    pub connection_id: Option<String>,
    pub user_id: Option<String>,
    pub metadata: HashMap<String, String>,
    pub enable_router: bool,
    pub device_info: Option<DeviceInfo>,
    pub token: Option<String>,
}

客户端配置

Fields

server_url: String

服务器地址（单个协议时使用，多协议时用作默认地址）

transport: TransportProtocol

传输协议（单个）

transports: Option<Vec<TransportProtocol>>

传输协议列表（用于竞速，如果设置了此列表，transport 将被忽略） 列表顺序就是优先级顺序，前面的优先级更高

protocol_urls: Option<HashMap<TransportProtocol, String>>

每个协议的独立地址配置（协议 -> 地址映射） 如果设置了此映射，每个协议将使用对应的地址

race_timeout: Option<Duration>

协议竞速超时时间（如果启用多协议竞速）

serialization_format: SerializationFormat

序列化格式（首选格式，用于协商）

compression: CompressionAlgorithm

压缩算法（首选算法，用于协商）

force_serialization_format: Option<SerializationFormat>

强制指定的序列化格式（如果设置，则强制使用此格式，不进行协商） 适用于某些端不支持 protobuf 等格式的场景

force_compression: Option<CompressionAlgorithm>

强制指定的压缩算法（如果设置，则强制使用此算法，不进行协商）

connect_timeout: Duration

连接超时时间

reconnect_interval: Duration

重连间隔

max_reconnect_attempts: Option<u32>

最大重连次数（None 表示无限重连）

heartbeat: HeartbeatConfig

心跳配置

tls: TlsConfig

TLS 配置

connection_id: Option<String>

自定义连接 ID（如果为 None，则自动生成）

user_id: Option<String>

用户 ID（用于认证）

metadata: HashMap<String, String>

额外的元数据

enable_router: bool

是否启用消息路由（默认 false）

device_info: Option<DeviceInfo>

设备信息（用于协商和设备管理）

token: Option<String>

Token（用于认证，如果服务端启用认证，必须提供）

Implementations

impl ClientConfig

pub fn new(server_url: String) -> Self

创建新的客户端配置

pub fn websocket(self) -> Self

使用 WebSocket 协议

pub fn quic(self) -> Self

使用 QUIC 协议

pub fn tcp(self) -> Self

使用 TCP 协议

pub fn with_format(self, format: SerializationFormat) -> Self

设置序列化格式

pub fn with_compression(self, compression: CompressionAlgorithm) -> Self

设置压缩算法

pub fn with_user_id(self, user_id: String) -> Self

设置用户 ID

pub fn with_token(self, token: String) -> Self

设置 Token（用于认证，如果服务端启用认证，必须提供）

pub fn with_protocol_race(self, protocols: Vec<TransportProtocol>) -> Self

启用多协议竞速

协议列表的顺序就是优先级顺序，前面的协议优先级更高 例如：with_protocol_race(vec![QUIC, WebSocket]) 表示 QUIC 优先级高于 WebSocket

pub fn with_protocol_url(self, protocol: TransportProtocol, url: String) -> Self

为特定协议设置服务器地址

pub fn with_protocol_urls( self, urls: HashMap<TransportProtocol, String>, ) -> Self

批量设置协议地址映射

pub fn get_protocol_url(&self, protocol: &TransportProtocol) -> String

获取指定协议的地址

pub fn with_race_timeout(self, timeout: Duration) -> Self

设置竞速超时时间

pub fn with_heartbeat(self, heartbeat: HeartbeatConfig) -> Self

设置心跳配置

pub fn with_tls(self, tls: TlsConfig) -> Self

设置 TLS 配置

pub fn with_connect_timeout(self, timeout: Duration) -> Self

设置连接超时

pub fn with_reconnect_interval(self, interval: Duration) -> Self

设置重连间隔

pub fn with_max_reconnect_attempts(self, max: Option<u32>) -> Self

设置最大重连次数（None 表示无限重连）

pub fn enable_router(self) -> Self

启用消息路由

pub fn with_device_info(self, device_info: DeviceInfo) -> Self

设置设备信息（用于协商和设备管理）

pub fn force_format(self, format: SerializationFormat) -> Self

强制指定序列化格式（不进行协商，直接使用此格式）

适用于某些端不支持 protobuf 等格式的场景 如果设置了强制格式，客户端将直接使用此格式，服务端必须接受

pub fn force_compression(self, compression: CompressionAlgorithm) -> Self

强制指定压缩算法（不进行协商，直接使用此算法）

如果设置了强制压缩，客户端将直接使用此算法，服务端必须接受

pub fn is_force_format(&self) -> bool

检查是否强制指定了格式（不进行协商）

pub fn get_serialization_format(&self) -> SerializationFormat

获取实际使用的序列化格式（强制格式优先，否则使用首选格式）

pub fn get_compression(&self) -> CompressionAlgorithm

获取实际使用的压缩算法（强制算法优先，否则使用首选算法）

pub fn get_protocols(&self) -> Vec<TransportProtocol>

获取要使用的协议列表

pub fn is_race_mode(&self) -> bool

是否启用协议竞速

Trait Implementations

impl Clone for ClientConfig

fn clone(&self) -> ClientConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClientConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClientConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ClientConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.