generic-library/libzmq
1
0
Fork 0
mirror of https://github.com/zeromq/libzmq.git synced 2024-12-14 11:06:59 +01:00
Code Issues Projects Releases Wiki Activity
6,282 Commits 4 Branches 39 Tags 40 MiB
e34e03d1a6
Commit Graph

497 Commits

Author SHA1 Message Date
Luca Boccassi
d57422819a Problem: documentation for ZMQ_XPUB_VERBOSE(R) is unclear 
Solultion: clarify that notifications for unique subs/unsubs are always
passed, and these option only affect the behaviour for duplicated ones.
 2018-03-02 13:42:45 +01:00
fnaime
da9bc91053
Wrong ZMQ_LINGER default value 
Problem: Wrong linger default value

Solution: correct documentation
 2017-11-23 14:15:09 -02:00
Luca Boccassi
e523adf3da Problem: new monitor events missing from docs 
Solution: add them
 2017-11-16 22:00:14 +00:00
ebyrob
d7926d6d5a
Change zmq_recv to zmg_msg_recv since zmq_msg_t is only used with the zmg_msg_recv style functions. 2017-11-10 09:06:16 -05:00
f18m
2aa0e6fd4d Change ZMQ_THREAD_AFFINITY to ZMQ_THREAD_AFFINITY_CPU_ADD/ZMQ_THREAD_AFFINITY_CPU_REMOVE. Avoid prefix thread names when no prefix was set. 2017-10-25 09:55:47 +02:00
Simon Giesecke
439e49bca1 Problem: description of return value is cloned from zmq_atomic_counter_new 
Solution: provide correct description

Fixes #2789
 2017-10-21 17:21:00 +02:00
