aries_cloudagent.transport.inbound package

Submodules

aries_cloudagent.transport.inbound.base module

Base inbound transport class.

class aries_cloudagent.transport.inbound.base.BaseInboundTransport(scheme: str, create_session: Callable, *, max_message_size: int = 0, wire_format: aries_cloudagent.transport.wire_format.BaseWireFormat = None)

Bases: abc.ABC

Base inbound transport class.

create_session(*, accept_undelivered: bool = False, can_respond: bool = False, client_info: dict = None, wire_format: aries_cloudagent.transport.wire_format.BaseWireFormat = None) → Awaitable[aries_cloudagent.transport.inbound.session.InboundSession]

Create a new inbound session.

Parameters:

• accept_undelivered – Flag for accepting undelivered messages
• can_respond – Flag indicating that the transport can send responses
• client_info – Request-specific client information
• wire_format – Optionally override the session wire format

max_message_size

Accessor for this transport’s max message size.

scheme

Accessor for this transport’s scheme.

start() → None

Start listening for on this transport.

stop() → None

Stop listening for on this transport.

class aries_cloudagent.transport.inbound.base.InboundTransportConfiguration(module, host, port)

Bases: tuple

host

Alias for field number 1

module

Alias for field number 0

port

Alias for field number 2

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

Bases: aries_cloudagent.transport.error.TransportError

Generic inbound transport error.

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

Bases: aries_cloudagent.transport.inbound.base.InboundTransportError

Error in loading an inbound transport.

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

Bases: aries_cloudagent.transport.inbound.base.InboundTransportError

Setup error for an inbound transport.

aries_cloudagent.transport.inbound.delivery_queue module

The Delivery Queue.

The delivery queue holds and manages messages that have not yet been delivered to their intended destination.

class aries_cloudagent.transport.inbound.delivery_queue.DeliveryQueue

Bases: object

DeliveryQueue class.

Manages undelivered messages.

add_message(msg: aries_cloudagent.transport.outbound.message.OutboundMessage)

Add an OutboundMessage to delivery queue.

The message is added once per recipient key

Parameters:msg – The OutboundMessage to add

expire_messages(ttl=None)

Expire messages that are past the time limit.

Parameters:ttl – Optional. Allows override of configured ttl

get_one_message_for_key(key: str)

Remove and return a matching message.

Parameters:key – The key to use for lookup

has_message_for_key(key: str)

Check for queued messages by key.

Parameters:key – The key to use for lookup

inspect_all_messages_for_key(key: str)

Return all messages for key.

Parameters:key – The key to use for lookup

message_count_for_key(key: str)

Count of queued messages by key.

Parameters:key – The key to use for lookup

remove_message_for_key(key: str, msg: aries_cloudagent.transport.outbound.message.OutboundMessage)

Remove specified message from queue for key.

Parameters:

• key – The key to use for lookup
• msg – The message to remove from the queue

class aries_cloudagent.transport.inbound.delivery_queue.QueuedMessage(msg: aries_cloudagent.transport.outbound.message.OutboundMessage)

Bases: object

Wrapper Class for queued messages.

Allows tracking Metadata.

older_than(compare_timestamp: float) → bool

Age Comparison.

Allows you to test age as compared to the provided timestamp.

Parameters:compare_timestamp – The timestamp to compare

aries_cloudagent.transport.inbound.http module

Http Transport classes and functions.

class aries_cloudagent.transport.inbound.http.HttpTransport(host: str, port: int, create_session, **kwargs)

Bases: aries_cloudagent.transport.inbound.base.BaseInboundTransport

Http Transport class.

inbound_message_handler(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f9c16a1e748>)

Message handler for inbound messages.

Parameters:request – aiohttp request object Returns:The web response

invite_message_handler(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f9c16a1e748>)

Message handler for invites.

Parameters:request – aiohttp request object Returns:The web response

make_application() → <sphinx.ext.autodoc.importer._MockObject object at 0x7f9c16a1e748>

Construct the aiohttp application.

start() → None

Start this transport.

Raises:InboundTransportSetupError – If there was an error starting the webserver

