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.handlers.route_query_request_handler module
  • aries_cloudagent.protocols.routing.v1_0.handlers.route_query_response_handler module
  • aries_cloudagent.protocols.routing.v1_0.handlers.route_update_request_handler module
  • aries_cloudagent.protocols.routing.v1_0.handlers.route_update_response_handler module
• aries_cloudagent.protocols.routing.v1_0.messages package
  • Submodules
  • aries_cloudagent.protocols.routing.v1_0.messages.forward module
  • aries_cloudagent.protocols.routing.v1_0.messages.route_query_request module
  • aries_cloudagent.protocols.routing.v1_0.messages.route_query_response module
  • aries_cloudagent.protocols.routing.v1_0.messages.route_update_request module
  • aries_cloudagent.protocols.routing.v1_0.messages.route_update_response module
• aries_cloudagent.protocols.routing.v1_0.models package
  • Submodules
  • aries_cloudagent.protocols.routing.v1_0.models.paginate module
  • aries_cloudagent.protocols.routing.v1_0.models.paginated module
  • aries_cloudagent.protocols.routing.v1_0.models.route_query_result module
  • aries_cloudagent.protocols.routing.v1_0.models.route_record module
  • aries_cloudagent.protocols.routing.v1_0.models.route_update module
  • aries_cloudagent.protocols.routing.v1_0.models.route_updated module

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: aries_cloudagent.protocols.routing.v1_0.manager.RoutingManagerError

Requested route was not found.

class aries_cloudagent.protocols.routing.v1_0.manager.RoutingManager(profile: aries_cloudagent.core.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) → aries_cloudagent.protocols.routing.v1_0.models.route_record.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: aries_cloudagent.protocols.routing.v1_0.models.route_record.RouteRecord)

Remove an existing route record.

async get_recipient(recip_verkey: str) → aries_cloudagent.protocols.routing.v1_0.models.route_record.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[aries_cloudagent.protocols.routing.v1_0.models.route_record.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

async send_create_route(router_connection_id: str, recip_key: str, outbound_handler: Coroutine)

Create and send a route update request.

Returns: the current routing state (request or done)

async update_routes(client_connection_id: str, updates: Sequence[aries_cloudagent.protocols.routing.v1_0.models.route_update.RouteUpdate]) → Sequence[aries_cloudagent.protocols.routing.v1_0.models.route_updated.RouteUpdated]

Update routes associated with the current connection.

Parameters

• client_connection_id – The ID of the connection record

• updates – The sequence of route updates (create/delete) to perform.

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

Bases: aries_cloudagent.core.error.BaseError

Generic routing error.

aries_cloudagent.protocols.routing.v1_0.message_types module

Message type identifiers for Routing.