man7.org > Linux > man-pages

Linux/UNIX system programming training

gnutls_server_name_get(3) — Linux manual page

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

gnutls_server_name_get(3)        gnutls        gnutls_server_name_get(3)

NAME         top

       gnutls_server_name_get - API function

SYNOPSIS         top

       #include <gnutls/gnutls.h>

       int gnutls_server_name_get(gnutls_session_t session, void * data,
       size_t * data_length, unsigned int * type, unsigned int indx);

ARGUMENTS         top

       gnutls_session_t session
                   is a gnutls_session_t type.

       void * data will hold the data

       size_t * data_length
                   will hold the data length. Must hold the maximum size
                   of data.

       unsigned int * type
                   will hold the server name indicator type

       unsigned int indx
                   is the index of the server_name

DESCRIPTION         top

       This function will allow you to get the name indication (if any),
       a client has sent.  The name indication may be any of the
       enumeration gnutls_server_name_type_t.

       If  type is GNUTLS_NAME_DNS, then this function is to be used by
       servers that support virtual hosting, and the data will be a null
       terminated IDNA ACE string (prior to GnuTLS 3.4.0 it was a UTF-8
       string).

       If  data has not enough size to hold the server name
       GNUTLS_E_SHORT_MEMORY_BUFFER is returned, and  data_length will
       hold the required size.

        indx is used to retrieve more than one server names (if sent by
       the client).  The first server name has an index of 0, the second
       1 and so on.  If no name with the given index exists
       GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE is returned.

RETURNS         top

       On success, GNUTLS_E_SUCCESS (0) is returned, on UTF-8 decoding
       error GNUTLS_E_IDNA_ERROR is returned, otherwise a negative error
       code is returned.

REPORTING BUGS         top

       Report bugs to <bugs@gnutls.org>.
       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 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

gnutls                            3.8.5        gnutls_server_name_get(3)

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface.

For details of in-depth Linux/UNIX system programming training courses that I teach, look here.

Hosting by jambit GmbH.

Cover of TLPI