Struct PendingClientCirc

pub struct PendingClientCirc {
    recvcreated: Receiver<CreateResponse>,
    circ: Arc<ClientCirc>,
}

A ClientCirc that needs to send a create cell and receive a created* cell.

To use one of these, call create_firsthop_fast() or create_firsthop() to negotiate the cryptographic handshake with the first hop.

Fields

recvcreated: Receiver<CreateResponse>

A oneshot receiver on which we’ll receive a CREATED* cell, or a DESTROY cell.

circ: Arc<ClientCirc>

The ClientCirc object that we can expose on success.

Implementations

impl PendingClientCirc

pub(crate) fn new( id: CircId, channel: Arc<Channel>, createdreceiver: Receiver<CreateResponse>, input: Receiver<ClientCircChanMsg, MpscSpec>, unique_id: UniqId, runtime: DynTimeProvider, memquota: CircuitAccount, ) -> (PendingClientCirc, Reactor)

Instantiate a new circuit object: used from Channel::new_circ().

Does not send a CREATE* cell on its own.

pub fn peek_unique_id(&self) -> UniqId

Extract the process-unique identifier for this pending circuit.

pub async fn create_firsthop_fast( self, params: CircParameters, ) -> Result<Arc<ClientCirc>>

Use the (questionable!) CREATE_FAST handshake to connect to the first hop of this circuit.

There’s no authentication in CRATE_FAST, so we don’t need to know whom we’re connecting to: we’re just connecting to whichever relay the channel is for.

pub async fn create_firsthop<Tg>( self, target: &Tg, params: CircParameters, ) -> Result<Arc<ClientCirc>>

where Tg: CircTarget,

Use the most appropriate handshake to connect to the first hop of this circuit.

Note that the provided ‘target’ must match the channel’s target, or the handshake will fail.

pub async fn create_firsthop_ntor<Tg>( self, target: &Tg, params: CircParameters, ) -> Result<Arc<ClientCirc>>

where Tg: CircTarget,

Use the ntor handshake to connect to the first hop of this circuit.

Note that the provided ‘target’ must match the channel’s target, or the handshake will fail.

pub async fn create_firsthop_ntor_v3<Tg>( self, target: &Tg, params: CircParameters, ) -> Result<Arc<ClientCirc>>

where Tg: CircTarget,

Use the ntor_v3 handshake to connect to the first hop of this circuit.

Assumes that the target supports ntor_v3. The caller should verify this before calling this function, e.g. by validating that the target has advertised “Relay=4”.

Note that the provided ‘target’ must match the channel’s target, or the handshake will fail.