3a3a557efe
git-subtree-dir: external/nng git-subtree-split: c5e9d8acfc226418dedcf2e34a617bffae043ff6
54 lines
1.4 KiB
Text
54 lines
1.4 KiB
Text
= 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.
|
|
|
|
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 xref:nng_close.3.adoc[`nng_close()`]) 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
|
|
|
|
[.text-left]
|
|
xref:nng_ctx_open.3.adoc[nng_ctx_open(3)],
|
|
xref:nng_strerror.3.adoc[nng_strerror(3)],
|
|
xref:nng_ctx.5.adoc[nng_ctx(5)],
|
|
xref:nng.7.adoc[nng(7)]
|