Skip to content

Commit 0eb5421

Browse files
committed
docs: Adds missing documentation for conn limits
1 parent 1e12360 commit 0eb5421

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

quic/s2n-quic-core/src/connection/limits.rs

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,11 @@ impl Limits {
208208
}
209209
);
210210

211-
setter!(with_max_idle_timeout, max_idle_timeout, Duration);
211+
setter!(
212+
/// Sets how many seconds the connection will stay open without any activity on it.
213+
with_max_idle_timeout,
214+
max_idle_timeout,
215+
Duration);
212216

213217
/// Sets both the max local and remote limits for bidirectional streams.
214218
#[deprecated(
@@ -285,7 +289,14 @@ impl Limits {
285289
max_handshake_duration,
286290
Duration
287291
);
288-
setter!(with_max_keep_alive_period, max_keep_alive_period, Duration);
292+
setter!(
293+
/// Sets the period at which the connection will send a ping to its peer.
294+
///
295+
/// This setting will not have any effect unless the connection [`keep_alive`] function is
296+
/// enabled. Additionally this setting should be smaller than the max_idle_timeout to have any effect.
297+
with_max_keep_alive_period,
298+
max_keep_alive_period,
299+
Duration);
289300
/// Sets whether active connection migration is supported for a server endpoint (default: true)
290301
///
291302
/// If set to false, the `disable_active_migration` transport parameter will be sent to the

0 commit comments

Comments
 (0)