Enum ServiceState

enum ServiceState<D: MockableConnectorData> {
    Closed {
        data: D,
        last_used: Instant,
    },
    Open {
        data: D,
        circuit: Arc<D::ClientCirc>,
        last_used: Instant,
        circuit_expiry_task: CircuitExpiryTask,
    },
    Working {
        barrier_recv: Receiver,
        error: Arc<Mutex<Option<ConnError>>>,
    },
    Dummy,
}

Value in the Services data structure

State and history of of our connections, including connection to any connection task.

last_used is used to expire data eventually.

Variants

Closed

We don’t have a circuit

Fields

data: D

The state

last_used: Instant

Last time we touched this, including reuse

Open

We have an open circuit, which we can (hopefully) just use

Fields

data: D

The state

circuit: Arc<D::ClientCirc>

The circuit

last_used: Instant

Last time we touched this, including reuse

This is set when we created the circuit, and updated when we hand out this circuit again in response to a new request.

We believe this mirrors C Tor behaviour; see RETAIN_CIRCUIT_AFTER_LAST_USE.

circuit_expiry_task: CircuitExpiryTask

We have a task that will close the circuit when required

This field serves to require construction sites of Open to demonstrate that there is an expiry task. In the future, it may also serve to cancel old expiry tasks.

Working

We have a task trying to find the service and establish the circuit

CachedData is owned by the task.

Fields

barrier_recv: Receiver

Signals instances of get_or_launch_connection when the task completes

error: Arc<Mutex<Option<ConnError>>>

Where the task will store the error.

Lock hierarchy: this lock is “inside” the big lock on Services.

Dummy

Dummy value for use with temporary mem replace

Implementations

impl<D: MockableConnectorData> ServiceState<D>

fn blank(runtime: &impl Runtime) -> Self

Make a new (blank) ServiceState::Closed

impl<D: MockableConnectorData> ServiceState<D>

fn spawn_circuit_expiry_task( connector: &HsClientConnector<impl Runtime, D>, hsid: HsId, table_index: TableIndex, last_used: Instant, now: Instant, ) -> Result<CircuitExpiryTask, SpawnError>

Spawn a task that will drop our reference to the rendezvous circuit at table_index when it has gone too long without any use.

According to RETAIN_CIRCUIT_AFTER_LAST_USE.

Trait Implementations

impl<D: MockableConnectorData> Debug for ServiceState<D>

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

Formats the value using the given formatter.