summaryrefslogtreecommitdiffstats
path: root/man3/nxt_unit_done.3
diff options
context:
space:
mode:
Diffstat (limited to 'man3/nxt_unit_done.3')
-rw-r--r--man3/nxt_unit_done.354
1 files changed, 54 insertions, 0 deletions
diff --git a/man3/nxt_unit_done.3 b/man3/nxt_unit_done.3
new file mode 100644
index 000000000..31fd1b620
--- /dev/null
+++ b/man3/nxt_unit_done.3
@@ -0,0 +1,54 @@
+.\" (C) 2023, NGINX, Inc.
+.\"
+.TH nxt_unit_done 3 (date) "NGINX Unit (unreleased)"
+.SH Name
+nxt_unit_done \- destroy context object in Unit app
+.SH Library
+NGINX Unit library
+.RI ( libunit ", " -lunit )
+.SH Synopsis
+.nf
+.B #include <nxt_unit.h>
+.PP
+.BI "void nxt_unit_done(nxt_unit_ctx_t *" ctx );
+.fi
+.SH Arguments
+.TP
+.I ctx
+Context object to be destroyed.
+It should have been created with
+.MR nxt_unit_init 3
+or
+.MR nxt_unit_ctx_alloc 3 .
+.SH Description
+.MR nxt_unit_done 3
+destroys a context object in a Unit application.
+.SH Return value
+None.
+.SH Errors
+None.
+.SH Examples
+See
+.MR nxt_unit_init 3
+and
+.MR nxt_unit_ctx_alloc 3 .
+.SH Copyright
+(C) 2017-2023, NGINX, Inc.
+.PP
+SPDX-License-Identifier: Apache-2.0
+.SH See also
+.MR nxt_unit_ctx_alloc 3 ,
+.MR nxt_unit_init 3 ,
+.MR unitd 8
+.PP
+Website
+.UR https://unit.nginx.org
+.UE
+.PP
+Mailing list
+.UR https://mailman.nginx.org/mailman/listinfo/unit
+.UE
+.PP
+GitHub
+.UR https://github.com/nginx/unit
+.UE