Skip to content

Commit 33edc5f

Browse files
Update docs
1 parent e45deda commit 33edc5f

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

boringtun/src/noise/timers.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,7 @@ impl Tunn {
433433

434434
/// Returns an [`Instant`] when [`Tunn::update_timers_at`] should be called again.
435435
///
436-
/// If this returns `None`, you may call it at your usual desired precision (usually once a second is enough).
436+
/// Calling it earlier than the given [`Instant`] is safe but unlikely to have any effect.
437437
pub fn next_timer_update(&self) -> Option<Instant> {
438438
// Mimic the `update_timers_at` function: If we have a handshake scheduled, other timers don't matter.
439439
if let Some(scheduled_handshake) = self.timers.send_handshake_at {

0 commit comments

Comments
 (0)