diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-03-30 23:07:20 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-03-30 23:07:20 -0700 |
| commit | f73cd76f54b8aead38689e0ea805d5d805dfbe96 (patch) | |
| tree | 0f6643e955770a9e96a8bbd900ca957a73fe1182 /docs/man/nng_stream_dialer_free.3str.adoc | |
| parent | 6f8944a96a5acd509014caae4e57dafbba51e126 (diff) | |
| download | nng-f73cd76f54b8aead38689e0ea805d5d805dfbe96.tar.gz nng-f73cd76f54b8aead38689e0ea805d5d805dfbe96.tar.bz2 nng-f73cd76f54b8aead38689e0ea805d5d805dfbe96.zip | |
Staging work. converted nng_ipc.
Diffstat (limited to 'docs/man/nng_stream_dialer_free.3str.adoc')
| -rw-r--r-- | docs/man/nng_stream_dialer_free.3str.adoc | 54 |
1 files changed, 0 insertions, 54 deletions
diff --git a/docs/man/nng_stream_dialer_free.3str.adoc b/docs/man/nng_stream_dialer_free.3str.adoc deleted file mode 100644 index 6669ca1e..00000000 --- a/docs/man/nng_stream_dialer_free.3str.adoc +++ /dev/null @@ -1,54 +0,0 @@ -= nng_stream_dialer_free(3str) -// -// Copyright 2019 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_stream_dialer_free - free byte stream dialer - -== SYNOPSIS - -[source, c] ----- -#include <nng/nng.h> - -void nng_stream_dialer_free(nng_stream_dialer *d); ----- - -== DESCRIPTION - -The `nng_stream_dialer_free()` function closes the supplied -byte stream dialer _d_, -and frees the underlying resources associated with it. - -If any -xref:nng_stream_dialer_dial.3str.adoc[dial] operations 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] -xref:nng_strerror.3.adoc[nng_strerror(3)], -xref:nng_stream_dialer_alloc.3str.adoc[nng_stream_dialer_alloc(3str)], -xref:nng_stream_dialer_close.3str.adoc[nng_stream_dialer_close(3str)], -xref:nng_stream_dialer_dial.3str.adoc[nng_stream_dialer_dial(3str)], -xref:nng_stream_dialer.5.adoc[nng_stream_dialer(5)] |