summaryrefslogtreecommitdiffstats
path: root/doc/functions/gnutls_global_init
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 07:33:12 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 07:33:12 +0000
commit36082a2fe36ecd800d784ae44c14f1f18c66a7e9 (patch)
tree6c68e0c0097987aff85a01dabddd34b862309a7c /doc/functions/gnutls_global_init
parentInitial commit. (diff)
downloadgnutls28-36082a2fe36ecd800d784ae44c14f1f18c66a7e9.tar.xz
gnutls28-36082a2fe36ecd800d784ae44c14f1f18c66a7e9.zip
Adding upstream version 3.7.9.upstream/3.7.9upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/functions/gnutls_global_init')
-rw-r--r--doc/functions/gnutls_global_init29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/functions/gnutls_global_init b/doc/functions/gnutls_global_init
new file mode 100644
index 0000000..200b6b8
--- /dev/null
+++ b/doc/functions/gnutls_global_init
@@ -0,0 +1,29 @@
+
+
+
+
+@deftypefun {int} {gnutls_global_init} ( @var{void})
+
+Since GnuTLS 3.3.0 this function is no longer necessary to be explicitly
+called. To disable the implicit call (in a library constructor) of this
+function set the environment variable @code{GNUTLS_NO_IMPLICIT_INIT} to 1.
+
+This function performs any required precalculations, detects
+the supported CPU capabilities and initializes the underlying
+cryptographic backend. In order to free any resources
+taken by this call you should @code{gnutls_global_deinit()}
+when gnutls usage is no longer needed.
+
+This function increments a global counter, so that
+@code{gnutls_global_deinit()} only releases resources when it has been
+called as many times as @code{gnutls_global_init()} . This is useful when
+GnuTLS is used by more than one library in an application. This
+function can be called many times, but will only do something the
+first time. It is thread safe since GnuTLS 3.3.0.
+
+A subsequent call of this function if the initial has failed will
+return the same error code.
+
+@strong{Returns:} On success, @code{GNUTLS_E_SUCCESS} (0) is returned,
+otherwise a negative error code is returned.
+@end deftypefun