summaryrefslogtreecommitdiff
path: root/docs/ref/ctx/nng_ctx_close.adoc
blob: 9e93db31c1c334027ff50dbe076265b8542f91f7 (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
## nng_ctx_close

Close context.

### Synopsis

```c
#include <nng/nng.h>

int nng_ctx_close(nng_ctx ctx);
```

### Description

The `nng_ctx_close` function closes the context _ctx_.
Messages that have been submitted for sending may be flushed or delivered, depending upon the transport.

Further attempts to use the context after this call returns will result in `NNG_ECLOSED`.
Threads waiting for operations on the context when this call is executed may also return with an `NNG_ECLOSED` result.

TIP: Closing the socket associated with _ctx_ also closes this context.

### Return Values

This function returns 0 on success, and non-zero otherwise.

### Errors

[horizontal]
`NNG_ECLOSED`:: The context _ctx_ is already closed or was never opened.

### See Also

xref:../sock/nng_close.adoc[nng_close],
xref:nng_ctx_open.adoc[nng_ctx_open]