acapy_agent.transport package

Subpackages

• acapy_agent.transport.inbound package
  • Submodules
  • acapy_agent.transport.inbound.base module
  • acapy_agent.transport.inbound.delivery_queue module
    • DeliveryQueue
      • DeliveryQueue.add_message()
      • DeliveryQueue.expire_messages()
      • DeliveryQueue.get_one_message_for_key()
      • DeliveryQueue.has_message_for_key()
      • DeliveryQueue.inspect_all_messages_for_key()
      • DeliveryQueue.message_count_for_key()
      • DeliveryQueue.remove_message_for_key()
    • QueuedMessage
      • QueuedMessage.older_than()
  • acapy_agent.transport.inbound.http module
  • acapy_agent.transport.inbound.manager module
  • acapy_agent.transport.inbound.message module
    • InboundMessage
      • InboundMessage.dispatch_processing_complete()
      • InboundMessage.wait_processing_complete()
  • acapy_agent.transport.inbound.receipt module
    • MessageReceipt
      • MessageReceipt.REPLY_MODE_ALL
      • MessageReceipt.REPLY_MODE_NONE
      • MessageReceipt.REPLY_MODE_THREAD
      • MessageReceipt.connection_id
      • MessageReceipt.direct_response_mode
      • MessageReceipt.direct_response_requested
      • MessageReceipt.in_time
      • MessageReceipt.parent_thread_id
      • MessageReceipt.raw_message
      • MessageReceipt.recipient_did
      • MessageReceipt.recipient_did_public
      • MessageReceipt.recipient_verkey
      • MessageReceipt.sender_did
      • MessageReceipt.sender_verkey
      • MessageReceipt.thread_id
  • acapy_agent.transport.inbound.session module
  • acapy_agent.transport.inbound.ws module
• acapy_agent.transport.outbound package
  • Submodules
  • acapy_agent.transport.outbound.base module
    • BaseOutboundTransport
      • BaseOutboundTransport.collector
      • BaseOutboundTransport.handle_message()
      • BaseOutboundTransport.start()
      • BaseOutboundTransport.stop()
      • BaseOutboundTransport.wire_format
    • OutboundDeliveryError
    • OutboundTransportError
    • OutboundTransportRegistrationError
    • QueuedOutboundMessage
      • QueuedOutboundMessage.STATE_DELIVER
      • QueuedOutboundMessage.STATE_DONE
      • QueuedOutboundMessage.STATE_ENCODE
      • QueuedOutboundMessage.STATE_NEW
      • QueuedOutboundMessage.STATE_PENDING
      • QueuedOutboundMessage.STATE_RETRY
  • acapy_agent.transport.outbound.http module
    • HttpTransport
      • HttpTransport.handle_message()
      • HttpTransport.is_external
      • HttpTransport.schemes
      • HttpTransport.start()
      • HttpTransport.stop()
  • acapy_agent.transport.outbound.manager module
    • OutboundTransportManager
      • OutboundTransportManager.MAX_RETRY_COUNT
      • OutboundTransportManager.deliver_queued_message()
      • OutboundTransportManager.encode_outbound_message()
      • OutboundTransportManager.encode_queued_message()
      • OutboundTransportManager.enqueue_message()
      • OutboundTransportManager.enqueue_webhook()
      • OutboundTransportManager.finished_deliver()
      • OutboundTransportManager.finished_encode()
      • OutboundTransportManager.flush()
      • OutboundTransportManager.get_external_running_transport()
      • OutboundTransportManager.get_registered_transport_for_scheme()
      • OutboundTransportManager.get_running_transport_for_endpoint()
      • OutboundTransportManager.get_running_transport_for_scheme()
      • OutboundTransportManager.get_transport_instance()
      • OutboundTransportManager.perform_encode()
      • OutboundTransportManager.process_queued()
      • OutboundTransportManager.register()
      • OutboundTransportManager.register_class()
      • OutboundTransportManager.setup()
      • OutboundTransportManager.start()
      • OutboundTransportManager.start_transport()
      • OutboundTransportManager.stop()
  • acapy_agent.transport.outbound.message module
    • OutboundMessage
  • acapy_agent.transport.outbound.status module
    • OutboundSendStatus
      • OutboundSendStatus.QUEUED_FOR_DELIVERY
      • OutboundSendStatus.SENT_TO_EXTERNAL_QUEUE
      • OutboundSendStatus.SENT_TO_SESSION
      • OutboundSendStatus.UNDELIVERABLE
      • OutboundSendStatus.WAITING_FOR_PICKUP
      • OutboundSendStatus.topic
  • acapy_agent.transport.outbound.ws module
    • WsTransport
      • WsTransport.handle_message()
      • WsTransport.is_external
      • WsTransport.schemes
      • WsTransport.start()
      • WsTransport.stop()
