Struct DefaultLitePullConsumerBuilder 

pub struct DefaultLitePullConsumerBuilder { /* private fields */ }

Builder for creating a DefaultLitePullConsumer with customized configuration.

Examples

use rocketmq_client::consumer::default_lite_pull_consumer::DefaultLitePullConsumer;

let consumer = DefaultLitePullConsumer::builder()
    .consumer_group("my_consumer_group")
    .name_server_addr("127.0.0.1:9876")
    .pull_batch_size(32)
    .auto_commit(true)
    .build();

Implementations

impl DefaultLitePullConsumerBuilder

pub fn new() -> Self

Creates a new builder with default configuration.

pub fn name_server_addr(self, addr: impl Into<CheetahString>) -> Self

Sets the name server address (required).

Examples

builder.name_server_addr("127.0.0.1:9876");

pub fn consumer_group(self, group: impl Into<CheetahString>) -> Self

Sets the consumer group name (required).

Examples

builder.consumer_group("my_consumer_group");

pub fn client_ip(self, ip: impl Into<CheetahString>) -> Self

Sets the client IP address (optional, auto-detected by default).

pub fn instance_name(self, name: impl Into<CheetahString>) -> Self

Sets the instance name (optional, auto-generated by default).

pub fn namespace(self, namespace: impl Into<CheetahString>) -> Self

Sets the namespace (optional).

pub fn message_model(self, model: MessageModel) -> Self

Sets the message model (default: Clustering).

pub fn consume_from_where(self, consume_from: ConsumeFromWhere) -> Self

Sets where to start consuming from when no offset exists (default: LastOffset).

pub fn consume_timestamp(self, timestamp: impl Into<CheetahString>) -> Self

Sets the timestamp to consume from (for CONSUME_FROM_TIMESTAMP mode).

pub fn allocate_message_queue_strategy( self, strategy: Arc<dyn AllocateMessageQueueStrategy + Send + Sync>, ) -> Self

Sets the message queue allocation strategy.

pub fn pull_batch_size(self, size: i32) -> Self

Sets the number of messages to pull in a single request (default: 10, range: 1-1024).

pub fn pull_thread_nums(self, nums: usize) -> Self

Sets the number of concurrent pull threads (default: 20).

pub fn pull_threshold_for_queue(self, threshold: i64) -> Self

Sets the maximum number of messages cached per queue (default: 1000).

pub fn pull_threshold_size_for_queue(self, threshold: i32) -> Self

Sets the maximum size in MiB of messages cached per queue (default: 100).

pub fn pull_threshold_for_all(self, threshold: i64) -> Self

Sets the maximum total number of cached messages across all queues (default: -1 for unlimited).

pub fn consume_max_span(self, span: i64) -> Self

Sets the maximum offset span allowed in a process queue (default: 2000).

pub fn pull_time_delay_millis_when_exception(self, delay: u64) -> Self

Sets the delay when pull encounters an exception (default: 1000ms).

pub fn pull_time_delay_millis_when_cache_flow_control(self, delay: u64) -> Self

Sets the delay when cache flow control is triggered (default: 50ms).

pub fn pull_time_delay_millis_when_broker_flow_control(self, delay: u64) -> Self

Sets the delay when broker flow control is triggered (default: 20ms).

pub fn poll_timeout_millis(self, timeout: u64) -> Self

Sets the default poll timeout in milliseconds (default: 5000).

pub fn auto_commit(self, enable: bool) -> Self

Sets whether to automatically commit offsets (default: true).

pub fn auto_commit_interval_millis(self, interval: u64) -> Self

Sets the interval between automatic offset commits (default: 5000ms, minimum: 1000ms).

pub fn topic_metadata_check_interval_millis(self, interval: u64) -> Self

Sets the interval for checking topic metadata changes (default: 10000ms).

pub fn message_request_mode(self, mode: MessageRequestMode) -> Self

Sets the message request mode (default: Pull).

pub fn rpc_hook(self, hook: Arc<dyn RPCHook>) -> Self

Sets the RPC hook for request/response interception.

pub fn enable_msg_trace(self) -> Self

Enables message trace with the default trace topic.

pub fn enable_msg_trace_with_topic( self, trace_topic: impl Into<CheetahString>, ) -> Self

Enables message trace with a custom trace topic.

pub fn trace_dispatcher( self, dispatcher: Arc<dyn TraceDispatcher + Send + Sync>, ) -> Self

Sets a custom trace dispatcher.

pub fn build(self) -> DefaultLitePullConsumer

Builds the DefaultLitePullConsumer.

Panics

Panics if required fields (consumer_group, name_server_addr) are not set.

Trait Implementations

impl Default for DefaultLitePullConsumerBuilder

fn default() -> Self

Returns the “default value” for a type.