aries_cloudagent.transport.outbound.queue package

Submodules

aries_cloudagent.transport.outbound.queue.base module

Base classes for the queue module.

class aries_cloudagent.transport.outbound.queue.base.BaseOutboundQueue(root_profile: aries_cloudagent.core.profile.Profile)

Bases: abc.ABC

Base class for the outbound queue generic type.

async close()

Stop the queue.

abstract async enqueue_message(payload: Union[str, bytes], endpoint: str)

Prepare and send message to external queue.

async open()

Start the queue.

async start()

Start the queue.

async stop()

Stop the queue.

exception aries_cloudagent.transport.outbound.queue.base.OutboundQueueConfigurationError(message)

Bases: aries_cloudagent.core.error.BaseError

An error with the queue configuration.

exception aries_cloudagent.transport.outbound.queue.base.OutboundQueueError(*args, error_code: Optional[str] = None, **kwargs)

Bases: aries_cloudagent.transport.error.TransportError

Generic outbound transport error.

aries_cloudagent.transport.outbound.queue.loader module

Dynamic loading of pluggable outbound queue engine classes.

aries_cloudagent.transport.outbound.queue.loader.get_outbound_queue(root_profile: aries_cloudagent.core.profile.Profile) → Optional[aries_cloudagent.transport.outbound.queue.base.BaseOutboundQueue]

Given settings, return instantiated outbound queue class.

aries_cloudagent.transport.outbound.queue.redis module

Redis outbound transport.

class aries_cloudagent.transport.outbound.queue.redis.RedisOutboundQueue(root_profile: aries_cloudagent.core.profile.Profile)

Bases: aries_cloudagent.transport.outbound.queue.base.BaseOutboundQueue

Redis outbound transport class.

config_key = 'redis_queue'

async enqueue_message(payload: Union[str, bytes], endpoint: str)

Prepare and send message to external redis.

Parameters

• payload – message payload in string or byte format

• endpoint – URI endpoint for delivery

async push(key: bytes, message: bytes)

Push a message to redis on key.

async start()

Start the transport.

async stop()

Stop the transport.