diff options
| author | Martin Willi <martin@strongswan.org> | 2005-11-25 13:42:58 +0000 |
|---|---|---|
| committer | Martin Willi <martin@strongswan.org> | 2005-11-25 13:42:58 +0000 |
| commit | ca76df97365ec3421719bfbf9ecd3f33939ad108 (patch) | |
| tree | 98f14e2944590fd642f3bfab0e03000ed64cde65 /Source/charon/threads/sender.h | |
| parent | 2a336de4cd0d2f9cbb2547dbe7b4ff278446b89a (diff) | |
| download | strongswan-ca76df97365ec3421719bfbf9ecd3f33939ad108.tar.bz2 strongswan-ca76df97365ec3421719bfbf9ecd3f33939ad108.tar.xz | |
- documentation and cleanup of threads package
Diffstat (limited to 'Source/charon/threads/sender.h')
| -rw-r--r-- | Source/charon/threads/sender.h | 23 |
1 files changed, 19 insertions, 4 deletions
diff --git a/Source/charon/threads/sender.h b/Source/charon/threads/sender.h index c57213ce3..5ddad80d5 100644 --- a/Source/charon/threads/sender.h +++ b/Source/charon/threads/sender.h @@ -1,7 +1,7 @@ /** * @file sender.h * - * @brief Implements the Sender Thread encapsulated in the sender_t object + * @brief Interface of sender_t. * */ @@ -28,20 +28,35 @@ typedef struct sender_t sender_t; /** - * @brief A Sender object which sends packets on the socket + * @brief Sends packets over the socket. + * + * @ingroup threads */ struct sender_t { /** * @brief Destroys a sender object * - * @param sender sender object - * @return SUCCESSFUL if succeeded, FAILED otherwise + * @param sender sender object + * @return + * - SUCCESS in any case */ status_t (*destroy) (sender_t *sender); }; +/** + * @brief Create the sender thread. + * + * The thread will start to work, getting packets + * from the send queue and sends them out. + * + * @return + * - created sender_t, or + * - NULL of thread could not be started + * + * @ingroup threads + */ sender_t * sender_create(); #endif /*SENDER_H_*/ |