aries_cloudagent.transport.queue package

Submodules

aries_cloudagent.transport.queue.base module

Abstract message queue.

class aries_cloudagent.transport.queue.base.BaseMessageQueue

Bases: abc.ABC

Abstract message queue class.

abstract async dequeue(*, timeout: Optional[int] = None)

Dequeue a message.

Returns

The dequeued message, or None if a timeout occurs

Raises

• asyncio.CancelledError if the queue has been stopped –

• asyncio.TimeoutError if the timeout is reached –

abstract async enqueue(message)

Enqueue a message.

Parameters

message – The message to add to the end of the queue

Raises

asyncio.CancelledError if the queue has been stopped –

abstract async join()

Wait for the queue to empty.

abstract reset()

Empty the queue and reset the stop event.

abstract stop()

Cancel active iteration of the queue.

abstract task_done()

Indicate that the current task is complete.

aries_cloudagent.transport.queue.basic module

Basic in memory queue.

class aries_cloudagent.transport.queue.basic.BasicMessageQueue

Bases: aries_cloudagent.transport.queue.base.BaseMessageQueue

Basic in memory queue implementation class.

async dequeue(*, timeout: Optional[int] = None)

Dequeue a message.

Returns

The dequeued message, or None if a timeout occurs

Raises

• asyncio.CancelledError if the queue has been stopped –

• asyncio.TimeoutError if the timeout is reached –

async enqueue(message)

Enqueue a message.

Parameters

message – The message to add to the end of the queue

Raises

asyncio.CancelledError if the queue has been stopped –

async join()

Wait for the queue to empty.

make_queue()

Create the queue instance.

reset()

Empty the queue and reset the stop event.

stop()

Cancel active iteration of the queue.

task_done()

Indicate that the current task is complete.