blob: 649316bd0cef46ab41dce358ad871ac2c018717c (
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
|
# nng_close
## NAME
nng_close --- close socket
## SYNOPSIS
```c
#include <nng/nng.h>
int nng_close(nng_socket s);
```
## DESCRIPTION
The `nng_close()` function closes the [socket][socket] _s_.
Messages that have been submitted for sending may be flushed or delivered,
depending upon the [transport][transport].
Further attempts to use the socket after this call returns will result
in `NNG_ECLOSED`.
Threads waiting for operations on the socket when this
call is executed may also return with an `NNG_ECLOSED` result.
> [!NOTE]
> Closing the socket while data is in transmission will likely lead to loss
> of that data.
> There is no automatic linger or flush to ensure that the socket send buffers
> have completely transmitted.
> It is recommended to wait a brief period after calling
> [`nng_send()`][nng_send] or similar functions, before calling this
> function.
## RETURN VALUES
This function returns 0 on success, and non-zero otherwise.
## ERRORS
- `NNG_ECLOSED`: The socket _s_ is already closed or was never opened.
{{#include ../refs.md}}
|