Simon Giesecke
cfef04035c Clarify usage of zmq_close (#2792) 
* Clarify usage of zmq_close
 2017-10-18 15:27:00 +01:00
Luca Boccassi
55a347c7da Problem: zmq_proxy_steerable manpage does not mention multipart 
Solution: mention that the STATISTICS command returns a message with 8
frames
 2017-10-17 13:20:34 +01:00
Luca Boccassi
cc8d3586cd Problem: formatting error in zmq_ctx_set 
Solution: fix it
 2017-10-17 13:18:46 +01:00
Luca Boccassi
fa5443e92f Merge pull request #2786 from f18m/affinity-scheduling-docs 
Increase details in docs
 2017-10-17 13:16:37 +01:00
f18m
b95ef430be Add docs for ZMQ_THREAD_NAME_PREFIX 2017-10-17 14:11:42 +02:00
f18m
e12f3e68c0 Increase details in docs 2017-10-17 14:03:53 +02:00
f18m
e2678b8b11 Add documentation for new steerable proxy command 2017-10-17 11:08:09 +02:00
Luca Boccassi
e5e83c53e5 Problem: ZMQ_THREAD_AFFINITY is not documented 
Solution: add a section in zmq_ctx_set's manpage
 2017-10-16 12:43:34 +01:00
Luca Boccassi
1478517e1a Problem: use of nice() for ZMQ_THREAD_PRIORITY not documented 
Solution: mention that it is used on Linux when SCHED_OTHER is selected
 2017-10-16 12:42:59 +01:00
Luca Boccassi
b6aee51691 Problem: strict ZAP protocol adherence is backward incompatible 
Solution: add ZMQ_ZAP_ENFORCE_DOMAIN to hide backward incompatible
change and make it disabled by default.
In a future release that breaks API compatibility we can then switch
the default to enabled in order to achieve full RFC compatibility.

Fixes #2762
 2017-10-09 17:48:33 +01:00
sigiesec
1414bf938c Problem: use of unqualified "id" in code example 
Solution: use "routing_id" instead
 2017-09-19 17:54:52 +02:00
sigiesec
d6694e7d47 Problem: Use of "rid" in the docs 
Solution: Replaced by "routing id"
 2017-09-19 17:53:54 +02:00
sigiesec
12f62c74c1 Problem: docs refer to "Identity" 
Solution: change docs to refer to "Routing id"
 2017-09-19 17:53:54 +02:00
sigiesec
7297df6278 Problem: documentation of ZMQ_ZAP_DOMAIN is wrong 
Solution: fix documentation
 2017-09-19 09:13:57 +02:00
Doron Somech
af03241dcb Revert "Problem: term "identity" is confusing" 2017-09-07 15:47:43 +03:00
sigiesec
cd55c62499 Problem: use of unqualified "id" in code example 
Solution: use "routing_id" instead
 2017-09-07 11:21:13 +02:00
sigiesec
0874eec803 Problem: Use of "rid" in the docs 
Solution: Replaced by "routing id"
 2017-09-07 11:18:50 +02:00
sigiesec
f174003740 Problem: docs refer to "Identity" 
Solution: change docs to refer to "Routing id"
 2017-09-07 11:09:18 +02:00
Simon Giesecke
00c6962516 Problem: test failing due to too few messages sent relative to SNDHWM 
Solution: relaxed assertion to accept 10% of the SNDHWM, and updated documentation accordingly
 2017-08-20 11:51:09 +02:00
Luca Boccassi
9387897674 Problem: multi-part able sockets deprecated in favour of non-multi-part 
Solution: as discussed, remove the deprecation notices, as many users
expressed the need for multi-part support.
Fixes #2699
 2017-08-19 11:23:18 +01:00
sigiesec
bdd0f3b18b Problem: documentation on zmq_socket_monitor out-of-sync with current 
state of ZMQ_EVENT_HANDSHAKE_FAILED_* events

Solution: update documentation
 2017-08-18 09:35:13 +02:00
Min RK
3130b913fc specify that groups shall be UTF8 
group being a `char *` is logically a text type, which needs an encoding.

Declare in the API that groups shall be UTF8-encoded,
matching the `zmq_msg_gets` API, which is the other user-facing `char *` API,
which has the same definition.

This allows bindings to provide text-type APIs,
which they cannot do if arbitrary bytes are allowed
 2017-08-17 16:12:53 +02:00
Simon Giesecke
63779094d3 Problem: new ZMQ_MSG_PROPERTY_* defines were not mentioned in the documentation 
Solution: add documentation
 2017-08-04 12:46:41 +02:00
Simon Giesecke
7a16c292b7 Problem: Documentation mentions a message property "Resource", which does not exist 
Solution: Remove from documentation
 2017-08-04 10:34:48 +02:00
Brian Russell
b963542e8f Add socket option BINDTODEVICE 
Linux now supports Virtual Routing and Forwarding (VRF) as per:

https://www.kernel.org/doc/Documentation/networking/vrf.txt

In order for an application to bind or connect to a socket with an
address in a VRF, they need to first bind the socket to the VRF device:

    setsockopt(sd, SOL_SOCKET, SO_BINDTODEVICE, dev, strlen(dev)+1);

Note "dev" is the VRF device, eg. VRF "blue", rather than an interface
enslaved to the VRF.

Add a new socket option, ZMQ_BINDTODEVICE, to bind a socket to a device.
In general, if a socket is bound to a device, eg. an interface, only
packets received from that particular device are processed by the socket.

If device is a VRF device, then subsequent binds/connects to that socket
use addresses in the VRF routing table.
 2017-07-31 15:31:47 +01:00
Marc Sune
609c131249 Problem: adapt, clarify docs ZMQ_ROUTER_MANDATORY 
Solution:

* Document the new behaviour when generating 'ZMQ_POLLOUT' events
  for ZMQ_ROUTER sockets with 'ZMQ_ROUTER_MANDATORY' set to `1`
* Add clarifications for 'ZMQ_ROUTER' socket when
  'ZMQ_ROUTER_MANDATORY' is set to `1`
 2017-07-14 18:49:14 +02:00
Emanuel Koczwara
cb54a6b24a Update zmq.txt 
Fixed minor typo.
 2017-06-23 18:57:33 +02:00
Jim Garlick
568feb1c7f gssapi: document NAMETYPE options in get/setsockopt(3) 
Problem: GSSAPI NAMETYPE options were not documented in man
pages for zmq_getsockopt() and zmq_setsockopt().

Solution: add new options to these manual pages.
 2017-04-24 16:13:10 -07:00
Jim Garlick
48f72844ad gssapi: add zmq_gssapi.7 to MAN7 in Makefile.am 
Problem: zmq_gssapi.7 was not mentioned in doc/Makefile.am

Solution: add man page to MAN7 in doc/Makefile.am
 2017-04-21 13:08:48 -07:00
Jim Garlick
8bd3f03cd4 gssapi: add NAMETYPE socket opts to zmq_gssapi.7 
Problem: new GSSAPI socket options are not documented.

Solution: add PRINCIPAL NAMES section to zmq_gssapi.7
 2017-04-21 13:08:48 -07:00
Jim Garlick
c371824b5b gssapi: document ZMQ_GSSAPI_PRINCIPAL as optional 
Problem: the ZMQ_GSSAPI_PRINCIPAL socket option is described
as mandatory in the zmq_gssapi(7) manual page.  In fact it
is optional.

Solution: Describe ZMQ_GSSAPI_PRINCIPAL as optional.
If unspecified, default credentials are used.
 2017-04-20 09:42:06 -07:00
Takeshi Abe
c7ce4a1cea Problem: typo in the zmq_socket doc 
Solution: fix it
 2017-02-23 10:29:25 +09:00
Luca Boccassi
5f8d87bf32 Problem: typo in the zmq_has doc 
Solution: fix it
 2017-01-19 21:00:15 +00:00
Asmod4n
b7cd6e8a85
add test and documentation for "draft" capability 2017-01-19 20:50:18 +01:00
Constantin Rack
d532f2e4d8 Merge pull request #2290 from bluca/doc_proxy_eintr 
Problem: zmq_proxy* may return EINTR other than ETERM
 2017-01-03 21:21:11 +01:00
Luca Boccassi
28c7abf821 Problem: zmq_proxy* may return EINTR other than ETERM 
Solution: mention this in the documentation
 2017-01-03 15:34:08 +01:00
Patrik Wenger
1b3df75b87 fix typos 2017-01-03 12:45:33 +01:00
Luca Boccassi
200649fd57 Problem: new handshake event monitoring undocumented 
Solution: add them to the event monitor manpage
 2016-12-30 23:40:22 +01:00
Luca Boccassi
2afba0085f Problem: documentation does not warn about ZMQ_EVENT_ALL and new events 
Solution: add a note pointing out that when new events are added the
ZMQ_EVENT_ALL mask will start returning them, so applications that
can't handle that transparently should not use it and instead pick
only the event types they want.
Creating a new event type and having monitors with ZMQ_EVENT_ALL
return them will not be considered a backward incompatible change
even though the flow of events will change.
 2016-12-30 23:27:56 +01:00
Luca Boccassi
113feb60a2 Problem: ZMQ_MSG_T_SIZE draft but not in DRAFT section 
Solution: move it there, add it to src/zmq_draft.h and clarify in the
documentation and in the NEWS file that this option is not yet stable
 2016-12-29 21:07:39 +01:00
Luca Boccassi
3dc016cab3 Problem: no documentation for ZMQ_SOCKS_PROXY 
Solution: add paragraphs to zmq_get/setsockopt man pages
 2016-12-26 14:54:58 +01:00
Luca Boccassi
baf32a1985 Problem: no documentation for zmq_curve_public 
Solution: add manpage
 2016-12-26 14:54:58 +01:00
Richard Janis Goldschmidt
ec25fd2ada Add a single sentence explaining what a context is 2016-11-21 14:11:33 +01:00
Luca Boccassi
8a286bb842 Problem: no documentation for ZMQ_MSG_T_SIZE ctx option 
Solution: mention it in zmq_ctx_get manpage
 2016-11-20 12:51:25 +00:00