This documentation is for the TIP (development tree) of NNG and may represent unreleased changes or functionality that is experimental, and is subject to change before release. The latest released version is v1.8.0. See the documentation for v1.8.0 for the most up-to-date information.

nng_aio_free(3)

NAME

nng_aio_free - free asynchronous I/O handle

SYNOPSIS

#include <nng/nng.h>

void nng_aio_free(nng_aio *aio);
void nng_aio_reap(nng_aio *aio);

DESCRIPTION

The nng_aio_free() function frees an allocated asynchronous I/O handle. If any operation is in progress, the operation is canceled, and the caller is blocked until the operation is completely canceled, to ensure that it is safe to deallocate the handle and any associated resources. (This is done by implicitly calling nng_aio_stop().)

The nng_aio_reap() function is the same as nng_aio_free(), but does its work in a background thread. This can be useful to discard the aio object from within the callback for the aio.

Once either of these functions are called, the aio object is invalid and must not be used again.

RETURN VALUES

None.

ERRORS

None.

SEE ALSO