• acapy_agent.transport.queue package
  • Submodules
  • acapy_agent.transport.queue.base module
    • BaseMessageQueue
      • BaseMessageQueue.dequeue()
      • BaseMessageQueue.enqueue()
      • BaseMessageQueue.join()
      • BaseMessageQueue.reset()
      • BaseMessageQueue.stop()
      • BaseMessageQueue.task_done()
  • acapy_agent.transport.queue.basic module
    • BasicMessageQueue
      • BasicMessageQueue.dequeue()
      • BasicMessageQueue.enqueue()
      • BasicMessageQueue.join()
      • BasicMessageQueue.make_queue()
      • BasicMessageQueue.reset()
      • BasicMessageQueue.stop()
      • BasicMessageQueue.task_done()

Submodules

acapy_agent.transport.error module

Transport-related error classes and codes.

exception acapy_agent.transport.error.RecipientKeysError(*args, error_code: str | None = None, **kwargs)

Bases: WireFormatError

Extract recipient keys error.

exception acapy_agent.transport.error.TransportError(*args, error_code: str | None = None, **kwargs)

Bases: BaseError

Base class for all transport errors.

exception acapy_agent.transport.error.WireFormatEncodeError(*args, error_code: str | None = None, **kwargs)

Bases: WireFormatError

Encoding error when packing the wire format.

error_code = 'message_encode_error'

exception acapy_agent.transport.error.WireFormatError(*args, error_code: str | None = None, **kwargs)

Bases: TransportError

Base class for wire-format errors.

exception acapy_agent.transport.error.WireFormatParseError(*args, error_code: str | None = None, **kwargs)

Bases: WireFormatError

Parse error when unpacking the wire format.

error_code = 'message_parse_error'

acapy_agent.transport.pack_format module

Standard packed message format classes.

class acapy_agent.transport.pack_format.PackWireFormat

Bases: BaseWireFormat

Standard DIDComm message parser and serializer.

async encode_message(session: ProfileSession, message_json: str | bytes, recipient_keys: Sequence[str], routing_keys: Sequence[str], sender_key: str) → str | bytes

Pass an incoming message to the appropriately versioned PackWireFormat.

get_for_outbound_msg(outbound_msg: str | bytes) → BaseWireFormat

Retrieve appropriate DIDComm instance for a given packed message.

get_for_packed_msg(packed_msg: str | bytes) → BaseWireFormat

Retrieve appropriate DIDComm instance for a given packed message.

get_recipient_keys(message_body: str | bytes) → List[str]

Get all recipient keys from a wire message.

async pack(session: ProfileSession, message_json: str | bytes, recipient_keys: Sequence[str], routing_keys: Sequence[str], sender_key: str)

Look up the wallet instance and perform the message pack.

async parse_message(session: ProfileSession, message_body: str | bytes) → Tuple[dict, MessageReceipt]

Pass an incoming message to the appropriately versioned PackWireFormat.

async unpack(session: ProfileSession, message_body: str | bytes, receipt: MessageReceipt)

Look up the wallet instance and perform the message unpack.

class acapy_agent.transport.pack_format.V1PackWireFormat

Bases: BaseWireFormat

DIDComm V1 message parser and serializer.

async encode_message(session: ProfileSession, message_json: str | bytes, recipient_keys: Sequence[str], routing_keys: Sequence[str], sender_key: str) → str | bytes

Encode an outgoing message for transport.

Parameters:

• session – The profile session for providing wallet access

• message_json – The message body to serialize

• recipient_keys – A sequence of recipient verkeys

• routing_keys – A sequence of routing verkeys

• sender_key – The verification key of the sending agent

Returns:

The encoded message

Raises:

MessageEncodeError – If the message could not be encoded

get_recipient_keys(message_body: str | bytes) → List[str]

Get all recipient keys from a wire message.

Parameters:

message_body – The body of the message

Returns:

List of recipient keys from the message body

Raises:

RecipientKeysError – If the recipient keys could not be extracted

async pack(session: ProfileSession, message_json: str | bytes, recipient_keys: Sequence[str], routing_keys: Sequence[str], sender_key: str)

