diff options
| 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_aio_stop.3.html | |
| parent | b67502ab569fafc050cb9b0380d2886bc2068ece (diff) | |
| download | nng-8b8fdbdc2e3fef03e21177eb3710491e4c080d43.tar.gz nng-8b8fdbdc2e3fef03e21177eb3710491e4c080d43.tar.bz2 nng-8b8fdbdc2e3fef03e21177eb3710491e4c080d43.zip | |
Publishing updates for v1.2.4
Diffstat (limited to 'man/v1.2.4/nng_aio_stop.3.html')
| -rw-r--r-- | man/v1.2.4/nng_aio_stop.3.html | 129 |
1 files changed, 129 insertions, 0 deletions
diff --git a/man/v1.2.4/nng_aio_stop.3.html b/man/v1.2.4/nng_aio_stop.3.html new file mode 100644 index 00000000..1d5126a3 --- /dev/null +++ b/man/v1.2.4/nng_aio_stop.3.html @@ -0,0 +1,129 @@ +--- +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_aio_stop(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_aio_stop(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></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_aio_stop - stop asynchronous I/O operation</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-kt">void</span> <span class="tok-nf">nng_aio_stop</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></code></pre> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_description">DESCRIPTION</h2> +<div class="sectionbody"> +<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.</p> +</div> +<div class="paragraph"> +<p>If an operation is in progress when this function is called, that operation +is canceled and the callback function is <em>not</em> allowed to run.</p> +</div> +<div class="paragraph"> +<p>If the callback function is already running when this function is called, +then it is allowed to complete before returning to the caller.</p> +</div> +<div class="paragraph"> +<p>No new operations will be started on this <em>aio</em>.</p> +</div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +Calling this function means that the operation may be aborted without +completing its callback function. +</td> +</tr> +</table> +</div> +<div class="admonitionblock tip"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-tip" title="Tip"></i> +</td> +<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 +might attempt to reschedule additional operations. +</td> +</tr> +</table> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_return_values">RETURN VALUES</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>None.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_errors">ERRORS</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>None.</p> +</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_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_wait.3.html">nng_aio_wait(3)</a>, +<a href="nng_aio_alloc.3.html">nng_aio_alloc(3)</a>, +<a href="nng_aio.5.html">nng_aio(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 |