stop() → None

Stop this transport.

aries_cloudagent.transport.inbound.manager module

Inbound transport manager.

class aries_cloudagent.transport.inbound.manager.InboundTransportManager(context: aries_cloudagent.config.injection_context.InjectionContext, receive_inbound: Coroutine[T_co, T_contra, V_co], return_inbound: Callable = None)

Bases: object

Inbound transport manager class.

closed_session(session: aries_cloudagent.transport.inbound.session.InboundSession)

Clean up a closed session.

Returns an undelivered message to the caller if possible.

create_session(transport_type: str, *, accept_undelivered: bool = False, can_respond: bool = False, client_info: dict = None, wire_format: aries_cloudagent.transport.wire_format.BaseWireFormat = None)

Create a new inbound session.

Parameters:

• transport_type – The inbound transport identifier
• accept_undelivered – Flag for accepting undelivered messages
• can_respond – Flag indicating that the transport can send responses
• client_info – An optional dict describing the client
• wire_format – Override the wire format for this session

dispatch_complete(message: aries_cloudagent.transport.inbound.message.InboundMessage, completed: aries_cloudagent.utils.task_queue.CompletedTask)

Handle completion of message dispatch.

get_transport_instance(transport_id: str) → aries_cloudagent.transport.inbound.base.BaseInboundTransport

Get an instance of a running transport by ID.

process_undelivered(session: aries_cloudagent.transport.inbound.session.InboundSession)

Interact with undelivered queue to find applicable messages.

Parameters:session – The inbound session

register(config: aries_cloudagent.transport.inbound.base.InboundTransportConfiguration) → str

Register transport module.

Parameters:config – The inbound transport configuration

register_transport(transport: aries_cloudagent.transport.inbound.base.BaseInboundTransport, transport_id: str) → str

Register a new inbound transport class.

Parameters:

• transport – Transport instance to register
• transport_id – The transport ID to register

return_to_session(outbound: aries_cloudagent.transport.outbound.message.OutboundMessage) → bool

Return an outbound message via an open session, if possible.

return_undelivered(outbound: aries_cloudagent.transport.outbound.message.OutboundMessage) → bool

Add an undelivered message to the undelivered queue.

At this point the message could not be associated with an inbound session and could not be delivered via an outbound transport.

setup()

Perform setup operations.

start()

Start all registered transports.

start_transport(transport_id: str)

Start a registered inbound transport.

Parameters:transport_id – ID for the inbound transport to start

stop(wait: bool = True)

Stop all registered transports.

aries_cloudagent.transport.inbound.message module

Classes representing inbound messages.

class aries_cloudagent.transport.inbound.message.InboundMessage(payload: Union[str, bytes], receipt: aries_cloudagent.transport.inbound.receipt.MessageReceipt, *, connection_id: str = None, session_id: str = None, transport_type: str = None)

Bases: object

Container class linking a message payload with its receipt details.

aries_cloudagent.transport.inbound.receipt module

Classes for representing message receipt details.

class aries_cloudagent.transport.inbound.receipt.MessageReceipt(*, connection_id: str = None, direct_response_mode: str = None, in_time: datetime.datetime = None, raw_message: str = None, recipient_verkey: str = None, recipient_did: str = None, recipient_did_public: bool = None, sender_did: str = None, sender_verkey: str = None, thread_id: str = None)

Bases: object

Properties of an agent message’s delivery.

REPLY_MODE_ALL = 'all'

REPLY_MODE_NONE = 'none'

REPLY_MODE_THREAD = 'thread'

connection_id

Accessor for the pairwise connection identifier.

Returns:This context’s connection identifier

direct_response_mode

Accessor for the requested direct response mode.

Returns:This context’s requested direct response mode

direct_response_requested

Accessor for the the state of the direct response mode.

Returns:This context’s requested direct response mode

in_time

Accessor for the datetime the message was received.

Returns:This context’s received time

raw_message

Accessor for the raw message text.

Returns:The raw message text

recipient_did

Accessor for the recipient DID which corresponds with the verkey.

Returns:The recipient DID

recipient_did_public