Look up the wallet instance and perform the message pack.

async parse_message(session: ProfileSession, message_body: str | bytes) → Tuple[dict, MessageReceipt]

Deserialize an incoming message and further populate the request context.

Parameters:

• session – The profile session for providing wallet access

• message_body – The body of the message

Returns:

A tuple of the parsed message and a message receipt instance

Raises:

• WireFormatParseError – If the JSON parsing failed

• WireFormatParseError – If a wallet is required but can’t be located

async unpack(session: ProfileSession, message_body: str | bytes, receipt: MessageReceipt)

Look up the wallet instance and perform the message unpack.

acapy_agent.transport.pack_format.get_version_for_outbound_msg(outbound_msg: str | bytes)

Get the version of the packed message.

acapy_agent.transport.pack_format.get_version_for_packed_msg(packed_msg: str | bytes)

Get the version of the packed message.

acapy_agent.transport.stats module

aiohttp stats collector support.

class acapy_agent.transport.stats.StatsTracer(*args: Any, **kwargs: Any)

Bases: TraceConfig

Attach hooks to client session events and report statistics.

async connection_queued_end(session, context, params)

Handle the end of a queued connection.

async connection_queued_start(session, context, params)

Handle the start of a queued connection.

async connection_ready(session, context, params)

Handle the end of connection acquisition.

async dns_resolvehost_end(session, context, params)

Handle the end of a DNS resolution.

async dns_resolvehost_start(session, context, params)

Handle the start of a DNS resolution.

async request_end(session, context, params)

Handle the end of request.

async request_start(session, context, params)

Handle the start of a request.

async socket_connect_start(session, context, params)

Handle the start of a socket connection.

acapy_agent.transport.v2_pack_format module

acapy_agent.transport.wire_format module

Abstract wire format classes.

class acapy_agent.transport.wire_format.BaseWireFormat

Bases: object

Abstract messaging wire format.

abstractmethod async encode_message(session: ProfileSession, message_json: str | bytes, recipient_keys: Sequence[str], routing_keys: Sequence[str], sender_key: str) → str | bytes

Encode an outgoing message for transport.

Parameters:

• session – The profile session for providing wallet access

• message_json – The message body to serialize

• recipient_keys – A sequence of recipient verkeys

• routing_keys – A sequence of routing verkeys

• sender_key – The verification key of the sending agent

Returns:

The encoded message

Raises:

MessageEncodeError – If the message could not be encoded

abstractmethod get_recipient_keys(message_body: str | bytes) → List[str]

Get all recipient keys from a wire message.

Parameters:

message_body – The body of the message

Returns:

List of recipient keys from the message body

Raises:

RecipientKeysError – If the recipient keys could not be extracted

abstractmethod async parse_message(session: ProfileSession, message_body: str | bytes) → Tuple[dict, MessageReceipt]

Deserialize an incoming message and further populate the request context.

Parameters:

• session – The profile session for providing wallet access

• message_body – The body of the message

Returns:

A tuple of the parsed message and a message receipt instance

Raises:

WireFormatParseError – If the message can’t be parsed

class acapy_agent.transport.wire_format.JsonWireFormat

Bases: BaseWireFormat

Unencrypted wire format.

abstractmethod async encode_message(session: ProfileSession, message_json: str | bytes, recipient_keys: Sequence[str], routing_keys: Sequence[str], sender_key: str) → str | bytes

Encode an outgoing message for transport.

Parameters:

• session – The profile session for providing wallet access

• message_json – The message body to serialize

• recipient_keys – A sequence of recipient verkeys

• routing_keys – A sequence of routing verkeys

• sender_key – The verification key of the sending agent

Returns:

The encoded message

Raises:

MessageEncodeError – If the message could not be encoded

get_recipient_keys(message_body: str | bytes) → List[str]

Get all recipient keys from a wire message.

Parameters:

message_body – The body of the message

Returns:

List of recipient keys from the message body

Raises:

RecipientKeysError – If the recipient keys could not be extracted

abstractmethod async parse_message(session: ProfileSession, message_body: str | bytes) → Tuple[dict, MessageReceipt]

Deserialize an incoming message and further populate the request context.

Parameters:

• session – The profile session for providing wallet access

• message_body – The body of the message

Returns:

A tuple of the parsed message and a message receipt instance

Raises:

WireFormatParseError – If the JSON parsing failed