gnutls_init(3) — Linux manual page
gnutls_init(3) gnutls gnutls_init(3)
NAME
gnutls_init - API function
SYNOPSIS
#include <gnutls/gnutls.h>
int gnutls_init(gnutls_session_t * session, unsigned int flags);
ARGUMENTS
gnutls_session_t * session
is a pointer to a gnutls_session_t type.
unsigned int flags
indicate if this session is to be used for server or
client.
DESCRIPTION
This function initializes the provided session. Every session
must be initialized before use, and after successful
initialization and use must be deinitialized by calling
gnutls_deinit().
flags can be any combination of flags from gnutls_init_flags_t.
Note that since version 3.1.2 this function enables some common
TLS extensions such as session tickets and OCSP certificate
status request in client side by default. To prevent that use the
GNUTLS_NO_DEFAULT_EXTENSIONS flag.
Note that it is never mandatory to use gnutls_deinit() after this
function fails. Since gnutls 3.8.0, it is safe to
unconditionally use gnutls_deinit() even after failure regardless
of whether the memory was initialized prior to gnutls_init();
however, clients wanting to be portable to older versions of the
library should either skip deinitialization on failure, or
pre-initialize the memory passed in to gnutls_init() to all
zeroes via memset() or similar.
RETURNS
GNUTLS_E_SUCCESS on success, or an error code.
REPORTING BUGS
Report bugs to <bugs@gnutls.org>.
Home page: https://www.gnutls.org
COPYRIGHT
Copyright © 2001-2023 Free Software Foundation, Inc., and others.
Copying and distribution of this file, with or without
modification, are permitted in any medium without royalty
provided the copyright notice and this notice are preserved.
SEE ALSO
The full documentation for gnutls is maintained as a Texinfo
manual. If the /usr/share/doc/gnutls/ directory does not contain
the HTML form visit
https://www.gnutls.org/manual/
COLOPHON
This page is part of the GnuTLS (GnuTLS Transport Layer Security
Library) project. Information about the project can be found at
⟨http://www.gnutls.org/⟩. If you have a bug report for this
manual page, send it to bugs@gnutls.org. This page was obtained
from the tarball gnutls-3.8.5.tar.xz fetched from
⟨http://www.gnutls.org/download.html⟩ on 2024-06-14. If you
discover any rendering problems in this HTML version of the page,
or you believe there is a better or more up-to-date source for
the page, or you have corrections or improvements to the
information in this COLOPHON (which is not part of the original
manual page), send a mail to man-pages@man7.org