Struct tokio_nsq::NSQConsumerConfig

pub struct NSQConsumerConfig { /* fields omitted */ }

Configuration object for an NSQD consumer

Implementations

impl NSQConsumerConfig

pub fn new(topic: Arc<NSQTopic>, channel: Arc<NSQChannel>) -> Self

A default configuration. You will likely need to configure other options.

pub fn set_max_in_flight(self, max_in_flight: u32) -> Self

The maximum number of messages to process at once shared across all connections. Defaults to a single message.

pub fn set_sources(self, sources: NSQConsumerConfigSources) -> Self

Where an NSQ consumer should find connections. Either an explicit list of NSQ Daemons, or a list of NSQ Lookup Daemons to find NSQ instances. Defaults to no connections.

pub fn set_shared(self, shared: NSQConfigShared) -> Self

NSQ Daemon connection options, such as compression and TLS.

pub fn set_sample_rate(self, sample_rate: u8) -> Self

What percentage of messages to sample from the stream. N must be > 0 && <= 100. Defaults to consuming all messages. If the configured sample rate is outside of the allowed range the value will be converted to the nearest valid rate.

pub fn set_rebalance_interval(self, rebalance_interval: Duration) -> Self

To maintain max in flight NSQ Daemons need to periodically have the ready count rebalanced. For example as nodes fail. Defaults to every 5 seconds.

pub fn build(self) -> NSQConsumer

Construct an NSQ consumer with this configuration.

Trait Implementations

impl Clone for NSQConsumerConfig

fn clone(&self) -> NSQConsumerConfig

Returns a copy of the value.

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

Performs copy-assignment from source.