mirror of https://gitee.com/bigwinds/arangodb
1773 lines
41 KiB
HTML
1773 lines
41 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
|
|
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
|
|
<meta name="generator" content="AsciiDoc 8.6.4" />
|
|
<title>zmq_setsockopt(3)</title>
|
|
<style type="text/css">
|
|
/* Sans-serif font. */
|
|
h1, h2, h3, h4, h5, h6,
|
|
div.title, caption.title,
|
|
thead, p.table.header,
|
|
div#toctitle,
|
|
span#author, span#revnumber, span#revdate, span#revremark,
|
|
div#footer {
|
|
font-family: Arial,Helvetica,sans-serif;
|
|
}
|
|
|
|
/* Serif font. */
|
|
div.sectionbody {
|
|
font-family: Georgia,"Times New Roman",Times,serif;
|
|
}
|
|
|
|
/* Monospace font. */
|
|
tt {
|
|
font-size: inherit;
|
|
}
|
|
|
|
body {
|
|
margin: 1em 5% 1em 5%;
|
|
}
|
|
|
|
a {
|
|
color: blue;
|
|
text-decoration: underline;
|
|
}
|
|
a:visited {
|
|
color: fuchsia;
|
|
}
|
|
|
|
em {
|
|
font-style: italic;
|
|
color: navy;
|
|
}
|
|
|
|
strong {
|
|
font-weight: bold;
|
|
color: #083194;
|
|
}
|
|
|
|
tt {
|
|
font-size: inherit;
|
|
color: navy;
|
|
}
|
|
|
|
h1, h2, h3, h4, h5, h6 {
|
|
color: #527bbd;
|
|
margin-top: 1.2em;
|
|
margin-bottom: 0.5em;
|
|
line-height: 1.3;
|
|
}
|
|
|
|
h1, h2, h3 {
|
|
border-bottom: 2px solid silver;
|
|
}
|
|
h2 {
|
|
padding-top: 0.5em;
|
|
}
|
|
h3 {
|
|
float: left;
|
|
}
|
|
h3 + * {
|
|
clear: left;
|
|
}
|
|
|
|
div.sectionbody {
|
|
margin-left: 0;
|
|
}
|
|
|
|
hr {
|
|
border: 1px solid silver;
|
|
}
|
|
|
|
p {
|
|
margin-top: 0.5em;
|
|
margin-bottom: 0.5em;
|
|
}
|
|
|
|
ul, ol, li > p {
|
|
margin-top: 0;
|
|
}
|
|
ul > li { color: #aaa; }
|
|
ul > li > * { color: black; }
|
|
|
|
pre {
|
|
padding: 0;
|
|
margin: 0;
|
|
}
|
|
|
|
span#author {
|
|
color: #527bbd;
|
|
font-weight: bold;
|
|
font-size: 1.1em;
|
|
}
|
|
span#email {
|
|
}
|
|
span#revnumber, span#revdate, span#revremark {
|
|
}
|
|
|
|
div#footer {
|
|
font-size: small;
|
|
border-top: 2px solid silver;
|
|
padding-top: 0.5em;
|
|
margin-top: 4.0em;
|
|
}
|
|
div#footer-text {
|
|
float: left;
|
|
padding-bottom: 0.5em;
|
|
}
|
|
div#footer-badges {
|
|
float: right;
|
|
padding-bottom: 0.5em;
|
|
}
|
|
|
|
div#preamble {
|
|
margin-top: 1.5em;
|
|
margin-bottom: 1.5em;
|
|
}
|
|
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
|
|
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
|
|
div.admonitionblock {
|
|
margin-top: 1.0em;
|
|
margin-bottom: 1.5em;
|
|
}
|
|
div.admonitionblock {
|
|
margin-top: 2.0em;
|
|
margin-bottom: 2.0em;
|
|
margin-right: 10%;
|
|
color: #606060;
|
|
}
|
|
|
|
div.content { /* Block element content. */
|
|
padding: 0;
|
|
}
|
|
|
|
/* Block element titles. */
|
|
div.title, caption.title {
|
|
color: #527bbd;
|
|
font-weight: bold;
|
|
text-align: left;
|
|
margin-top: 1.0em;
|
|
margin-bottom: 0.5em;
|
|
}
|
|
div.title + * {
|
|
margin-top: 0;
|
|
}
|
|
|
|
td div.title:first-child {
|
|
margin-top: 0.0em;
|
|
}
|
|
div.content div.title:first-child {
|
|
margin-top: 0.0em;
|
|
}
|
|
div.content + div.title {
|
|
margin-top: 0.0em;
|
|
}
|
|
|
|
div.sidebarblock > div.content {
|
|
background: #ffffee;
|
|
border: 1px solid #dddddd;
|
|
border-left: 4px solid #f0f0f0;
|
|
padding: 0.5em;
|
|
}
|
|
|
|
div.listingblock > div.content {
|
|
border: 1px solid #dddddd;
|
|
border-left: 5px solid #f0f0f0;
|
|
background: #f8f8f8;
|
|
padding: 0.5em;
|
|
}
|
|
|
|
div.quoteblock, div.verseblock {
|
|
padding-left: 1.0em;
|
|
margin-left: 1.0em;
|
|
margin-right: 10%;
|
|
border-left: 5px solid #f0f0f0;
|
|
color: #777777;
|
|
}
|
|
|
|
div.quoteblock > div.attribution {
|
|
padding-top: 0.5em;
|
|
text-align: right;
|
|
}
|
|
|
|
div.verseblock > pre.content {
|
|
font-family: inherit;
|
|
font-size: inherit;
|
|
}
|
|
div.verseblock > div.attribution {
|
|
padding-top: 0.75em;
|
|
text-align: left;
|
|
}
|
|
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
|
|
div.verseblock + div.attribution {
|
|
text-align: left;
|
|
}
|
|
|
|
div.admonitionblock .icon {
|
|
vertical-align: top;
|
|
font-size: 1.1em;
|
|
font-weight: bold;
|
|
text-decoration: underline;
|
|
color: #527bbd;
|
|
padding-right: 0.5em;
|
|
}
|
|
div.admonitionblock td.content {
|
|
padding-left: 0.5em;
|
|
border-left: 3px solid #dddddd;
|
|
}
|
|
|
|
div.exampleblock > div.content {
|
|
border-left: 3px solid #dddddd;
|
|
padding-left: 0.5em;
|
|
}
|
|
|
|
div.imageblock div.content { padding-left: 0; }
|
|
span.image img { border-style: none; }
|
|
a.image:visited { color: white; }
|
|
|
|
dl {
|
|
margin-top: 0.8em;
|
|
margin-bottom: 0.8em;
|
|
}
|
|
dt {
|
|
margin-top: 0.5em;
|
|
margin-bottom: 0;
|
|
font-style: normal;
|
|
color: navy;
|
|
}
|
|
dd > *:first-child {
|
|
margin-top: 0.1em;
|
|
}
|
|
|
|
ul, ol {
|
|
list-style-position: outside;
|
|
}
|
|
ol.arabic {
|
|
list-style-type: decimal;
|
|
}
|
|
ol.loweralpha {
|
|
list-style-type: lower-alpha;
|
|
}
|
|
ol.upperalpha {
|
|
list-style-type: upper-alpha;
|
|
}
|
|
ol.lowerroman {
|
|
list-style-type: lower-roman;
|
|
}
|
|
ol.upperroman {
|
|
list-style-type: upper-roman;
|
|
}
|
|
|
|
div.compact ul, div.compact ol,
|
|
div.compact p, div.compact p,
|
|
div.compact div, div.compact div {
|
|
margin-top: 0.1em;
|
|
margin-bottom: 0.1em;
|
|
}
|
|
|
|
div.tableblock > table {
|
|
border: 3px solid #527bbd;
|
|
}
|
|
thead, p.table.header {
|
|
font-weight: bold;
|
|
color: #527bbd;
|
|
}
|
|
tfoot {
|
|
font-weight: bold;
|
|
}
|
|
td > div.verse {
|
|
white-space: pre;
|
|
}
|
|
p.table {
|
|
margin-top: 0;
|
|
}
|
|
/* Because the table frame attribute is overriden by CSS in most browsers. */
|
|
div.tableblock > table[frame="void"] {
|
|
border-style: none;
|
|
}
|
|
div.tableblock > table[frame="hsides"] {
|
|
border-left-style: none;
|
|
border-right-style: none;
|
|
}
|
|
div.tableblock > table[frame="vsides"] {
|
|
border-top-style: none;
|
|
border-bottom-style: none;
|
|
}
|
|
|
|
|
|
div.hdlist {
|
|
margin-top: 0.8em;
|
|
margin-bottom: 0.8em;
|
|
}
|
|
div.hdlist tr {
|
|
padding-bottom: 15px;
|
|
}
|
|
dt.hdlist1.strong, td.hdlist1.strong {
|
|
font-weight: bold;
|
|
}
|
|
td.hdlist1 {
|
|
vertical-align: top;
|
|
font-style: normal;
|
|
padding-right: 0.8em;
|
|
color: navy;
|
|
}
|
|
td.hdlist2 {
|
|
vertical-align: top;
|
|
}
|
|
div.hdlist.compact tr {
|
|
margin: 0;
|
|
padding-bottom: 0;
|
|
}
|
|
|
|
.comment {
|
|
background: yellow;
|
|
}
|
|
|
|
.footnote, .footnoteref {
|
|
font-size: 0.8em;
|
|
}
|
|
|
|
span.footnote, span.footnoteref {
|
|
vertical-align: super;
|
|
}
|
|
|
|
#footnotes {
|
|
margin: 20px 0 20px 0;
|
|
padding: 7px 0 0 0;
|
|
}
|
|
|
|
#footnotes div.footnote {
|
|
margin: 0 0 5px 0;
|
|
}
|
|
|
|
#footnotes hr {
|
|
border: none;
|
|
border-top: 1px solid silver;
|
|
height: 1px;
|
|
text-align: left;
|
|
margin-left: 0;
|
|
width: 20%;
|
|
min-width: 100px;
|
|
}
|
|
|
|
div.colist td {
|
|
padding-right: 0.5em;
|
|
padding-bottom: 0.3em;
|
|
vertical-align: top;
|
|
}
|
|
div.colist td img {
|
|
margin-top: 0.3em;
|
|
}
|
|
|
|
@media print {
|
|
div#footer-badges { display: none; }
|
|
}
|
|
|
|
div#toc {
|
|
margin-bottom: 2.5em;
|
|
}
|
|
|
|
div#toctitle {
|
|
color: #527bbd;
|
|
font-size: 1.1em;
|
|
font-weight: bold;
|
|
margin-top: 1.0em;
|
|
margin-bottom: 0.1em;
|
|
}
|
|
|
|
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
|
|
margin-top: 0;
|
|
margin-bottom: 0;
|
|
}
|
|
div.toclevel2 {
|
|
margin-left: 2em;
|
|
font-size: 0.9em;
|
|
}
|
|
div.toclevel3 {
|
|
margin-left: 4em;
|
|
font-size: 0.9em;
|
|
}
|
|
div.toclevel4 {
|
|
margin-left: 6em;
|
|
font-size: 0.9em;
|
|
}
|
|
|
|
span.aqua { color: aqua; }
|
|
span.black { color: black; }
|
|
span.blue { color: blue; }
|
|
span.fuchsia { color: fuchsia; }
|
|
span.gray { color: gray; }
|
|
span.green { color: green; }
|
|
span.lime { color: lime; }
|
|
span.maroon { color: maroon; }
|
|
span.navy { color: navy; }
|
|
span.olive { color: olive; }
|
|
span.purple { color: purple; }
|
|
span.red { color: red; }
|
|
span.silver { color: silver; }
|
|
span.teal { color: teal; }
|
|
span.white { color: white; }
|
|
span.yellow { color: yellow; }
|
|
|
|
span.aqua-background { background: aqua; }
|
|
span.black-background { background: black; }
|
|
span.blue-background { background: blue; }
|
|
span.fuchsia-background { background: fuchsia; }
|
|
span.gray-background { background: gray; }
|
|
span.green-background { background: green; }
|
|
span.lime-background { background: lime; }
|
|
span.maroon-background { background: maroon; }
|
|
span.navy-background { background: navy; }
|
|
span.olive-background { background: olive; }
|
|
span.purple-background { background: purple; }
|
|
span.red-background { background: red; }
|
|
span.silver-background { background: silver; }
|
|
span.teal-background { background: teal; }
|
|
span.white-background { background: white; }
|
|
span.yellow-background { background: yellow; }
|
|
|
|
span.big { font-size: 2em; }
|
|
span.small { font-size: 0.6em; }
|
|
/* Overrides for manpage documents */
|
|
h1 {
|
|
padding-top: 0.5em;
|
|
padding-bottom: 0.5em;
|
|
border-top: 2px solid silver;
|
|
border-bottom: 2px solid silver;
|
|
}
|
|
h2 {
|
|
border-style: none;
|
|
}
|
|
div.sectionbody {
|
|
margin-left: 5%;
|
|
}
|
|
|
|
@media print {
|
|
div#toc { display: none; }
|
|
}
|
|
|
|
</style>
|
|
<script type="text/javascript">
|
|
/*<+'])');
|
|
// Function that scans the DOM tree for header elements (the DOM2
|
|
// nodeIterator API would be a better technique but not supported by all
|
|
// browsers).
|
|
var iterate = function (el) {
|
|
for (var i = el.firstChild; i != null; i = i.nextSibling) {
|
|
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
|
|
var mo = re.exec(i.tagName);
|
|
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
|
|
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
|
|
}
|
|
iterate(i);
|
|
}
|
|
}
|
|
}
|
|
iterate(el);
|
|
return result;
|
|
}
|
|
|
|
var toc = document.getElementById("toc");
|
|
var entries = tocEntries(document.getElementById("content"), toclevels);
|
|
for (var i = 0; i < entries.length; ++i) {
|
|
var entry = entries[i];
|
|
if (entry.element.id == "")
|
|
entry.element.id = "_toc_" + i;
|
|
var a = document.createElement("a");
|
|
a.href = "#" + entry.element.id;
|
|
a.appendChild(document.createTextNode(entry.text));
|
|
var div = document.createElement("div");
|
|
div.appendChild(a);
|
|
div.className = "toclevel" + entry.toclevel;
|
|
toc.appendChild(div);
|
|
}
|
|
if (entries.length == 0)
|
|
toc.parentNode.removeChild(toc);
|
|
},
|
|
|
|
|
|
/////////////////////////////////////////////////////////////////////
|
|
// Footnotes generator
|
|
/////////////////////////////////////////////////////////////////////
|
|
|
|
/* Based on footnote generation code from:
|
|
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
|
|
*/
|
|
|
|
footnotes: function () {
|
|
var cont = document.getElementById("content");
|
|
var noteholder = document.getElementById("footnotes");
|
|
var spans = cont.getElementsByTagName("span");
|
|
var refs = {};
|
|
var n = 0;
|
|
for (i=0; i<spans.length; i++) {
|
|
if (spans[i].className == "footnote") {
|
|
n++;
|
|
// Use [\s\S] in place of . so multi-line matches work.
|
|
// Because JavaScript has no s (dotall) regex flag.
|
|
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
|
|
noteholder.innerHTML +=
|
|
"<div class='footnote' id='_footnote_" + n + "'>" +
|
|
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
|
|
n + "</a>. " + note + "</div>";
|
|
spans[i].innerHTML =
|
|
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
|
|
"' title='View footnote' class='footnote'>" + n + "</a>]";
|
|
var id =spans[i].getAttribute("id");
|
|
if (id != null) refs["#"+id] = n;
|
|
}
|
|
}
|
|
if (n == 0)
|
|
noteholder.parentNode.removeChild(noteholder);
|
|
else {
|
|
// Process footnoterefs.
|
|
for (i=0; i<spans.length; i++) {
|
|
if (spans[i].className == "footnoteref") {
|
|
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
|
|
href = href.match(/#.*/)[0]; // Because IE return full URL.
|
|
n = refs[href];
|
|
spans[i].innerHTML =
|
|
"[<a href='#_footnote_" + n +
|
|
"' title='View footnote' class='footnote'>" + n + "</a>]";
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
}
|
|
/*]]>*/
|
|
</script>
|
|
</head>
|
|
<body class="manpage">
|
|
<div id="header">
|
|
<h1>
|
|
zmq_setsockopt(3) Manual Page
|
|
</h1>
|
|
<h2>NAME</h2>
|
|
<div class="sectionbody">
|
|
<p>zmq_setsockopt -
|
|
set 0MQ socket options
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="content">
|
|
<div class="sect1">
|
|
<h2 id="_synopsis">SYNOPSIS</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p><strong>int zmq_setsockopt (void <em>*socket</em>, int <em>option_name</em>, const void <em>*option_value</em>, size_t <em>option_len</em>);</strong></p></div>
|
|
<div class="paragraph"><p>Caution: All options, with the exception of ZMQ_SUBSCRIBE, ZMQ_UNSUBSCRIBE and
|
|
ZMQ_LINGER, only take effect for subsequent socket bind/connects.</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_description">DESCRIPTION</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>The <em>zmq_setsockopt()</em> function shall set the option specified by the
|
|
<em>option_name</em> argument to the value pointed to by the <em>option_value</em> argument
|
|
for the ØMQ socket pointed to by the <em>socket</em> argument. The <em>option_len</em>
|
|
argument is the size of the option value in bytes.</p></div>
|
|
<div class="paragraph"><p>The following socket options can be set with the <em>zmq_setsockopt()</em> function:</p></div>
|
|
<div class="sect2">
|
|
<h3 id="_zmq_hwm_set_high_water_mark">ZMQ_HWM: Set high water mark</h3>
|
|
<div class="paragraph"><p>The <em>ZMQ_HWM</em> option shall set the high water mark for the specified <em>socket</em>.
|
|
The high water mark is a hard limit on the maximum number of outstanding
|
|
messages ØMQ shall queue in memory for any single peer that the specified
|
|
<em>socket</em> is communicating with.</p></div>
|
|
<div class="paragraph"><p>If this limit has been reached the socket shall enter an exceptional state and
|
|
depending on the socket type, ØMQ shall take appropriate action such as
|
|
blocking or dropping sent messages. Refer to the individual socket descriptions
|
|
in <a href="zmq_socket.html">zmq_socket(3)</a> for details on the exact action taken for each socket
|
|
type.</p></div>
|
|
<div class="paragraph"><p>The default <em>ZMQ_HWM</em> value of zero means "no limit".</p></div>
|
|
<div class="hdlist"><table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value type
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
uint64_t
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value unit
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
messages
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Default value
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
0
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Applicable socket types
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
all
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_zmq_swap_set_disk_offload_size">ZMQ_SWAP: Set disk offload size</h3>
|
|
<div class="paragraph"><p>The <em>ZMQ_SWAP</em> option shall set the disk offload (swap) size for the specified
|
|
<em>socket</em>. A socket which has <em>ZMQ_SWAP</em> set to a non-zero value may exceed its
|
|
high water mark; in this case outstanding messages shall be offloaded to
|
|
storage on disk rather than held in memory.</p></div>
|
|
<div class="paragraph"><p>The value of <em>ZMQ_SWAP</em> defines the maximum size of the swap space in bytes.</p></div>
|
|
<div class="hdlist"><table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value type
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
int64_t
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value unit
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
bytes
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Default value
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
0
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Applicable socket types
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
all
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_zmq_affinity_set_i_o_thread_affinity">ZMQ_AFFINITY: Set I/O thread affinity</h3>
|
|
<div class="paragraph"><p>The <em>ZMQ_AFFINITY</em> option shall set the I/O thread affinity for newly created
|
|
connections on the specified <em>socket</em>.</p></div>
|
|
<div class="paragraph"><p>Affinity determines which threads from the ØMQ I/O thread pool associated with
|
|
the socket’s <em>context</em> shall handle newly created connections. A value of zero
|
|
specifies no affinity, meaning that work shall be distributed fairly among all
|
|
ØMQ I/O threads in the thread pool. For non-zero values, the lowest bit
|
|
corresponds to thread 1, second lowest bit to thread 2 and so on. For example,
|
|
a value of 3 specifies that subsequent connections on <em>socket</em> shall be handled
|
|
exclusively by I/O threads 1 and 2.</p></div>
|
|
<div class="paragraph"><p>See also <a href="zmq_init.html">zmq_init(3)</a> for details on allocating the number of I/O
|
|
threads for a specific <em>context</em>.</p></div>
|
|
<div class="hdlist"><table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value type
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
uint64_t
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value unit
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
N/A (bitmap)
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Default value
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
0
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Applicable socket types
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
N/A
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_zmq_identity_set_socket_identity">ZMQ_IDENTITY: Set socket identity</h3>
|
|
<div class="paragraph"><p>The <em>ZMQ_IDENTITY</em> option shall set the identity of the specified <em>socket</em>.
|
|
Socket identity determines if existing ØMQ infrastructure (<em>message queues</em>,
|
|
<em>forwarding devices</em>) shall be identified with a specific application and
|
|
persist across multiple runs of the application.</p></div>
|
|
<div class="paragraph"><p>If the socket has no identity, each run of an application is completely
|
|
separate from other runs. However, with identity set the socket shall re-use
|
|
any existing ØMQ infrastructure configured by the previous run(s). Thus the
|
|
application may receive messages that were sent in the meantime, <em>message
|
|
queue</em> limits shall be shared with previous run(s) and so on.</p></div>
|
|
<div class="paragraph"><p>Identity should be at least one byte and at most 255 bytes long. Identities
|
|
starting with binary zero are reserved for use by ØMQ infrastructure.</p></div>
|
|
<div class="hdlist"><table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value type
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
binary data
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value unit
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
N/A
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Default value
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
NULL
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Applicable socket types
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
all
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_zmq_subscribe_establish_message_filter">ZMQ_SUBSCRIBE: Establish message filter</h3>
|
|
<div class="paragraph"><p>The <em>ZMQ_SUBSCRIBE</em> option shall establish a new message filter on a <em>ZMQ_SUB</em>
|
|
socket. Newly created <em>ZMQ_SUB</em> sockets shall filter out all incoming messages,
|
|
therefore you should call this option to establish an initial message filter.</p></div>
|
|
<div class="paragraph"><p>An empty <em>option_value</em> of length zero shall subscribe to all incoming
|
|
messages. A non-empty <em>option_value</em> shall subscribe to all messages beginning
|
|
with the specified prefix. Multiple filters may be attached to a single
|
|
<em>ZMQ_SUB</em> socket, in which case a message shall be accepted if it matches at
|
|
least one filter.</p></div>
|
|
<div class="hdlist"><table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value type
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
binary data
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value unit
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
N/A
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Default value
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
N/A
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Applicable socket types
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
ZMQ_SUB
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_zmq_unsubscribe_remove_message_filter">ZMQ_UNSUBSCRIBE: Remove message filter</h3>
|
|
<div class="paragraph"><p>The <em>ZMQ_UNSUBSCRIBE</em> option shall remove an existing message filter on a
|
|
<em>ZMQ_SUB</em> socket. The filter specified must match an existing filter previously
|
|
established with the <em>ZMQ_SUBSCRIBE</em> option. If the socket has several
|
|
instances of the same filter attached the <em>ZMQ_UNSUBSCRIBE</em> option shall remove
|
|
only one instance, leaving the rest in place and functional.</p></div>
|
|
<div class="hdlist"><table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value type
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
binary data
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value unit
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
N/A
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Default value
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
N/A
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Applicable socket types
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
ZMQ_SUB
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_zmq_rcvtimeo_maximum_time_before_a_recv_operation_returns_with_eagain">ZMQ_RCVTIMEO: Maximum time before a recv operation returns with EAGAIN</h3>
|
|
<div class="paragraph"><p>Sets the timeout for receive operation on the socket. If the value is <tt>0</tt>,
|
|
<em>zmq_recv(3)</em> will return immediately, with a EAGAIN error if there is no
|
|
message to receive. If the value is <tt>-1</tt>, it will block until a message is
|
|
available. For all other values, it will wait for a message for that amount
|
|
of time before returning with an EAGAIN error.</p></div>
|
|
<div class="hdlist"><table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value type
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
int
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value unit
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
milliseconds
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Default value
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
-1 (infinite)
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Applicable socket types
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
all
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_zmq_sndtimeo_maximum_time_before_a_send_operation_returns_with_eagain">ZMQ_SNDTIMEO: Maximum time before a send operation returns with EAGAIN</h3>
|
|
<div class="paragraph"><p>Sets the timeout for send operation on the socket. If the value is <tt>0</tt>,
|
|
<em>zmq_send(3)</em> will return immediately, with a EAGAIN error if the message
|
|
cannot be sent. If the value is <tt>-1</tt>, it will block until the message is sent.
|
|
For all other values, it will try to send the message for that amount of time
|
|
before returning with an EAGAIN error.</p></div>
|
|
<div class="hdlist"><table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value type
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
int
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value unit
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
milliseconds
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Default value
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
-1 (infinite)
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Applicable socket types
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
all
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_zmq_rate_set_multicast_data_rate">ZMQ_RATE: Set multicast data rate</h3>
|
|
<div class="paragraph"><p>The <em>ZMQ_RATE</em> option shall set the maximum send or receive data rate for
|
|
multicast transports such as <a href="zmq_pgm.html">zmq_pgm(7)</a> using the specified <em>socket</em>.</p></div>
|
|
<div class="hdlist"><table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value type
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
int64_t
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value unit
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
kilobits per second
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Default value
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
100
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Applicable socket types
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
all, when using multicast transports
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_zmq_recovery_ivl_set_multicast_recovery_interval">ZMQ_RECOVERY_IVL: Set multicast recovery interval</h3>
|
|
<div class="paragraph"><p>The <em>ZMQ_RECOVERY_IVL</em> option shall set the recovery interval for multicast
|
|
transports using the specified <em>socket</em>. The recovery interval determines the
|
|
maximum time in seconds that a receiver can be absent from a multicast group
|
|
before unrecoverable data loss will occur.</p></div>
|
|
<div class="admonitionblock">
|
|
<table><tr>
|
|
<td class="icon">
|
|
<div class="title">Caution</div>
|
|
</td>
|
|
<td class="content">Exercise care when setting large recovery intervals as the data
|
|
needed for recovery will be held in memory. For example, a 1 minute recovery
|
|
interval at a data rate of 1Gbps requires a 7GB in-memory buffer.</td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="hdlist"><table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value type
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
int64_t
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value unit
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
seconds
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Default value
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
10
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Applicable socket types
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
all, when using multicast transports
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_zmq_recovery_ivl_msec_set_multicast_recovery_interval_in_milliseconds">ZMQ_RECOVERY_IVL_MSEC: Set multicast recovery interval in milliseconds</h3>
|
|
<div class="paragraph"><p>The <em>ZMQ_RECOVERY_IVL_MSEC</em> option shall set the recovery interval, specified
|
|
in milliseconds (ms) for multicast transports using the specified <em>socket</em>.
|
|
The recovery interval determines the maximum time in milliseconds that a
|
|
receiver can be absent from a multicast group before unrecoverable data loss
|
|
will occur.</p></div>
|
|
<div class="paragraph"><p>A non-zero value of the <em>ZMQ_RECOVERY_IVL_MSEC</em> option will take precedence
|
|
over the <em>ZMQ_RECOVERY_IVL</em> option, but since the default for the
|
|
<em>ZMQ_RECOVERY_IVL_MSEC</em> is -1, the default is to use the <em>ZMQ_RECOVERY_IVL</em>
|
|
option value.</p></div>
|
|
<div class="admonitionblock">
|
|
<table><tr>
|
|
<td class="icon">
|
|
<div class="title">Caution</div>
|
|
</td>
|
|
<td class="content">Exercise care when setting large recovery intervals as the data
|
|
needed for recovery will be held in memory. For example, a 1 minute recovery
|
|
interval at a data rate of 1Gbps requires a 7GB in-memory buffer.</td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="hdlist"><table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value type
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
int64_t
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value unit
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
milliseconds
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Default value
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
-1
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Applicable socket types
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
all, when using multicast transports
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_zmq_mcast_loop_control_multicast_loop_back">ZMQ_MCAST_LOOP: Control multicast loop-back</h3>
|
|
<div class="paragraph"><p>The <em>ZMQ_MCAST_LOOP</em> option shall control whether data sent via multicast
|
|
transports using the specified <em>socket</em> can also be received by the sending
|
|
host via loop-back. A value of zero disables the loop-back functionality, while
|
|
the default value of 1 enables the loop-back functionality. Leaving multicast
|
|
loop-back enabled when it is not required can have a negative impact on
|
|
performance. Where possible, disable <em>ZMQ_MCAST_LOOP</em> in production
|
|
environments.</p></div>
|
|
<div class="hdlist"><table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value type
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
int64_t
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value unit
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
boolean
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Default value
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
1
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Applicable socket types
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
all, when using multicast transports
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_zmq_sndbuf_set_kernel_transmit_buffer_size">ZMQ_SNDBUF: Set kernel transmit buffer size</h3>
|
|
<div class="paragraph"><p>The <em>ZMQ_SNDBUF</em> option shall set the underlying kernel transmit buffer size
|
|
for the <em>socket</em> to the specified size in bytes. A value of zero means leave
|
|
the OS default unchanged. For details please refer to your operating system
|
|
documentation for the <em>SO_SNDBUF</em> socket option.</p></div>
|
|
<div class="hdlist"><table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value type
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
uint64_t
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value unit
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
bytes
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Default value
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
0
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Applicable socket types
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
all
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_zmq_rcvbuf_set_kernel_receive_buffer_size">ZMQ_RCVBUF: Set kernel receive buffer size</h3>
|
|
<div class="paragraph"><p>The <em>ZMQ_RCVBUF</em> option shall set the underlying kernel receive buffer size for
|
|
the <em>socket</em> to the specified size in bytes. A value of zero means leave the
|
|
OS default unchanged. For details refer to your operating system documentation
|
|
for the <em>SO_RCVBUF</em> socket option.</p></div>
|
|
<div class="hdlist"><table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value type
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
uint64_t
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value unit
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
bytes
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Default value
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
0
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Applicable socket types
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
all
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_zmq_linger_set_linger_period_for_socket_shutdown">ZMQ_LINGER: Set linger period for socket shutdown</h3>
|
|
<div class="paragraph"><p>The <em>ZMQ_LINGER</em> option shall set the linger period for the specified <em>socket</em>.
|
|
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 closed with
|
|
<a href="zmq_close.html">zmq_close(3)</a>, and further affects the termination of the socket’s
|
|
context with <a href="zmq_term.html">zmq_term(3)</a>. The following outlines the different
|
|
behaviours:</p></div>
|
|
<div class="ulist"><ul>
|
|
<li>
|
|
<p>
|
|
The default value of <em>-1</em> specifies an infinite linger period. Pending
|
|
messages shall not be discarded after a call to <em>zmq_close()</em>; attempting to
|
|
terminate the socket’s context with <em>zmq_term()</em> shall block until all
|
|
pending messages have been sent to a peer.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
The value of <em>0</em> specifies no linger period. Pending messages shall be
|
|
discarded immediately when the socket is closed with <em>zmq_close()</em>.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Positive values specify an upper bound for the linger period in milliseconds.
|
|
Pending messages shall not be discarded after a call to <em>zmq_close()</em>;
|
|
attempting to terminate the socket’s context with <em>zmq_term()</em> 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.
|
|
</p>
|
|
<div class="hdlist"><table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value type
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
int
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value unit
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
milliseconds
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Default value
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
-1 (infinite)
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Applicable socket types
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
all
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table></div>
|
|
</li>
|
|
</ul></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_zmq_reconnect_ivl_set_reconnection_interval">ZMQ_RECONNECT_IVL: Set reconnection interval</h3>
|
|
<div class="paragraph"><p>The <em>ZMQ_RECONNECT_IVL</em> option shall set the initial reconnection interval for
|
|
the specified <em>socket</em>. The reconnection interval is the period ØMQ
|
|
shall wait between attempts to reconnect disconnected peers when using
|
|
connection-oriented transports.</p></div>
|
|
<div class="admonitionblock">
|
|
<table><tr>
|
|
<td class="icon">
|
|
<div class="title">Note</div>
|
|
</td>
|
|
<td class="content">The reconnection interval may be randomized by ØMQ to prevent
|
|
reconnection storms in topologies with a large number of peers per socket.</td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="hdlist"><table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value type
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
int
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value unit
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
milliseconds
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Default value
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
100
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Applicable socket types
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
all, only for connection-oriented transports
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_zmq_reconnect_ivl_max_set_maximum_reconnection_interval">ZMQ_RECONNECT_IVL_MAX: Set maximum reconnection interval</h3>
|
|
<div class="paragraph"><p>The <em>ZMQ_RECONNECT_IVL_MAX</em> option shall set the maximum reconnection interval
|
|
for the specified <em>socket</em>. This is the maximum period ØMQ shall wait between
|
|
attempts to reconnect. On each reconnect attempt, the previous interval shall be
|
|
doubled untill ZMQ_RECONNECT_IVL_MAX is reached. This allows for exponential
|
|
backoff strategy. Default value means no exponential backoff is performed and
|
|
reconnect interval calculations are only based on ZMQ_RECONNECT_IVL.</p></div>
|
|
<div class="admonitionblock">
|
|
<table><tr>
|
|
<td class="icon">
|
|
<div class="title">Note</div>
|
|
</td>
|
|
<td class="content">Values less than ZMQ_RECONNECT_IVL will be ignored.</td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="hdlist"><table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value type
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
int
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value unit
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
milliseconds
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Default value
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
0 (only use ZMQ_RECONNECT_IVL)
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Applicable socket types
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
all, only for connection-oriented transports
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_zmq_backlog_set_maximum_length_of_the_queue_of_outstanding_connections">ZMQ_BACKLOG: Set maximum length of the queue of outstanding connections</h3>
|
|
<div class="paragraph"><p>The <em>ZMQ_BACKLOG</em> option shall set the maximum length of the queue of
|
|
outstanding peer connections for the specified <em>socket</em>; this only applies to
|
|
connection-oriented transports. For details refer to your operating system
|
|
documentation for the <em>listen</em> function.</p></div>
|
|
<div class="hdlist"><table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value type
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
int
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Option value unit
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
connections
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Default value
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
100
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Applicable socket types
|
|
<br />
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p style="margin-top: 0;">
|
|
all, only for connection-oriented transports.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_return_value">RETURN VALUE</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>The <em>zmq_setsockopt()</em> function shall return zero if successful. Otherwise it
|
|
shall return <tt>-1</tt> and set <em>errno</em> to one of the values defined below.</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_errors">ERRORS</h2>
|
|
<div class="sectionbody">
|
|
<div class="dlist"><dl>
|
|
<dt class="hdlist1">
|
|
<strong>EINVAL</strong>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The requested option <em>option_name</em> is unknown, or the requested <em>option_len</em> or
|
|
<em>option_value</em> is invalid.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
<strong>ETERM</strong>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The ØMQ <em>context</em> associated with the specified <em>socket</em> was terminated.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
<strong>ENOTSOCK</strong>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The provided <em>socket</em> was invalid.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
<strong>EINTR</strong>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The operation was interrupted by delivery of a signal.
|
|
</p>
|
|
</dd>
|
|
</dl></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_example">EXAMPLE</h2>
|
|
<div class="sectionbody">
|
|
<div class="listingblock">
|
|
<div class="title">Subscribing to messages on a <em>ZMQ_SUB</em> socket</div>
|
|
<div class="content">
|
|
<pre><tt>/* Subscribe to all messages */
|
|
rc = zmq_setsockopt (socket, ZMQ_SUBSCRIBE, "", 0);
|
|
assert (rc == 0);
|
|
/* Subscribe to messages prefixed with "ANIMALS.CATS" */
|
|
rc = zmq_setsockopt (socket, ZMQ_SUBSCRIBE, "ANIMALS.CATS", 12);</tt></pre>
|
|
</div></div>
|
|
<div class="listingblock">
|
|
<div class="title">Setting I/O thread affinity</div>
|
|
<div class="content">
|
|
<pre><tt>int64_t affinity;
|
|
/* Incoming connections on TCP port 5555 shall be handled by I/O thread 1 */
|
|
affinity = 1;
|
|
rc = zmq_setsockopt (socket, ZMQ_AFFINITY, &affinity, sizeof affinity);
|
|
assert (rc);
|
|
rc = zmq_bind (socket, "tcp://lo:5555");
|
|
assert (rc);
|
|
/* Incoming connections on TCP port 5556 shall be handled by I/O thread 2 */
|
|
affinity = 2;
|
|
rc = zmq_setsockopt (socket, ZMQ_AFFINITY, &affinity, sizeof affinity);
|
|
assert (rc);
|
|
rc = zmq_bind (socket, "tcp://lo:5556");
|
|
assert (rc);</tt></pre>
|
|
</div></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_see_also">SEE ALSO</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p><a href="zmq_getsockopt.html">zmq_getsockopt(3)</a>
|
|
<a href="zmq_socket.html">zmq_socket(3)</a>
|
|
<a href="zmq.html">zmq(7)</a></p></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_authors">AUTHORS</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>This manual page was written by the ØMQ community.</p></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="footnotes"><hr /></div>
|
|
<div id="footer">
|
|
<div id="footer-text">
|
|
ØMQ 2.2.0<br />
|
|
Last updated 2012-04-04 13:05:48 CEST
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|