sdforge 0.3.0

Multi-protocol SDK framework with unified macro configuration
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

// Copyright (c) 2026 Kirky.X
// SPDX-License-Identifier: MIT
//! WebSocket support for Axiom
//!
//! This module provides WebSocket protocol support alongside SSE.
//! It includes message types, connection management, and routing.
//!
//! # Features
//!
//! - Real-time bidirectional communication
//! - Automatic connection management
//! - Message serialization/deserialization
//! - Broadcast and point-to-point messaging
//!
//! # Example
//!
//! ```rust
//! use sdforge::websocket::{WebSocketMessage, ConnectionManager};
//!
//! let manager = ConnectionManager::new();
//! let message = WebSocketMessage::Request {
//!     id: "123".to_string(),
//!     method: "get_data".to_string(),
//!     params: serde_json::json!({"key": "value"}),
//! };
//! ```
//!
//! # Module Organization
//!
//! - `message`: [`WebSocketMessage`] enum, parsing, and depth/size limits
//! - `connection`: [`WebSocketConnection`], [`ConnectionManager`], `RateLimitConfig`,
//!   [`WebSocketConfig`], `AppState`
//! - `broadcast`: [`ConnectionManager::broadcast`] fan-out implementation
//! - `handler`: [`WebSocketHandler`] trait, `DefaultWebSocketHandler`,
//!   [`ValidatedWebSocketUpgrade`], [`websocket_upgrade`], `handle_socket`, [`build`]

#[cfg(feature = "websocket")]
mod broadcast;
#[cfg(feature = "websocket")]
mod connection;
#[cfg(feature = "websocket")]
mod handler;
#[cfg(feature = "websocket")]
mod message;

#[cfg(test)]
#[cfg(feature = "websocket")]
mod tests;

// Re-export public API. Order mirrors the original `mod.rs` declarations so
// downstream `use crate::websocket::*` continues to resolve every type.
#[cfg(feature = "websocket")]
pub use connection::{
    AppState, ConnectionManager, RateLimitConfig, WebSocketConfig, WebSocketConnection,
};
#[cfg(feature = "websocket")]
pub use handler::{
    build, websocket_upgrade, BoxFuture, DefaultWebSocketHandler, ValidatedWebSocketUpgrade,
    WebSocketHandler, WebSocketRoute,
};
#[cfg(feature = "websocket")]
pub use message::{
    calculate_value_depth, parse_websocket_message, WebSocketMessage, MAX_JSON_DEPTH,
    MAX_MESSAGE_SIZE,
};
// Test-only helpers from `message` module — re-exported under test cfg so the
// split test files can access them via `use crate::websocket::*`.
#[cfg(test)]
#[cfg(feature = "websocket")]
pub use message::{calculate_json_depth, MAX_STRING_LENGTH};