X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Socket%2FServerSocketHandle.hh;h=445505ee0e4190f98b5ced573daada61ab054fbb;hb=85ab07d100a382467a42e19d741d403a7a96c951;hp=7c84d93bb531bce40e69c22fccca2221d46077f3;hpb=3e42ecb22121f2e6df86b27bea73f890384a4ee4;p=senf.git diff --git a/Socket/ServerSocketHandle.hh b/Socket/ServerSocketHandle.hh index 7c84d93..445505e 100644 --- a/Socket/ServerSocketHandle.hh +++ b/Socket/ServerSocketHandle.hh @@ -1,6 +1,6 @@ // $Id$ // -// Copyright (C) 2006 +// Copyright (C) 2006 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS) // Kompetenzzentrum fuer Satelitenkommunikation (SatCom) // Stefan Bund @@ -46,31 +46,31 @@ namespace senf { /** \brief Generic SocketHandle with server interface - This class provides the server side policy interface of the socket abstraction. - ServerSocketHandle defines the complete policy interface. It does not implement any - functionality itself however. All calls are forwarded to the following policy classes: - - - - - - - -
senf::ServerSocketHandle::bind AddressingPolicy::bind (\ref senf::AddressingPolicyBase)
senf::ServerSocketHandle::listen CommunicationPolicy::listen (\ref senf::CommunicationPolicyBase)
senf::ServerSocketHandle::local AddressingPolicy::local (\ref senf::AddressingPolicyBase)
senf::ServerSocketHandle::accept CommunicationPolicy::accept (\ref senf::CommunicationPolicyBase)
senf::ServerSocketHandle::acceptfrom CommunicationPolicy::accept (\ref senf::CommunicationPolicyBase)
- - A ServerSocketHandle is only meaningful for connection oriented addressable protocols - (CommunicationPolicy is ConnectedCommunicationPolicy and AddressingPolicy is not - NoAddressingPolicy). - - It is important to note, that not all members are always accessible. Which are depends on - the \c Policy template argument. If any of the policy axis is left unspecified the - corresponding members will not be callable (you will get a compile time error). Even if - every policy axis is defined, some members might (and will) not exist if they are - meaningless for the protocol of the socket. This depends on the exact policy. - - To find out, which members are available, you have to check the documentation of the policy - classes. You can also find a summary of all members available in the leaf protocol class - documentation. + This class provides the server side policy interface of the socket abstraction. + ServerSocketHandle defines the complete policy interface. It does not implement any + functionality itself however. All calls are forwarded to the following policy classes: + + + + + + + +
senf::ServerSocketHandle::bind AddressingPolicy::bind (\ref senf::AddressingPolicyBase)
senf::ServerSocketHandle::listen CommunicationPolicy::listen (\ref senf::CommunicationPolicyBase)
senf::ServerSocketHandle::local AddressingPolicy::local (\ref senf::AddressingPolicyBase)
senf::ServerSocketHandle::accept CommunicationPolicy::accept (\ref senf::CommunicationPolicyBase)
senf::ServerSocketHandle::acceptfrom CommunicationPolicy::accept (\ref senf::CommunicationPolicyBase)
+ + A ServerSocketHandle is only meaningful for connection oriented addressable protocols + (CommunicationPolicy is ConnectedCommunicationPolicy and AddressingPolicy is not + NoAddressingPolicy). + + It is important to note, that not all members are always accessible. Which are depends on + the \c Policy template argument. If any of the policy axis is left unspecified the + corresponding members will not be callable (you will get a compile time error). Even if + every policy axis is defined, some members might (and will) not exist if they are + meaningless for the protocol of the socket. This depends on the exact policy. + + To find out, which members are available, you have to check the documentation of the policy + classes. You can also find a summary of all members available in the leaf protocol class + documentation. */ template class ServerSocketHandle @@ -80,15 +80,15 @@ namespace senf { /////////////////////////////////////////////////////////////////////////// // Types - /// Address type from the addressing policy + /// Address type from the addressing policy typedef typename Policy::AddressingPolicy::Address Address; - /// 'Best' type for passing address as parameter - /** Depending on the type of \c Address, this will be either Address or Address - const &. See call_traits documentation in the Boost.Utility library\endlink. - */ + /// 'Best' type for passing address as parameter + /** Depending on the type of \c Address, this will be either Address or Address + const &. See call_traits documentation in the Boost.Utility library\endlink. + */ typedef typename boost::call_traits
::param_type AddressParam; - /// Corresponding client socket handle with the same policy + /// Corresponding client socket handle with the same policy typedef ClientSocketHandle ClientSocketHandle; /////////////////////////////////////////////////////////////////////////// @@ -106,7 +106,7 @@ namespace senf { typename SocketHandle::template IsCompatible::type * = 0); template - typename SocketHandle::template IsCompatible::type const & + typename SocketHandle::template IsCompatible::type const & operator=(ServerSocketHandle other); ///@} @@ -116,76 +116,76 @@ namespace senf { ///\name Server socket interface ///@{ - /** \brief Set local address - - For addressable protocols (AddressingPolicy is not NoAddressingPolicy), bind() will set - the local address of the socket. + /** \brief Set local address - \param[in] addr Local socket address to asign + For addressable protocols (AddressingPolicy is not NoAddressingPolicy), bind() will set + the local address of the socket. - \throws senf::SystemException - */ + \param[in] addr Local socket address to asign + + \throws senf::SystemException + */ void bind (AddressParam addr); - /** \brief Allow clients to connect to this server socket - - \todo This is very protocol specific, I don't want it in the policy - interface. Especially the backlog argument seems quite protocol specific to - me. However, we cannot listen() before we bind() so listen() cannot reside in the - constructor. We need to find a good solution here. - - \throws senf::SystemException - */ - // Possible solution: Make listen() an abstract method of the protocol interface, make the - // backlog parameter into a member living in the body or protocol class and set it using - // some accessor. Hmm ... this all seems somehow futile ... + /** \brief Allow clients to connect to this server socket + + \todo This is very protocol specific, I don't want it in the policy + interface. Especially the backlog argument seems quite protocol specific to + me. However, we cannot listen() before we bind() so listen() cannot reside in the + constructor. We need to find a good solution here. + + \throws senf::SystemException + */ + // Possible solution: Make listen() an abstract method of the protocol interface, make the + // backlog parameter into a member living in the body or protocol class and set it using + // some accessor. Hmm ... this all seems somehow futile ... void listen (unsigned backlog=0); - /** \brief Query local address + /** \brief Query local address - This member will return the address of the local socket in addressable protocols - (AddressingPolicy is not NoAddressingPolicy). + This member will return the address of the local socket in addressable protocols + (AddressingPolicy is not NoAddressingPolicy). - There are two Variants of this member, one will return the address by value, the other - takes a reference argument to elide the copy operation. + There are two Variants of this member, one will return the address by value, the other + takes a reference argument to elide the copy operation. - \throws senf::SystemException - */ + \throws senf::SystemException + */ Address local (); void local (Address & addr); ///< Query local address /**< \see \ref local() */ - - /** \brief Accept new connection - If the handle is non-blocking, accept will NOT block. If no connection - is available to be returned, accept will return a ClientSocketHandle - which is not valid() + /** \brief Accept new connection - \throws senf::SystemException + If the handle is non-blocking, accept will NOT block. If no connection + is available to be returned, accept will return a ClientSocketHandle + which is not valid() - This variant ... + \throws senf::SystemException - \returns handle of new client connection - */ - ClientSocketHandle + This variant ... + + \returns handle of new client connection + */ + ClientSocketHandle accept (); std::pair - acceptfrom (); ///< Accept new connection + acceptfrom (); ///< Accept new connection /**< This variant will additionally return the remote - address of the client - \returns \c std::pair with client handle and client - address. - \see \ref accept() */ + address of the client + \returns \c std::pair with client handle and client + address. + \see \ref accept() */ ClientSocketHandle acceptfrom (Address & addr); ///< Accept new connection /**< This variant will additionally return the remote - address of the client - \param[out] client address - \returns handle of new client connection - \see \ref accept() */ - + address of the client + \param[out] client address + \returns handle of new client connection + \see \ref accept() */ + ///@} static ServerSocketHandle cast_static(FileHandle handle); @@ -200,7 +200,7 @@ namespace senf { explicit ServerSocketHandle(std::auto_ptr protocol); private: - + }; /// @} @@ -215,6 +215,8 @@ namespace senf { // Local Variables: // mode: c++ -// c-file-style: "senf" // fill-column: 100 +// c-file-style: "senf" +// indent-tabs-mode: nil +// ispell-local-dictionary: "american" // End: