generic-library/libzmq
1
0
Fork 0
mirror of https://github.com/zeromq/libzmq.git synced 2025-10-23 08:31:46 +02:00
Code Issues Projects Releases Wiki Activity

Problem: Unclear zmq_msg_send failure semantics

Browse Source 
Solution: Explicitly explain message ownership semantics when the call
fails.

Fixes #3526.
This commit is contained in:
Andreas Rottmann
2019-05-31 17:33:34 +02:00
parent 96b9eece15
commit fae26774f5
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/zmq_msg_send.txt
View File

@@ -33,9 +33,12 @@ Specifies that the message being sent is a multi-part message, and that further
message parts are to follow. Refer to the section regarding multi-part messages message parts are to follow. Refer to the section regarding multi-part messages
below for a detailed description. below for a detailed description.
The _zmq_msg_t_ structure passed to _zmq_msg_send()_ is nullified during the The _zmq_msg_t_ structure passed to _zmq_msg_send()_ is nullified on a
call. If you want to send the same message to multiple sockets you have to copy successful call. If you want to send the same message to multiple sockets you
it (e.g. using _zmq_msg_copy()_). have to copy it (e.g. using _zmq_msg_copy()_). If the call fails, the
_zmq_msg_t_ structure stays intact, and must be consumed by another call to
_zmq_msg_send()_ on the same or another socket, or released using
_zmq_msg_close()_ to avoid a memory leak.
NOTE: A successful invocation of _zmq_msg_send()_ does not indicate that the NOTE: A successful invocation of _zmq_msg_send()_ does not indicate that the
message has been transmitted to the network, only that it has been queued on message has been transmitted to the network, only that it has been queued on