// $Id$
//
-// Copyright (C) 2006
+// Copyright (C) 2006
// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
// Stefan Bund <stefan.bund@fokus.fraunhofer.de>
// Free Software Foundation, Inc.,
// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+/** \file
+ \brief FramingPolicy public header
+ */
+
#ifndef HH_FramingPolicy_
#define HH_FramingPolicy_ 1
//#include "FramingPolicy.mpp"
///////////////////////////////hh.p////////////////////////////////////////
-namespace satcom {
-namespace lib {
+namespace senf {
+
+ /// \addtogroup policy_impl_group
+ /// @{
+
+ /** \brief FramingPolicy for stream oriented sockets
+ This policy does not explicitly modify the SocketHAndle
+ API. It however affects the semantics of the read and write
+ operations. On a stream oriented socket, read() and write()
+ operations may be combined, the boundary between separate
+ write() calls will be lost on the receiving side.
+ */
struct StreamFramingPolicy : public FramingPolicyBase
{};
+ /** \brief FramingPolicy for datagram oriented sockets
+
+ This policy does not explicitly modify the SocketHAndle
+ API. It however affects the semantics of the read and write
+ operations. On a datagram socket, each read() or write() call
+ we read or write a single datagram. Datagram boundaries are
+ kept intact accross the network.
+ */
struct DatagramFramingPolicy : public FramingPolicyBase
{};
-}}
+ /// @}
+
+}
///////////////////////////////hh.e////////////////////////////////////////
//#include "FramingPolicy.cci"
\f
// Local Variables:
// mode: c++
-// c-file-style: "satcom"
+// fill-column: 100
+// c-file-style: "senf"
+// indent-tabs-mode: nil
+// ispell-local-dictionary: "american"
// End: