adding IPv4SourceForcingDgramWriter. use inheritance for IPv?SourceForcingWriter

[senf.git] / PPI / Setup.hh

diff --git a/PPI/Setup.hh b/PPI/Setup.hh
index cbff044..9a06fa4 100644 (file)
--- a/PPI/Setup.hh
+++ b/PPI/Setup.hh
@@ -23,8 +23,8 @@
 /** \file
     \brief Setup public header */
 
-#ifndef HH_Setup_
-#define HH_Setup_ 1
+#ifndef HH_SENF_PPI_Setup_
+#define HH_SENF_PPI_Setup_ 1
 
 // Custom includes
 #include <boost/type_traits.hpp>
@@ -47,6 +47,13 @@ namespace ppi {
         as \a source argument. In the same way, if a module has an input connector called \c input,
         the module may be given directly as \a target argument. This simplifies the most common case
         of a module with one input and one output connector.
+
+        The connect call will check at runtime, whether the two connectors are type-compatible:
+        \li Either or both of the connectors are untyped (they accept/send arbitrary senf::Packet's)
+        \li Both connectors send/accept the exactly same packet type.
+
+        \throws connector::IncompatibleConnectorsException if the two connectors are not type
+            compatible.
         
         \see \ref ppi_connections
      */