aries_cloudagent.transport.inbound package

Submodules

aries_cloudagent.transport.inbound.base module

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: 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: 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: 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

aries_cloudagent.transport.inbound.manager module

aries_cloudagent.transport.inbound.message module

Classes representing inbound messages.

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

Bases: object

Container class linking a message payload with its receipt details.

dispatch_processing_complete()

Dispatch processing complete.

async wait_processing_complete()

Wait for processing to complete.

aries_cloudagent.transport.inbound.receipt module

Classes for representing message receipt details.

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

Bases: object

Properties of an agent message’s delivery.

REPLY_MODE_ALL = 'all'

REPLY_MODE_NONE = 'none'

REPLY_MODE_THREAD = 'thread'

property connection_id: str

Accessor for the pairwise connection identifier.

Returns

This context’s connection identifier

property direct_response_mode: str

Accessor for the requested direct response mode.

Returns

This context’s requested direct response mode

property direct_response_requested: str

Accessor for the the state of the direct response mode.

Returns

This context’s requested direct response mode

property in_time: str

Accessor for the datetime the message was received.

Returns

This context’s received time

property parent_thread_id: Optional[str]

Accessor for the identifier of the message parent thread.

Returns

The delivery parent thread ID

property raw_message: str

Accessor for the raw message text.

Returns

The raw message text

property recipient_did: str

Accessor for the recipient DID which corresponds with the verkey.

Returns

The recipient DID

property recipient_did_public: bool

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

property recipient_verkey: str

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

Returns

The recipient verkey

property sender_did: str

Accessor for the sender DID which corresponds with the verkey.

Returns

The sender did

property sender_verkey: str

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

Returns

This context’s sender’s verkey

property thread_id: str

Accessor for the identifier of the message thread.

Returns

The delivery thread ID

aries_cloudagent.transport.inbound.session module

aries_cloudagent.transport.inbound.ws module