DGNum/rust-irc
6
0
Fork 0
Code Issues 1 Pull requests 3 Projects Releases Packages Wiki Activity Actions

Improved documentation for message throttling configuration.

Browse source
This commit is contained in:
Aaron Weiss 2018-01-01 21:47:28 -05:00
parent e446ff5042
commit 16292fcc2c
No known key found for this signature in database
GPG key ID: 047D32DF25DC22EF
1 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/client/data/config.rs
View file

@ -60,10 +60,14 @@ pub struct Config {
pub ping_time: Option<u32>, pub ping_time: Option<u32>,
/// The amount of time in seconds for a client to reconnect due to no ping response. /// The amount of time in seconds for a client to reconnect due to no ping response.
pub ping_timeout: Option<u32>, pub ping_timeout: Option<u32>,
/// The amount of time in seconds to consider a window for burst messages. /// The length in seconds of a rolling window for message throttling. If more than
/// `max_messages_in_burst` messages are sent within `burst_window_length` seconds, additional
/// messages will be delayed automatically as appropriate. In particular, in the past
/// `burst_window_length` seconds, there will never be more than `max_messages_in_burst` messages
/// sent.
pub burst_window_length: Option<u32>, pub burst_window_length: Option<u32>,
/// The maximum number of messages that can be sent in a burst window before they'll be delayed. /// The maximum number of messages that can be sent in a burst window before they'll be delayed.
/// Messages are automatically delayed until the start of the next window. /// Messages are automatically delayed as appropriate.
pub max_messages_in_burst: Option<u32>, pub max_messages_in_burst: Option<u32>,
/// Whether the client should use NickServ GHOST to reclaim its primary nickname if it is in /// Whether the client should use NickServ GHOST to reclaim its primary nickname if it is in
/// use. This has no effect if `nick_password` is not set. /// use. This has no effect if `nick_password` is not set.
@ -391,14 +395,18 @@ impl Config {
self.ping_timeout.as_ref().cloned().unwrap_or(10) self.ping_timeout.as_ref().cloned().unwrap_or(10)
} }
/// The amount of time in seconds to consider a window for burst messages. /// The amount of time in seconds to consider a window for burst messages. The message throttling
/// system maintains the invariant that in the past `burst_window_length` seconds, the maximum
/// number of messages sent is `max_messages_in_burst`.
/// This defaults to 8 seconds when not specified. /// This defaults to 8 seconds when not specified.
pub fn burst_window_length(&self) -> u32 { pub fn burst_window_length(&self) -> u32 {
self.burst_window_length.as_ref().cloned().unwrap_or(8) self.burst_window_length.as_ref().cloned().unwrap_or(8)
} }
/// The maximum number of messages that can be sent in a burst window before they'll be delayed. /// The maximum number of messages that can be sent in a burst window before they'll be delayed.
/// Messages are automatically delayed until the start of the next window. /// Messages are automatically delayed until the start of the next window. The message throttling
/// system maintains the invariant that in the past `burst_window_length` seconds, the maximum
/// number of messages sent is `max_messages_in_burst`.
/// This defaults to 15 messages when not specified. /// This defaults to 15 messages when not specified.
pub fn max_messages_in_burst(&self) -> u32 { pub fn max_messages_in_burst(&self) -> u32 {
self.max_messages_in_burst.as_ref().cloned().unwrap_or(15) self.max_messages_in_burst.as_ref().cloned().unwrap_or(15)