Check if the recipient did is public.

Indicates whether the message is associated with a public (ledger) recipient DID.

Returns:True if the recipient’s DID is public, else false

recipient_verkey

Accessor for the recipient verkey key used to pack the incoming request.

Returns:The recipient verkey

sender_did

Accessor for the sender DID which corresponds with the verkey.

Returns:The sender did

sender_verkey

Accessor for the sender public key used to pack the incoming request.

Returns:This context’s sender’s verkey

thread_id

Accessor for the identifier of the message thread.

Returns:The delivery thread ID

aries_cloudagent.transport.inbound.session module

Inbound connection handling classes.

class aries_cloudagent.transport.inbound.session.AcceptResult(accepted: bool, retry: bool = False)

Bases: object

Represent the result of accept_response.

class aries_cloudagent.transport.inbound.session.InboundSession(*, context: aries_cloudagent.config.injection_context.InjectionContext, inbound_handler: Callable, session_id: str, wire_format: aries_cloudagent.transport.wire_format.BaseWireFormat, accept_undelivered: bool = False, can_respond: bool = False, client_info: dict = None, close_handler: Callable = None, reply_mode: str = None, reply_thread_ids: Sequence[str] = None, reply_verkeys: Sequence[str] = None, transport_type: str = None)

Bases: object

Track an open transport connection for direct routing of outbound messages.

accept_response(message: aries_cloudagent.transport.outbound.message.OutboundMessage) → aries_cloudagent.transport.inbound.session.AcceptResult

Try to queue an outbound message if it applies to this session.

Returns: a tuple of (message buffered, retry later)

add_reply_thread_ids(*thids)

Add a thread ID to the set of potential reply targets.

add_reply_verkeys(*verkeys)

Add a verkey to the set of potential reply targets.

can_respond

Accessor for the session can-respond state.

clear_response()

Handle when the buffered response message has been delivered.

close()

Setter for the session closed state.

closed

Accessor for the session closed state.

encode_outbound(outbound: aries_cloudagent.transport.outbound.message.OutboundMessage) → aries_cloudagent.transport.outbound.message.OutboundMessage

Apply wire formatting to an outbound message.

parse_inbound(payload_enc: Union[str, bytes]) → aries_cloudagent.transport.inbound.message.InboundMessage

Convert a message payload and to an inbound message.

process_inbound(message: aries_cloudagent.transport.inbound.message.InboundMessage)

Process an incoming message and update the session metadata as necessary.

Parameters:message – The inbound message instance

receive(payload_enc: Union[str, bytes]) → aries_cloudagent.transport.inbound.message.InboundMessage

Receive a new message payload and dispatch the message.

receive_inbound(message: aries_cloudagent.transport.inbound.message.InboundMessage)

Deliver the inbound message to the conductor.

reply_mode

Accessor for the session reply mode.

reply_thread_ids

Accessor for the reply thread IDs.

reply_verkeys

Accessor for the reply verkeys.

response_buffered

Check if a response is currently buffered.

select_outbound(message: aries_cloudagent.transport.outbound.message.OutboundMessage) → bool

Determine if an outbound message should be sent to this session.

Parameters:message – The outbound message to be checked

set_response(message: aries_cloudagent.transport.outbound.message.OutboundMessage)

Set the contents of the response message buffer.

wait_response() → Union[str, bytes]

Wait for a response to be buffered and pack it.

aries_cloudagent.transport.inbound.ws module

Websockets Transport classes and functions.

class aries_cloudagent.transport.inbound.ws.WsTransport(host: str, port: int, create_session, **kwargs)

Bases: aries_cloudagent.transport.inbound.base.BaseInboundTransport

Websockets Transport class.

inbound_message_handler(request)

Message handler for inbound messages.

Parameters:request – aiohttp request object Returns:The web response

make_application() → <sphinx.ext.autodoc.importer._MockObject object at 0x7f9c17074a90>

Construct the aiohttp application.

scheme

Accessor for this transport’s scheme.

start() → None

Start this transport.

Raises:InboundTransportSetupError – If there was an error starting the webserver

stop() → None

Stop this transport.