Struct ClientConfluxMsgHandler 

pub(crate) struct ClientConfluxMsgHandler {
    state: ConfluxState,
    nonce: V1Nonce,
    join_point: HopNum,
    init_rtt: Option<Duration>,
    link_sent: Option<SystemTime>,
    runtime: DynTimeProvider,
    last_seq_recv: u64,
    last_seq_sent: u64,
    last_seq_delivered: Arc<AtomicU64>,
    have_seen_switch: bool,
    cells_since_switch: usize,
    cwnd_params: CongestionWindowParams,
}

Client-side implementation of a conflux message handler.

Fields

state: ConfluxState

The current state this leg is in.

nonce: V1Nonce

The nonce associated with the circuits from this set.

join_point: HopNum

The expected conflux join point.

init_rtt: Option<Duration>

measured during the conflux handshake.

On the client side, this is the RTT between RELAY_CONFLUX_LINK and RELAY_CONFLUX_LINKED.

link_sent: Option<SystemTime>

The time when the handshake was initiated.

runtime: DynTimeProvider

A handle to the time provider.

last_seq_recv: u64

The sequence number of the last message received on this leg.

This is a relative number.

Incremented by the ConfluxMsgHandler each time a cell that counts towards sequence numbers is received on this leg.

last_seq_sent: u64

The sequence number of the last message sent on this leg.

This is a relative number.

Incremented by the ConfluxMsgHandler each time a cell that counts towards sequence numbers is sent on this leg.

last_seq_delivered: Arc<AtomicU64>

The absolute sequence number of the last message delivered to a stream.

This is shared by all the circuits in a conflux set,

Incremented by the ConfluxMsgHandler upon delivering the cell to its corresponding stream.

have_seen_switch: bool

Whether we have processed any SWITCH cells on the leg this handler is installed on.

cells_since_switch: usize

The number of cells that count towards the conflux seqnos received on this leg since the last SWITCH.

cwnd_params: CongestionWindowParams

The congestion window parameters.

Used for SWITCH cell validation.

Implementations

impl ClientConfluxMsgHandler

pub(crate) fn new( join_point: HopNum, nonce: V1Nonce, last_seq_delivered: Arc<AtomicU64>, cwnd_params: CongestionWindowParams, runtime: DynTimeProvider, ) -> Self

Create a new client conflux message handler.

fn handle_conflux_link( &mut self, msg: UnparsedRelayMsg, hop: HopNum, ) -> Result<Option<ConfluxCmd>>

Handle a conflux LINK request coming from the specified hop.

fn handle_conflux_linked( &mut self, msg: UnparsedRelayMsg, hop: HopNum, ) -> Result<Option<ConfluxCmd>>

Handle a conflux LINKED response coming from the specified hop.

The caller must validate the hop the cell originated from.

To prevent DROPMARK attacks, this returns a protocol error if any of the following conditions are not met:

• this is an unlinked circuit that sent a LINK command
• that the nonce matches the nonce used in the LINK command

fn handle_conflux_linked_ack( &mut self, msg: UnparsedRelayMsg, hop: HopNum, ) -> Result<Option<ConfluxCmd>>

Handle a conflux LINKED acknowledgment coming from the specified hop.

fn handle_conflux_switch( &mut self, msg: UnparsedRelayMsg, _hop: HopNum, ) -> Result<Option<ConfluxCmd>>

Handle a conflux SWITCH coming from the specified hop.

fn validate_switch_seqno(&self, rel_seqno: u32) -> Result<()>

Validate the relative sequence number specified in a switch command.

Returns an error if

• rel_seqno is 0 (i.e. the SWITCH cell does not actually increment the last_seq_recv seqno on this leg)
• the tunnel has not yet received any data and rel_seqno is greater than the initial congestion window,

Trait Implementations

impl AbstractConfluxMsgHandler for ClientConfluxMsgHandler

fn handshake_timeout(&self) -> Option<SystemTime>

Get the wallclock time when the handshake on this circuit is supposed to time out.

Returns None if the handshake is not currently in progress.

fn init_rtt(&self) -> Option<Duration>

Returns the initial RTT measured by this handler.

fn validate_source_hop(&self, msg: &UnparsedRelayMsg, hop: HopNum) -> Result<()>

Validate the specified source hop of a conflux cell.

fn handle_msg( &mut self, msg: UnparsedRelayMsg, hop: HopNum, ) -> Result<Option<ConfluxCmd>>

Handle the specified conflux msg.

fn status(&self) -> ConfluxStatus

Returns the conflux status of this handler.

fn note_link_sent(&mut self, ts: SystemTime) -> Result<(), Bug>

Client-only: note that the LINK cell was sent.

fn last_seq_recv(&self) -> u64

Return the sequence number of the last message received on this leg.

fn last_seq_sent(&self) -> u64

Return the sequence number of the last message sent on this leg.

fn set_last_seq_sent(&mut self, n: u64)

Set the sequence number of the last message sent on this leg.

fn inc_last_seq_recv(&mut self)

Increment the sequence number of the last message received on this leg.

fn inc_last_seq_sent(&mut self)

Increment the sequence number of the last message sent on this leg.