summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--man/tip/nng_aio_free.3.html2
-rw-r--r--man/tip/nng_aio_set_timeout.3.html12
-rw-r--r--man/tip/nng_aio_stop.3.html9
-rw-r--r--man/tip/nng_clock.3supp.html2
-rw-r--r--man/tip/nng_ctx_get.3.html4
-rw-r--r--man/tip/nng_ctx_getopt.3.html4
-rw-r--r--man/tip/nng_dialer_get.3.html4
-rw-r--r--man/tip/nng_dialer_getopt.3.html4
-rw-r--r--man/tip/nng_getopt.3.html4
-rw-r--r--man/tip/nng_options.5.html14
-rw-r--r--man/tip/nng_socket_get.3.html4
-rw-r--r--man/tip/nng_stream_dialer_get.3str.html4
-rw-r--r--man/tip/nng_stream_get.3str.html4
-rw-r--r--man/tip/nng_stream_listener_get.3str.html4
14 files changed, 42 insertions, 33 deletions
diff --git a/man/tip/nng_aio_free.3.html b/man/tip/nng_aio_free.3.html
index f7731383..5e96c3c7 100644
--- a/man/tip/nng_aio_free.3.html
+++ b/man/tip/nng_aio_free.3.html
@@ -37,7 +37,7 @@ that it is safe to deallocate the handle and any associated resources.
</div>
<div class="paragraph">
<p>The <code>nng_aio_reap()</code> function is the same as <code>nng_aio_free()</code>, but does
-it&#8217;s work in a background thread.
+its work in a background thread.
This can be useful to discard the <em>aio</em> object from within the callback for the <em>aio</em>.</p>
</div>
<div class="admonitionblock important">
diff --git a/man/tip/nng_aio_set_timeout.3.html b/man/tip/nng_aio_set_timeout.3.html
index 00cd8cbb..26f4a5ac 100644
--- a/man/tip/nng_aio_set_timeout.3.html
+++ b/man/tip/nng_aio_set_timeout.3.html
@@ -20,7 +20,10 @@ title: nng_aio_set_timeout(3)
<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf">&lt;nng/nng.h&gt;</span>
<span class="tok-k">typedef</span> <span class="tok-kt">int</span> <span class="tok-n">nng_duration</span><span class="tok-p">;</span>
-<span class="tok-kt">void</span> <span class="tok-nf">nng_aio_set_timeout</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-n">nng_duration</span> <span class="tok-n">timeout</span><span class="tok-p">);</span></code></pre>
+<span class="tok-kt">void</span> <span class="tok-nf">nng_aio_set_timeout</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-n">nng_duration</span> <span class="tok-n">timeout</span><span class="tok-p">);</span>
+
+<span class="tok-k">typedef</span> <span class="tok-kt">uint64_t</span> <span class="tok-n">nng_time</span><span class="tok-p">;</span>
+<span class="tok-kt">void</span> <span class="tok-nf">nng_aio_set_expire</span><span class="tok-p">(</span><span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-n">nng_time</span> <span class="tok-n">expiration</span><span class="tok-p">);</span></code></pre>
</div>
</div>
</div>
@@ -42,6 +45,13 @@ If the timeout is <code>NNG_DURATION_DEFAULT</code>, then a "default" or socket-
timeout is used.
(This is frequently the same as <code>NNG_DURATION_INFINITE</code>.)</p>
</div>
+<div class="paragraph">
+<p>The <code>nng_aio_set_expire()</code> function is similar to <code>nng_aio_set_timeout()</code>, but sets
+an absolute expiration time based on the system clock. The <em>expiration</em>
+is expressed as a number of milliseconds since some point in the past.
+The <a href="nng_clock.3supp.html"><code>nng_clock()</code></a> function can be used to determine
+the current value of the clock.</p>
+</div>
<div class="admonitionblock tip">
<table>
<tr>
diff --git a/man/tip/nng_aio_stop.3.html b/man/tip/nng_aio_stop.3.html
index 301b4f5f..9ceb86ac 100644
--- a/man/tip/nng_aio_stop.3.html
+++ b/man/tip/nng_aio_stop.3.html
@@ -30,13 +30,12 @@ title: nng_aio_stop(3)
<div class="paragraph">
<p>The <code>nng_aio_stop()</code> function stops the asynchronous I/O operation
associated with <em>aio</em> by aborting with <code>NNG_ECANCELED</code>, and then waits
-for it to complete or to be completely aborted, and for the any
+for it to complete or to be completely aborted, and for the
callback associated with the <em>aio</em> to have completed executing.</p>
</div>
<div class="paragraph">
<p>Further calls to
-<a href="nng_aio_schedule.3.html"><code>nng_aio_schedule()</code></a> using this <em>aio</em> will fail with
-<code>NNG_ECLOSED</code>.</p>
+<a href="nng_aio_begin.3.html"><code>nng_aio_begin()</code></a> using this <em>aio</em> will return false.</p>
</div>
<div class="paragraph">
<p>It is safe to call this for an <em>aio</em>, even when no operation is currently
@@ -51,7 +50,7 @@ pending for it.</p>
<td class="content">
When multiple asynchronous I/O handles are in use and need to be
shut down, it is safest to stop all of them, before deallocating any of
-this with <a href="nng_aio_free.3.html"><code>nng_aio_free()</code></a>, particularly if the callbacks
+them with <a href="nng_aio_free.3.html"><code>nng_aio_free()</code></a>, particularly if the callbacks
might attempt to reschedule additional operations.
</td>
</tr>
@@ -82,7 +81,7 @@ might attempt to reschedule additional operations.
<p><a href="nng_aio_alloc.3.html">nng_aio_alloc(3)</a>,
<a href="nng_aio_cancel.3.html">nng_aio_cancel(3)</a>,
<a href="nng_aio_free.3.html">nng_aio_free(3)</a>,
-<a href="nng_aio_schedule.3.html">nng_aio_schedule(3)</a>,
+<a href="nng_aio_begin.3.html">nng_aio_begin(3)</a>,
<a href="nng_aio_wait.3.html">nng_aio_wait(3)</a>,
<a href="nng_aio.5.html">nng_aio(5)</a>,
<a href="nng.7.html">nng(7)</a></p>
diff --git a/man/tip/nng_clock.3supp.html b/man/tip/nng_clock.3supp.html
index cac058e3..cbd40e99 100644
--- a/man/tip/nng_clock.3supp.html
+++ b/man/tip/nng_clock.3supp.html
@@ -36,7 +36,7 @@ arbitrary time in the past.
The resolution of the clock depends on the underlying timing facilities
of the system.
This function may be used for timing, but applications should not expect
-very fine grained values.</p>
+very fine-grained values.</p>
</div>
<div class="admonitionblock important">
<table>
diff --git a/man/tip/nng_ctx_get.3.html b/man/tip/nng_ctx_get.3.html
index 3ff491a9..bee0e848 100644
--- a/man/tip/nng_ctx_get.3.html
+++ b/man/tip/nng_ctx_get.3.html
@@ -119,8 +119,8 @@ The value will be stored at <em>ivalp</em>.</p>
<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>
+(The special value <code>NNG_DURATION_INFINITE</code> means an infinite amount of time, and
+the special value <code>NNG_DURATION_DEFAULT</code> means a context-specific default.)</p>
</dd>
<dt class="hdlist1"><code>nng_ctx_get_size()</code></dt>
<dd>
diff --git a/man/tip/nng_ctx_getopt.3.html b/man/tip/nng_ctx_getopt.3.html
index f721aa45..245d24cb 100644
--- a/man/tip/nng_ctx_getopt.3.html
+++ b/man/tip/nng_ctx_getopt.3.html
@@ -132,8 +132,8 @@ The value will be stored at <em>ivalp</em>.</p>
<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>
+(The special value <code>NNG_DURATION_INFINITE</code> means an infinite amount of time, and
+the special value <code>NNG_DURATION_DEFAULT</code> means a context-specific default.)</p>
</dd>
<dt class="hdlist1"><code>nng_ctx_getopt_size()</code></dt>
<dd>
diff --git a/man/tip/nng_dialer_get.3.html b/man/tip/nng_dialer_get.3.html
index e89c43a7..4f9809f5 100644
--- a/man/tip/nng_dialer_get.3.html
+++ b/man/tip/nng_dialer_get.3.html
@@ -113,8 +113,8 @@ The value will be stored at <em>ivalp</em>.</p>
<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>
+(The special value <code>NNG_DURATION_INFINITE</code> means an infinite amount of time, and
+the special value <code>NNG_DURATION_DEFAULT</code> means a context-specific default.)</p>
</dd>
<dt class="hdlist1"><code>nng_dialer_get_ptr()</code></dt>
<dd>
diff --git a/man/tip/nng_dialer_getopt.3.html b/man/tip/nng_dialer_getopt.3.html
index 18ec4fb9..0f3ed0b3 100644
--- a/man/tip/nng_dialer_getopt.3.html
+++ b/man/tip/nng_dialer_getopt.3.html
@@ -126,8 +126,8 @@ The value will be stored at <em>ivalp</em>.</p>
<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>
+(The special value <code>NNG_DURATION_INFINITE</code> means an infinite amount of time, and
+the special value <code>NNG_DURATION_DEFAULT</code> means a context-specific default.)</p>
</dd>
<dt class="hdlist1"><code>nng_dialer_getopt_ptr()</code></dt>
<dd>
diff --git a/man/tip/nng_getopt.3.html b/man/tip/nng_getopt.3.html
index 84cfbcde..ba41793e 100644
--- a/man/tip/nng_getopt.3.html
+++ b/man/tip/nng_getopt.3.html
@@ -123,8 +123,8 @@ The value will be stored at <em>ivalp</em>.</p>
<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>
+(The special value <code>NNG_DURATION_INFINITE</code> means an infinite amount of time, and
+the special value <code>NNG_DURATION_DEFAULT</code> means a context-specific default.)</p>
</dd>
<dt class="hdlist1"><code>nng_getopt_ptr()</code></dt>
<dd>
diff --git a/man/tip/nng_options.5.html b/man/tip/nng_options.5.html
index c6459c28..2faa9309 100644
--- a/man/tip/nng_options.5.html
+++ b/man/tip/nng_options.5.html
@@ -55,24 +55,24 @@ retrieved on objects.</p>
</div>
<div class="paragraph">
<p>Sockets (<a href="nng_socket.5.html"><code>nng_socket</code></a> objects) use the functions
-<a href="nng_getopt.3.html"><code>nng_getopt()</code></a>
-and <a href="nng_setopt.3.html"><code>nng_setopt()</code></a> to set and retrieve option values.</p>
+<a href="nng_socket_get.3.html"><code>nng_socket_get()</code></a>
+and <a href="nng_socket_set.3.html"><code>nng_socket_set()</code></a> to set and retrieve option values.</p>
</div>
<div class="paragraph">
<p>Dialers (<a href="nng_dialer.5.html"><code>nng_dialer</code></a> objects) use the functions
-<a href="nng_dialer_getopt.3.html"><code>nng_dialer_getopt()</code></a> and
-<a href="nng_dialer_setopt.3.html"><code>nng_dialer_setopt()</code></a> to set and retrieve option
+<a href="nng_dialer_get.3.html"><code>nng_dialer_get()</code></a> and
+<a href="nng_dialer_set.3.html"><code>nng_dialer_set()</code></a> to set and retrieve option
values.</p>
</div>
<div class="paragraph">
<p>Listeners (<a href="nng_listener.5.html"><code>nng_listener</code></a> objects) use the functions
-<a href="nng_listener_getopt.3.html"><code>nng_listener_getopt()</code></a>
-and <a href="nng_listener_setopt.3.html"><code>nng_listener_setopt()</code></a> to set and
+<a href="nng_listener_get.3.html"><code>nng_listener_get()</code></a>
+and <a href="nng_listener_set.3.html"><code>nng_listener_set()</code></a> to set and
retrieve option values.</p>
</div>
<div class="paragraph">
<p>Pipes (<a href="nng_pipe.5.html"><code>nng_pipe</code></a> objects) can only retrieve option values using
-the <a href="nng_pipe_getopt.3.html"><code>nng_pipe_getopt()</code></a> function.</p>
+the <a href="nng_pipe_get.3.html"><code>nng_pipe_get()</code></a> function.</p>
</div>
<div class="paragraph">
<p>Other object types may have additional methods to access these options.</p>
diff --git a/man/tip/nng_socket_get.3.html b/man/tip/nng_socket_get.3.html
index de493e9f..0439825f 100644
--- a/man/tip/nng_socket_get.3.html
+++ b/man/tip/nng_socket_get.3.html
@@ -126,8 +126,8 @@ The value will be stored at <em>ivalp</em>.</p>
<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>
+(The special value <code>NNG_DURATION_INFINITE</code> means an infinite amount of time, and
+the special value <code>NNG_DURATION_DEFAULT</code> means a context-specific default.)</p>
</dd>
<dt class="hdlist1"><code>nng_socket_get_ptr()</code></dt>
<dd>
diff --git a/man/tip/nng_stream_dialer_get.3str.html b/man/tip/nng_stream_dialer_get.3str.html
index a2fb1e8f..1293454e 100644
--- a/man/tip/nng_stream_dialer_get.3str.html
+++ b/man/tip/nng_stream_dialer_get.3str.html
@@ -111,8 +111,8 @@ It may be easier to use one of the typed forms of this function.
<p>This function is used to retrieve time
<a href="nng_duration.5.html">durations</a>
(such as timeouts), stored 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>
+(The special value <code>NNG_DURATION_INFINITE</code> means an infinite amount of time, and
+the special value <code>NNG_DURATION_DEFAULT</code> means a context-specific default.)</p>
</dd>
<dt class="hdlist1"><code>nng_stream_dialer_get_ptr()</code></dt>
<dd>
diff --git a/man/tip/nng_stream_get.3str.html b/man/tip/nng_stream_get.3str.html
index 7105fb48..5f27529a 100644
--- a/man/tip/nng_stream_get.3str.html
+++ b/man/tip/nng_stream_get.3str.html
@@ -111,8 +111,8 @@ It may be easier to use one of the typed forms of this function.
<p>This function is used to retrieve time
<a href="nng_duration.5.html">durations</a>
(such as timeouts), stored 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>
+(The special value <code>NNG_DURATION_INFINITE</code> means an infinite amount of time, and
+the special value <code>NNG_DURATION_DEFAULT</code> means a context-specific default.)</p>
</dd>
<dt class="hdlist1"><code>nng_stream_get_ptr()</code></dt>
<dd>
diff --git a/man/tip/nng_stream_listener_get.3str.html b/man/tip/nng_stream_listener_get.3str.html
index d7d42c41..f9e3d1df 100644
--- a/man/tip/nng_stream_listener_get.3str.html
+++ b/man/tip/nng_stream_listener_get.3str.html
@@ -112,8 +112,8 @@ It may be easier to use one of the typed forms of this function.
<p>This function is used to retrieve time
<a href="nng_duration.5.html">durations</a>
(such as timeouts), stored 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>
+(The special value <code>NNG_DURATION_INFINITE</code> means an infinite amount of time, and
+the special value <code>NNG_DURATION_DEFAULT</code> means a context-specific default.)</p>
</dd>
<dt class="hdlist1"><code>nng_stream_listener_get_ptr()</code></dt>
<dd>