diff options
author | Martin Sustrik <sustrik@fastmq.commkdir> | 2009-12-09 09:19:16 +0100 |
---|---|---|
committer | Martin Sustrik <sustrik@fastmq.commkdir> | 2009-12-09 09:19:16 +0100 |
commit | cab5a4a1596e5019c7fd306ad49aac67209b467c (patch) | |
tree | fc14e9a2c1c64dd9a626b7f18b4a967ce376e191 /src | |
parent | c98e29fb6e017a667452cd0a50536da691600353 (diff) |
minor documentation updates
Diffstat (limited to 'src')
-rw-r--r-- | src/encoder.hpp | 12 |
1 files changed, 6 insertions, 6 deletions
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 <string.h> #include <algorithm> -#include <stdio.h> - 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) { |