| --- |
| layout: default |
| version: 0.3-beta-2 |
| --- |
| <!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.6" />
|
| <title>nn_getsockopt(3)</title>
|
| <style type="text/css">
|
| /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
|
|
|
| /* Default font. */
|
| body {
|
| font-family: Georgia,serif;
|
| }
|
|
|
| /* Title font. */
|
| h1, h2, h3, h4, h5, h6,
|
| div.title, caption.title,
|
| thead, p.table.header,
|
| #toctitle,
|
| #author, #revnumber, #revdate, #revremark,
|
| #footer {
|
| font-family: Arial,Helvetica,sans-serif;
|
| }
|
|
|
| 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;
|
| }
|
|
|
| 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;
|
| }
|
| h5 {
|
| font-size: 1.0em;
|
| }
|
|
|
| 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;
|
| }
|
|
|
| #author {
|
| color: #527bbd;
|
| font-weight: bold;
|
| font-size: 1.1em;
|
| }
|
| #email {
|
| }
|
| #revnumber, #revdate, #revremark {
|
| }
|
|
|
| #footer {
|
| font-size: small;
|
| border-top: 2px solid silver;
|
| padding-top: 0.5em;
|
| margin-top: 4.0em;
|
| }
|
| #footer-text {
|
| float: left;
|
| padding-bottom: 0.5em;
|
| }
|
| #footer-badges {
|
| float: right;
|
| padding-bottom: 0.5em;
|
| }
|
|
|
| #preamble {
|
| margin-top: 1.5em;
|
| margin-bottom: 1.5em;
|
| }
|
| 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: #888;
|
| }
|
|
|
| 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;
|
| }
|
|
|
| tfoot {
|
| font-weight: bold;
|
| }
|
| td > div.verse {
|
| white-space: pre;
|
| }
|
|
|
| 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 {
|
| #footer-badges { display: none; }
|
| }
|
|
|
| #toc {
|
| margin-bottom: 2.5em;
|
| }
|
|
|
| #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; }
|
|
|
| span.underline { text-decoration: underline; }
|
| span.overline { text-decoration: overline; }
|
| span.line-through { text-decoration: line-through; }
|
|
|
|
|
| /*
|
| * xhtml11 specific
|
| *
|
| * */
|
|
|
| tt {
|
| font-family: monospace;
|
| font-size: inherit;
|
| color: navy;
|
| }
|
|
|
| div.tableblock {
|
| margin-top: 1.0em;
|
| margin-bottom: 1.5em;
|
| }
|
| div.tableblock > table {
|
| border: 3px solid #527bbd;
|
| }
|
| thead, p.table.header {
|
| font-weight: bold;
|
| color: #527bbd;
|
| }
|
| 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;
|
| }
|
|
|
|
|
| /*
|
| * html5 specific
|
| *
|
| * */
|
|
|
| .monospaced {
|
| font-family: monospace;
|
| font-size: inherit;
|
| color: navy;
|
| }
|
|
|
| table.tableblock {
|
| margin-top: 1.0em;
|
| margin-bottom: 1.5em;
|
| }
|
| thead, p.tableblock.header {
|
| font-weight: bold;
|
| color: #527bbd;
|
| }
|
| p.tableblock {
|
| margin-top: 0;
|
| }
|
| table.tableblock {
|
| border-width: 3px;
|
| border-spacing: 0px;
|
| border-style: solid;
|
| border-color: #527bbd;
|
| border-collapse: collapse;
|
| }
|
| th.tableblock, td.tableblock {
|
| border-width: 1px;
|
| padding: 4px;
|
| border-style: solid;
|
| border-color: #527bbd;
|
| }
|
|
|
| table.tableblock.frame-topbot {
|
| border-left-style: hidden;
|
| border-right-style: hidden;
|
| }
|
| table.tableblock.frame-sides {
|
| border-top-style: hidden;
|
| border-bottom-style: hidden;
|
| }
|
| table.tableblock.frame-none {
|
| border-style: hidden;
|
| }
|
|
|
| th.tableblock.halign-left, td.tableblock.halign-left {
|
| text-align: left;
|
| }
|
| th.tableblock.halign-center, td.tableblock.halign-center {
|
| text-align: center;
|
| }
|
| th.tableblock.halign-right, td.tableblock.halign-right {
|
| text-align: right;
|
| }
|
|
|
| th.tableblock.valign-top, td.tableblock.valign-top {
|
| vertical-align: top;
|
| }
|
| th.tableblock.valign-middle, td.tableblock.valign-middle {
|
| vertical-align: middle;
|
| }
|
| th.tableblock.valign-bottom, td.tableblock.valign-bottom {
|
| vertical-align: bottom;
|
| }
|
|
|
|
|
| /*
|
| * manpage specific
|
| *
|
| * */
|
|
|
| body.manpage h1 {
|
| padding-top: 0.5em;
|
| padding-bottom: 0.5em;
|
| border-top: 2px solid silver;
|
| border-bottom: 2px solid silver;
|
| }
|
| body.manpage h2 {
|
| border-style: none;
|
| }
|
| body.manpage div.sectionbody {
|
| margin-left: 3em;
|
| }
|
|
|
| @media print {
|
| body.manpage div#toc { display: none; }
|
| }
|
| p {font-family:sans-serif;}
|
| h1,h2,h3,h4,h5,h6 {color:#808080;}
|
| a {color:#000000;}
|
| a:visited {color:#000000;}
|
| dt {color:#000000; font-style: italic;}
|
| tt {color: #000000;}
|
| em {color: #000000;}
|
| strong {color: #000000; font-weight: bold;}
|
|
|
|
|
|
|
| </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");
|
| if (!toc) {
|
| return;
|
| }
|
|
|
| // Delete existing TOC entries in case we're reloading the TOC.
|
| var tocEntriesToRemove = [];
|
| var i;
|
| for (i = 0; i < toc.childNodes.length; i++) {
|
| var entry = toc.childNodes[i];
|
| if (entry.nodeName == 'div'
|
| && entry.getAttribute("class")
|
| && entry.getAttribute("class").match(/^toclevel/))
|
| tocEntriesToRemove.push(entry);
|
| }
|
| for (i = 0; i < tocEntriesToRemove.length; i++) {
|
| toc.removeChild(tocEntriesToRemove[i]);
|
| }
|
|
|
| // Rebuild TOC entries.
|
| 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 () {
|
| // Delete existing footnote entries in case we're reloading the footnodes.
|
| var i;
|
| var noteholder = document.getElementById("footnotes");
|
| if (!noteholder) {
|
| return;
|
| }
|
| var entriesToRemove = [];
|
| for (i = 0; i < noteholder.childNodes.length; i++) {
|
| var entry = noteholder.childNodes[i];
|
| if (entry.nodeName == 'div' && entry.getAttribute("class") == "footnote")
|
| entriesToRemove.push(entry);
|
| }
|
| for (i = 0; i < entriesToRemove.length; i++) {
|
| noteholder.removeChild(entriesToRemove[i]);
|
| }
|
|
|
| // Rebuild footnote entries.
|
| var cont = document.getElementById("content");
|
| var spans = cont.getElementsByTagName("span");
|
| var refs = {};
|
| var n = 0;
|
| for (i=0; i<spans.length; i++) {
|
| if (spans[i].className == "footnote") {
|
| n++;
|
| var note = spans[i].getAttribute("data-note");
|
| if (!note) {
|
| // 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];
|
| spans[i].innerHTML =
|
| "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
|
| "' title='View footnote' class='footnote'>" + n + "</a>]";
|
| spans[i].setAttribute("data-note", note);
|
| }
|
| noteholder.innerHTML +=
|
| "<div class='footnote' id='_footnote_" + n + "'>" +
|
| "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
|
| n + "</a>. " + note + "</div>";
|
| 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>]";
|
| }
|
| }
|
| }
|
| },
|
|
|
| install: function(toclevels) {
|
| var timerId;
|
|
|
| function reinstall() {
|
| asciidoc.footnotes();
|
| if (toclevels) {
|
| asciidoc.toc(toclevels);
|
| }
|
| }
|
|
|
| function reinstallAndRemoveTimer() {
|
| clearInterval(timerId);
|
| reinstall();
|
| }
|
|
|
| timerId = setInterval(reinstall, 500);
|
| if (document.addEventListener)
|
| document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
|
| else
|
| window.onload = reinstallAndRemoveTimer;
|
| }
|
|
|
| }
|
| asciidoc.install();
|
| /*]]>*/
|
| </script>
|
| </head>
|
| <body class="manpage">
|
| <div id="header">
|
| <h1>
|
| nn_getsockopt(3) Manual Page
|
| </h1>
|
| <h2>NAME</h2>
|
| <div class="sectionbody">
|
| <p>nn_getsockopt -
|
| retrieve a socket option
|
| </p>
|
| </div>
|
| </div>
|
| <div id="content">
|
| <div class="sect1">
|
| <h2 id="_synopsis">SYNOPSIS</h2>
|
| <div class="sectionbody">
|
| <div class="paragraph"><p><strong>#include <nanomsg/nn.h></strong></p></div>
|
| <div class="paragraph"><p><strong>int nn_getsockopt (int <em>s</em>, int <em>level</em>, int <em>option</em>, void <em>*optval</em>, size_t <em>*optvallen</em>);</strong></p></div>
|
| </div>
|
| </div>
|
| <div class="sect1">
|
| <h2 id="_description">DESCRIPTION</h2>
|
| <div class="sectionbody">
|
| <div class="paragraph"><p>Retrieves the value for the <em>option</em>. The <em>level</em> argument specifies
|
| the protocol level at which the option resides. For generic socket-level options
|
| use <em>NN_SOL_SOCKET</em> level. For socket-type-specific options use socket type
|
| for <em>level</em> argument (e.g. <em>NN_SUB</em>). For transport-specific options use ID of
|
| the transport as the <em>level</em> argument (e.g. <em>NN_TCP</em>).</p></div>
|
| <div class="paragraph"><p>The value is stored in the buffer pointed to by <em>optval</em> argument. Size of the
|
| buffer is specified by the <em>optvallen</em> argument. If the size of the option is
|
| greater than size of the buffer, the value will be silently truncated.
|
| Otherwise, the <em>optvallen</em> will be modified to indicate the actual length of
|
| the option.</p></div>
|
| <div class="paragraph"><p><em><nanomsg/nn.h></em> header defines generic socket-level options
|
| (<em>NN_SOL_SOCKET</em> level). The options are as follows:</p></div>
|
| <div class="dlist"><dl>
|
| <dt class="hdlist1">
|
| <strong>NN_DOMAIN</strong>
|
| </dt>
|
| <dd>
|
| <p>
|
| Returns the domain constant as it was passed to <em>nn_socket()</em>.
|
| </p>
|
| </dd>
|
| <dt class="hdlist1">
|
| <strong>NN_PROTOCOL</strong>
|
| </dt>
|
| <dd>
|
| <p>
|
| Returns the protocol constant as it was passed to <em>nn_socket()</em>.
|
| </p>
|
| </dd>
|
| <dt class="hdlist1">
|
| <strong>NN_LINGER</strong>
|
| </dt>
|
| <dd>
|
| <p>
|
| Specifies how long should the socket try to send pending outbound messages
|
| after <em>nn_close()</em> have been called, in milliseconds. Negative value means
|
| infinite linger. The type of the option is int. Default value
|
| is 1000 (1 second).
|
| </p>
|
| </dd>
|
| <dt class="hdlist1">
|
| <strong>NN_SNDBUF</strong>
|
| </dt>
|
| <dd>
|
| <p>
|
| Size of the send buffer, in bytes. To prevent blocking for messages larger
|
| than the buffer, exactly one message may be buffered in addition to the data
|
| in the send buffer. The type of this option is int. Default value is 128kB.
|
| </p>
|
| </dd>
|
| <dt class="hdlist1">
|
| <strong>NN_RCVBUF</strong>
|
| </dt>
|
| <dd>
|
| <p>
|
| Size of the receive buffer, in bytes. To prevent blocking for messages
|
| larger than the buffer, exactly one message may be buffered in addition
|
| to the data in the receive buffer. The type of this option is int. Default
|
| value is 128kB.
|
| </p>
|
| </dd>
|
| <dt class="hdlist1">
|
| <strong>NN_SNDTIMEO</strong>
|
| </dt>
|
| <dd>
|
| <p>
|
| The timeout for send operation on the socket, in milliseconds. If message
|
| cannot be sent within the specified timeout, EAGAIN error is returned.
|
| Negative value means infinite timeout. The type of the option is int.
|
| Default value is -1.
|
| </p>
|
| </dd>
|
| <dt class="hdlist1">
|
| <strong>NN_RCVTIMEO</strong>
|
| </dt>
|
| <dd>
|
| <p>
|
| The timeout for recv operation on the socket, in milliseconds. If message
|
| cannot be received within the specified timeout, EAGAIN error is returned.
|
| Negative value means infinite timeout. The type of the option is int.
|
| Default value is -1.
|
| </p>
|
| </dd>
|
| <dt class="hdlist1">
|
| <strong>NN_RECONNECT_IVL</strong>
|
| </dt>
|
| <dd>
|
| <p>
|
| For connection-based transports such as TCP, this option specifies how
|
| long to wait, in milliseconds, when connection is broken before trying
|
| to re-establish it. Note that actual reconnect interval may be randomised
|
| to some extent to prevent severe reconnection storms. The type of the option
|
| is int. Default value is 100 (0.1 second).
|
| </p>
|
| </dd>
|
| <dt class="hdlist1">
|
| <strong>NN_RECONNECT_IVL_MAX</strong>
|
| </dt>
|
| <dd>
|
| <p>
|
| This option is to be used only in addition to <em>NN_RECONNECT_IVL</em> option.
|
| It specifies maximum reconnection interval. On each reconnect attempt,
|
| the previous interval is doubled until <em>NN_RECONNECT_IVL_MAX</em> is reached.
|
| Value of zero means that no exponential backoff is performed and reconnect
|
| interval is based only on <em>NN_RECONNECT_IVL</em>. If <em>NN_RECONNECT_IVL_MAX</em> is
|
| less than <em>NN_RECONNECT_IVL</em>, it is ignored. The type of the option is int.
|
| Default value is 0.
|
| </p>
|
| </dd>
|
| <dt class="hdlist1">
|
| <strong>NN_SNDPRIO</strong>
|
| </dt>
|
| <dd>
|
| <p>
|
| Retrieves outbound priority currently set on the socket. This
|
| option has no effect on socket types that send messages to all the peers.
|
| However, if the socket type sends each message to a single peer
|
| (or a limited set of peers), peers with high priority take precedence
|
| over peers with low priority. The type of the option is int. Highest
|
| priority is 1, lowest priority is 16. Default value is 8.
|
| </p>
|
| </dd>
|
| <dt class="hdlist1">
|
| <strong>NN_IPV4ONLY</strong>
|
| </dt>
|
| <dd>
|
| <p>
|
| If set to 1, only IPv4 addresses are used. If set to 0, both IPv4 and IPv6
|
| addresses are used. The type of the option is int. Default value is 1.
|
| </p>
|
| </dd>
|
| <dt class="hdlist1">
|
| <strong>NN_SNDFD</strong>
|
| </dt>
|
| <dd>
|
| <p>
|
| Retrieves a file descriptor that is readable when a message can be sent
|
| to the socket. The descriptor should be used only for polling and never
|
| read from or written to. The type of the option is same as the type of
|
| file descriptor on the platform. That is, int on POSIX-complaint platforms
|
| and SOCKET on Windows. The descriptor becomes invalid and should not be
|
| used any more once the socket is closed. This socket option is not available
|
| for unidirectional recv-only socket types.
|
| </p>
|
| </dd>
|
| <dt class="hdlist1">
|
| <strong>NN_RCVFD</strong>
|
| </dt>
|
| <dd>
|
| <p>
|
| Retrieves a file descriptor that is readable when a message can be received
|
| from the socket. The descriptor should be used only for polling and never
|
| read from or written to. The type of the option is same as the type of
|
| file descriptor on the platform. That is, int on POSIX-complaint platforms
|
| and SOCKET on Windows. The descriptor becomes invalid and should not be
|
| used any more once the socket is closed. This socket option is not available
|
| for unidirectional send-only socket types.
|
| </p>
|
| </dd>
|
| <dt class="hdlist1">
|
| <strong>NN_SOCKET_NAME</strong>
|
| </dt>
|
| <dd>
|
| <p>
|
| Socket name for error reporting and statistics. The type of the option
|
| is string. Default value is "socket.N" where N is socket integer.
|
| <strong>This option is experimental, see <a href="nn_env.7.html">nn_env(7)</a> for details</strong>
|
| </p>
|
| </dd>
|
| </dl></div>
|
| </div>
|
| </div>
|
| <div class="sect1">
|
| <h2 id="_return_value">RETURN VALUE</h2>
|
| <div class="sectionbody">
|
| <div class="paragraph"><p>If the function succeeds zero is returned. Otherwise, -1 is
|
| returned and <em>errno</em> is set to 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>EBADF</strong>
|
| </dt>
|
| <dd>
|
| <p>
|
| The provided socket is invalid.
|
| </p>
|
| </dd>
|
| <dt class="hdlist1">
|
| <strong>ENOPROTOOPT</strong>
|
| </dt>
|
| <dd>
|
| <p>
|
| The option is unknown at the level indicated.
|
| </p>
|
| </dd>
|
| <dt class="hdlist1">
|
| <strong>ETERM</strong>
|
| </dt>
|
| <dd>
|
| <p>
|
| The library is terminating.
|
| </p>
|
| </dd>
|
| </dl></div>
|
| </div>
|
| </div>
|
| <div class="sect1">
|
| <h2 id="_example">EXAMPLE</h2>
|
| <div class="sectionbody">
|
| <div class="listingblock">
|
| <div class="content">
|
| <pre><tt>int linger;
|
| size_t sz = sizeof (linger);
|
| nn_getsockopt (s, NN_SOL_SOCKET, NN_LINGER, &linger, &sz);</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="nn_socket.3.html">nn_socket(3)</a>
|
| <a href="nn_setsockopt.3.html">nn_setsockopt(3)</a>
|
| <a href="nanomsg.7.html">nanomsg(7)</a></p></div>
|
| </div>
|
| </div>
|
| <div class="sect1">
|
| <h2 id="_authors">AUTHORS</h2>
|
| <div class="sectionbody">
|
| <div class="paragraph"><p>Martin Sustrik <<a href="mailto:sustrik@250bpm.com">sustrik@250bpm.com</a>></p></div>
|
| </div>
|
| </div>
|
| </div>
|
| <div id="footnotes"><hr /></div>
|
| <div id="footer">
|
| <div id="footer-text">
|
| nanomsg 0.3-beta-2-g8ae44eb-dirty<br />
|
| Last updated 2014-03-04 23:29:50 CET
|
| </div>
|
| </div>
|
| </body>
|
| </html>
|
