blob: 84308b9b6389bdd82d4a98eb0cabb453a83652e4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
= nng_dialer_close(3)
//
// 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_dialer_close - close dialer
== SYNOPSIS
[source, c]
----
#include <nng/nng.h>
int nng_dialer_close(nng_dialer d);
----
== DESCRIPTION
The `nng_dialer_close()` function closes the dialer _d_.
This also closes any xref:nng_pipe.5.adoc[`nng_pipe`] objects that have
been created by the dialer.
Once this function returns, the dialer _d_ and any of its resources
are deallocated.
Therefore it is an error to attempt to access _d_ after
this function has returned.
(Attempts to do so will result in `NNG_ECLOSED` errors.)
Dialers are implicitly closed when the socket they are associated with is closed.
== RETURN VALUES
This function returns 0 on success, and non-zero otherwise.
== ERRORS
[horizontal]
`NNG_ECLOSED`:: Parameter _d_ does not refer to an open dialer.
== SEE ALSO
[.text-left]
xref:nng_socket_close.3.adoc[nng_socket_close(3)],
xref:nng_dial.3.adoc[nng_dial(3)],
xref:nng_dialer_create.3.adoc[nng_dialer_create(3)]
xref:nng_strerror.3.adoc[nng_strerror(3)],
xref:nng_dialer.5.adoc[nng_dialer(5)],
xref:nng.7.adoc[nng(7)]
|
