Struct Activity 

pub(super) struct Activity(Arc<Mutex<Instant>>);

When something last made progress, like a connection by what its client sent or got, or a container which took the stdin of a session. Clones share the time.

Tuple Fields

0: Arc<Mutex<Instant>>

Implementations

impl Activity

pub(super) fn new() -> Self

An activity whose last progress is now.

pub(super) fn touch(&self)

Something made progress now.

pub(super) fn last(&self) -> Instant

When something last made progress.

pub(super) async fn idle(&self, timeout: Option<Duration>)

Resolves once the connection was not active for the timeout. A timeout too large to represent is none, like no timeout.

pub(super) async fn until_idle<T>( &self, timeout: Option<Duration>, run: impl Future<Output = T>, on_idle: impl FnOnce(), ) -> Option<T>

Run run until it is done, or until the connection was not active for the timeout, which gives None. on_idle runs before run gets dropped then.

pub(super) async fn until_stalled<T>( &self, start: Instant, timeout: Duration, run: impl Future<Output = T>, ) -> Option<T>

Run run until it is done, or until the activity was not touched for the timeout, counted from start at the earliest, which gives None. The writes of a connection touch it as they go out, which lets the end of a connection take as long as a slow client needs, see STALL_TIMEOUT.

pub(super) async fn until_stalled_or_idle<T>( &self, start: Instant, timeout: Duration, idle_timeout: Option<Duration>, run: impl Future<Output = T>, ) -> Option<T>

Like Self::until_stalled, but not before the activity was not touched for the idle timeout either. A client which pauses the output, like a pager, keeps the end as long as it kept the rest of a session, one which ended for its idle timeout gets only the timeout, like with an idle timeout too large for the clock.

pub(super) fn watch( &self, timeout: Option<Duration>, ended: CancellationToken, on_idle: impl FnOnce() + Send + 'static, )

Watch the connection in a task of its own until ended gets cancelled, and run on_idle once it was not active for the timeout before that.

Trait Implementations

impl Clone for Activity

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Activity

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.