Struct uflow::EndpointConfig

pub struct EndpointConfig {
    pub channel_count: usize,
    pub max_send_rate: usize,
    pub max_receive_rate: usize,
    pub max_packet_size: usize,
    pub max_receive_alloc: usize,
}

Parameters used to configure either endpoint of a uflow connection.

Fields

channel_count: usize

The number of channels used to send packets.

Must be greater than 0, and less than or equal to MAX_CHANNELS.

Note: The number of channels used by an endpoint to send data may differ from the opposing endpoint.

max_send_rate: usize

The maximum send rate, in bytes per second. The endpoint will ensure that its outgoing bandwidth does not exceed this value.

Must be greater than 0. Values larger than 2^32 will be truncated.

max_receive_rate: usize

The maximum acceptable receive rate, in bytes per second. The opposing endpoint will ensure that its outgoing bandwidth does not exceed this value.

Must be greater than 0. Values larger than 2^32 will be truncated.

max_packet_size: usize

The maximum size of a sent packet, in bytes. The endpoint will ensure that it does not send packets with a size exceeding this value.

Must be greater than 0, and less than or equal to MAX_PACKET_SIZE.

max_receive_alloc: usize

The maximum allocation size of the endpoint’s receive buffer, in bytes. The endpoint will ensure that the total amount of memory allocated to receive packet data doesn’t exceed this value, rounded up to the nearest multiple of MAX_FRAGMENT_SIZE.

Must be greater than 0.

Note: The maximum allocation size necessarily constrains the maximum receivable packet size. A connection attempt will fail if the max_packet_size of the opposing endpoint exceeds this value.

Implementations

impl Config

pub fn channel_count(self, channel_count: usize) -> Config

Sets channel_count to the provided value.

pub fn max_send_rate(self, rate: usize) -> Config

Sets max_send_rate to the provided value.

pub fn max_receive_rate(self, rate: usize) -> Config

Sets max_receive_rate to the provided value.

pub fn max_receive_alloc(self, max_receive_alloc: usize) -> Config

Sets max_receive_alloc to the provided value.

pub fn is_valid(&self) -> bool

Returns true if each parameter has a valid value.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Creates an endpoint configuration with the following parameters:

• Number of channels: 1
• Maximum outgoing bandwidth: 10MB/s
• Maximum incoming bandwidth: 10MB/s
• Maximum receive allocation: 1MB