X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FMainpage.dox;h=72b5f4b8c800f4f87b14ba89d37ca8ea3e04e04a;hb=66293acca094b2f29e26e70208691db4af274efb;hp=f4d8be7fe4a08703da33695a1f2f4681b5e719bc;hpb=69255c0f1669fc80b0e4a2bf524715f336b127ad;p=senf.git diff --git a/PPI/Mainpage.dox b/PPI/Mainpage.dox index f4d8be7..72b5f4b 100644 --- a/PPI/Mainpage.dox +++ b/PPI/Mainpage.dox @@ -53,20 +53,7 @@ /** \page ppi_overview PPI Overview and Concepts -
-
Contents
-
    -
  1. \ref ppi_design
  2. -
  3. \ref ppi_packets
  4. -
  5. \ref ppi_modules
  6. -
  7. \ref ppi_connectors
  8. -
  9. \ref ppi_connections
  10. -
  11. \ref ppi_throttling
  12. -
  13. \ref ppi_events
  14. -
  15. \ref ppi_run
  16. -
  17. \ref ppi_flows
  18. -
-
+ \autotoc \section ppi_design Design considerations @@ -78,8 +65,9 @@ \section ppi_packets Packets The PPI processes packets and uses the Packet - library to handle them. All packets are passed around as generic \ref senf::Packet - references, the PPI does not enforce any packet type restrictions. + library 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