From cab5a4a1596e5019c7fd306ad49aac67209b467c Mon Sep 17 00:00:00 2001 From: Martin Sustrik Date: Wed, 9 Dec 2009 09:19:16 +0100 Subject: minor documentation updates --- src/encoder.hpp | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'src') diff --git a/src/encoder.hpp b/src/encoder.hpp index 884852c..6387c4e 100644 --- a/src/encoder.hpp +++ b/src/encoder.hpp @@ -24,8 +24,6 @@ #include #include -#include - namespace zmq { @@ -42,10 +40,12 @@ namespace zmq } // The function tries to fill the supplied chunk by binary data. - // Returns the size of data actually filled in. If offset is not - // NULL, it is filled by offset of the first message in the batch. - // If there's no beginning of a message in the batch, offset is - // set to -1. + // If offset is not NULL, it is filled by offset of the first message + // in the batch. If there's no beginning of a message in the batch, + // offset is set to -1. Both data_ and size_ are in/out parameters. + // Upon exit, data_ contains actual position of the data read (may + // be different from the position requested) and size_ contains number + // of bytes actually provided. inline void read (unsigned char **data_, size_t *size_, int *offset_ = NULL) { -- cgit v1.2.3