aries_cloudagent.protocols.routing.v1_0 package

Subpackages

• aries_cloudagent.protocols.routing.v1_0.handlers package
  • Submodules
  • aries_cloudagent.protocols.routing.v1_0.handlers.forward_handler module
• aries_cloudagent.protocols.routing.v1_0.messages package
  • Submodules
  • aries_cloudagent.protocols.routing.v1_0.messages.forward module
    • Forward
      • Forward.Meta
    • ForwardSchema
      • ForwardSchema.Meta
      • ForwardSchema.handle_str_message()
• aries_cloudagent.protocols.routing.v1_0.models package
  • Submodules
  • aries_cloudagent.protocols.routing.v1_0.models.route_record module
    • RouteRecord
      • RouteRecord.Meta
      • RouteRecord.RECORD_ID_NAME
      • RouteRecord.RECORD_TYPE
      • RouteRecord.ROLE_CLIENT
      • RouteRecord.ROLE_SERVER
      • RouteRecord.TAG_NAMES
      • RouteRecord.record_id
      • RouteRecord.record_value
      • RouteRecord.retrieve_by_connection_id()
      • RouteRecord.retrieve_by_recipient_key()
    • RouteRecordSchema
      • RouteRecordSchema.Meta
      • RouteRecordSchema.validate_fields()

Submodules

aries_cloudagent.protocols.routing.v1_0.manager module

Routing manager classes for tracking and inspecting routing records.

exception aries_cloudagent.protocols.routing.v1_0.manager.RouteNotFoundError(*args, error_code: Optional[str] = None, **kwargs)

Bases: RoutingManagerError

Requested route was not found.

class aries_cloudagent.protocols.routing.v1_0.manager.RoutingManager(profile: Profile)

Bases: object

Class for handling routing records.

RECORD_TYPE = 'forward_route'

async create_route_record(client_connection_id: Optional[str] = None, recipient_key: Optional[str] = None, internal_wallet_id: Optional[str] = None) → RouteRecord

Create and store a new RouteRecord.

Parameters

• client_connection_id – The ID of the connection record

• recipient_key – The recipient verkey of the route

• internal_wallet_id – The ID of the wallet record. Used for internal routing

Returns

The new routing record

async delete_route_record(route: RouteRecord)

Remove an existing route record.

async get_recipient(recip_verkey: str) → RouteRecord

Resolve the recipient for a verkey.

Parameters

recip_verkey – The verkey (“to”) of the incoming Forward message

Returns

The RouteRecord associated with this verkey

async get_routes(client_connection_id: Optional[str] = None, tag_filter: Optional[dict] = None) → Sequence[RouteRecord]

Fetch all routes associated with the current connection.

Parameters

• client_connection_id – The ID of the connection record

• tag_filter – An optional dictionary of tag filters

Returns

A sequence of route records found by the query

exception aries_cloudagent.protocols.routing.v1_0.manager.RoutingManagerError(*args, error_code: Optional[str] = None, **kwargs)

Bases: BaseError

Generic routing error.

aries_cloudagent.protocols.routing.v1_0.message_types module

Message type identifiers for Routing.