Skip to main content

QueueClient

queue_runtime::client

Trait QueueClient 

Source 
pub trait QueueClient: Send + Sync {
    // Required methods
    fn send_message<'life0, 'life1, 'async_trait>(
        &'life0 self,
        queue: &'life1 QueueName,
        message: Message,
    ) -> Pin<Box<dyn Future<Output = Result<MessageId, QueueError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn send_messages<'life0, 'life1, 'async_trait>(
        &'life0 self,
        queue: &'life1 QueueName,
        messages: Vec<Message>,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<MessageId>, QueueError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn receive_message<'life0, 'life1, 'async_trait>(
        &'life0 self,
        queue: &'life1 QueueName,
        timeout: Duration,
    ) -> Pin<Box<dyn Future<Output = Result<Option<ReceivedMessage>, QueueError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn receive_messages<'life0, 'life1, 'async_trait>(
        &'life0 self,
        queue: &'life1 QueueName,
        max_messages: u32,
        timeout: Duration,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<ReceivedMessage>, QueueError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn complete_message<'life0, 'async_trait>(
        &'life0 self,
        receipt: ReceiptHandle,
    ) -> Pin<Box<dyn Future<Output = Result<(), QueueError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn abandon_message<'life0, 'async_trait>(
        &'life0 self,
        receipt: ReceiptHandle,
    ) -> Pin<Box<dyn Future<Output = Result<(), QueueError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn dead_letter_message<'life0, 'async_trait>(
        &'life0 self,
        receipt: ReceiptHandle,
        reason: String,
    ) -> Pin<Box<dyn Future<Output = Result<(), QueueError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn accept_session<'life0, 'life1, 'async_trait>(
        &'life0 self,
        queue: &'life1 QueueName,
        session_id: Option<SessionId>,
    ) -> Pin<Box<dyn Future<Output = Result<Box<dyn SessionClient>, QueueError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn provider_type(&self) -> ProviderType;
    fn supports_sessions(&self) -> bool;
    fn supports_batching(&self) -> bool;
}
Expand description

Main interface for queue operations across all providers

Required Methods§

Source

fn send_message<'life0, 'life1, 'async_trait>( &'life0 self, queue: &'life1 QueueName, message: Message, ) -> Pin<Box<dyn Future<Output = Result<MessageId, QueueError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Send single message to queue

Source

fn send_messages<'life0, 'life1, 'async_trait>( &'life0 self, queue: &'life1 QueueName, messages: Vec<Message>, ) -> Pin<Box<dyn Future<Output = Result<Vec<MessageId>, QueueError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Send multiple messages in batch (if supported)

Source

fn receive_message<'life0, 'life1, 'async_trait>( &'life0 self, queue: &'life1 QueueName, timeout: Duration, ) -> Pin<Box<dyn Future<Output = Result<Option<ReceivedMessage>, QueueError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Receive single message from queue

Source

fn receive_messages<'life0, 'life1, 'async_trait>( &'life0 self, queue: &'life1 QueueName, max_messages: u32, timeout: Duration, ) -> Pin<Box<dyn Future<Output = Result<Vec<ReceivedMessage>, QueueError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Receive multiple messages from queue

Source

fn complete_message<'life0, 'async_trait>( &'life0 self, receipt: ReceiptHandle, ) -> Pin<Box<dyn Future<Output = Result<(), QueueError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Mark message as successfully processed

Source

fn abandon_message<'life0, 'async_trait>( &'life0 self, receipt: ReceiptHandle, ) -> Pin<Box<dyn Future<Output = Result<(), QueueError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Return message to queue for retry

Source

fn dead_letter_message<'life0, 'async_trait>( &'life0 self, receipt: ReceiptHandle, reason: String, ) -> Pin<Box<dyn Future<Output = Result<(), QueueError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Send message to dead letter queue

Source

fn accept_session<'life0, 'life1, 'async_trait>( &'life0 self, queue: &'life1 QueueName, session_id: Option<SessionId>, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn SessionClient>, QueueError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Accept session for ordered processing

Source

fn provider_type(&self) -> ProviderType

Get provider type

Source

fn supports_sessions(&self) -> bool

Check if provider supports sessions

Source

fn supports_batching(&self) -> bool

Check if provider supports batch operations

Implementors§