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
//! Global configuration for this crate.
//!
//! You may change the configuration by calling `set_config` function.
//!
//! # Example
//! ```rust
//! use tcp_client::config::{ClientConfig, set_config};
//!
//! # fn main() {
//! set_config(ClientConfig::default());
//! # }
//! ```
use std::sync::RwLock;
/// Global configuration.
///
/// # Example
/// ```rust
/// use tcp_client::config::ClientConfig;
///
/// # fn main() {
/// let config = ClientConfig::default();
/// # let _ = config;
/// # }
/// ```
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
pub struct ClientConfig {
/// `connect_sec` is the timeout of connecting to the server.
/// Default value is `30`.
///
/// # Example
/// ```rust
/// use tcp_client::config::ClientConfig;
///
/// # fn main() {
/// let config = ClientConfig {
/// connect_sec: 30,
/// ..ClientConfig::default()
/// };
/// # let _ = config;
/// # }
/// ```
pub connect_sec: u64,
/// `idle_sec` is the timeout of sending/receiving from the server.
/// This is only used after sending a packet.
/// Default value is `30`.
///
/// # Example
/// ```rust
/// use tcp_client::config::ClientConfig;
///
/// # fn main() {
/// let config = ClientConfig {
/// idle_sec: 30,
/// ..ClientConfig::default()
/// };
/// # let _ = config;
/// # }
/// ```
pub idle_sec: u64,
}
impl Default for ClientConfig {
fn default() -> Self {
Self {
connect_sec: 30,
idle_sec: 30,
}
}
}
static CONFIG: RwLock<ClientConfig> = RwLock::new(ClientConfig {
connect_sec: 30,
idle_sec: 30,
});
/// Sets the global configuration.
///
/// This function is recommended to only be called once during initialization.
///
/// # Example
/// ```rust
/// use tcp_client::config::{ClientConfig, set_config};
///
/// # fn main() {
/// set_config(ClientConfig::default());
/// # }
/// ```
#[inline]
pub fn set_config(config: ClientConfig) {
let mut c = CONFIG.write().unwrap();
*c = config;
}
/// Gets the global configuration.
///
/// # Example
/// ```rust
/// use tcp_client::config::get_config;
///
/// # fn main() {
/// let config = get_config();
/// # let _ = config;
/// # }
/// ```
#[inline]
pub fn get_config() -> ClientConfig {
let c = CONFIG.read().unwrap();
(*c).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
}