Publishing updates for v1.2.4

author: Garrett D'Amore <garrett@damore.org> 2020-01-23 23:24:04 -0800
committer: Garrett D'Amore <garrett@damore.org> 2020-01-23 23:24:04 -0800
commit: 8b8fdbdc2e3fef03e21177eb3710491e4c080d43 (patch)
tree: 0336322fa94119e9e37f9d88545ba6e58307cf2a /man/v1.2.4/nng_dialer_get.3.html
parent: b67502ab569fafc050cb9b0380d2886bc2068ece (diff)
download: nng-8b8fdbdc2e3fef03e21177eb3710491e4c080d43.tar.gz
nng-8b8fdbdc2e3fef03e21177eb3710491e4c080d43.tar.bz2
nng-8b8fdbdc2e3fef03e21177eb3710491e4c080d43.zip
1 files changed, 267 insertions, 0 deletions
diff --git a/man/v1.2.4/nng_dialer_get.3.html b/man/v1.2.4/nng_dialer_get.3.html
new file mode 100644
index 00000000..0e8020ed
--- /dev/null
+++ b/man/v1.2.4/nng_dialer_get.3.html
@@ -0,0 +1,267 @@
+---
+version: v1.2.4
+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_dialer_get(3)</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_dialer_get(3) 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="#_forms">Forms</a></li>
+</ul>
+</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>nng_dialer_get - get dialer option</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">&lt;nng/nng.h&gt;</span><span class="tok-cp"></span>
+
+<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_get</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">opt</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">*</span><span class="tok-n">val</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-o">*</span><span class="tok-n">valszp</span><span class="tok-p">);</span>
+
+<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_get_bool</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">opt</span><span class="tok-p">,</span> <span class="tok-kt">bool</span> <span class="tok-o">*</span><span class="tok-n">bvalp</span><span class="tok-p">);</span>
+
+<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_get_int</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">opt</span><span class="tok-p">,</span> <span class="tok-kt">int</span> <span class="tok-o">*</span><span class="tok-n">ivalp</span><span class="tok-p">);</span>
+
+<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_get_ms</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">opt</span><span class="tok-p">,</span> <span class="tok-n">nng_duration</span> <span class="tok-o">*</span><span class="tok-n">durp</span><span class="tok-p">);</span>
+
+<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_get_ptr</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">opt</span><span class="tok-p">,</span> <span class="tok-kt">void</span> <span class="tok-o">**</span><span class="tok-n">ptr</span><span class="tok-p">);</span>
+
+<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_get_size</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">opt</span><span class="tok-p">,</span> <span class="tok-kt">size_t</span> <span class="tok-o">*</span><span class="tok-n">zp</span><span class="tok-p">);</span>
+
+<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_get_addr</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">opt</span><span class="tok-p">,</span> <span class="tok-n">nng_sockaddr</span> <span class="tok-o">*</span><span class="tok-n">sap</span><span class="tok-p">);</span>
+
+<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_get_string</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">opt</span><span class="tok-p">,</span> <span class="tok-kt">char</span> <span class="tok-o">**</span><span class="tok-n">strp</span><span class="tok-p">);</span>
+
+<span class="tok-kt">int</span> <span class="tok-nf">nng_dialer_get_uint64</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span> <span class="tok-n">d</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">opt</span><span class="tok-p">,</span> <span class="tok-kt">uint64_t</span> <span class="tok-o">*</span><span class="tok-n">u64p</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>nng_dialer_get()</code> functions are used to retrieve option values for
+the <a href="nng_dialer.5.html">dialer</a> <em>d</em>.
+The actual options that may be retrieved in this way
+vary, and many are documented in <a href="nng_options.5.html">nng_options(5)</a>.</p>
+</div>
+<div class="paragraph">
+<p>Additionally some transport-specific options and protocol-specific options
+are documented with the transports and protocols themselves.</p>
+</div>
+<div class="sect2">
+<h3 id="_forms">Forms</h3>
+<div class="paragraph">
+<p>In all of these forms, the option <em>opt</em> is retrieved from the dialer <em>d</em>.
+The forms vary based on the type of the option they take.</p>
+</div>
+<div class="paragraph">
+<p>The details of the type, size, and semantics of the option will depend
+on the actual option, and will be documented with the option itself.</p>
+</div>
+<div class="dlist">
+<dl>
+<dt class="hdlist1"><code>nng_dialer_get()</code></dt>
+<dd>
+<p>This function is untyped and can be used to retrieve the value of any option.
+The caller must store a pointer to a buffer to receive the value in <em>val</em>,
+and the size of the buffer shall be stored at the location referenced
+by <em>valszp</em>.<br>
+<br>
+When the function returns, the actual size of the data copied (or that
+would have been copied if sufficient space were present) is stored at
+the location referenced by <em>valszp</em>.
+If the caller&#8217;s buffer is not large
+enough to hold the entire object, then the copy is truncated.
+Therefore the caller should validate that the returned size in <em>valszp</em> does not
+exceed the original buffer size to check for truncation.<br>
+<br>
+It is acceptable to pass <code>NULL</code> for <em>val</em> if the value in <em>valszp</em> is zero.
+This can be used to determine the size of the buffer needed to receive
+the object.</p>
+</dd>
+</dl>
+</div>
+<div class="admonitionblock tip">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-tip" title="Tip"></i>
+</td>
+<td class="content">
+It may be easier to use one of the typed forms of this function.
+</td>
+</tr>
+</table>
+</div>
+<div class="dlist">
+<dl>
+<dt class="hdlist1"><code>nng_dialer_get_bool()</code></dt>
+<dd>
+<p>This function is for options which take a Boolean (<code>bool</code>).
+The value will be stored at <em>bvalp</em>.</p>
+</dd>
+<dt class="hdlist1"><code>nng_dialer_get_int()</code></dt>
+<dd>
+<p>This function is for options which take an integer (<code>int</code>).
+The value will be stored at <em>ivalp</em>.</p>
+</dd>
+<dt class="hdlist1"><code>nng_dialer_get_ms()</code></dt>
+<dd>
+<p>This function is used to retrieve time <a href="nng_duration.5.html">durations</a>
+(such as timeouts), stored in <em>durp</em> as a number of milliseconds.
+(The special value <code>NNG_DUR_INFINITE</code> means an infinite amount of time, and
+the special value <code>NNG_DUR_DEFAULT</code> means a context-specific default.)</p>
+</dd>
+<dt class="hdlist1"><code>nng_dialer_get_ptr()</code></dt>
+<dd>
+<p>This function is used to retrieve a pointer, <em>ptr</em>, to structured data.
+The data referenced by <em>ptr</em> is generally managed using other functions.
+Note that this form is somewhat special in that the object is generally
+not copied, but instead the <strong>pointer</strong> to the object is copied.</p>
+</dd>
+<dt class="hdlist1"><code>nng_dialer_get_size()</code></dt>
+<dd>
+<p>This function is used to retrieve a size into the pointer <em>zp</em>,
+typically for buffer sizes, message maximum sizes, and similar options.</p>
+</dd>
+<dt class="hdlist1"><code>nng_dialer_get_addr()</code></dt>
+<dd>
+<p>This function is used to retrieve an <a href="nng_sockaddr.5.html"><code>nng_sockaddr</code></a>
+into the value referenced by <em>sap</em>.</p>
+</dd>
+<dt class="hdlist1"><code>nng_dialer_get_string()</code></dt>
+<dd>
+<p>This function is used to retrieve a string into <em>strp</em>.
+This string is created from the source using <a href="nng_strdup.3.html"><code>nng_strdup()</code></a>
+and consequently must be freed by the caller using
+<a href="nng_strfree.3.html"><code>nng_strfree()</code></a> when it is no longer needed.</p>
+</dd>
+<dt class="hdlist1"><code>nng_dialer_get_uint64()</code></dt>
+<dd>
+<p>This function is used to retrieve a 64-bit unsigned value into the value
+referenced by <em>u64p</em>.
+This is typically used for options related to identifiers, network
+numbers, and similar.</p>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_return_values">RETURN VALUES</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>These functions returns 0 on success, and non-zero otherwise.</p>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_errors">ERRORS</h2>
+<div class="sectionbody">
+<div class="hdlist">
+<table>
+<tr>
+<td class="hdlist1">
+<code>NNG_EBADTYPE</code>
+</td>
+<td class="hdlist2">
+<p>Incorrect type for option.</p>
+</td>
+</tr>
+<tr>
+<td class="hdlist1">
+<code>NNG_ECLOSED</code>
+</td>
+<td class="hdlist2">
+<p>Parameter <em>d</em> does not refer to an open dialer.</p>
+</td>
+</tr>
+<tr>
+<td class="hdlist1">
+<code>NNG_EINVAL</code>
+</td>
+<td class="hdlist2">
+<p>Size of destination <em>val</em> too small for object.</p>
+</td>
+</tr>
+<tr>
+<td class="hdlist1">
+<code>NNG_ENOMEM</code>
+</td>
+<td class="hdlist2">
+<p>Insufficient memory exists.</p>
+</td>
+</tr>
+<tr>
+<td class="hdlist1">
+<code>NNG_ENOTSUP</code>
+</td>
+<td class="hdlist2">
+<p>The option <em>opt</em> is not supported.</p>
+</td>
+</tr>
+<tr>
+<td class="hdlist1">
+<code>NNG_EWRITEONLY</code>
+</td>
+<td class="hdlist2">
+<p>The option <em>opt</em> is write-only.</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="nng_dialer_create.3.html">nng_dialer_create(3)</a>
+<a href="nng_dialer_set.3.html">nng_dialer_set(3)</a>
+<a href="nng_strdup.3.html">nng_strdup(3)</a>,
+<a href="nng_strerror.3.html">nng_strerror(3)</a>,
+<a href="nng_strfree.3.html">nng_strfree(3)</a>,
+<a href="nng_dialer.5.html">nng_dialer(5)</a>,
+<a href="nng_duration.5.html">nng_duration(5)</a>,
+<a href="nng_options.5.html">nng_options(5)</a>,
+<a href="nng_sockaddr.5.html">nng_sockaddr(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
author	Garrett D'Amore <garrett@damore.org>	2020-01-23 23:24:04 -0800
committer	Garrett D'Amore <garrett@damore.org>	2020-01-23 23:24:04 -0800
commit	8b8fdbdc2e3fef03e21177eb3710491e4c080d43 (patch)
tree	0336322fa94119e9e37f9d88545ba6e58307cf2a /man/v1.2.4/nng_dialer_get.3.html
parent	b67502ab569fafc050cb9b0380d2886bc2068ece (diff)
download	nng-8b8fdbdc2e3fef03e21177eb3710491e4c080d43.tar.gz nng-8b8fdbdc2e3fef03e21177eb3710491e4c080d43.tar.bz2 nng-8b8fdbdc2e3fef03e21177eb3710491e4c080d43.zip