PPI: Add missing TargetDgramWriter doku
[senf.git] / PPI / SocketSink.hh
index a5c384b..74580cc 100644 (file)
@@ -45,8 +45,8 @@ namespace senf {
 namespace ppi {
 
     /** \brief Writer for module::ActiveSocketSink / module::PassiveSocketSink
-        
-        This writer will write the packets completely as datagrams to the given socket which must be connected. 
+
+        This writer will write the packets completely as datagrams to the given socket which must be connected.
      */
     class ConnectedDgramWriter
     {
@@ -56,16 +56,74 @@ namespace ppi {
                                     senf::DatagramFramingPolicy,
                                     senf::ConnectedCommunicationPolicy>::policy > Handle;
                                         ///< Handle type supported by this writer
-        
-        void operator()(Handle handle, Packet packet);
+
+        void operator()(Handle handle, Packet const & packet);
+                                        ///< Write \a packet to \a handle
+                                        /**< Write the complete \a packet as a datagram to \a
+                                             handle.
+                                             \param[in] handle Handle to write data to
+                                             \param[in] packet Packet to write */
+    };
+
+    /** \brief Writer sending data with ClientSocketHandle::writeto()
+
+        This writer will send out data using ClientSocketHandle::writeto(). The target address can
+        be specified in the writer constructor and can be adjusted at any time.
+
+        If no target address is set, incoming data will be <em>silently dropped</em>.
+     */
+    template <class HandleType>
+    class TargetDgramWriter
+    {
+    public:
+        typedef HandleType Handle;
+
+        TargetDgramWriter();            ///< Create TargetDgramWriter with unset target address
+        TargetDgramWriter(typename Handle::Address const & target);
+                                        ///< Create TargetDgramWriter sending to \a target
+
+        typename Handle::Address target() const; ///< Get current target address
+        void target(typename Handle::Address const & target); ///< Set target address
+
+        void operator()(Handle handle, Packet const & packet); ///< Write \a packet to \a handle
+                                        /**< Write the complete \a packet as a datagram to \a
+                                             handle.
+                                             \param[in] handle Handle to write data to
+                                             \param[in] packet Packet to write */
+
+    private:
+        typename Handle::Address target_;
+    };
+
+    class IPv4SourceForcingDgramWriter : ConnectedDgramWriter
+    {
+    public:
+        IPv4SourceForcingDgramWriter();
+        IPv4SourceForcingDgramWriter(senf::INet4Address sourceAddr, senf::INet4SocketAddress destAddr);
+        typedef senf::ClientSocketHandle<
+            senf::MakeSocketPolicy< senf::WriteablePolicy,
+                                    senf::DatagramFramingPolicy>::policy > Handle;
+                                        ///< Handle type supported by this writer
+
+        void source(senf::INet4Address & source);
+        senf::INet4Address source();
+        void destination(senf::INet4SocketAddress & dest);
+        senf::INet4SocketAddress destination();
+
+        void operator()(Handle handle, Packet const & packet);
                                         ///< Write \a packet to \a handle
                                         /**< Write the complete \a packet as a datagram to \a
                                              handle.
                                              \param[in] handle Handle to write data to
                                              \param[in] packet Packet to write */
+    private:
+        int sendtoandfrom(int sock, const void *data, size_t dataLen, const in_addr *dst, int port, const in_addr *src);
+        senf::INet4Address source_;
+        senf::INet4Address destination_;
+        unsigned int protocolId_;
     };
 
-    class IPv6SourceForcingDgramWriter
+    class IPv6SourceForcingDgramWriter : ConnectedDgramWriter
     {
     public:
         IPv6SourceForcingDgramWriter();
@@ -74,13 +132,13 @@ namespace ppi {
             senf::MakeSocketPolicy< senf::WriteablePolicy,
                                     senf::DatagramFramingPolicy>::policy > Handle;
                                         ///< Handle type supported by this writer
-        
+
         void source(senf::INet6Address & source);
         senf::INet6Address source();
         void destination(senf::INet6SocketAddress & dest);
         senf::INet6SocketAddress destination();
 
-        void operator()(Handle handle, Packet packet);
+        void operator()(Handle handle, Packet const & packet);
                                         ///< Write \a packet to \a handle
                                         /**< Write the complete \a packet as a datagram to \a
                                              handle.
@@ -91,9 +149,9 @@ namespace ppi {
         senf::INet6Address source_;
         senf::INet6Address destination_;
         unsigned int protocolId_;
-};    
-    
-    
+};
+
+
 }}
 
 namespace senf {
@@ -101,9 +159,9 @@ namespace ppi {
 namespace module {
 
     /** \brief Output %module writing data to a FileHandle using the provided Writer.
-        If using the default ConnectedDgramWriter the filehandle must be writable, connected and 
-        able to handle complete datagrams.  
-        
+        If using the default ConnectedDgramWriter the filehandle must be writable, connected and
+        able to handle complete datagrams.
+
         This output %module will write data to a FileHandle object using a given \a Writer. This
         output %module is active. This requires the file handle to be able to signal its readiness to
         accept more data via the Scheduler.
@@ -137,20 +195,34 @@ namespace module {
         typedef typename Writer::Handle Handle; ///< Handle type requested by writer
 
         connector::ActiveInput<> input; ///< Input connector from which data is received
-        
-        ActiveSocketSink(Handle handle); ///< Create new writer for the given handle
+
+        ActiveSocketSink();             ///< Create non-connected writer
+                                        /**< The writer will be disabled until a socket is set
+                                             \pre Requires \a Writer to be default constructible */
+        explicit ActiveSocketSink(Writer const & writer);
+                                        ///< Create non-connected writer
+                                        /**< The writer will be disabled until a socket is set
+                                             \pre Requires \a Writer to be copy constructible
+                                             \param[in] writer Writer helper writing packet date to
+                                                 the socket */
+        explicit ActiveSocketSink(Handle handle); ///< Create new writer for the given handle
                                         /**< Data will be written to \a handle using \a Writer.
                                              \pre Requires \a Writer to be default constructible
                                              \param[in] handle Handle to write data to */
-        ActiveSocketSink(Handle handle, Writer const & writer); 
+        ActiveSocketSink(Handle handle, Writer const & writer);
                                         ///< Create new writer for the given handle
                                         /**< Data will be written to \a handle using \a Writer.
                                              \pre Requires \a Writer to be copy constructible
-                                             \param[in] handle Handle to write data to 
-                                             \param[in] writer Writer helper writing packet date to the
-                                                 socket */
+                                             \param[in] handle Handle to write data to
+                                             \param[in] writer Writer helper writing packet date to
+                                                 the socket */
+
+        Writer & writer();              ///< Access the Writer
+        Handle handle();                ///< Access handle
+        void handle(Handle handle);     ///< Set handle
+                                        /**< Assigning an empty or in-valid() handle will disable
+                                             the module until a new. valid handle is assigned. */
 
-        Writer & writer();                  ///< Access the Writer
     private:
         void write();
 
@@ -160,9 +232,9 @@ namespace module {
     };
 
     /** \brief Output module writing data to a FileHandle using the provided \a Writer.
-        If using the default ConnectedDgramWriter the filehandle must be writable, connected and 
-        able to handle complete datagrams.  
-        
+        If using the default ConnectedDgramWriter the filehandle must be writable, connected and
+        able to handle complete datagrams.
+
         This output module will write data to a FileHandle object using a given \a Writer. This
         output module is passive. This implies, that the output handle may not block. This also
         implies, that data will probably get lost if written to fast for the underlying transport
@@ -198,8 +270,17 @@ namespace module {
         typedef typename Writer::Handle Handle; ///< Handle type requested by writer
 
         connector::PassiveInput<> input; ///< Input connector from which data is received
-        
-        PassiveSocketSink(Handle handle); ///< Create new writer for the given handle
+
+        PassiveSocketSink();            ///< Create non-connected writer
+                                        /**< The writer will be disabled until a socket is set
+                                             \pre Requires \a Writer to be default constructible */
+        explicit PassiveSocketSink(Writer const & writer);
+                                        ///< Create non-connected writer
+                                        /**< The writer will be disabled until a socket is set
+                                             \pre Requires \a Writer to be copy constructible
+                                             \param[in] writer Writer helper writing packet date to
+                                                 the socket */
+        explicit PassiveSocketSink(Handle handle); ///< Create new writer for the given handle
                                         /**< Data will be written to \a handle using \a Writer.
                                              \pre Requires \a Writer to be default constructible
                                              \param[in] handle Handle to write data to */
@@ -207,22 +288,23 @@ namespace module {
                                         ///< Create new writer for the given handle
                                         /**< Data will be written to \a handle using \a Writer.
                                              \pre Requires \a Writer to be copy constructible
-                                             \param[in] handle Handle to write data to */
+                                             \param[in] handle Handle to write data to
+                                             \param[in] writer Writer helper writing packet date to
+                                                 the socket */
+
+        Writer & writer();              ///< Access the Writer
+        Handle & handle();              ///< Access handle
+        void handle(Handle handle);     ///< Set handle
+                                        /**< Assigning an empty or in-valid() handle will disable
+                                             the module until a new. valid handle is assigned. */
 
-        Writer & writer();      ///< Access the Writer
-        Handle & handle();      /**< Access the handle. This is intendet to be mainly used to reconnect 
-                                     the underlying socket. */
-       /* void reconnect(senf::SocketAddress newAddress);
-        ///< Reconnect the handle to which the packets are written
-       */
+#ifndef DOXYGEN
         void replaceHandle(Handle newHandle);
-                                        /**< Replace the handle to which the packets are written
-                                         * Normally you should access the handle and call connect with
-                                         * the new address. This also works for other 
-                                         * (active) ConnectedSocketSinks/Sources */
-                                        
+#endif
+
     private:
         void write();
+        void checkThrottle();
 
         Handle handle_;
         Writer writer_;
@@ -237,7 +319,7 @@ namespace module {
 #include "SocketSink.cti"
 #endif
 
-\f
+
 // Local Variables:
 // mode: c++
 // fill-column: 100