Struct DefaultMQPullConsumer 

pub struct DefaultMQPullConsumer { /* private fields */ }

👎Deprecated since 0.9.0:

Classic Pull is retained for compatibility; prefer DefaultLitePullConsumer for new applications

Java Classic Pull compatibility facade backed by the shared Rust client runtime.

Implementations

impl DefaultMQPullConsumer

pub fn new() -> Self

Creates a detached compatibility value.

Use Self::builder to obtain a runnable consumer. The detached constructor is retained for source compatibility and fails closed on runtime operations.

pub fn with_consumer_group(consumer_group: impl Into<CheetahString>) -> Self

Creates a detached compatibility value with a group name.

pub fn builder( client_runtime: Arc<ClientRuntime>, ) -> DefaultMQPullConsumerBuilder

Returns a builder that requires an application-owned runtime.

pub fn consumer_group(&self) -> Option<&CheetahString>

Returns the configured consumer group, if present.

pub fn client_config(&self) -> ClientResult<Arc<ClientConfig>>

Returns the client configuration used by this consumer.

Errors

Returns an initialization error for a detached compatibility value.

pub async fn start(&self) -> ClientResult<()>

Starts the consumer.

Errors

Returns an initialization error for a detached value, a stable lifecycle error when the consumer was already started or shut down, or the underlying client startup error.

pub async fn shutdown(&self) -> ClientResult<()>

Shuts the consumer down and awaits its runtime-owned client and rebalance tasks.

Errors

Returns an initialization error for a detached value or an underlying client shutdown error. Repeated shutdown is idempotent.

pub async fn is_running(&self) -> bool

Returns whether the consumer is running.

pub async fn pull( &self, message_queue: &MessageQueue, sub_expression: &str, offset: i64, max_messages: i32, ) -> ClientResult<PullResult>

Pulls by tag expression using the default ordinary-pull timeout.

Errors

Returns an error when the consumer is not running, the arguments are invalid, route or transport resolution fails, the broker rejects the request, or the request times out.

pub async fn pull_with_selector( &self, message_queue: &MessageQueue, selector: MessageSelector, offset: i64, max_messages: i32, ) -> ClientResult<PullResult>

Pulls with an explicit TAG or SQL selector.

Errors

Returns the same validation, lifecycle, transport, broker, and timeout errors as Self::pull.

pub async fn pull_async<C>( &self, message_queue: &MessageQueue, sub_expression: &str, offset: i64, max_messages: i32, callback: C, ) -> ClientResult<()>

where C: ClassicPullCallback,

Starts an asynchronous tag pull using the Java-compatible narrow signature.

Errors

Returns an error before scheduling when validation, lifecycle, route resolution, or the initial transport request fails. Later failures are delivered to the callback.

pub async fn pull_async_with_selector<C>( &self, message_queue: &MessageQueue, selector: MessageSelector, offset: i64, max_messages: i32, callback: C, ) -> ClientResult<()>

where C: ClassicPullCallback,

Starts an asynchronous pull with an explicit TAG or SQL selector.

Errors

Returns an error before scheduling when validation, lifecycle, route resolution, or the initial transport request fails. Later failures are delivered to the callback.

pub async fn pull_with_options( &self, options: PullOptions, ) -> ClientResult<PullResult>

Pulls using a fully typed option set.

Errors

Returns a validation, lifecycle, route, transport, broker, or timeout error.

pub async fn pull_block_if_not_found( &self, message_queue: &MessageQueue, sub_expression: &str, offset: i64, max_messages: i32, ) -> ClientResult<PullResult>

Pulls with broker suspension when no message is immediately available.

Errors

Returns a validation, lifecycle, route, transport, broker, or timeout error.

pub async fn pull_async_with_options<C>( &self, options: PullOptions, callback: C, ) -> ClientResult<()>

where C: ClassicPullCallback,

Starts an asynchronous pull whose completion runs on the client’s callback executor.

Errors

Returns an error before scheduling when validation, lifecycle, route resolution, or the initial transport request fails. Later failures are delivered to the callback.

pub async fn pull_block_if_not_found_async<C>( &self, message_queue: &MessageQueue, sub_expression: &str, offset: i64, max_messages: i32, callback: C, ) -> ClientResult<()>

where C: ClassicPullCallback,

Starts an asynchronous block-if-not-found pull.

Errors

Returns an error before scheduling when validation, lifecycle, route resolution, or the initial transport request fails. Later failures are delivered to the callback.

pub async fn fetch_subscribe_message_queues( &self, topic: &str, ) -> ClientResult<Vec<MessageQueue>>

Fetches all readable queues for a topic.

Errors

Returns an error when the consumer is not running or topic route lookup fails.

pub async fn register_message_queue_listener<L>( &self, topic: &str, listener: L, ) -> ClientResult<()>

where L: MessageQueueListener + 'static,

Registers a listener for stable topic queue-set changes.

Errors

Returns an error for a blank topic, a detached consumer, or a failed running-consumer subscription update.

pub async fn update_consume_offset( &self, message_queue: &MessageQueue, offset: i64, ) -> ClientResult<()>

Updates the local consume offset for a queue.

Errors

Returns an error when the consumer is not running, the offset is negative, or the offset store is unavailable.

pub async fn fetch_consume_offset( &self, message_queue: &MessageQueue, from_store: bool, ) -> ClientResult<i64>

Fetches a queue offset from memory or the configured offset store.

Errors

Returns an error when the consumer is not running, the offset store is unavailable, or a broker-backed read fails.

pub async fn search_offset( &self, message_queue: &MessageQueue, timestamp: u64, ) -> ClientResult<i64>

Searches the queue offset nearest to a store timestamp.

Errors

Returns an error when the consumer is not running or the broker query fails.

pub async fn max_offset( &self, message_queue: &MessageQueue, ) -> ClientResult<i64>

Returns the maximum queue offset.

Errors

Returns an error when the consumer is not running or the broker query fails.

pub async fn min_offset( &self, message_queue: &MessageQueue, ) -> ClientResult<i64>

Returns the minimum queue offset.

Errors

Returns an error when the consumer is not running or the broker query fails.

pub fn default_mq_pull_consumer_impl( &self, ) -> ClientResult<DefaultMQPullConsumerImpl>

Returns the functional implementation handle.

Errors

Returns an initialization error for a detached compatibility value.

Trait Implementations

impl Clone for DefaultMQPullConsumer

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for DefaultMQPullConsumer

fn default() -> Self

Returns the “default value” for a type.

impl MQPullConsumer for DefaultMQPullConsumer

async fn start(&self) -> ClientResult<()>

👎Deprecated since 0.9.0:

Classic Pull is retained for compatibility; prefer DefaultLitePullConsumer for new applications

Starts the consumer.

async fn shutdown(&self) -> ClientResult<()>

👎Deprecated since 0.9.0:

Classic Pull is retained for compatibility; prefer DefaultLitePullConsumer for new applications

Shuts the consumer down.

async fn pull( &self, message_queue: &MessageQueue, sub_expression: &str, offset: i64, max_messages: i32, ) -> ClientResult<PullResult>

👎Deprecated since 0.9.0:

Classic Pull is retained for compatibility; prefer DefaultLitePullConsumer for new applications

Pulls one queue by tag expression.