Struct tor_cell::relaycell::msg::Sendme

pub struct Sendme { /* private fields */ }

A Sendme message is used to increase flow-control windows.

To avoid congestion, each Tor circuit and stream keeps track of a number of data cells that it is willing to send. It decrements these numbers every time it sends a cell. If these numbers reach zero, then no more cells can be sent on the stream or circuit.

The only way to re-increment these numbers is by receiving a Sendme cell from the other end of the circuit or stream.

For security, current circuit-level Sendme cells include an authentication tag that proves knowledge of the cells that they are acking.

See tor-spec.txt for more information; also see the source for tor_proto::circuit::sendme.

Implementations

impl Sendme

pub fn new_empty() -> Self

Return a new empty sendme cell

This format is used on streams, and on circuits without sendme authentication.

pub fn new_tag(x: [u8; 20]) -> Self

This format is used on circuits with sendme authentication.

pub fn into_tag(self) -> Option<Vec<u8>>

Consume this cell and return its authentication tag, if any

Trait Implementations

impl Body for Sendme

fn decode_from_reader(r: &mut Reader<'_>) -> Result<Self>

Decode a relay cell body from a provided reader.

fn encode_onto<W: Writer + ?Sized>(self, w: &mut W) -> EncodeResult<()>

Encode the body of this cell into the end of a writer.

impl Clone for Sendme

fn clone(&self) -> Sendme

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Sendme

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

Formats the value using the given formatter.

impl From<Sendme> for AnyRelayMsg

fn from(m: Sendme) -> AnyRelayMsg

Converts to this type from the input type.

impl RelayMsg for Sendme

fn cmd(&self) -> RelayCmd

Return the stream command associated with this message.

fn encode_onto<W: Writer + ?Sized>(self, w: &mut W) -> EncodeResult<()>

Encode the body of this message, not including command or length

fn decode_from_reader(cmd: RelayCmd, r: &mut Reader<'_>) -> Result<Self>

Extract the body of a message with command cmd from reader r.

impl TryFrom<AnyRelayMsg> for Sendme

type Error = Error

The type returned in the event of a conversion error.

fn try_from(msg: AnyRelayMsg) -> Result<Sendme>

Performs the conversion.