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: bool, send: bool, receive: bool, peek: bool, peek_batch: bool, renew_lock: bool, abandon: bool, dead_letter: bool, clear: bool)

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()bool

Informs if the queue is able to abandon messages.

Returns

true if queue is able to abandon.

can_clear()bool

Informs if the queue can be cleared.

Returns

true if queue can be cleared.

can_dead_letter()bool

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()bool

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

Returns

true if queue supports reading message count.

can_peek()bool

Informs if the queue is able to peek messages.

Returns

true if queue is able to peek messages.

can_peek_batch()bool

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()bool

Informs if the queue is able to receive messages.

Returns

true if queue is able to receive messages.

can_renew_lock()bool

Informs if the queue is able to renew message lock.

Returns

true if queue is able to renew message lock.

can_send()bool

Informs if the queue is able to send messages.

Returns

true if queue is able to send messages.