= nng_aio_finish(3)
|
//
|
// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
|
// Copyright 2018 Capitar IT Group BV <info@capitar.com>
|
//
|
// This document is supplied under the terms of the MIT License, a
|
// copy of which should be located in the distribution where this
|
// file was obtained (LICENSE.txt). A copy of the license may also be
|
// found online at https://opensource.org/licenses/MIT.
|
//
|
|
== NAME
|
|
nng_aio_finish - finish asynchronous I/O operation
|
|
== SYNOPSIS
|
|
[source, c]
|
----
|
#include <nng/nng.h>
|
|
void nng_aio_finish(nng_aio *aio, int err);
|
----
|
|
== DESCRIPTION
|
|
The `nng_aio_finish()` function marks operation associated with _aio_ as
|
complete, with the status _err_.
|
This will be the result returned by
|
xref:nng_aio_result.3.adoc[`nng_aio_result()`].
|
|
This function causes the callback associated with the _aio_ to called.
|
|
IMPORTANT: It is mandatory that operation providers call this function
|
*exactly once* when they are finished with the operation.
|
After calling this function they *must not* perform any further accesses
|
to the _aio_.
|
|
NOTE: This function is only for I/O providers (those actually performing
|
the operation such as HTTP handler functions or transport providers); ordinary
|
users of the _aio_ should not have any need for this function.
|
|
== RETURN VALUES
|
|
None.
|
|
== ERRORS
|
|
None.
|
|
== SEE ALSO
|
|
[.text-left]
|
xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)],
|
xref:nng_aio_begin.3.adoc[nng_aio_begin(3)],
|
xref:nng_aio_cancel.3.adoc[nng_aio_cancel(3)],
|
xref:nng_aio_defer.3.adoc[nng_aio_defer(3)],
|
xref:nng_aio_result.3.adoc[nng_aio_result(3)],
|
xref:nng_aio.5.adoc[nng_aio(5)],
|
xref:nng.7.adoc[nng(7)]
|
