Skip to main content

FlareClient

Struct FlareClient 

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

Flare 客户端

Implementations§

Source§

impl FlareClient

Source

pub async fn send_frame(&self, frame: &Frame) -> Result<()>

发送消息 Frame

Source

pub async fn send_frame_and_wait( &self, frame: &Frame, timeout: Duration, ) -> Result<Frame>

发送并等待响应(按 message_id 匹配)

Source

pub fn is_connected(&self) -> bool

检查是否已连接(native 同步;WASM 请用 Self::is_connected_async

Source

pub async fn is_connected_async(&self) -> bool

检查是否已连接(async,全平台)

Source

pub async fn disconnect(self) -> Result<()>

断开连接

Source

pub fn connection_id(&self) -> Option<String>

获取连接 ID(native 同步;WASM 请用 Self::connection_id_async

Source

pub async fn connection_id_async(&self) -> Option<String>

获取连接 ID(async,全平台)

Source

pub async fn parser_snapshot(&self) -> MessageParser

获取协商后的消息解析器快照

Source

pub fn active_protocol(&self) -> TransportProtocol

获取活动协议

Source

pub async fn update_heartbeat_config(&self, config: HeartbeatConfig)

运行期替换心跳策略。

Source

pub async fn set_heartbeat_app_state(&self, state: HeartbeatAppState)

更新应用前后台状态。移动端进入后台时可拉长心跳,回到前台时恢复较短心跳。

Source

pub async fn set_heartbeat_nat_timeout(&self, timeout: Option<Duration>)

更新 NAT 空闲超时探测结果。传入 None 表示清除探测值。

Source

pub async fn heartbeat_effective_interval(&self) -> Duration

当前实际心跳间隔。

Source

pub async fn update_parser(&self, parser: MessageParser)

更新消息管道解析器(协商完成后调用)

Source

pub async fn add_observer(&self, observer: Arc<dyn ConnectionObserver>)

添加连接观察者

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

Trait Implementations§

Source§

impl Clone for FlareClient

Source§

fn clone(&self) -> FlareClient

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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