diff options
Diffstat (limited to 'docs/man/nng_ipc_free.3ipc.adoc')
| -rw-r--r-- | docs/man/nng_ipc_free.3ipc.adoc | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/man/nng_ipc_free.3ipc.adoc b/docs/man/nng_ipc_free.3ipc.adoc new file mode 100644 index 00000000..646122a0 --- /dev/null +++ b/docs/man/nng_ipc_free.3ipc.adoc @@ -0,0 +1,59 @@ += nng_ipc_free(3ipc) +// +// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// Copyright 2019 Devolutions <info@devolutions.net> +// +// 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_ipc_free - free IPC connection + +== SYNOPSIS + +[source, c] +---- +#include <nng/nng.h> +#include <nng/supplemental/ipc/ipc.h> + +void nng_ipc_free(nng_ipc *conn); +---- + +== DESCRIPTION + +The `nng_ipc_free()` function closes the supplied IPC connection, _conn_, +and frees the underlying resources associated with it. + +If any operations are pending (such as <<nng_ipc_send.3ipc#,`nng_ipc_send()`>> +or <<nng_ipc_recv.3ipc#,`nng_ipc_recv()`>>) they will be terminated with +an `NNG_ECLOSED` error condition. + +WARNING: It is important that the application ensure that no further accesses +are made to _conn_, as the memory backing it will be reclaimed for other uses. + +NOTE: Closing the connection while data is in transmission will likely +lead to loss of that data. +There is no automatic linger or flush to ensure that the socket send buffers +have completely transmitted. + +== RETURN VALUES + +None. + +== ERRORS + +None. + +== SEE ALSO + +[.text-left] +<<nng_strerror.3#,nng_strerror(3)>>, +<<nng_ipc_close.3ipc#,nng_ipc_close(3ipc)>>, +<<nng_ipc_recv.3ipc#,nng_ipc_recv(3ipc)>>, +<<nng_ipc_send.3ipc#,nng_ipc_send(3ipc)>>, +<<nng_ipc.5#,nng_ipc(5)>> |