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
|
= nng_ctx_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_ctx_close - close context
== SYNOPSIS
[source, 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 and the setting of the
<<nng_options.5#NNG_OPT_LINGER,`NNG_OPT_LINGER`>> option.
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.
NOTE: Closing the socket associated with _ctx_
(using <<nng_close.3#,`nng_close()`>>) also closes this context.
== RETURN VALUES
This function returns 0 on success, and non-zero otherwise.
== ERRORS
`NNG_ECLOSED`:: The context _ctx_ is already closed or was never opened.
== SEE ALSO
<<nng_ctx_open.3#,nng_ctx_open(3)>>,
<<nng_strerror.3#,nng_strerror(3)>>,
<<nng_ctx.5#,nng_ctx(5)>>,
<<nng.7#,nng(7)>>
|
