Struct PendingRequest

pub(crate) struct PendingRequest {
    guard_id: FirstHopId,
    usage: GuardUsage,
    usable: Option<Sender<bool>>,
    waiting_since: Option<Instant>,
    net_has_been_down: bool,
}

Pending information about a guard that we handed out in response to some request, but where we have not yet reported whether the guard is usable.

We create one of these whenever we give out a guard with an uncertain usability status via GuardUsable::new_uncertain.

Fields

guard_id: FirstHopId

Identity of the guard that we gave out.

usage: GuardUsage

The usage for which this guard was requested.

We need this information because, if we find that a better guard than this one might be usable, we should only give it precedence if that guard is also allowable for this usage.

usable: Option<Sender<bool>>

A oneshot channel used to tell the circuit manager that a circuit built through this guard can be used.

(This is an option so that we can safely make reply() once-only. Otherwise we run into lifetime issues elsewhere.)

waiting_since: Option<Instant>

The time at which the circuit manager told us that this guard was successful.

net_has_been_down: bool

If true, then the network has been down for a long time when we launched this request.

If this request succeeds, it probably means that the net has come back up.

Implementations

impl PendingRequest

pub(crate) fn new( guard_id: FirstHopId, usage: GuardUsage, usable: Option<Sender<bool>>, net_has_been_down: bool, ) -> Self

Create a new PendingRequest.

pub(crate) fn guard_id(&self) -> &FirstHopId

Return the Id of the guard we gave out.

pub(crate) fn usage(&self) -> &GuardUsage

Return the usage for which we gave out the guard.

pub(crate) fn waiting_since(&self) -> Option<Instant>

Return the time (if any) when we were told that the guard was successful.

pub(crate) fn net_has_been_down(&self) -> bool

Return true if the network had been down for a long time when this guard was handed out.

pub(crate) fn reply(&mut self, usable: bool)

Tell the circuit manager that the guard is usable (or unusable), depending on the argument.

Does nothing if reply() has already been called.

pub(crate) fn mark_waiting(&mut self, now: Instant)

Mark this request as “waiting” since the time now.

This function should only be called once per request.

Trait Implementations

impl Debug for PendingRequest

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

Formats the value using the given formatter.