Skip to main content

ClientBuilder

Struct ClientBuilder 

Source
pub struct ClientBuilder { /* private fields */ }
Expand description

简单模式客户端构建器

提供最小实现,使用闭包定义消息处理逻辑,适合快速原型开发和学习。

§设计原则

  • 公共逻辑统一处理:基于 HybridClient,共享所有核心能力(多协议、序列化协商、心跳等)
  • 最小抽象:消息处理通过闭包定义,不依赖 trait 实现
  • 零配置:使用默认配置即可运行

§使用方式

使用闭包定义消息和事件处理逻辑,无需实现 trait。

Implementations§

Source§

impl ClientBuilder

Source

pub fn new(server_url: impl Into<String>) -> Self

创建新的客户端构建器

§参数
  • server_url: 服务器地址,例如 “ws://127.0.0.1:8080” 或 “quic://127.0.0.1:8080”
Source

pub fn on_message<F>(self, handler: F) -> Self
where F: Fn(&Frame) -> Result<()> + Send + Sync + 'static,

设置消息处理函数

§参数
  • handler: 消息处理函数,接收 Frame
Source

pub fn on_event<F>(self, handler: F) -> Self
where F: Fn(&ConnectionEvent) + Send + Sync + 'static,

设置事件处理函数

§参数
  • handler: 事件处理函数,接收 ConnectionEvent
Source

pub fn with_protocol(self, protocol: TransportProtocol) -> Self

设置传输协议

Source

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

启用多协议竞速

协议列表的顺序就是优先级顺序,前面的协议优先级更高

Source

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

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

Source

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

设置用户 ID

Source

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

设置设备信息(CONNECT 协商与设备管理)

Source

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

设置 Token(用于认证,如果服务端启用认证,必须提供)

Source

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

设置序列化格式

Source

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

设置压缩算法

Source

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

设置心跳配置

Source

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

设置 TLS 配置

Source

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

设置连接超时

Source

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

设置重连间隔

Source

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

设置最大重连次数

Source

pub fn enable_router(self) -> Self

启用消息路由

启用后,可以通过 ClientCore 的 router 方法注册消息处理器

Source

pub fn build(self) -> Result<SimpleClient>

构建客户端

§返回

返回配置好的 SimpleClient 实例

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more