diff options
| author | Garrett D'Amore <garrett@damore.org> | 2019-01-21 22:40:10 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2019-02-16 19:22:27 -0800 |
| commit | 5cf750697624d4fd63cfe26921209d7c30e1a2d2 (patch) | |
| tree | bf11695e5f1ec5e400c87da0cc6ff23935a2eeff /docs/man/nng_ipc_dialer_close.3ipc.adoc | |
| parent | ca655b9db689ee0e655248b1a9f166b8db6cc984 (diff) | |
| download | nng-5cf750697624d4fd63cfe26921209d7c30e1a2d2.tar.gz nng-5cf750697624d4fd63cfe26921209d7c30e1a2d2.tar.bz2 nng-5cf750697624d4fd63cfe26921209d7c30e1a2d2.zip | |
fixes #872 create unified nng_stream API
This is a major change, and includes changes to use a polymorphic
stream API for all transports. There have been related bugs fixed
along the way. Additionally the man pages have changed.
The old non-polymorphic APIs are removed now. This is a breaking
change, but the old APIs were never part of any released public API.
Diffstat (limited to 'docs/man/nng_ipc_dialer_close.3ipc.adoc')
| -rw-r--r-- | docs/man/nng_ipc_dialer_close.3ipc.adoc | 57 |
1 files changed, 0 insertions, 57 deletions
diff --git a/docs/man/nng_ipc_dialer_close.3ipc.adoc b/docs/man/nng_ipc_dialer_close.3ipc.adoc deleted file mode 100644 index 013274eb..00000000 --- a/docs/man/nng_ipc_dialer_close.3ipc.adoc +++ /dev/null @@ -1,57 +0,0 @@ -= nng_ipc_dialer_close(3ipc) -// -// 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_ipc_dialer_close - close IPC dialer - -== SYNOPSIS - -[source, c] ----- -#include <nng/nng.h> -#include <nng/supplemental/ipc/ipc.h> - -void nng_ipc_dialer_close(nng_ipc_dialer *d); ----- - -== DESCRIPTION - -The `nng_ipc_dialer_close()` function closes the supplied IPC dialer _d_, -but does not free the underlying resources associated with it. - -If any <<nng_ipc_dialer_dial.3ipc#,dial>> operations using _d_ are -in progress, they will be terminated with an `NNG_ECLOSED` error condition. - -Furthermore any future accesses to the dialer _d_ will also result in -`NNG_ECLOSED`. - -NOTE: This function does not release the memory for the dialer, so the -application should still free the memory using -<<nng_ipc_dialer_free.3ipc#,`nng_ipc_dialer_free(3ipc)`>> -once it is certain that nothing else is using it. - -== RETURN VALUES - -None. - -== ERRORS - -None. - -== SEE ALSO - -[.text-left] -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_ipc_dialer_alloc.3ipc#,nng_ipc_dialer_alloc(3ipc)>>, -<<nng_ipc_dialer_dial.3ipc#,nng_ipc_dialer_dial(3ipc)>>, -<<nng_ipc_dialer_free.3ipc#,nng_ipc_dialer_free(3ipc)>>, -<<nng_ipc_dialer.5#,nng_ipc_dialer(5)>> |