// $Id$
//
-// Copyright (C) 2006
+// Copyright (C) 2006
// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
// Stefan Bund <stefan.bund@fokus.fraunhofer.de>
/** \brief basic SocketHandle supporting protocol and policy abstraction
- 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.
+ 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
- introduces the protocol class. However, the class has no public constructors (see the
- derived classes senf::ProtocolClientSocketHandle and senf::ProtocolServerSocketHandle).
+ senf::SocketHandle takes the socket policy as a template argument. senf::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
- 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).
+ The most important functionality provided by senf::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).
- \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.
+ \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.
- \todo Create a SocketHandleBase class and move some non-Policy dependent code there
+ \todo Create a SocketHandleBase class and move some non-Policy dependent code there
*/
template <class SocketPolicy>
class SocketHandle
typedef SocketPolicy Policy;
- /** \brief Check policy compatibility
+ /** \brief Check policy compatibility
- IsCompatible is a template meta-function which will check some other socket policy for
- conversion compatibility. This check is used in the senf::SocketPolicy implementation to
- restrict the conversion operator.
- */
+ IsCompatible is a template meta-function which will check some other socket policy for
+ conversion compatibility. This check is used in the senf::SocketPolicy implementation to
+ restrict the conversion operator.
+ */
template <class OtherPolicy>
struct IsCompatible
: public boost::enable_if< SocketPolicyIsBaseOf<SocketPolicy,OtherPolicy>,
// default destructor
// conversion constructors
-
+
template <class OtherPolicy>
- SocketHandle(SocketHandle<OtherPolicy> other,
+ SocketHandle(SocketHandle<OtherPolicy> other,
typename IsCompatible<OtherPolicy>::type * = 0);
- ///< Convert from other socket handle checking policy
- ///< compatibility
+ ///< Convert from other socket handle checking policy
+ ///< compatibility
///@}
///////////////////////////////////////////////////////////////////////////
template <class OtherPolicy>
typename IsCompatible<OtherPolicy>::type const & operator=(SocketHandle<OtherPolicy> other);
- ///< Assign from other socket handle checking policy
- ///< compatibility
+ ///< Assign from other socket handle checking policy
+ ///< compatibility
void state(SocketStateMap & map, unsigned lod=0);
- ///< Inquire state information of socket handle
- /**< The map argument (a string to string mapping) will be
- filled with information coverning the current state of
- the socket. The information provided depends on the
- socket protocol. The amount of information returned can
- be controlled using the \p lod value.
-
- See senf::SocketProtocol::state() for more information,
- how the Information is generated.
-
- \param map string to string mapping to be filled with
- state information
- \param lod level of detail requesten. The interpretation
- of this value is protocol specific
-
- \implementation This member will be re-implemented in
- every derived class. This is very important since
- state() is \e not a virtual function (which we
- don't want since we don't want to add a vtable
- pointer to every handle instance). */
+ ///< Inquire state information of socket handle
+ /**< The map argument (a string to string mapping) will be
+ filled with information coverning the current state of
+ the socket. The information provided depends on the
+ socket protocol. The amount of information returned can
+ be controlled using the \p lod value.
+
+ See senf::SocketProtocol::state() for more information,
+ how the Information is generated.
+
+ \param map string to string mapping to be filled with
+ state information
+ \param lod level of detail requesten. The interpretation
+ of this value is protocol specific
+
+ \implementation This member will be re-implemented in
+ every derived class. This is very important since
+ state() is \e not a virtual function (which we
+ don't want since we don't want to add a vtable
+ pointer to every handle instance). */
std::string dumpState(unsigned lod=0);
- ///< Format complete state information as string
- /**< Formats the complete state map value and returns it as
- a single multi-line string.
+ ///< Format complete state information as string
+ /**< Formats the complete state map value and returns it as
+ a single multi-line string.
- \implementation This member will be re-implemented in
- every derived class. See the state()
- documentation. */
+ \implementation This member will be re-implemented in
+ every derived class. See the state()
+ documentation. */
protected:
explicit SocketHandle(std::auto_ptr<SocketProtocol> protocol, bool isServer);
- ///< Initialize SocketHandle providing the protocol
- /**< \param protocol Protocol class of the protocol
- implemented by this socket handle
- \param isServer \c true, if this SobcketHandle instance
- implements a server handle, \c false otherwise */
+ ///< Initialize SocketHandle providing the protocol
+ /**< \param protocol Protocol class of the protocol
+ implemented by this socket handle
+ \param isServer \c true, if this SobcketHandle instance
+ implements a server handle, \c false otherwise */
SocketHandle(FileHandle other, bool isChecked);
///< Initialize SocketHandle from arbitrary checked
///< FileHandle
- /**< This constructor is used to support up- and downcasting
- of SocketHandle instances.
+ /**< This constructor is used to support up- and downcasting
+ of SocketHandle instances.
- \warning It is absolutely necessary to ensure, that the
- FileHandle passed in is \e really a SocketHandle
- holding a SocketBody (and not a simple FileBody)
- instance. Additionally. the SocketPolicy absolutely
- must be compatible.
+ \warning It is absolutely necessary to ensure, that the
+ FileHandle passed in is \e really a SocketHandle
+ holding a SocketBody (and not a simple FileBody)
+ instance. Additionally. the SocketPolicy absolutely
+ must be compatible.
- \param other FileHandle to assign
- \param isChecked has to be \c true
+ \param other FileHandle to assign
+ \param isChecked has to be \c true
- \todo Answer, why the heck I need the \c isChecked
- parameter ??
- */
+ \todo Answer, why the heck I need the \c isChecked
+ parameter ??
+ */
- SocketBody & body(); ///< Access socket body
+ SocketBody & body(); ///< Access socket body
/**< This member replaces the corresponding FileHandle
- member and returns an appropriately cast body
- reference */
+ member and returns an appropriately cast body
+ reference */
SocketBody const & body() const; ///< Access socket body in const context
/**< This member replaces the corresponding FileHandle
- member and returns an appropriately cast body
- reference */
+ member and returns an appropriately cast body
+ reference */
SocketProtocol const & protocol() const;
///< Access protocol class
- void assign(FileHandle other); /**< \internal */
+ void assign(FileHandle other); /**< \internal */
public:
static SocketHandle cast_static(FileHandle handle);
/** \brief Write stream status dump to output stream
- Write senf::SocketHandle::dumpState() to \c os
+ Write senf::SocketHandle::dumpState() to \c os
- \related senf::SocketHandle
+ \related senf::SocketHandle
*/
template <class Policy>
std::ostream & operator<<(std::ostream & os, SocketHandle<Policy> handle);
/** \brief static socket (down-)cast
-
- This function is like \c static_cast but for socket handles. It allows to downcast any
- FileHandle to any SocketHandle (and its derived types). static_socket_cast will \e not check
- the validity of the cast, it will assume, that the cast is valid.
- The function will however check, that the cast is possible. Casting between (at compile
- time) known incompatible types (like casting a SocketHandle with a communication policy of
- ConnectedCommunicationPolicy to a SocketHandle with UnconnectedCommunicationPolicy will fail
- at compile time).
+ This function is like \c static_cast but for socket handles. It allows to downcast any
+ FileHandle to any SocketHandle (and its derived types). static_socket_cast will \e not check
+ the validity of the cast, it will assume, that the cast is valid.
+
+ The function will however check, that the cast is possible. Casting between (at compile
+ time) known incompatible types (like casting a SocketHandle with a communication policy of
+ ConnectedCommunicationPolicy to a SocketHandle with UnconnectedCommunicationPolicy will fail
+ at compile time).
- \warning
- If the type you cast to is not really a compatible socket handle type you will get undefined
- behavior, probably your program will crash (You will get an assertion in debug builds).
+ \warning
+ If the type you cast to is not really a compatible socket handle type you will get undefined
+ behavior, probably your program will crash (You will get an assertion in debug builds).
- \related senf::SocketHandle
+ \related senf::SocketHandle
*/
template <class Target, class Source>
Target static_socket_cast(Source handle);
/** \brief dynamic socket (down-)cast
- This function is like \c dynamic_cast but for socket handles. It is a runtime typechecked
- version of static_socket_cast.
-
- \throws std::bad_cast You have tried to perform an invalid down- or crosscast.
-
- \related senf::SocketHandle
+ This function is like \c dynamic_cast but for socket handles. It is a runtime typechecked
+ version of static_socket_cast.
+
+ \throws std::bad_cast You have tried to perform an invalid down- or crosscast.
+
+ \related senf::SocketHandle
*/
template <class Target, class Source>
Target dynamic_socket_cast(Source handle);
/** \brief dynamically check cast validity
- This function will check, wether the given cast is valid. This is the same as checking, that
- dynamic_socket_cast does not throw.
+ This function will check, wether the given cast is valid. This is the same as checking, that
+ dynamic_socket_cast does not throw.
- This member is needed, since there is no 'null' SocketHandle (comparable to a null pointer)
- which could be returned by a non-throwing variant of dynamic_socket_cast.
+ This member is needed, since there is no 'null' SocketHandle (comparable to a null pointer)
+ which could be returned by a non-throwing variant of dynamic_socket_cast.
- \related senf::SocketHandle
+ \related senf::SocketHandle
*/
template <class Target, class Source>
bool check_socket_cast(Source handle);
\f
// Local Variables:
// mode: c++
-// c-file-style: "senf"
// fill-column: 100
+// c-file-style: "senf"
+// indent-tabs-mode: nil
+// ispell-local-dictionary: "american"
// End:
projects / senf.git / blobdiff