Commit cab5a4a1 authored by Martin Sustrik's avatar Martin Sustrik

minor documentation updates

parent c98e29fb
This example is a simple instant messaging implementation. There are multiple This example is a simple instant messaging implementation. There are multiple
partipants in the chat, both sending and reading messages. The sending partipants in the chat, both sending and reading messages. The sending
application 'prompt' is separated from the application displayinf the chat application 'prompt' is separated from the application displaying the chat
'display' so that there's no need for sophisticated GUI. 'display' so that there's no need for sophisticated GUI.
To run the example you'll need both applications plus the 'forwarder' device To run the example you'll need both applications plus the 'forwarder' device
...@@ -12,7 +12,7 @@ $ ./configure --with-chat --with-forwarder ...@@ -12,7 +12,7 @@ $ ./configure --with-chat --with-forwarder
$ make $ make
$ sudo make install $ sudo make install
Once it is build create the configuration file (say config.xml) for the Once it is built create the configuration file (say config.xml) for the
forwarder describing which network endpoints are to be used for incoming and forwarder describing which network endpoints are to be used for incoming and
outgoing messages: outgoing messages:
......
...@@ -24,8 +24,6 @@ ...@@ -24,8 +24,6 @@
#include <string.h> #include <string.h>
#include <algorithm> #include <algorithm>
#include <stdio.h>
namespace zmq namespace zmq
{ {
...@@ -42,10 +40,12 @@ namespace zmq ...@@ -42,10 +40,12 @@ namespace zmq
} }
// The function tries to fill the supplied chunk by binary data. // The function tries to fill the supplied chunk by binary data.
// Returns the size of data actually filled in. If offset is not // If offset is not NULL, it is filled by offset of the first message
// NULL, it is filled by offset of the first message in the batch. // in the batch. If there's no beginning of a message in the batch,
// If there's no beginning of a message in the batch, offset is // offset is set to -1. Both data_ and size_ are in/out parameters.
// set to -1. // 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_, inline void read (unsigned char **data_, size_t *size_,
int *offset_ = NULL) int *offset_ = NULL)
{ {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment