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