Struct ClientDirTunnel 

pub struct ClientDirTunnel {
    tunnel: Arc<ClientTunnel>,
}

A client directory tunnel. This is always single path.

Fields

tunnel: Arc<ClientTunnel>

The protocol level tunnel.

Implementations

impl ClientDirTunnel

fn tunnel_ref(&self) -> &Arc<ClientTunnel>

Return a reference to the underlying tunnel.

Note: The “tunnel” name is hardcoded here. If it becomes an annoyance, we could make it as a meta value of the deftly declaration.

pub fn is_closed(&self) -> bool

Return true if this tunnel is closed and therefore unusable.

pub fn last_hop(&self) -> Result<TargetHop>

Return a TargetHop representing precisely the last hop of the circuit as in set as a HopLocation with its id and hop number.

Return an error if there is no last hop.

pub fn terminate(&self)

Shutdown the tunnel meaning this sends a shutdown command to the underlying circuit reactor which will stop asynchronously.

Note that it is not necessary to use this method as in if the tunnel reference is dropped, the circuit will close automatically.

pub fn unique_id(&self) -> UniqId

Return a process-unique identifier for this tunnel.

pub async fn send_raw_msg(&self, msg: AnyRelayMsg, hop: TargetHop) -> Result<()>

Send raw message.

pub async fn start_conversation( &self, msg: Option<AnyRelayMsg>, reply_handler: impl MsgHandler + Send + 'static, hop: TargetHop, ) -> Result<Conversation<'_>>

Start an ad-hoc protocol exchange to the specified hop on this tunnel.

See ClientTunnel::start_conversation documentation for more details.

pub fn wait_for_close( &self, ) -> impl Future<Output = ()> + Send + Sync + 'static + use<>

Return a future that will resolve once this circuit has closed.

Note that this method does not itself cause the circuit to shut down.

impl ClientDirTunnel

pub async fn begin_dir_stream(&self) -> Result<DataStream>

Start a stream to the given address and port, using a BEGIN_DIR cell.

impl ClientDirTunnel

fn circuit(&self) -> Result<&ClientCirc>

Return a reference to the circuit of this tunnel.

pub async fn extend<T: CircTarget>( &self, target: &T, params: CircParameters, ) -> Result<()>

Extend the circuit to a new target last hop using the ntor v3 handshake.

TODO: Might want to pass which handshake type as a parameter so this function can be a catch all on all possible handshakes. For now, use ntor v3 for all the things.

pub fn n_hops(&self) -> Result<usize>

Return the number of hops of the underlying circuit.

impl ClientDirTunnel

pub fn first_hop(&self) -> OwnedChanTarget

Return a description of the first hop of this circuit.

pub async fn first_hop_clock_skew(&self) -> Result<ClockSkew>

Get the clock skew claimed by the first hop of the circuit.

See Channel::clock_skew().

Trait Implementations

impl AsRef<ClientTunnel> for ClientDirTunnel

fn as_ref(&self) -> &ClientTunnel

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for ClientDirTunnel

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

Formats the value using the given formatter.

impl From<Arc<ClientTunnel>> for ClientDirTunnel

fn from(tunnel: Arc<ClientTunnel>) -> Self

Converts to this type from the input type.

impl From<ClientTunnel> for ClientDirTunnel

fn from(tunnel: ClientTunnel) -> Self

Converts to this type from the input type.