Struct TunnelBudget 

pub struct TunnelBudget { /* private fields */ }

Available on crate feature masque only.

What each CONNECT-UDP tunnel of a proxy may move.

Every datagram is charged once, where it enters the proxy: one from the client when the tunnel receives it, whatever happens to it next (empty, for an unknown context, oversized or dropped later all count), one for the client when the tunnel takes it from its send queue. So a relay’s output is what is charged toward the client: target packets a relay consumes without sending anything back are not. A datagram costs one packet and its length in bytes, at least TunnelBudget::with_min_charge. Over budget, it is dropped and counted in ConnectUdpStats; nothing waits.

Until the target sends anything back, at most TunnelBudget::with_unanswered packets and bytes are forwarded to it, so one tunnel cannot spray a target that does not answer. Every tunnel has its own allowance; a client that opens more tunnels gets more of it, which the per-principal limits of a proxy bound.

Implementations

impl TunnelBudget

pub const fn new() -> TunnelBudget

No rates or quota; 64 packets and 64 KiB to a target that has not answered; a charge of at least 64 bytes.

pub fn maybe_with_to_target(self, rate: Option<DatagramRate>) -> TunnelBudget

The rate of datagrams from the client to the target.

pub fn maybe_set_to_target( &mut self, rate: Option<DatagramRate>, ) -> &mut TunnelBudget

The rate of datagrams from the client to the target.

pub fn with_to_target(self, rate: DatagramRate) -> TunnelBudget

The rate of datagrams from the client to the target.

pub fn set_to_target(&mut self, rate: DatagramRate) -> &mut TunnelBudget

The rate of datagrams from the client to the target.

pub fn without_to_target(self) -> TunnelBudget

The rate of datagrams from the client to the target.

pub fn unset_to_target(&mut self) -> &mut TunnelBudget

The rate of datagrams from the client to the target.

pub fn maybe_with_to_client(self, rate: Option<DatagramRate>) -> TunnelBudget

The rate of datagrams from the target to the client.

pub fn maybe_set_to_client( &mut self, rate: Option<DatagramRate>, ) -> &mut TunnelBudget

The rate of datagrams from the target to the client.

pub fn with_to_client(self, rate: DatagramRate) -> TunnelBudget

The rate of datagrams from the target to the client.

pub fn set_to_client(&mut self, rate: DatagramRate) -> &mut TunnelBudget

The rate of datagrams from the target to the client.

pub fn without_to_client(self) -> TunnelBudget

The rate of datagrams from the target to the client.

pub fn unset_to_client(&mut self) -> &mut TunnelBudget

The rate of datagrams from the target to the client.

pub fn maybe_with_quota(self, bytes: Option<u64>) -> TunnelBudget

The most bytes, both ways together, a tunnel is charged in its lifetime. Only what the rates admitted counts: a datagram a rate refused is not charged to the quota.

pub fn maybe_set_quota(&mut self, bytes: Option<u64>) -> &mut TunnelBudget

The most bytes, both ways together, a tunnel is charged in its lifetime. Only what the rates admitted counts: a datagram a rate refused is not charged to the quota.

pub fn with_quota(self, bytes: u64) -> TunnelBudget

The most bytes, both ways together, a tunnel is charged in its lifetime. Only what the rates admitted counts: a datagram a rate refused is not charged to the quota.

pub fn set_quota(&mut self, bytes: u64) -> &mut TunnelBudget

The most bytes, both ways together, a tunnel is charged in its lifetime. Only what the rates admitted counts: a datagram a rate refused is not charged to the quota.

pub fn without_quota(self) -> TunnelBudget

The most bytes, both ways together, a tunnel is charged in its lifetime. Only what the rates admitted counts: a datagram a rate refused is not charged to the quota.

pub fn unset_quota(&mut self) -> &mut TunnelBudget

The most bytes, both ways together, a tunnel is charged in its lifetime. Only what the rates admitted counts: a datagram a rate refused is not charged to the quota.

pub fn with_unanswered(self, packets: u64, bytes: u64) -> TunnelBudget

What a tunnel forwards to a target that has not sent anything back yet.

pub fn set_unanswered(&mut self, packets: u64, bytes: u64) -> &mut TunnelBudget

What a tunnel forwards to a target that has not sent anything back yet.

pub fn with_min_charge(self, bytes: u64) -> TunnelBudget

The least a datagram is charged in bytes, so small and empty ones still cost; no datagram is charged more than one UDP payload, whatever this says.

pub fn set_min_charge(&mut self, bytes: u64) -> &mut TunnelBudget

The least a datagram is charged in bytes, so small and empty ones still cost; no datagram is charged more than one UDP payload, whatever this says.

Trait Implementations

impl Clone for TunnelBudget

fn clone(&self) -> TunnelBudget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TunnelBudget

impl Debug for TunnelBudget

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

Formats the value using the given formatter.

impl Default for TunnelBudget

fn default() -> TunnelBudget

Returns the “default value” for a type.

impl Eq for TunnelBudget

impl PartialEq for TunnelBudget

fn eq(&self, other: &TunnelBudget) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TunnelBudget