Struct amiquip::ConnectionTuning

pub struct ConnectionTuning {
    pub mem_channel_bound: usize,
    pub buffered_writes_high_water: usize,
    pub buffered_writes_low_water: usize,
}

Tuning parameters for the amiquip client.

The options are solely used to control local behavior of the client. They are not part of the AMQP spec and are not communicated with the server in any way. For options that configure the AMQP connection, see ConnectionOptions.

Fields

mem_channel_bound: usize

Set the bound used when creating mio_extras::channel::sync_channel() channels for sending messages to the connection's I/O thread. The default value for this field is 16.

See the discussion on connection tuning for more information.

buffered_writes_high_water: usize

Set the maximum amount of data in bytes that the I/O thread will buffer before it begins to apply backpressure on clients by not reading from their channels. If the high water mark is reached, the I/O loop will not resume reading from client channels until the amount of buffered data drops below buffered_writes_low_water bytes. The default value for this field is 16 MiB.

See the discussion on connection tuning for more information.

buffered_writes_low_water: usize

Set the low water mark for the I/O thread to resume reading from client channels. The default value for this field is 0 bytes.

See the discussion on connection tuning for more information.

Methods

impl ConnectionTuning

pub fn mem_channel_bound(self, mem_channel_bound: usize) -> Self

Set the channel memory bound.

pub fn buffered_writes_high_water(
    self,
    buffered_writes_high_water: usize
) -> Self

Set the high water mark for buffered data to be written to the underlying stream.

pub fn buffered_writes_low_water(self, buffered_writes_low_water: usize) -> Self

Set the low water mark for buffered data to be written to the underlying stream.

Trait Implementations

impl Clone for ConnectionTuning

fn clone(&self) -> ConnectionTuning

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ConnectionTuning

fn default() -> Self

Returns the "default value" for a type.

impl Debug for ConnectionTuning

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

Formats the value using the given formatter.