Packets: Add 'name()' member to packet registry entries

[senf.git] / PPI / Mainpage.dox

diff --git a/PPI/Mainpage.dox b/PPI/Mainpage.dox
index f4d8be7..2491f50 100644 (file)
--- a/PPI/Mainpage.dox
+++ b/PPI/Mainpage.dox
@@ -53,20 +53,7 @@
 
 /** \page ppi_overview PPI Overview and Concepts
 
-    <div class="toc">
-    <div>Contents</div>
-    <ol>
-    <li>\ref ppi_design</li>
-    <li>\ref ppi_packets</li>
-    <li>\ref ppi_modules</li>
-    <li>\ref ppi_connectors</li>
-    <li>\ref ppi_connections</li>
-    <li>\ref ppi_throttling</li>
-    <li>\ref ppi_events</li>
-    <li>\ref ppi_run</li>
-    <li>\ref ppi_flows</li>
-    </ol>
-    </div>
+    \autotoc
 
     \section ppi_design Design considerations
 
@@ -78,8 +65,9 @@
     \section ppi_packets Packets
 
     The PPI processes packets and uses the <a href="@TOPDIR@/Packets/doc/html/index.html">Packet
-    library</a> to handle them. All packets are passed around as generic \ref senf::Packet
-    references, the PPI does not enforce any packet type restrictions.
+    library</a> to handle them. All packets are internally passed around as generic \ref
+    senf::Packet references, however connectors may optionally be defined as sending or receiving
+    packets of a specific type only.
 
     \section ppi_modules Modules
 
@@ -212,6 +200,9 @@
     To provide this flexibility, all input connectors incorporate a packet queue. This queue is
     exposed to the module and allows the module to optionally process packets in batches.
 
+    Connectors take an optional template argument which allows to specify the type of packet this
+    connector sends or received. This template arguments defaults to \ref senf::Packet.
+
     \see \ref senf::ppi::connector
 
     \section ppi_connections Connections
@@ -236,10 +227,10 @@
       CopyPacketGenerator generator (stuffingPacket);
 
       senf::UDPv4ClientSocketHandle inputSocket (1111);
-      senf::ppi::module::ActiveSocketReader udpInput (inputSocket);
+      senf::ppi::module::ActiveSocketSource<> udpInput (inputSocket);
 
       senf::UDPv4ClientSocketHandle outputSocket ("2.3.4.5:2222");
-      senf::ppi::module::PassiveSocketWriter udpOutput (outputSocket);
+      senf::ppi::module::PassiveSocketSink<> udpOutput (outputSocket);
 
       senf::ppi::module::PassiveQueue adaptor;