Struct TrafficControlParameters 

pub struct TrafficControlParameters {
    pub max_base_traffic_amount: u64,
    pub max_base_traffic_accumulation_duration: Option<Duration>,
    pub read_vs_write_scaling_factor: u32,
    pub set_balance_request_submission_window_size: Option<Duration>,
    pub enforce_rate_limiting: bool,
    pub base_event_cost: Option<u64>,
    pub free_confirmation_responses: bool,
}

Fields

max_base_traffic_amount: u64

[doc-entry-start: TrafficControlParameters] In bytes, the maximum amount of base traffic that can be accumulated

max_base_traffic_accumulation_duration: Option<Duration>

Maximum duration over which the base rate can be accumulated Consequently, base_traffic_rate = max_base_traffic_amount / max_base_traffic_accumulation_duration

read_vs_write_scaling_factor: u32

Read scaling factor to compute the event cost. In parts per 10 000.

set_balance_request_submission_window_size: Option<Duration>

Window size used to compute the max sequencing time of a submission request This impacts how quickly a submission is expected to be accepted before a retry should be attempted by the caller Default is 5 minutes

enforce_rate_limiting: bool

If true, submission requests without enough traffic credit will not be delivered

base_event_cost: Option<u64>

In bytes, base event cost added to all sequenced events. Optional

free_confirmation_responses: bool

Whether to charge for confirmation responses Default: false

[doc-entry-end: TrafficControlParameters]

Implementations

impl TrafficControlParameters

pub fn base_event_cost(&self) -> u64

Returns the value of base_event_cost, or the default value if base_event_cost is unset.

Trait Implementations

impl Clone for TrafficControlParameters

fn clone(&self) -> TrafficControlParameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TrafficControlParameters

impl Debug for TrafficControlParameters

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

Formats the value using the given formatter.

impl Default for TrafficControlParameters

fn default() -> TrafficControlParameters

Returns the “default value” for a type.

impl Eq for TrafficControlParameters

impl Hash for TrafficControlParameters

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for TrafficControlParameters

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for TrafficControlParameters

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TrafficControlParameters