diff options
author | Kai Blin <kai@samba.org> | 2010-01-28 11:11:33 +0100 |
---|---|---|
committer | Kai Blin <kai@samba.org> | 2010-01-28 11:11:33 +0100 |
commit | 9184f524f0e5fe828b723200182969e0e3e8685d (patch) | |
tree | ca32cb758d9d50dc72964afe3ed936059a4a46ad | |
parent | 2fdff7f596268b53084f3fc15102c9e000966f02 (diff) | |
download | samba-9184f524f0e5fe828b723200182969e0e3e8685d.tar.gz samba-9184f524f0e5fe828b723200182969e0e3e8685d.tar.bz2 samba-9184f524f0e5fe828b723200182969e0e3e8685d.zip |
tsocket: Fix description for tstream_readv_pdu_queue_send/recv
-rw-r--r-- | lib/tsocket/tsocket.h | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/lib/tsocket/tsocket.h b/lib/tsocket/tsocket.h index b9b9dc39d9..8410a3c27a 100644 --- a/lib/tsocket/tsocket.h +++ b/lib/tsocket/tsocket.h @@ -975,11 +975,10 @@ struct tevent_req *tstream_readv_pdu_send(TALLOC_CTX *mem_ctx, int tstream_readv_pdu_recv(struct tevent_req *req, int *perrno); /** - * @brief Queue a dgram blob for sending through the socket. + * @brief Queue a read request for a PDU on the socket. * - * This function queues a blob for sending to destination through an existing - * dgram socket. The async callback is triggered when the whole blob is - * delivered to the underlying system socket. + * This function queues a read request for a PDU on a stream socket. The async + * callback is triggered when a full PDU has been read from the socket. * * The caller needs to make sure that all non-scalar input parameters hang * arround for the whole lifetime of the request. @@ -1008,14 +1007,14 @@ struct tevent_req *tstream_readv_pdu_queue_send(TALLOC_CTX *mem_ctx, void *next_vector_private); /** - * @brief Receive the result of the sent dgram blob. + * @brief Receive the PDU blob read from the stream. * * @param[in] req The tevent request from tstream_readv_pdu_queue_send(). * * @param[out] perrno The error set to the actual errno. * - * @return The length of the datagram (0 is never returned!), -1 on - * error with perrno set to the actual errno. + * @return The number of bytes read on success, -1 on error with + * perrno set to the actual errno. */ int tstream_readv_pdu_queue_recv(struct tevent_req *req, int *perrno); |