Merge pull request #1013 from hintjens/master

hintjens · hintjens · commit 4aca7b80d8bc · 2015-05-30T20:56:11.000+02:00
Problem: documentation is out of date
diff --git a/README.txt b/README.txt
@@ -298,7 +298,7 @@ To write an actor, use this template. Note that your actor is a single function
         zsock_signal (pipe, 0);
 
         while (!self->terminated) {
-            zsock_t *which = zpoller_wait (self->poller, -1);
+            zsock_t *which = (zsock_t *) zpoller_wait (self->poller, -1);
             if (which == self->pipe)
                 s_self_handle_pipe (self);
             else
diff --git a/api/zsock.xml b/api/zsock.xml
@@ -150,7 +150,7 @@
     <method name = "attach">
         Attach a socket to zero or more endpoints. If endpoints is not null,
         parses as list of ZeroMQ endpoints, separated by commas, and prefixed by
-        '@' (to bind the socket) or '>' (to attach the socket). Returns 0 if all
+        '@' (to bind the socket) or '>' (to connect the socket). Returns 0 if all
         endpoints were valid, or -1 if there was a syntax error. If the endpoint
         does not start with '@' or '>', the serverish argument defines whether
         it is used to bind (serverish = true) or connect (serverish = false).
diff --git a/bindings/python/czmq.py b/bindings/python/czmq.py
@@ -1862,7 +1862,7 @@ def disconnect(self, format, *args):
     def attach(self, endpoints, serverish):
         """Attach a socket to zero or more endpoints. If endpoints is not null,
 parses as list of ZeroMQ endpoints, separated by commas, and prefixed by
-'@' (to bind the socket) or '>' (to attach the socket). Returns 0 if all
+'@' (to bind the socket) or '>' (to connect the socket). Returns 0 if all
 endpoints were valid, or -1 if there was a syntax error. If the endpoint
 does not start with '@' or '>', the serverish argument defines whether
 it is used to bind (serverish = true) or connect (serverish = false)."""
diff --git a/bindings/qml/src/QmlZsock.cpp b/bindings/qml/src/QmlZsock.cpp
@@ -63,12 +63,12 @@ int QmlZsock::disconnect (const QString &format) {
 };
 
 ///
-//  Attach a socket to zero or more endpoints. If endpoints is not null,    
-//  parses as list of ZeroMQ endpoints, separated by commas, and prefixed by
-//  '@' (to bind the socket) or '>' (to attach the socket). Returns 0 if all
-//  endpoints were valid, or -1 if there was a syntax error. If the endpoint
-//  does not start with '@' or '>', the serverish argument defines whether  
-//  it is used to bind (serverish = true) or connect (serverish = false).   
+//  Attach a socket to zero or more endpoints. If endpoints is not null,     
+//  parses as list of ZeroMQ endpoints, separated by commas, and prefixed by 
+//  '@' (to bind the socket) or '>' (to connect the socket). Returns 0 if all
+//  endpoints were valid, or -1 if there was a syntax error. If the endpoint 
+//  does not start with '@' or '>', the serverish argument defines whether   
+//  it is used to bind (serverish = true) or connect (serverish = false).    
 int QmlZsock::attach (const QString &endpoints, bool serverish) {
     return zsock_attach (self, endpoints.toUtf8().data(), serverish);
 };
diff --git a/bindings/qml/src/QmlZsock.h b/bindings/qml/src/QmlZsock.h
@@ -67,12 +67,12 @@ public slots:
     //  isn't supported.                                               
     int disconnect (const QString &format);
 
-    //  Attach a socket to zero or more endpoints. If endpoints is not null,    
-    //  parses as list of ZeroMQ endpoints, separated by commas, and prefixed by
-    //  '@' (to bind the socket) or '>' (to attach the socket). Returns 0 if all
-    //  endpoints were valid, or -1 if there was a syntax error. If the endpoint
-    //  does not start with '@' or '>', the serverish argument defines whether  
-    //  it is used to bind (serverish = true) or connect (serverish = false).   
+    //  Attach a socket to zero or more endpoints. If endpoints is not null,     
+    //  parses as list of ZeroMQ endpoints, separated by commas, and prefixed by 
+    //  '@' (to bind the socket) or '>' (to connect the socket). Returns 0 if all
+    //  endpoints were valid, or -1 if there was a syntax error. If the endpoint 
+    //  does not start with '@' or '>', the serverish argument defines whether   
+    //  it is used to bind (serverish = true) or connect (serverish = false).    
     int attach (const QString &endpoints, bool serverish);
 
     //  Returns socket type as printable constant string.
diff --git a/bindings/ruby/lib/czmq/ffi/zsock.rb b/bindings/ruby/lib/czmq/ffi/zsock.rb
@@ -232,12 +232,12 @@ def disconnect format, result
         result
       end
       
-      # Attach a socket to zero or more endpoints. If endpoints is not null,    
-      # parses as list of ZeroMQ endpoints, separated by commas, and prefixed by
-      # '@' (to bind the socket) or '>' (to attach the socket). Returns 0 if all
-      # endpoints were valid, or -1 if there was a syntax error. If the endpoint
-      # does not start with '@' or '>', the serverish argument defines whether  
-      # it is used to bind (serverish = true) or connect (serverish = false).   
+      # Attach a socket to zero or more endpoints. If endpoints is not null,     
+      # parses as list of ZeroMQ endpoints, separated by commas, and prefixed by 
+      # '@' (to bind the socket) or '>' (to connect the socket). Returns 0 if all
+      # endpoints were valid, or -1 if there was a syntax error. If the endpoint 
+      # does not start with '@' or '>', the serverish argument defines whether   
+      # it is used to bind (serverish = true) or connect (serverish = false).    
       def attach endpoints, serverish
         raise DestroyedError unless @ptr
         endpoints = String(endpoints)
diff --git a/doc/asciidoc.conf b/doc/asciidoc.conf
@@ -9,7 +9,7 @@ literal-style=template="literalparagraph"
 (?su)[\\]?(?P<name>linkczmq):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
 
 ifdef::backend-docbook[]
-[linkfczmq-inlinemacro]
+[linkczmq-inlinemacro]
 {0%{target}}
 {0#<citerefentry>}
 {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
diff --git a/doc/zchunk.doc b/doc/zchunk.doc
@@ -49,6 +49,11 @@ This is the class interface:
     CZMQ_EXPORT size_t
         zchunk_append (zchunk_t *self, const void *data, size_t size);
     
+    //  Append user-supplied data to chunk, return resulting chunk size. If the
+    //  data would exceeed the available space, the chunk grows in size.
+    CZMQ_EXPORT size_t
+        zchunk_extend (zchunk_t *self, const void *data, size_t size);
+    
     //  Copy as much data from 'source' into the chunk as possible; returns the
     //  new size of chunk. If all data from 'source' is used, returns exhausted
     //  on the source chunk. Source can be consumed as many times as needed until
diff --git a/doc/zchunk.txt b/doc/zchunk.txt
@@ -49,6 +49,11 @@ CZMQ_EXPORT size_t
 CZMQ_EXPORT size_t
     zchunk_append (zchunk_t *self, const void *data, size_t size);
 
+//  Append user-supplied data to chunk, return resulting chunk size. If the
+//  data would exceeed the available space, the chunk grows in size.
+CZMQ_EXPORT size_t
+    zchunk_extend (zchunk_t *self, const void *data, size_t size);
+
 //  Copy as much data from 'source' into the chunk as possible; returns the
 //  new size of chunk. If all data from 'source' is used, returns exhausted
 //  on the source chunk. Source can be consumed as many times as needed until
diff --git a/doc/zframe.doc b/doc/zframe.doc
@@ -31,6 +31,11 @@ This is the class interface:
     CZMQ_EXPORT zframe_t *
         zframe_new_empty ();
     
+    //  Create a frame with a specified string content.
+    //  The caller is responsible for destroying the return value when finished with it.
+    CZMQ_EXPORT zframe_t *
+        zframe_from (const char *string);
+    
     //  Receive frame from socket, returns zframe_t object or NULL if the recv  
     //  was interrupted. Does a blocking recv, if you want to not block then use
     //  zpoller or zloop.                                                       
@@ -78,8 +83,8 @@ This is the class interface:
     CZMQ_EXPORT int
         zframe_more (zframe_t *self);
     
-    //  Set frame MORE indicator (1 or 0). Note this is NOT used when sending 
-    //  frame to socket, you have to specify flag explicitly.                 
+    //  Set frame MORE indicator (1 or 0). Note this is NOT used when sending
+    //  frame to socket, you have to specify flag explicitly.                
     CZMQ_EXPORT void
         zframe_set_more (zframe_t *self, int more);
     
diff --git a/doc/zframe.txt b/doc/zframe.txt
@@ -27,6 +27,11 @@ CZMQ_EXPORT void
 CZMQ_EXPORT zframe_t *
     zframe_new_empty ();
 
+//  Create a frame with a specified string content.
+//  The caller is responsible for destroying the return value when finished with it.
+CZMQ_EXPORT zframe_t *
+    zframe_from (const char *string);
+
 //  Receive frame from socket, returns zframe_t object or NULL if the recv  
 //  was interrupted. Does a blocking recv, if you want to not block then use
 //  zpoller or zloop.                                                       
@@ -74,8 +79,8 @@ CZMQ_EXPORT bool
 CZMQ_EXPORT int
     zframe_more (zframe_t *self);
 
-//  Set frame MORE indicator (1 or 0). Note this is NOT used when sending 
-//  frame to socket, you have to specify flag explicitly.                 
+//  Set frame MORE indicator (1 or 0). Note this is NOT used when sending
+//  frame to socket, you have to specify flag explicitly.                
 CZMQ_EXPORT void
     zframe_set_more (zframe_t *self, int more);
 
diff --git a/doc/zlistx.doc b/doc/zlistx.doc
@@ -15,33 +15,33 @@ This is the class interface:
     //  Create a new, empty list.
     CZMQ_EXPORT zlistx_t *
         zlistx_new (void);
-        
+    
     //  Destroy a list. If an item destructor was specified, all items in the
     //  list are automatically destroyed as well.
     CZMQ_EXPORT void
         zlistx_destroy (zlistx_t **self_p);
-        
+    
     //  Add an item to the head of the list. Calls the item duplicator, if any,
     //  on the item. Resets cursor to list head. Returns an item handle on
     //  success, NULL if memory was exhausted.
     CZMQ_EXPORT void *
         zlistx_add_start (zlistx_t *self, void *item);
-        
+    
     //  Add an item to the tail of the list. Calls the item duplicator, if any,
     //  on the item. Resets cursor to list head. Returns an item handle on
     //  success, NULL if memory was exhausted.
     CZMQ_EXPORT void *
         zlistx_add_end (zlistx_t *self, void *item);
-        
+    
     //  Return the number of items in the list
     CZMQ_EXPORT size_t
         zlistx_size (zlistx_t *self);
-        
+    
     //  Return the item at the head of list. If the list is empty, returns NULL.
     //  Leaves cursor pointing at the head item, or NULL if the list is empty.
     CZMQ_EXPORT void *
         zlistx_first (zlistx_t *self);
-        
+    
     //  Return the next item. At the end of the list (or in an empty list),
     //  returns NULL. Use repeated zlistx_next () calls to work through the list
     //  from zlistx_first (). First time, acts as zlistx_first().
@@ -53,7 +53,7 @@ This is the class interface:
     //  backwards from zlistx_last (). First time, acts as zlistx_last().
     CZMQ_EXPORT void *
         zlistx_prev (zlistx_t *self);
-        
+    
     //  Return the item at the tail of list. If the list is empty, returns NULL.
     //  Leaves cursor pointing at the tail item, or NULL if the list is empty.
     CZMQ_EXPORT void *
@@ -88,14 +88,21 @@ This is the class interface:
     CZMQ_EXPORT void *
         zlistx_detach (zlistx_t *self, void *handle);
     
+    //  Detach item at the cursor, if any, from the list. The item is not modified,
+    //  and the caller is responsible for destroying it as necessary. Returns item
+    //  that was detached, or null if none was. Moves cursor to previous item, so
+    //  you can detach items while iterating forwards through a list.
+    CZMQ_EXPORT void *
+        zlistx_detach_cur (zlistx_t *self);
+    
     //  Delete an item, using its handle. Calls the item destructor is any is
     //  set. If handle is null, deletes the first item on the list. Returns 0
     //  if an item was deleted, -1 if not. If cursor was at item, moves cursor
     //  to previous item, so you can delete items while iterating forwards
     //  through a list.
     CZMQ_EXPORT int
         zlistx_delete (zlistx_t *self, void *handle);
-        
+    
     //  Move an item to the start of the list, via its handle.
     CZMQ_EXPORT void
         zlistx_move_start (zlistx_t *self, void *handle);
@@ -108,13 +115,13 @@ This is the class interface:
     //  is set.
     CZMQ_EXPORT void
         zlistx_purge (zlistx_t *self);
-        
+    
     //  Sort the list. If an item comparator was set, calls that to compare
     //  items, otherwise compares on item value. The sort is not stable, so may
     //  reorder equal items.
     CZMQ_EXPORT void
         zlistx_sort (zlistx_t *self);
-        
+    
     //  Create a new node and insert it into a sorted list. Calls the item
     //  duplicator, if any, on the item. If low_value is true, starts searching
     //  from the start of the list, otherwise searches from the end. Use the item
@@ -123,7 +130,7 @@ This is the class interface:
     //  list head.
     CZMQ_EXPORT void *
         zlistx_insert (zlistx_t *self, void *item, bool low_value);
-        
+    
     //  Move an item, specified by handle, into position in a sorted list. Uses
     //  the item comparator, if any, to determine the new location. If low_value
     //  is true, starts searching from the start of the list, otherwise searches
@@ -141,7 +148,7 @@ This is the class interface:
     //  freed when the list is destroyed.
     CZMQ_EXPORT void
         zlistx_set_destructor (zlistx_t *self, czmq_destructor destructor);
-        
+    
     //  Set a user-defined duplicator for list items; by default items are not
     //  copied when the list is duplicated.
     CZMQ_EXPORT void
diff --git a/doc/zlistx.txt b/doc/zlistx.txt
@@ -12,33 +12,33 @@ SYNOPSIS
 //  Create a new, empty list.
 CZMQ_EXPORT zlistx_t *
     zlistx_new (void);
-    
+
 //  Destroy a list. If an item destructor was specified, all items in the
 //  list are automatically destroyed as well.
 CZMQ_EXPORT void
     zlistx_destroy (zlistx_t **self_p);
-    
+
 //  Add an item to the head of the list. Calls the item duplicator, if any,
 //  on the item. Resets cursor to list head. Returns an item handle on
 //  success, NULL if memory was exhausted.
 CZMQ_EXPORT void *
     zlistx_add_start (zlistx_t *self, void *item);
-    
+
 //  Add an item to the tail of the list. Calls the item duplicator, if any,
 //  on the item. Resets cursor to list head. Returns an item handle on
 //  success, NULL if memory was exhausted.
 CZMQ_EXPORT void *
     zlistx_add_end (zlistx_t *self, void *item);
-    
+
 //  Return the number of items in the list
 CZMQ_EXPORT size_t
     zlistx_size (zlistx_t *self);
-    
+
 //  Return the item at the head of list. If the list is empty, returns NULL.
 //  Leaves cursor pointing at the head item, or NULL if the list is empty.
 CZMQ_EXPORT void *
     zlistx_first (zlistx_t *self);
-    
+
 //  Return the next item. At the end of the list (or in an empty list),
 //  returns NULL. Use repeated zlistx_next () calls to work through the list
 //  from zlistx_first (). First time, acts as zlistx_first().
@@ -50,7 +50,7 @@ CZMQ_EXPORT void *
 //  backwards from zlistx_last (). First time, acts as zlistx_last().
 CZMQ_EXPORT void *
     zlistx_prev (zlistx_t *self);
-    
+
 //  Return the item at the tail of list. If the list is empty, returns NULL.
 //  Leaves cursor pointing at the tail item, or NULL if the list is empty.
 CZMQ_EXPORT void *
@@ -85,14 +85,21 @@ CZMQ_EXPORT void *
 CZMQ_EXPORT void *
     zlistx_detach (zlistx_t *self, void *handle);
 
+//  Detach item at the cursor, if any, from the list. The item is not modified,
+//  and the caller is responsible for destroying it as necessary. Returns item
+//  that was detached, or null if none was. Moves cursor to previous item, so
+//  you can detach items while iterating forwards through a list.
+CZMQ_EXPORT void *
+    zlistx_detach_cur (zlistx_t *self);
+
 //  Delete an item, using its handle. Calls the item destructor is any is
 //  set. If handle is null, deletes the first item on the list. Returns 0
 //  if an item was deleted, -1 if not. If cursor was at item, moves cursor
 //  to previous item, so you can delete items while iterating forwards
 //  through a list.
 CZMQ_EXPORT int
     zlistx_delete (zlistx_t *self, void *handle);
-    
+
 //  Move an item to the start of the list, via its handle.
 CZMQ_EXPORT void
     zlistx_move_start (zlistx_t *self, void *handle);
@@ -105,13 +112,13 @@ CZMQ_EXPORT void
 //  is set.
 CZMQ_EXPORT void
     zlistx_purge (zlistx_t *self);
-    
+
 //  Sort the list. If an item comparator was set, calls that to compare
 //  items, otherwise compares on item value. The sort is not stable, so may
 //  reorder equal items.
 CZMQ_EXPORT void
     zlistx_sort (zlistx_t *self);
-    
+
 //  Create a new node and insert it into a sorted list. Calls the item
 //  duplicator, if any, on the item. If low_value is true, starts searching
 //  from the start of the list, otherwise searches from the end. Use the item
@@ -120,7 +127,7 @@ CZMQ_EXPORT void
 //  list head.
 CZMQ_EXPORT void *
     zlistx_insert (zlistx_t *self, void *item, bool low_value);
-    
+
 //  Move an item, specified by handle, into position in a sorted list. Uses
 //  the item comparator, if any, to determine the new location. If low_value
 //  is true, starts searching from the start of the list, otherwise searches
@@ -138,7 +145,7 @@ CZMQ_EXPORT zlistx_t *
 //  freed when the list is destroyed.
 CZMQ_EXPORT void
     zlistx_set_destructor (zlistx_t *self, czmq_destructor destructor);
-    
+
 //  Set a user-defined duplicator for list items; by default items are not
 //  copied when the list is duplicated.
 CZMQ_EXPORT void
diff --git a/doc/zsock.doc b/doc/zsock.doc
diff --git a/doc/zsock.txt b/doc/zsock.txt
diff --git a/include/zsock.h b/include/zsock.h
