Struct IptEstablisher

pub(crate) struct IptEstablisher {
    _terminate_tx: Sender<Void>,
    state: Arc<Mutex<EstablisherState>>,
}

Handle onto the task which is establishing and maintaining one IPT

Fields

_terminate_tx: Sender<Void>

A oneshot sender which, when dropped, notifies the running task that it’s time to shut down.

state: Arc<Mutex<EstablisherState>>

Mutable state shared with the Establisher, Reactor, and MsgHandler.

Implementations

impl IptEstablisher

pub(crate) fn launch<R: Runtime>( runtime: &R, params: IptParameters, pool: Arc<HsCircPool<R>>, keymgr: &Arc<KeyMgr>, ) -> Result<(Self, Receiver<IptStatus>), FatalError>

Try to set up, and maintain, an IPT at target.

Rendezvous requests will be rejected or accepted depending on the value of accepting_requests (which must be Advertised or NotAdvertised).

Also returns a stream of events that is produced whenever we have a change in the IptStatus for this intro point. Note that this stream is potentially lossy.

The returned watch::Receiver will yield Faulty if the IPT establisher is shut down (or crashes).

When the resulting IptEstablisher is dropped, it will cancel all tasks and close all circuits used to establish this introduction point.

pub(crate) fn start_accepting(&self)

Begin accepting requests from this introduction point.

If any introduction requests are sent before we have called this method, they are treated as an error and our connection to this introduction point is closed.

Trait Implementations

impl Drop for IptEstablisher

When the IptEstablisher is dropped it is torn down

Synchronously

• No rendezvous requests will be accepted that arrived after Drop::drop returns.

Asynchronously

• Circuits constructed for this IPT are torn down
• The rend_reqs sink is closed (dropped)
• IptStatusStatus::Faulty will be indicated

fn drop(&mut self)

Executes the destructor for this type.