acapy_agent.transport.queue package

Submodules

acapy_agent.transport.queue.base module

Abstract message queue.

class acapy_agent.transport.queue.base.BaseMessageQueue

Bases: ABC

Abstract message queue class.

abstractmethod async dequeue(*, timeout: int | None = 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 –

abstractmethod 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 –

abstractmethod async join()

Wait for the queue to empty.

abstractmethod reset()

Empty the queue and reset the stop event.

abstractmethod stop()

Cancel active iteration of the queue.

abstractmethod task_done()

Indicate that the current task is complete.

acapy_agent.transport.queue.basic module

Basic in memory queue.

class acapy_agent.transport.queue.basic.BasicMessageQueue

Bases: BaseMessageQueue

Basic in memory queue implementation class.

async dequeue(*, timeout: int | None = 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.