Router¶

Overview¶

Purpose¶

The Router is responsible for forwarding both intra-node and inter-node messages between engine instances. It forwards intra-node messages directly between local engines, and sends and receives inter-node messages via the Transport engine. It makes routing decisions based on the DestinationIdentity in EngineMessage headers, and retrieves routing information for identities from the Network Identity Store engine.

State¶

RoutingTable¶

--8<-- "router/types/routing_table.md:purpose"

--8<-- "router/types/routing_table.md:type"

Messages received¶

EngineMessage¶

--8<-- "router/messages/engine_message.md:purpose"

--8<-- "router/messages/engine_message.md:type"

P2PMessage¶

--8<-- "router/messages/p2p_message.md:purpose"

--8<-- "router/messages/p2p_message.md:type"

RelayMessage¶

--8<-- "router/messages/relay_message.md:purpose"

--8<-- "router/messages/relay_message.md:type"

TopicCreateRequest¶

--8<-- "router/messages/topic_create_request.md:purpose"

--8<-- "router/messages/topic_create_request.md:type"

TopicDeleteRequest¶

--8<-- "router/messages/topic_delete_request.md:purpose"

--8<-- "router/messages/topic_delete_request.md:type"

TopicSubRequest¶

--8<-- "router/messages/topic_sub_request.md:purpose"

--8<-- "router/messages/topic_sub_request.md:type"

TopicUnsubRequest¶

--8<-- "router/messages/topic_unsub_request.md:purpose"

--8<-- "router/messages/topic_unsub_request.md:type"

Message flow¶

sequenceDiagram

--8<-- "router/messages/engine_message.md:sequence"

--8<-- "router/messages/p2p_message.md:sequence"

--8<-- "router/messages/relay_message.md:sequence"

--8<-- "router/messages/topic_create_request.md:sequence"

--8<-- "router/messages/topic_delete_request.md:sequence"

--8<-- "router/messages/topic_sub_request.md:sequence"

--8<-- "router/messages/topic_unsub_request.md:sequence"