aries_cloudagent.transport.outbound package

Subpackages

• aries_cloudagent.transport.outbound.queue package
  • Subpackages
    • aries_cloudagent.transport.outbound.queue.tests package
      • Submodules
      • aries_cloudagent.transport.outbound.queue.tests.test_basic_queue module
  • Submodules
  • aries_cloudagent.transport.outbound.queue.base module
  • aries_cloudagent.transport.outbound.queue.basic module
• aries_cloudagent.transport.outbound.tests package
  • Submodules
  • aries_cloudagent.transport.outbound.tests.test_http_transport module
  • aries_cloudagent.transport.outbound.tests.test_manager module
  • aries_cloudagent.transport.outbound.tests.test_ws_transport module

Submodules

aries_cloudagent.transport.outbound.base module

Base outbound transport.

class aries_cloudagent.transport.outbound.base.BaseOutboundTransport

Bases: abc.ABC

Base outbound transport class.

handle_message(message: aries_cloudagent.messaging.outbound_message.OutboundMessage)

Handle message from queue.

Parameters:message – OutboundMessage to send over transport implementation

start()

Start the transport.

stop()

Shut down the transport.

exception aries_cloudagent.transport.outbound.base.OutboundTransportRegistrationError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.error.BaseError

Outbound transport registration error.

aries_cloudagent.transport.outbound.http module

Http outbound transport.

class aries_cloudagent.transport.outbound.http.HttpTransport

Bases: aries_cloudagent.transport.outbound.base.BaseOutboundTransport

Http outbound transport class.

handle_message(message: aries_cloudagent.messaging.outbound_message.OutboundMessage)

Handle message from queue.

Parameters:message – OutboundMessage to send over transport implementation

schemes = ('http', 'https')

start()

Start the transport.

stop()

Stop the transport.

aries_cloudagent.transport.outbound.manager module

Outbound transport manager.

exception aries_cloudagent.transport.outbound.manager.OutboundDeliveryError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.error.BaseError

Base exception when a message cannot be delivered via an outbound transport.

class aries_cloudagent.transport.outbound.manager.OutboundTransportManager(queue: aries_cloudagent.transport.outbound.queue.base.BaseOutboundMessageQueue = None)

Bases: object

Outbound transport manager class.

dispatch_message(message: aries_cloudagent.messaging.outbound_message.OutboundMessage, attempt: int = None)

Dispatch a message to the relevant transport.

Find a registered transport for the scheme in the uri and use it to send the message.

Parameters:message – The outbound message to dispatch

get_registered_transport_for_scheme(scheme: str)

Find the registered transport for a given scheme.

get_running_transport_for_scheme(scheme: str)

Find the running transport for a given scheme.

poll()

Send messages from the queue to the transports.

register(module_path)

Register a new outbound transport by module path.

Parameters:

module_path – Module path to register

Raises:

• OutboundTransportRegistrationError – If the imported class cannot be located
• OutboundTransportRegistrationError – If the imported class does not specify a schemes attribute
• OutboundTransportRegistrationError – If the scheme has already been registered

register_class(transport_class: Type[aries_cloudagent.transport.outbound.base.BaseOutboundTransport])

Register a new outbound transport class.

Parameters:

transport_class – Transport class to register

Raises:

• OutboundTransportRegistrationError – If the imported class does not specify a schemes attribute
• OutboundTransportRegistrationError – If the scheme has already been registered

send_message(message: aries_cloudagent.messaging.outbound_message.OutboundMessage)

Add a message to the outbound queue.

Parameters:message – The outbound message to send

start()

Start all transports and feed messages from the queue.

start_transport(schemes, transport_cls)

Start the transport.

stop(wait: bool = True)

Stop all transports.

aries_cloudagent.transport.outbound.ws module

Websockets outbound transport.

class aries_cloudagent.transport.outbound.ws.WsTransport

Bases: aries_cloudagent.transport.outbound.base.BaseOutboundTransport

Websockets outbound transport class.

handle_message(message: aries_cloudagent.messaging.outbound_message.OutboundMessage)

Handle message from queue.

Parameters:message – OutboundMessage to send over transport implementation

schemes = ('ws', 'wss')

start()

Start the outbound transport.

stop()

Stop the outbound transport.