summaryrefslogtreecommitdiff
path: root/docs/man/nng_ctx_close.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-04-04 23:53:06 -0700
committerGarrett D'Amore <garrett@damore.org>2024-04-05 00:00:25 -0700
commit5fc6ec2d44e3372445ef4bf3bfb3fadc9d01dc94 (patch)
tree51bd752bcb819d0e3441759665c823477b514338 /docs/man/nng_ctx_close.3.adoc
parentfded308be23375fc46af3255d45f4900d27d2ea0 (diff)
downloadnng-5fc6ec2d44e3372445ef4bf3bfb3fadc9d01dc94.tar.gz
nng-5fc6ec2d44e3372445ef4bf3bfb3fadc9d01dc94.tar.bz2
nng-5fc6ec2d44e3372445ef4bf3bfb3fadc9d01dc94.zip
Context functions converted.
Diffstat (limited to 'docs/man/nng_ctx_close.3.adoc')
-rw-r--r--docs/man/nng_ctx_close.3.adoc54
1 files changed, 0 insertions, 54 deletions
diff --git a/docs/man/nng_ctx_close.3.adoc b/docs/man/nng_ctx_close.3.adoc
deleted file mode 100644
index cfc51bfa..00000000
--- a/docs/man/nng_ctx_close.3.adoc
+++ /dev/null
@@ -1,54 +0,0 @@
-= 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)]