xref: /aosp_15_r20/external/pigweed/pw_hdlc/router.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985) 
1.. _module-pw_hdlc-router:
2
3======
4Router
5======
6.. pigweed-module-subpage::
7   :name: pw_hdlc
8
9``pw_hdlc::Router`` is an experimental asynchronous HDLC router using
10``pw_channel``.
11
12It sends and receives HDLC packets using an external byte-oriented channel
13and routes the decoded packets to local datagram-oriented channels.
14
15---
16API
17---
18.. doxygenclass:: pw::hdlc::Router
19   :members:
20
21-----------------
22More pw_hdlc docs
23-----------------
24.. include:: docs.rst
25   :start-after: .. pw_hdlc-nav-start
26   :end-before: .. pw_hdlc-nav-end
27