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

//! Native server runtime for WebSocket, QUIC, TCP, and hybrid listeners.
//!
//! The server module is available on native targets when the `server` feature is
//! enabled. It provides:
//!
//! - [`FlareServerBuilder`] for production integrations built around
//!   [`ServerEventHandler`], authentication, message pipelines, and connection
//!   lifecycle hooks.
//! - [`ServerBuilder`] for closure-based demos and compact prototypes.
//! - [`ObserverServerBuilder`] for integrations that need explicit connection
//!   observation.
//! - [`ConnectionManager`] and [`ServerHandle`] for sending frames, broadcasting,
//!   disconnecting clients, and inspecting connection snapshots.
//!
//! The server stack owns transport admission, negotiation, heartbeat detection,
//! backpressure-aware fanout, and cleanup. Business-specific message semantics
//! should remain in application handlers or higher-level services.

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

pub mod auth;
pub mod builder;
pub mod config;
pub mod connection;
pub mod device;
pub mod events;
pub mod handle;
pub mod heartbeat;
pub mod transports;

pub use auth::{AuthResult, Authenticator, DefaultAuthenticator};
pub use builder::{
    FlareServer, FlareServerBuilder, MessageContext, ObserverServer, ObserverServerBuilder,
    ServerBuilder, SimpleServer,
};
pub use config::ServerConfig;
pub use connection::{ConnectionInfo, ConnectionManager, ConnectionManagerTrait, ConnectionStats};
pub use device::{DeviceConflictStrategy, DeviceConflictStrategyBuilder, DeviceManager};
pub use events::ServerEventHandler;
pub use handle::{DefaultServerHandle, ServerHandle};
pub use heartbeat::HeartbeatDetector;
#[cfg(feature = "quic")]
pub use transports::QUICServer;
#[cfg(feature = "tcp")]
pub use transports::TCPServer;
#[cfg(feature = "websocket")]
pub use transports::WebSocketServer;
pub use transports::{ConnectionHandler, HybridServer, Server};

// Re-export server-oriented error types for ergonomic imports.
pub use crate::common::error::Result;
pub use crate::common::error::ServerError;

pub use crate::common::config_types::TransportProtocol;