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 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
//! Global configuration for this crate.
//!
//! You may change the configuration by calling `set_config` function.
//!
//! # Example
//! ```rust
//! use tcp_server::config::{ServerConfig, set_config};
//!
//! # fn main() {
//! set_config(ServerConfig::default());
//! # }
//! ```
use std::sync::RwLock;
use lazy_static::lazy_static;
/// Global configuration.
///
/// # Example
/// ```rust
/// use tcp_server::config::ServerConfig;
///
/// # fn main() {
/// let config = ServerConfig::default();
/// # let _ = config;
/// # }
/// ```
#[derive(Debug, Clone, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
pub struct ServerConfig {
/// `addr` is the address the server bind.
/// Default value is `localhost:0`.
///
/// # Example
/// ```rust
/// use tcp_server::config::ServerConfig;
///
/// # fn main() {
/// let config = ServerConfig {
/// addr: "localhost:0".to_string(),
/// ..ServerConfig::default()
/// };
/// # let _ = config;
/// # }
/// ```
pub addr: String,
/// `connect_sec` is the timeout of connecting from the client.
/// Default value is `30`.
///
/// # Example
/// ```rust
/// use tcp_server::config::ServerConfig;
///
/// # fn main() {
/// let config = ServerConfig {
/// connect_sec: 30,
/// ..ServerConfig::default()
/// };
/// # let _ = config;
/// # }
/// ```
pub connect_sec: u64,
/// `idle_sec` is the timeout of sending/receiving message.
/// Default value is `30`.
///
/// # Example
/// ```rust
/// use tcp_server::config::ServerConfig;
///
/// # fn main() {
/// let config = ServerConfig {
/// idle_sec: 30,
/// ..ServerConfig::default()
/// };
/// # let _ = config;
/// # }
/// ```
pub idle_sec: u64,
}
impl Default for ServerConfig {
fn default() -> Self {
Self {
addr: "localhost:0".to_string(),
connect_sec: 30,
idle_sec: 30,
}
}
}
lazy_static! {
static ref CONFIG: RwLock<ServerConfig> = RwLock::new(ServerConfig::default());
}
/// Sets the global configuration.
///
/// This function is recommended to only be called once during initialization.
///
/// # Example
/// ```rust
/// use tcp_server::config::{ServerConfig, set_config};
///
/// # fn main() {
/// set_config(ServerConfig::default());
/// # }
/// ```
#[inline]
pub fn set_config(config: ServerConfig) {
let mut c = CONFIG.write().unwrap();
*c = config;
}
/// Gets the global configuration.
///
/// # Example
/// ```rust
/// use tcp_server::config::get_config;
///
/// # fn main() {
/// let config = get_config();
/// # let _ = config;
/// # }
/// ```
#[inline]
pub fn get_config() -> ServerConfig {
let c = CONFIG.read().unwrap();
(*c).clone()
}
/// A cheaper shortcut of
/// ```rust,ignore
/// get_config().addr
/// ```
#[inline]
pub fn get_addr() -> String {
let c = CONFIG.read().unwrap();
(*c).addr.clone()
}
/// A cheaper shortcut of
/// ```rust,ignore
/// get_config().connect_sec
/// ```
#[inline]
pub fn get_connect_sec() -> u64 {
let c = CONFIG.read().unwrap();
(*c).connect_sec
}
/// A cheaper shortcut of
/// ```rust,ignore
/// get_config().idle_sec
/// ```
#[inline]
pub fn get_idle_sec() -> u64 {
let c = CONFIG.read().unwrap();
(*c).idle_sec
}