X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FSocketSink.hh;h=00ff17d7cae540d439664f0a7d3a25372421a1ad;hb=259da4c692259311c6ec99566b57f5ed1e68e93e;hp=5e63b99d45100f418f45dadb31c3d57900336567;hpb=e7ac3fef18af5ec0076f02290ad439a9d6e05491;p=senf.git diff --git a/PPI/SocketSink.hh b/PPI/SocketSink.hh index 5e63b99..00ff17d 100644 --- a/PPI/SocketSink.hh +++ b/PPI/SocketSink.hh @@ -1,8 +1,8 @@ // $Id$ // -// Copyright (C) 2007 -// Fraunhofer Institute for Open Communication Systems (FOKUS) -// Competence Center NETwork research (NET), St. Augustin, GERMANY +// Copyright (C) 2007 +// Fraunhofer Institute for Open Communication Systems (FOKUS) +// Competence Center NETwork research (NET), St. Augustin, GERMANY // Stefan Bund // // This program is free software; you can redistribute it and/or modify @@ -69,12 +69,12 @@ namespace senf { namespace ppi { namespace module { - /** \brief Output module writing data to a FileHandle using the provided Writer. + /** \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. - 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 + 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. The default \a Writer is senf::ppi::ConnectedDgramWriter which will write out the complete packet to @@ -87,8 +87,8 @@ namespace module { public: typedef unspecified Handle; // type of handle requested - SomeWriter(); // EITHER default constructible OR - SomeWriter(SomeWriter const & other); // copy constructible + SomeWriter(); // EITHER default constructible OR + SomeWriter(SomeWriter const & other); // copy constructible void operator()(Handle handle, Packet packet); // insertion function }; @@ -178,11 +178,11 @@ namespace module { \pre Requires \a Writer to be copy constructible \param[in] handle Handle to write data to */ - Writer & writer(); ///< Access the Writer - Handle & handle(); /**< Access the handle. This is intendet to be mainly used to reconnect the under - lying socket. */ + 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 + ///< Reconnect the handle to which the packets are written */ void replaceHandle(Handle newHandle); /**< Replace the handle to which the packets are written