pip_services3_messaging.queues.MessagingCapabilities module

pip_services3_messaging.queues.MessagingCapabilities

Messaging capabilities implementation.

copyright:Conceptual Vision Consulting LLC 2018-2019, see AUTHORS for more details. license:MIT, see LICENSE for more details.

class pip_services3_messaging.queues.MessagingCapabilities.MessagingCapabilities(message_count, send, receive, peek, peek_batch, renew_lock, abandon, dead_letter, clear)

Bases: object

Data object that contains supported capabilities of a message queue. If certain capability is not supported a queue will throw NotImplemented exception.

can_abandon()

Informs if the queue is able to abandon messages.

Returns:true if queue is able to abandon.

can_clear()

Informs if the queue can be cleared.

Returns:true if queue can be cleared.

can_dead_letter()

Informs if the queue is able to send messages to dead letter queue.

Returns:true if queue is able to send messages to dead letter queue.

can_message_count()

Informs if the queue is able to read number of messages.

Returns:true if queue supports reading message count.

can_peek()

Informs if the queue is able to peek messages.

Returns:true if queue is able to peek messages.

can_peek_batch()

Informs if the queue is able to peek multiple messages in one batch.

Returns:true if queue is able to peek multiple messages in one batch.

can_receive()

Informs if the queue is able to receive messages.

Returns:true if queue is able to receive messages.

can_renew_lock()

Informs if the queue is able to renew message lock.

Returns:true if queue is able to renew message lock.

can_send()

Informs if the queue is able to send messages.

Returns:true if queue is able to send messages.