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/nng_socket.5.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/nng_socket.5.html')
| -rw-r--r-- | man/v1.1.1/nng_socket.5.html | 121 |
1 files changed, 121 insertions, 0 deletions
diff --git a/man/v1.1.1/nng_socket.5.html b/man/v1.1.1/nng_socket.5.html new file mode 100644 index 00000000..0da07dcd --- /dev/null +++ b/man/v1.1.1/nng_socket.5.html @@ -0,0 +1,121 @@ +--- +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>nng_socket(5)</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>nng_socket(5) 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> +<ul class="sectlevel2"> +<li><a href="#NNG_SOCKET_INITIALIZER">Initialization</a></li> +</ul> +</li> +<li><a href="#_see_also">SEE ALSO</a></li> +</ul> +</div> +<h2 id="_name">NAME</h2> +<div class="sectionbody"> +<p>nng_socket - socket handle</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"><nng/nng.h></span><span class="tok-cp"></span> + +<span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_socket_s</span> <span class="tok-n">nng_socket</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>An <code>nng_socket</code> is a handle to an underlying “socket” object. +All communication between the application and remote Scalability Protocol +peers is done through sockets. +A given socket can have multiple dialers (<code><a href="nng_dialer.5.html">nng_dialer</a></code>) +and/or listeners (<code><a href="nng_listener.5.html">nng_listener</a></code>), and multiple +pipes (<code><a href="nng_pipe.5.html">nng_pipe</a></code>), and +may be connected to multiple transports at the same time. +However, a given socket will have exactly one “protocol” associated with it, +and is responsible for any state machines or other protocol-specific logic.</p> +</div> +<div class="admonitionblock important"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-important" title="Important"></i> +</td> +<td class="content"> +The <code>nng_socket</code> structure is always passed by value (both +for input parameters and return values), and should be treated opaquely. +Passing structures this way ensures gives the compiler a chance to perform +accurate type checks in functions passing values of this type. +</td> +</tr> +</table> +</div> +<div class="paragraph"> +<p>Each <code>nng_socket</code> is created by a protocol-specific constructor, such as +<code><a href="nng_rep_open.3.html">nng_rep_open()</a></code>. +When the socket is no longer needed, it can be closed with +<code><a href="nng_close.3.html">nng_close()</a></code>.</p> +</div> +<div class="sect2"> +<h3 id="NNG_SOCKET_INITIALIZER">Initialization</h3> +<div class="paragraph"> +<p>A socket may be initialized using the macro <code>NNG_SOCKET_INITIALIZER</code> +before it is opened, to prevent confusion with valid open sockets.</p> +</div> +<div class="paragraph"> +<p>For example:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="pygments highlight"><code data-lang="c"><span></span><span class="tok-n">nng_socket</span> <span class="tok-n">s</span> <span class="tok-o">=</span> <span class="tok-n">NNG_SOCKET_INITIALIZER</span><span class="tok-p">;</span></code></pre> +</div> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_see_also">SEE ALSO</h2> +<div class="sectionbody"> +<div class="paragraph text-left"> +<p><a href="libnng.3.html">libnng(3)</a>, +<a href="nng_close.3.html">nng_close(3)</a>, +<a href="nng_getopt.3.html">nng_getopt(3)</a>, +<a href="nng_setopt.3.html">nng_setopt(3)</a>, +<a href="nng_socket_id.3.html">nng_socket_id(3)</a>, +<a href="nng_dialer.5.html">nng_dialer(5)</a>, +<a href="nng_listener.5.html">nng_listener(5)</a>, +<a href="nng_options.5.html">nng_options(5)</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 |