= 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)]
