/** \brief basic SocketHandle supporting protocol and policy abstraction
- The senf::SocketHandle class introduces the two abstraction layers of the socket
+ The %senf::SocketHandle class introduces the two abstraction layers of the socket
library. senf::SocketHandle does \e not provide socket functions it only provides the
infrastructure necessary to support both, the protocol and the policy interface.
- senf::SocketHandle takes the socket policy as a template argument. senf::SocketHandle also
+ %SocketHandle takes the socket policy as a template argument. %SocketHandle also
introduces the protocol class. However, the class has no public constructors (see the
derived classes senf::ProtocolClientSocketHandle and senf::ProtocolServerSocketHandle).
- The most important functionality provided by senf::SocketHandle is the conversion
+ The most important functionality provided by %SocketHandle is the conversion
constructor. This allows to implicitly convert between compatible socket handle types as
specified by the socket policy. The conversion constructor is defined in such a way, that
only valid conversions are possible (see the implementation source for a more complete
discussion).
+ \tparam SPolicy socket policy
+
\note This class is \e not meant to be used as a base-class outside the library
implementation; The protected interface is for internal use only.
See the class description for information on the \a
action and \a index parameters
- \param[in] Stream mandatory stream to match
- \param[in] Area optional area to match
- \param[in] Level optional level, matches messages with
+ \tparam Stream mandatory stream to match
+ \tparam Area optional area to match
+ \tparam Level optional level, matches messages with
at least the given level.
\param[in] action routing action to take
\param[in] index position of new route in the routing
found, it will be removed, otherwise the call will be
ignored
- \param[in] Stream mandatory stream to match
- \param[in] Area optional area to match
- \param[in] Level optional level, matches messages with
+ \tparam Stream mandatory stream to match
+ \tparam Area optional area to match
+ \tparam Level optional level, matches messages with
at least the given level.
\param[in] action routing action to take */
std::string const & message) = 0;
///< Called to write out the routing message
/**< This member must be defined in the derived class to
- somehow format and write the log message.
+ somehow format and write the %log message.
- Every log message always possesses a complete set of
+ Every %log message always possesses a complete set of
meta information (\a stream, \a area and \a level).
\note This member must \e not block since it may be