Changed to colour every module ending with Source or Sink red

[senf.git] / senf / PPI / SocketSink.hh

diff --git a/senf/PPI/SocketSink.hh b/senf/PPI/SocketSink.hh
index 204e1ea..ab68990 100644 (file)
--- a/senf/PPI/SocketSink.hh
+++ b/senf/PPI/SocketSink.hh
@@ -58,7 +58,7 @@ namespace ppi {
                                         ///< Handle type supported by this writer
         typedef Packet PacketType;
 
-        void operator()(Handle handle, Packet const & packet);
+        bool operator()(Handle handle, Packet const & packet);
                                         ///< Write \a packet to \a handle
                                         /**< Write the complete \a packet as a datagram to \a
                                              handle.
@@ -87,7 +87,7 @@ namespace ppi {
         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
+        bool 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
@@ -113,7 +113,7 @@ namespace ppi {
         void destination(senf::INet4SocketAddress & dest);
         senf::INet4SocketAddress destination();
 
-        void operator()(Handle handle, Packet const & packet);
+        bool operator()(Handle handle, Packet const & packet);
                                         ///< Write \a packet to \a handle
                                         /**< Write the complete \a packet as a datagram to \a
                                              handle.
@@ -142,7 +142,7 @@ namespace ppi {
         void destination(senf::INet6SocketAddress & dest);
         senf::INet6SocketAddress destination();
 
-        void operator()(Handle handle, Packet const & packet);
+        bool operator()(Handle handle, Packet const & packet);
                                         ///< Write \a packet to \a handle
                                         /**< Write the complete \a packet as a datagram to \a
                                              handle.
@@ -184,7 +184,7 @@ namespace module {
               SomeWriter();                                        // EITHER default constructible OR
               SomeWriter(SomeWriter const & other);                // copy constructible
 
-              void operator()(Handle handle, Packet packet);       // insertion function
+              bool operator()(Handle handle, Packet packet);       // insertion function
           };
         \endcode
         Whenever a packet is received for sending, the \a Writer's \c operator() is called.
@@ -241,10 +241,10 @@ namespace module {
         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
-        mechanism. Either this is desired (like for a UDP socket) or some additional bandwidth
-        shaping needs to be used.
+        output module is passive. This implies, that <em>the output handle may not block</em>. This
+        also implies, that data will probably get lost if written to fast for the underlying
+        transport mechanism. Either this is desired (like for a UDP socket) or some additional
+        bandwidth shaping needs to be used.
 
         The default \a Writer is senf::ppi::ConnectedDgramWriter which will write out the complete packet to
         the file handle.
@@ -260,7 +260,7 @@ namespace module {
               SomeWriter();                                          // EITHER default constructible
               SomeWriter(SomeWriter const & other);                    // OR copy constructible
 
-              void operator()(Handle handle, Packet packet);       // insertion function
+              bool operator()(Handle handle, Packet packet);       // insertion function
           };
         \endcode
         Whenever a packet is received for sending, the \a Writer's \c operator() is called.
@@ -302,7 +302,7 @@ namespace module {
         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. */
+                                             the module until a new valid handle is assigned. */
 
 #ifndef DOXYGEN
         void replaceHandle(Handle newHandle);
@@ -325,7 +325,7 @@ namespace module {
 #include "SocketSink.cti"
 #endif
 
-
+\f
 // Local Variables:
 // mode: c++
 // fill-column: 100