Skip to content

Commit

Permalink
Updated man pages
Browse files Browse the repository at this point in the history
  • Loading branch information
hintjens committed Apr 23, 2014
1 parent 574e8b7 commit f246c4b
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 6 deletions.
22 changes: 19 additions & 3 deletions doc/zhash.txt
Expand Up @@ -104,15 +104,31 @@ CZMQ_EXPORT void

// Serialize hash table to a binary frame that can be sent in a message.
// The packed format is compatible with the 'dictionary' type defined in
// rfc.zeromq.org/spec:19/FILEMQ. Comments are not included in the packed
// data. Item values MUST be strings.
// http://rfc.zeromq.org/spec:35/FILEMQ, and implemented by zproto:
//
// ; A list of name/value pairs
// dictionary = dict-count *( dict-name dict-value )
// dict-count = number-4
// dict-value = longstr
// dict-name = string
//
// ; Strings are always length + text contents
// longstr = number-4 *VCHAR
// string = number-1 *VCHAR
//
// ; Numbers are unsigned integers in network byte order
// number-1 = 1OCTET
// number-4 = 4OCTET
//
// Comments are not included in the packed data. Item values MUST be
// strings.
CZMQ_EXPORT zframe_t *
zhash_pack (zhash_t *self);

// Unpack binary frame into a new hash table. Packed data must follow format
// defined by zhash_pack. Hash table is set to autofree. An empty frame
// unpacks to an empty hash table.
zhash_t *
CZMQ_EXPORT zhash_t *
zhash_unpack (zframe_t *frame);

// Self test of this class
Expand Down
6 changes: 3 additions & 3 deletions doc/zloop.txt
Expand Up @@ -41,9 +41,9 @@ CZMQ_EXPORT void
zloop_set_tolerant (zloop_t *self, zmq_pollitem_t *item);

// Register a timer that expires after some delay and repeats some number of
// times. At each expiry, will call the handler, passing the arg. To
// run a timer forever, use 0 times. Returns a timer_id that is used to cancel
// the timer in the future. Returns -1 if there was an error.
// times. At each expiry, will call the handler, passing the arg. To run a
// timer forever, use 0 times. Returns a timer_id that is used to cancel the
// timer in the future. Returns -1 if there was an error.
CZMQ_EXPORT int
zloop_timer (zloop_t *self, size_t delay, size_t times, zloop_timer_fn handler, void *arg);

Expand Down

0 comments on commit f246c4b

Please sign in to comment.