flare-core 1.0.3

A high-performance, reliable long-connection communication toolkit for Rust, supporting WebSocket and QUIC protocols with features like authentication, device management, serialization negotiation, and protocol racing.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

//! Client-side builders, transports, heartbeat management, and connection state.
//!
//! Native builds support WebSocket, QUIC, TCP, and hybrid protocol racing depending
//! on enabled features. WASM builds support the browser WebSocket client stack.
//!
//! Main entry points:
//!
//! - `FlareClientBuilder` for production integrations with a message listener
//!   and pipeline-oriented lifecycle.
//! - `ClientBuilder` for closure-based examples and simple applications.
//! - `ObserverClientBuilder` for native integrations that need explicit
//!   connection observation and protocol racing.
//! - `HybridClient` for native transport racing when multiple protocols are
//!   available.
//!
//! WASM integrators: read [`crate::transport::connection`] for `Send`/`Sync` and LocalSet rules,
//! and use the wasm async helpers re-exported by this module for browser entry points.

#[cfg(not(any(
    feature = "websocket",
    all(feature = "quic", not(target_arch = "wasm32")),
    all(feature = "tcp", not(target_arch = "wasm32"))
)))]
compile_error!(
    "feature `client` requires at least one transport feature: `websocket`, native `quic`, or native `tcp`"
);

pub mod builder;
pub mod config;
pub mod connection;
pub mod events;
pub mod heartbeat;
pub mod router;
pub mod runtime;
pub mod transports;
#[cfg(target_arch = "wasm32")]
pub mod wasm_tokio;

#[cfg(not(target_arch = "wasm32"))]
pub mod manager;

pub use builder::{ClientBuilder, FlareClient, FlareClientBuilder, MessageListener, SimpleClient};
pub use config::ClientConfig;
pub use connection::{ConnectionState, ConnectionStateManager};
pub use events::{ClientEventHandler, DefaultClientMessageObserver};
pub use heartbeat::HeartbeatManager;
pub use router::{AsyncHandler, MessageHandler, MessageRouter, SimpleHandler};
pub use transports::Client;
#[cfg(feature = "websocket")]
pub use transports::WebSocketClient;

#[cfg(target_arch = "wasm32")]
pub use wasm_tokio::{
    ensure_initialized as ensure_wasm_tokio, run_async as run_wasm_async,
    spawn_detached as spawn_wasm_detached,
};

#[cfg(not(target_arch = "wasm32"))]
pub use builder::{ObserverClient, ObserverClientBuilder};
#[cfg(not(target_arch = "wasm32"))]
pub use manager::ClientConnectionManager;
#[cfg(all(
    not(target_arch = "wasm32"),
    any(feature = "websocket", feature = "quic", feature = "tcp")
))]
pub use transports::HybridClient;
#[cfg(all(not(target_arch = "wasm32"), feature = "quic"))]
pub use transports::QUICClient;
#[cfg(all(not(target_arch = "wasm32"), feature = "tcp"))]
pub use transports::TCPClient;

pub use crate::common::config_types::TransportProtocol;
pub use crate::common::error::ClientError;
pub use crate::common::error::Result;