diff options
Diffstat (limited to 'docs/man/nng_tcp_dialer_free.3tcp.adoc')
| -rw-r--r-- | docs/man/nng_tcp_dialer_free.3tcp.adoc | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/man/nng_tcp_dialer_free.3tcp.adoc b/docs/man/nng_tcp_dialer_free.3tcp.adoc new file mode 100644 index 00000000..3116ad8e --- /dev/null +++ b/docs/man/nng_tcp_dialer_free.3tcp.adoc @@ -0,0 +1,53 @@ += nng_tcp_dialer_free(3tcp) +// +// 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_tcp_dialer_free - free TCP dialer + +== SYNOPSIS + +[source, c] +---- +#include <nng/nng.h> +#include <nng/supplemental/tcp/tcp.h> + +void nng_tcp_dialer_free(nng_tcp_dialer *d); +---- + +== DESCRIPTION + +The `nng_tcp_dialer_free()` function closes the supplied TCP dialer _d_, +and frees the underlying resources associated with it. + +If any dial operations +(see `<<nng_tcp_dialer_dial.3tcp#,nng_tcp_dialer_dial()>>`) using _d_ are +in progress, 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 _d_, as the memory backing it will be reclaimed for other uses. + +== RETURN VALUES + +None. + +== ERRORS + +None. + +== SEE ALSO + +[.text-left] +<<nng_strerror.3#,nng_strerror(3)>>, +<<nng_tcp_dialer_alloc.3tcp#,nng_tcp_dialer_alloc(3tcp)>>, +<<nng_tcp_dialer_close.3tcp#,nng_tcp_dialer_close(3tcp)>>, +<<nng_tcp_dialer_dial.3tcp#,nng_tcp_dialer_dial(3tcp)>>, +<<nng_tcp_dialer.5#,nng_tcp_dialer(5)>> |