Skip to main content

FlareClientBuilder

Struct FlareClientBuilder 

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

Flare 模式客户端构建器

提供完整功能实现的客户端构建器

用户需要实现 MessageListener trait,框架会自动处理消息序列化、压缩、加密和心跳管理

  • 压缩/解压
  • 加密/解密
  • 心跳管理
  • 自动重连

Implementations§

Source§

impl FlareClientBuilder

Source

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

创建新的 Flare 客户端构建器

Source

pub fn with_listener(self, listener: Arc<dyn MessageListener>) -> Self

设置消息监听器(必须)

Source

pub fn with_middleware(self, middleware: ArcMessageMiddleware) -> Self

添加中间件

Source

pub fn with_processor(self, processor: ArcMessageProcessor) -> Self

添加处理器

Source

pub fn with_observer(self, observer: Arc<dyn ConnectionObserver>) -> Self

添加连接观察者(可选)

观察者会收到连接事件(Connected、Disconnected、Error、Message)

添加连接观察者

观察者会收到连接事件(Connected、Disconnected、Error、Message)

§示例
use flare_core::client::builder::flare::FlareClientBuilder;
use flare_core::transport::events::{ConnectionObserver, ConnectionEvent};
use std::sync::Arc;

struct MyObserver;

impl ConnectionObserver for MyObserver {
    fn on_event(&self, event: &ConnectionEvent) {
        match event {
            ConnectionEvent::Connected => {
                println!("已连接");
            }
            ConnectionEvent::Disconnected(reason) => {
                println!("连接断开: {}", reason);
            }
            ConnectionEvent::Message(data) => {
                // 处理原始消息数据
                println!("收到消息: {} bytes", data.len());
            }
            ConnectionEvent::Error(err) => {
                println!("连接错误: {:?}", err);
            }
        }
    }
}

let builder = FlareClientBuilder::new("ws://127.0.0.1:8080")
    .with_observer(Arc::new(MyObserver));
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_format(self, format: SerializationFormat) -> Self

设置序列化格式

Source

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

设置压缩算法

Source

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

强制指定序列化格式

Source

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

强制指定压缩算法

Source

pub fn with_device_info(self, device_info: DeviceInfo) -> 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_race_timeout(self, timeout: Duration) -> Self

设置协议竞速超时

Source

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

设置重连间隔

Source

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

设置最大重连次数

Source

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

设置 Token(用于认证)

Source

pub fn enable_router(self) -> Self

启用消息路由

Source

pub async fn build_with_race(self) -> Result<FlareClient>

构建客户端(使用协议竞速)

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