Struct HsClientConnector

pub struct HsClientConnector<R: Runtime, D: MockableConnectorData = Data> {
    pub(crate) runtime: R,
    pub(crate) circpool: Arc<HsCircPool<R>>,
    pub(crate) services: Arc<Mutex<Services<D>>>,
    pub(crate) mock_for_state: D::MockGlobalState,
}

An object that negotiates connections with onion services

This can be used by multiple requests on behalf of different clients, with potentially different HS service discovery keys (KS_hsc_*) and potentially different circuit isolation.

The principal entrypoint is get_or_launch_connection().

This object is handle-like: it is fairly cheap to clone, and contains Arcs internally.

Fields

runtime: R

The runtime

circpool: Arc<HsCircPool<R>>

A HsCircPool that we use to build circuits to HsDirs, introduction points, and rendezvous points.

services: Arc<Mutex<Services<D>>>

Information we are remembering about different onion services.

mock_for_state: D::MockGlobalState

For mocking in tests of state.rs

Implementations

impl<R: Runtime> HsClientConnector<R, Data>

pub fn new( runtime: R, circpool: Arc<HsCircPool<R>>, config: &impl HsClientConnectorConfig, housekeeping_prompt: BoxStream<'static, ()>, ) -> Result<Self, StartupError>

Create a new HsClientConnector

housekeeping_prompt should yield “occasionally”, perhaps every few hours or maybe daily.

In Arti we arrange for this to happen when we have a new consensus.

Housekeeping events shouldn’t arrive while we’re dormant, since the housekeeping might involve processing that ought to be deferred.

pub fn get_or_launch_circuit<'r>( &'r self, netdir: &'r Arc<NetDir>, hs_id: HsId, secret_keys: HsClientSecretKeys, isolation: StreamIsolation, ) -> impl Future<Output = Result<Arc<ClientCirc>, ConnError>> + Send + Sync + 'r

Connect to a hidden service

On success, this function will return an open rendezvous circuit with an authenticated connection to the onion service whose identity is hs_id. If such a circuit already exists, and its isolation is compatible with isolation, that circuit may be returned; otherwise, a new circuit will be created.

Once a circuit is returned, the caller can use it to open new streams to the onion service. To do so, call [ClientCirc::begin_stream] on it.

Each HS connection request must provide the appropriate service discovery keys to use - or default if the hidden service is not running in restricted discovery mode.

pub fn get_or_launch_connection<'r>( &'r self, netdir: &'r Arc<NetDir>, hs_id: HsId, secret_keys: HsClientSecretKeys, isolation: StreamIsolation, ) -> impl Future<Output = Result<Arc<ClientCirc>, ConnError>> + Send + Sync + 'r

👎Deprecated since 0.5.1: Use get_or_launch_circuit instead.

A deprecated alias for get_or_launch_circuit.

We renamed it to be more clear about what exactly it is launching.

impl<R: Runtime, D: MockableConnectorData> HsClientConnector<R, D>

pub(crate) fn services(&self) -> Result<MutexGuard<'_, Services<D>>, Bug>

Lock the Services table and return the guard

Convenience method

pub(crate) fn spawn_housekeeping_task( &self, prompt: BoxStream<'static, ()>, ) -> Result<(), StartupError>

Spawn a task which watches prompt and calls Services::run_housekeeping

Trait Implementations

impl<R: Runtime, D: MockableConnectorData> Clone for HsClientConnector<R, D>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.