1
0
mirror of https://github.com/mfontanini/libtins synced 2026-01-28 12:44:25 +01:00

Documented all functions in header files.

This commit is contained in:
Matias Fontanini
2011-08-16 23:10:22 -03:00
parent 3feb2fdeae
commit 0d2b6a507b
7 changed files with 182 additions and 8 deletions

View File

@@ -44,6 +44,8 @@ namespace Tins {
*/
class PacketSender {
public:
/** \brief The default timeout for receive actions.
*/
static const uint32_t DEFAULT_TIMEOUT;
/** \brief Flags to indicate the socket type.
@@ -63,6 +65,10 @@ namespace Tins {
*/
PacketSender(uint32_t recv_timeout = DEFAULT_TIMEOUT);
/** \brief PacketSender destructor.
*
* This gracefully closes all open sockets.
*/
~PacketSender();
/** \brief Opens a layer y socket.