Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in / Register
Toggle navigation
L
libzmq
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Packages
Packages
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
submodule
libzmq
Commits
c7693bed
Commit
c7693bed
authored
Dec 04, 2013
by
Shane Hubred
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Updated documentation for zmq_disconnect() and zmq_setsockopt().
parent
a9492a08
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
22 additions
and
14 deletions
+22
-14
zmq_disconnect.txt
doc/zmq_disconnect.txt
+10
-2
zmq_setsockopt.txt
doc/zmq_setsockopt.txt
+12
-12
No files found.
doc/zmq_disconnect.txt
View file @
c7693bed
...
...
@@ -9,17 +9,25 @@ zmq_disconnect - Disconnect a socket
SYNOPSIS
--------
int zmq_disconnect (void '*socket', const char '*endpoint');
*int zmq_disconnect (void '*socket', const char '*endpoint');*
DESCRIPTION
-----------
The _zmq_disconnect()_ function shall disconnect a socket specified
by the 'socket' argument from the endpoint specified by the 'endpoint'
argument.
argument. Any outstanding messages physically received from the network but not
yet received by the application with _zmq_recv()_ shall be discarded. The
behaviour for discarding messages sent by the application with _zmq_send()_ but
not yet physically transferred to the network depends on the value of the
_ZMQ_LINGER_ socket option for the specified 'socket'.
The 'endpoint' argument is as described in linkzmq:zmq_connect[3]
NOTE: The default setting of _ZMQ_LINGER_ does not discard unsent messages;
this behaviour may cause the application to block when calling _zmq_term()_.
For details refer to linkzmq:zmq_setsockopt[3] and linkzmq:zmq_term[3].
RETURN VALUE
------------
...
...
doc/zmq_setsockopt.txt
View file @
c7693bed
...
...
@@ -215,24 +215,24 @@ ZMQ_LINGER: Set linger period for socket shutdown
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_LINGER' option shall set the linger period for the specified 'socket'.
The linger period determines how long pending messages which have yet to be
sent to a peer shall linger in memory after a socket is
clos
ed with
linkzmq:zmq_
close[3], and further affects the termination of the socket's
context with linkzmq:zmq_term[3]. The following outlines the different
behaviours:
sent to a peer shall linger in memory after a socket is
disconnect
ed with
linkzmq:zmq_
disconnect[3] or closed with linkzmq:zmq_close[3], and further
affects the termination of the socket's context with linkzmq:zmq_term[3]. The
following outlines the different
behaviours:
* The default value of '-1' specifies an infinite linger period. Pending
messages shall not be discarded after a call to _zmq_
close()_; attempting to
terminate the socket's context with _zmq_term()_ shall block until all
pending messages have been sent to a peer.
messages shall not be discarded after a call to _zmq_
disconnect()_ or
_zmq_close()_; attempting to terminate the socket's context with _zmq_term()_
shall block until all
pending messages have been sent to a peer.
* The value of '0' specifies no linger period. Pending messages shall be
discarded immediately
when the socket is closed with
_zmq_close()_.
discarded immediately
after a call to _zmq_disconnect()_ or
_zmq_close()_.
* Positive values specify an upper bound for the linger period in milliseconds.
Pending messages shall not be discarded after a call to _zmq_
close()_;
attempting to terminate the socket's context with _zmq_term()_ shall block
until either all pending messages have been sent to a peer, or the linger
period expires, after which any pending messages shall be discarded.
Pending messages shall not be discarded after a call to _zmq_
disconnect()_ or
_zmq_close()_; attempting to terminate the socket's context with _zmq_term()_
shall block until either all pending messages have been sent to a peer, or the
linger
period expires, after which any pending messages shall be discarded.
[horizontal]
Option value type:: int
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment