tor_proto::tunnel::reactor

Enum RunOnceCmdInner

Source 
enum RunOnceCmdInner {
    Send {
        leg: LegId,
        cell: SendRelayCell,
        done: Option<Sender<Result<()>>>,
    },
    SendMsgAndInstallHandler {
        msg: Option<AnyRelayMsgOuter>,
        handler: Option<Box<dyn MetaCellHandler + Send + 'static>>,
        done: Sender<Result<()>>,
    },
    HandleSendMe {
        leg: LegId,
        hop: HopNum,
        sendme: Sendme,
    },
    BeginStream {
        cell: Result<(SendRelayCell, StreamId)>,
        hop: HopLocation,
        leg: LegId,
        done: Sender<Result<(StreamId, HopLocation, RelayCellFormat)>>,
    },
    CloseStream {
        hop: HopLocation,
        sid: StreamId,
        behav: CloseStreamBehavior,
        reason: TerminateReason,
        done: Option<Sender<Result<()>>>,
    },
    FirstHopClockSkew {
        answer: Sender<Result<ClockSkew, Bug>>,
    },
    RemoveLeg {
        leg: LegId,
        reason: RemoveLegReason,
    },
    ConfluxHandshakeComplete {
        leg: LegId,
        cell: SendRelayCell,
    },
    Link {
        circuits: Vec<Circuit>,
        answer: Sender<Result<Vec<Result<(), ConfluxHandshakeError>>>>,
    },
    Enqueue {
        leg: LegId,
        msg: OooRelayMsg,
    },
    CleanShutdown,
}
Expand description

Instructions for running something in the reactor loop.

Run at the end of Reactor::run_once.

Variants§

§

Send

Send a RELAY cell.

Fields

§leg: LegId

The leg the cell should be sent on.

§cell: SendRelayCell

The cell to send.

§done: Option<Sender<Result<()>>>

A channel for sending completion notifications.

§

SendMsgAndInstallHandler

Available on crate feature send-control-msg only.

Send a given control message on this circuit, and install a control-message handler to receive responses.

Fields

§msg: Option<AnyRelayMsgOuter>

The message to send, if any

§handler: Option<Box<dyn MetaCellHandler + Send + 'static>>

A message handler to install.

If this is None, there must already be a message handler installed

§done: Sender<Result<()>>

A sender that we use to tell the caller that the message was sent and the handler installed.

§

HandleSendMe

Handle a SENDME message.

Fields

§leg: LegId

The leg the SENDME was received on.

§hop: HopNum

The hop number.

§sendme: Sendme

The SENDME message to handle.

§

BeginStream

Begin a stream with the provided hop in this circuit.

Uses the provided stream ID, and sends the provided message to that hop.

Fields

§cell: Result<(SendRelayCell, StreamId)>

The cell to send.

§hop: HopLocation

The location of the hop on the tunnel. We don’t use this (and Circuits shouldn’t need to worry about legs anyways), but need it so that we can pass it back in done to the caller.

§leg: LegId

The circuit leg to begin the stream on.

§done: Sender<Result<(StreamId, HopLocation, RelayCellFormat)>>

Oneshot channel to notify on completion, with the allocated stream ID.

§

CloseStream

Close the specified stream.

Fields

§hop: HopLocation

The hop number.

§sid: StreamId

The ID of the stream to close.

§behav: CloseStreamBehavior

The stream-closing behavior.

§reason: TerminateReason

The reason for closing the stream.

§done: Option<Sender<Result<()>>>

A channel for sending completion notifications.

§

FirstHopClockSkew

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

Fields

§answer: Sender<Result<ClockSkew, Bug>>

Oneshot channel to return the clock skew.

§

RemoveLeg

Remove a circuit leg from the conflux set.

Fields

§leg: LegId

The circuit leg to remove.

§reason: RemoveLegReason

The reason for removal.

This is only used for conflux circuits that get removed before the conflux handshake is complete.

The RemoveLegReason is mapped by the reactor to a ConfluxHandshakeError that is sent to the initiator of the handshake to indicate the reason the handshake failed.

§

ConfluxHandshakeComplete

Available on crate feature conflux only.

A circuit has completed the conflux handshake, and wants to send the specified cell.

This is similar to RunOnceCmdInner::Send, but needs to remain a separate variant, because in addition to instructing the reactor to send a cell, it also notifies it that the conflux handshake is complete on the specified leg. This enables the reactor to save the handshake result (Ok(())), and, if there are no other legs still in the handshake phase, send the result to the handshake initiator.

Fields

§leg: LegId

The circuit leg that has completed the handshake, This is the leg the cell should be sent on.

§cell: SendRelayCell

The cell to send.

Available on crate feature conflux only.

Send a LINK cell on each of the unlinked circuit legs in the conflux set of this reactor.

Fields

§circuits: Vec<Circuit>

The circuits to link into the tunnel

§answer: Sender<Result<Vec<Result<(), ConfluxHandshakeError>>>>

Oneshot channel for notifying of conflux handshake completion.

§

Enqueue

Available on crate feature conflux only.

Enqueue an out-of-order cell in ooo_msg.

Fields

§leg: LegId

The leg the entry originated from.

§msg: OooRelayMsg

The out-of-order message.

§

CleanShutdown

Perform a clean shutdown on this circuit.

Implementations§

Trait Implementations§

Source§

impl Debug for RunOnceCmdInner

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<RunOnceCmdInner> for RunOnceCmd

Source§

fn from(value: RunOnceCmdInner) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSend for T
where T: Any + Send,

§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T