aries_cloudagent.protocols.routing package

Submodules

aries_cloudagent.protocols.routing.manager module

Routing manager classes for tracking and inspecting routing records.

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

Bases: aries_cloudagent.protocols.routing.manager.RoutingManagerError

Requested route was not found.

class aries_cloudagent.protocols.routing.manager.RoutingManager(context: aries_cloudagent.config.injection_context.InjectionContext)[source]

Bases: object

Class for handling routing records.

RECORD_TYPE = 'forward_route'
context

Accessor for the current request context.

Returns:The request context for this connection
create_route_record(client_connection_id: str = None, recipient_key: str = None) → aries_cloudagent.protocols.routing.models.route_record.RouteRecord[source]

Create and store a new RouteRecord.

Parameters:
  • client_connection_id – The ID of the connection record
  • recipient_key – The recipient verkey of the route
Returns:

The new routing record
delete_route_record(route: aries_cloudagent.protocols.routing.models.route_record.RouteRecord)[source]

Remove an existing route record.

get_recipient(recip_verkey: str) → aries_cloudagent.protocols.routing.models.route_record.RouteRecord[source]

Resolve the recipient for a verkey.

Parameters:recip_verkey – The verkey (“to”) of the incoming Forward message
Returns:The RouteRecord associated with this verkey
get_routes(client_connection_id: str = None, tag_filter: dict = None) → Sequence[aries_cloudagent.protocols.routing.models.route_record.RouteRecord][source]

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
send_create_route(router_connection_id: str, recip_key: str, outbound_handler)[source]

Create and send a route update request.

Returns: the current routing state (request or done)

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

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.manager.RoutingManagerError(*args, error_code: str = None, **kwargs)[source]

Bases: aries_cloudagent.core.error.BaseError

Generic routing error.

aries_cloudagent.protocols.routing.message_types module

Message type identifiers for Routing.