signal-fish-server 0.2.0

A lightweight, in-memory WebSocket signaling server for peer-to-peer game networking
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

//! Server behavior configuration types.

use super::defaults::{
    default_empty_room_timeout, default_enable_reconnection, default_event_buffer_size,
    default_heartbeat_throttle_secs, default_inactive_room_timeout, default_max_join_attempts,
    default_max_players, default_max_room_creations, default_max_rooms_per_game,
    default_ping_timeout, default_rate_limit_time_window, default_reconnection_window,
    default_region_id, default_room_cleanup_interval,
};
use serde::{Deserialize, Serialize};

/// Server configuration for room and player management.
#[derive(Debug, Deserialize, Serialize, Clone)]
pub struct ServerConfig {
    /// Default maximum players per room
    #[serde(default = "default_max_players")]
    pub default_max_players: u8,
    /// Timeout for client ping responses (seconds)
    #[serde(default = "default_ping_timeout")]
    pub ping_timeout: u64,
    /// Interval for room cleanup task (seconds)
    #[serde(default = "default_room_cleanup_interval")]
    pub room_cleanup_interval: u64,
    /// Maximum number of rooms per game
    #[serde(default = "default_max_rooms_per_game")]
    pub max_rooms_per_game: usize,
    /// Time after creation when empty rooms expire (seconds)
    #[serde(default = "default_empty_room_timeout")]
    pub empty_room_timeout: u64,
    /// Time after last activity when rooms with players expire (seconds)
    #[serde(default = "default_inactive_room_timeout")]
    pub inactive_room_timeout: u64,
    /// Time window for reconnection after disconnection (seconds)
    #[serde(default = "default_reconnection_window")]
    pub reconnection_window: u64,
    /// Number of events to buffer per room for reconnection
    #[serde(default = "default_event_buffer_size")]
    pub event_buffer_size: usize,
    /// Enable player reconnection after disconnection
    #[serde(default = "default_enable_reconnection")]
    pub enable_reconnection: bool,
    /// Threshold for heartbeat throttling (seconds).
    /// Controls how frequently heartbeat timestamps are recorded.
    /// Set to 0 to disable throttling (update on every heartbeat).
    #[serde(
        default = "default_heartbeat_throttle_secs",
        alias = "heartbeat_db_throttle_secs"
    )]
    pub heartbeat_throttle_secs: u64,
    /// Identifier for the deployment region (used in player info and room codes).
    #[serde(default = "default_region_id")]
    pub region_id: String,
    /// Optional prefix prepended to generated room codes.
    #[serde(default)]
    pub room_code_prefix: Option<String>,
}

impl Default for ServerConfig {
    fn default() -> Self {
        Self {
            default_max_players: default_max_players(),
            ping_timeout: default_ping_timeout(),
            room_cleanup_interval: default_room_cleanup_interval(),
            max_rooms_per_game: default_max_rooms_per_game(),
            empty_room_timeout: default_empty_room_timeout(),
            inactive_room_timeout: default_inactive_room_timeout(),
            reconnection_window: default_reconnection_window(),
            event_buffer_size: default_event_buffer_size(),
            enable_reconnection: default_enable_reconnection(),
            heartbeat_throttle_secs: default_heartbeat_throttle_secs(),
            region_id: default_region_id(),
            room_code_prefix: None,
        }
    }
}

/// Rate limiting configuration.
#[derive(Debug, Deserialize, Serialize, Clone)]
pub struct RateLimitConfig {
    /// Maximum number of room creation requests per time window
    #[serde(default = "default_max_room_creations")]
    pub max_room_creations: u32,
    /// Time window for rate limiting (seconds)
    #[serde(default = "default_rate_limit_time_window")]
    pub time_window: u64,
    /// Maximum number of join attempts per time window
    #[serde(default = "default_max_join_attempts")]
    pub max_join_attempts: u32,
}

impl Default for RateLimitConfig {
    fn default() -> Self {
        Self {
            max_room_creations: default_max_room_creations(),
            time_window: default_rate_limit_time_window(),
            max_join_attempts: default_max_join_attempts(),
        }
    }
}