diff options
| author | Garrett D'Amore <garrett@damore.org> | 2020-01-23 23:43:07 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2020-01-23 23:43:07 -0800 |
| commit | bce3ca536ff7e3cba601138bda1ba4ce77d55270 (patch) | |
| tree | 21faa9ef34431475bc66d9dce3c78ffa3a3ec1d9 /man/v1.1.1/nn_device.3compat.html | |
| parent | 0449a153c1b782aadffea8e3188089090a13f70c (diff) | |
| download | nng-bce3ca536ff7e3cba601138bda1ba4ce77d55270.tar.gz nng-bce3ca536ff7e3cba601138bda1ba4ce77d55270.tar.bz2 nng-bce3ca536ff7e3cba601138bda1ba4ce77d55270.zip | |
Publishing updates for v1.1.1
Diffstat (limited to 'man/v1.1.1/nn_device.3compat.html')
| -rw-r--r-- | man/v1.1.1/nn_device.3compat.html | 134 |
1 files changed, 134 insertions, 0 deletions
diff --git a/man/v1.1.1/nn_device.3compat.html b/man/v1.1.1/nn_device.3compat.html new file mode 100644 index 00000000..03f618c0 --- /dev/null +++ b/man/v1.1.1/nn_device.3compat.html @@ -0,0 +1,134 @@ +--- +version: v1.1.1 +layout: refman +--- +<!DOCTYPE html> +<html lang="en"> +<head> +<meta charset="UTF-8"> +<meta http-equiv="X-UA-Compatible" content="IE=edge"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> +<meta name="generator" content="Asciidoctor 2.0.10"> +<title>nn_device(3compat)</title> +<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"> +<link rel="stylesheet" href="./asciidoctor.css"> +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"> +</head> +<body class="manpage toc2 toc-left"> +<div id="header"> +<h1>nn_device(3compat) Manual Page</h1> +<div id="toc" class="toc2"> +<div id="toctitle">Table of Contents</div> +<ul class="sectlevel1"> +<li><a href="#_synopsis">SYNOPSIS</a></li> +<li><a href="#_description">DESCRIPTION</a></li> +<li><a href="#_return_values">RETURN VALUES</a></li> +<li><a href="#_errors">ERRORS</a></li> +<li><a href="#_see_also">SEE ALSO</a></li> +</ul> +</div> +<h2 id="_name">NAME</h2> +<div class="sectionbody"> +<p>nn_device - create forwarding device (compatible API)</p> +</div> +</div> +<div id="content"> +<div class="sect1"> +<h2 id="_synopsis">SYNOPSIS</h2> +<div class="sectionbody"> +<div class="listingblock"> +<div class="content"> +<pre class="pygments highlight"><code data-lang="c"><span></span><span class="tok-cp">#include</span> <span class="tok-cpf"><nanomsg/nn.h></span><span class="tok-cp"></span> + +<span class="tok-kt">int</span> <span class="tok-nf">nn_device</span><span class="tok-p">(</span><span class="tok-kt">int</span> <span class="tok-n">sock1</span><span class="tok-p">,</span> <span class="tok-kt">int</span> <span class="tok-n">sock2</span><span class="tok-p">);</span></code></pre> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_description">DESCRIPTION</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>The <code>nn_device()</code> function is used to create a forwarder, where messages +received on one of the two sockets <em>sock1</em> and <em>sock2</em> are forwarded to +the other.</p> +</div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +This function is provided for API +<a href="nng_compat.3compat.html">compatibility</a> with legacy <em>libnanomsg</em>. +Consider using the relevant <a href="libnng.3.html">modern API</a> instead. +</td> +</tr> +</table> +</div> +<div class="paragraph"> +<p>The two sockets must be compatible, and must be <a href="nng.7.html#raw_mode">raw mode</a> +sockets. +More detail about devices and how they can be used is available in the +new style <a href="nng_device.3.html">nng_device()</a> documentation.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_return_values">RETURN VALUES</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>This function blocks forever, and will return -1 only when +one of the sockets is closed or an error occurs.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_errors">ERRORS</h2> +<div class="sectionbody"> +<div class="hdlist"> +<table> +<tr> +<td class="hdlist1"> +<code>EBADF</code> +</td> +<td class="hdlist2"> +<p>One of the two sockets is invalid or not open, or has</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>EINVAL</code> +</td> +<td class="hdlist2"> +<p>The sockets are not compatible with each other, or not both raw.</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>ENOMEM</code> +</td> +<td class="hdlist2"> +<p>Insufficient memory is available.</p> +</td> +</tr> +</table> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_see_also">SEE ALSO</h2> +<div class="sectionbody"> +<div class="paragraph text-left"> +<p><a href="nn_errno.3compat.html">nn_errno(3compat)</a>, +<a href="nn_socket.3compat.html">nn_socket(3compat)</a>, +<a href="nng_compat.3compat.html">nng_compat(3compat)</a>, +<a href="nng.7.html">nng(7)</a></p> +</div> +</div> +</div> +</div> +<link rel="stylesheet" href="./pygments-default.css"> +</body> +</html>
\ No newline at end of file |