blob: 9a582f836518cc04c70f9bb405f528f8fbad8002 (
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
|
= nng_close(3)
:doctype: manpage
:manmanual: nng
:mansource: nng
:manvolnum: 3
:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \
Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \
{blank} + \
This document is supplied under the terms of the \
https://opensource.org/licenses/MIT[MIT License].
== NAME
nng_close - close a socket
== SYNOPSIS
[source, c]
-----------
#include <nng/nng.h>
int nng_close(int s);
-----------
== DESCRIPTION
The `nng_close()` function closes the supplied socket, 's'. Messages
that have been submitted for sending may be flushed or delivered,
depending upon the transport and the setting of the `NNG_OPT_LINGER`
option.
Further attempts to use the socket after this call returns will result
in `NNG_EBADF`. Threads waiting for operations on the socket when this
call is executed may also return with an `NNG_EBADF` result.
== RETURN VALUES
This function returns 0 on success, and non-zero otherwise.
== ERRORS
`NNG_EBADF`:: The socket is already closed or was never opened.
== SEE ALSO
<<nng_setopt#,nng_setopt(3)>>,
<<nng_strerror#,nng_strerror(3)>>,
<<nng#,nng(7)>>
== COPYRIGHT
{copyright}
|