gnutls_server_name_set(3) — Linux manual page

NAME | SYNOPSIS | ARGUMENTS | DESCRIPTION | RETURNS | REPORTING BUGS | COPYRIGHT | SEE ALSO | COLOPHON

gnutls_server_name_set(3)        gnutls        gnutls_server_name_set(3)

NAME         top

       gnutls_server_name_set - API function

SYNOPSIS         top

       #include <gnutls/gnutls.h>

       int gnutls_server_name_set(gnutls_session_t session,
       gnutls_server_name_type_t type, const void * name, size_t
       name_length);

ARGUMENTS         top

       gnutls_session_t session
                   is a gnutls_session_t type.

       gnutls_server_name_type_t type
                   specifies the indicator type

       const void * name
                   is a string that contains the server name.

       size_t name_length
                   holds the length of name excluding the terminating
                   null byte

DESCRIPTION         top

       This function is to be used by clients that want to inform (via a
       TLS extension mechanism) the server of the name they connected
       to.  This should be used by clients that connect to servers that
       do virtual hosting.

       The value of  name depends on the  type type.  In case of
       GNUTLS_NAME_DNS, a UTF-8 null-terminated domain name string,
       without the trailing dot, is expected.

       IPv4 or IPv6 addresses are not permitted to be set by this
       function.  If the function is called with a name of  name_length
       zero it will clear all server names set.

RETURNS         top

       On success, GNUTLS_E_SUCCESS (0) is returned, otherwise a
       negative error code is returned.

REPORTING BUGS         top

       Report bugs to <[email protected]>.
       Home page: https://www.gnutls.org

COPYRIGHT         top

       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         top

       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         top

       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 [email protected].  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 [email protected]

gnutls                            3.8.5        gnutls_server_name_set(3)