X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Socket%2FClientSocketHandle.hh;h=2e2372a1b5bff5fd7c6e75be7f60dc9ab65a7675;hb=08d97ee2fd048ae883c297118145487517a31258;hp=fb578127058086f7253eb7e7f04385cade5d89d0;hpb=bf0359f0d094233072c9640abeb72464a0719305;p=senf.git diff --git a/Socket/ClientSocketHandle.hh b/Socket/ClientSocketHandle.hh index fb57812..2e2372a 100644 --- a/Socket/ClientSocketHandle.hh +++ b/Socket/ClientSocketHandle.hh @@ -30,6 +30,8 @@ // Custom includes #include #include +#include +#include #include "SocketHandle.hh" //#include "ClientSocketHandle.mpp" @@ -46,20 +48,23 @@ namespace senf { This class provides the client side policy interface of the socket abstraction. ClientSocketHandle defines the complete policy interface. It does not implement - any functionality itself however. All calls are forward to the following policy classes: + any functionality itself however. The following table shows, to which policy members each + group of ClientSocketHandle members is forwardd. The last collumn shows, on which other + policies this member-group depends in the default policy classes. If you define + your own policy classes, the dependencies are up to you. - - - - - - - - - - - + + + + + + + + + + +
ClientSocketHandle member Policy member
read() ReadPolicy::read (\ref senf::ReadPolicyBase)
readfrom() ReadPolicy::readfrom (\ref senf::ReadPolicyBase)
write() WritePolicy::write (\ref senf::WritePolicyBase)
writeto() WritePolicy::writeto (\ref senf::WritePolicyBase)
connect() AddressingPolicy::connect (\ref senf::AddressingPolicyBase)
bind() AddressingPolicy::bind (\ref senf::AddressingPolicyBase)
peer() AddressingPolicy::peer (\ref senf::AddressingPolicyBase)
local() AddressingPolicy::local (\ref senf::AddressingPolicyBase)
rcvbuf() BufferingPolicy::sndbuf (\ref senf::BufferingPolicyBase)
sndbuf() BufferingPolicy::rcvbuf (\ref senf::BufferingPolicyBase)
ClientSocketHandle member Policy member Other policies
read() ReadPolicy::read (\ref senf::ReadPolicyBase)
readfrom() ReadPolicy::readfrom (\ref senf::ReadPolicyBase) UnconnectedCommunicationPolicy
write() WritePolicy::write (\ref senf::WritePolicyBase) ConnectedCommunicationPolicy
writeto() WritePolicy::writeto (\ref senf::WritePolicyBase) UnconnectedCommunicationPolicy
connect() AddressingPolicy::connect (\ref senf::AddressingPolicyBase)
bind() AddressingPolicy::bind (\ref senf::AddressingPolicyBase)
peer() AddressingPolicy::peer (\ref senf::AddressingPolicyBase)
local() AddressingPolicy::local (\ref senf::AddressingPolicyBase)
rcvbuf() BufferingPolicy::sndbuf (\ref senf::BufferingPolicyBase)
sndbuf() BufferingPolicy::rcvbuf (\ref senf::BufferingPolicyBase)
It is important to note, that not all members are always accessible. Which are depends on @@ -81,10 +86,6 @@ namespace senf { \see \ref policy_group \n \ref protocol_group - - \fixme Add enable_if conditions so anything convertible to unsigned will not be interpreted - as a Range template argument but will use the unsigned variant of - read/readfrom/write/writeto. */ template class ClientSocketHandle @@ -169,6 +170,11 @@ namespace senf { */ std::string read (unsigned limit=0); template +# ifndef DOXYGEN + typename boost::range_iterator::type + read (ForwardWritableRange const & range, + typename boost::disable_if< boost::is_convertible >::type * = 0); +# else typename boost::range_iterator::type read (ForwardWritableRange const & range); ///< Read data into range @@ -178,14 +184,16 @@ namespace senf { range. read returns a past-the-end iterator after the last character read. This iterator will point to somewhere within the input range. - \param[in/out] range Range to store data in + \param[in,out] range Range to store data in \returns past-the-end iterator pointer to after the last read character \see \ref read() \n Boost.Range */ +# endif template typename boost::range_iterator::type - read (ForwardWritableRange & range); + read (ForwardWritableRange & range, + typename boost::disable_if< boost::is_convertible >::type * = 0); ///< Read data into range /**< \see read(ForwardWritableRange const &) \n read() \n @@ -239,7 +247,7 @@ namespace senf { range. read returns a past-the-end iterator after the last character read. This iterator will point to somewhere within the input range. - \param[in/out] range Range to store data in + \param[in,out] range Range to store data in \param[out] from peers address from which the data was received \returns past-the-end iterator pointer to after the @@ -267,14 +275,15 @@ namespace senf { \see \ref readfrom() */ char * readfrom (char * start, char * end, Address & from); ///< Read data into memory buffer - /**< This variant will read data into the memory area at \c - buffer of size \c size. This is the most performant - version of readfrom(). - \param[in] buffer address of buffer to store data at - \param[in] size size of buffer - \param[out] from peer address - \returns Number of bytes read - \see \ref readfrom() */ + /**< This variant will read data into the memory area from + \a start to before \a end. This is guaranteed to be the + most efficient version of readfrom(). + \param[in] start address of buffer to store data at + \param[in] end address one past the end of the buffer + \param[out] from peers address from which the data was + received + \returns pointer past the end of the data read + \see \ref read() */ /** \brief Write data to socket @@ -450,4 +459,6 @@ namespace senf { // c-file-style: "senf" // indent-tabs-mode: nil // ispell-local-dictionary: "american" +// compile-command: "scons -u test" +// comment-column: 40 // End: