aboutsummaryrefslogtreecommitdiff
path: root/pw_router/docs.rst
diff options
context:
space:
mode:
Diffstat (limited to 'pw_router/docs.rst')
-rw-r--r--pw_router/docs.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/pw_router/docs.rst b/pw_router/docs.rst
index aefabc9d3..c5356c745 100644
--- a/pw_router/docs.rst
+++ b/pw_router/docs.rst
@@ -9,6 +9,8 @@ over network links.
Common router interfaces
========================
+.. _module-pw_router-packet_parser:
+
PacketParser
------------
To work with arbitrary packet formats, routers require a common interface for
@@ -16,6 +18,8 @@ extracting relevant packet data, such as the destination. This interface is
``pw::router::PacketParser``, defined in ``pw_router/packet_parser.h``, which
must be implemented for the packet framing format used by the network.
+.. _module-pw_router-egress:
+
Egress
------
The Egress class is a virtual interface for sending packet data over a network
@@ -47,6 +51,8 @@ under heavy load.
Some common egress implementations are provided upstream in Pigweed.
+.. _module-pw_router-static_router:
+
StaticRouter
============
``pw::router::StaticRouter`` is a router with a static table of address to