Blame doc/functions/gnutls_server_name_get

Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
@deftypefun {int} {gnutls_server_name_get} (gnutls_session_t @var{session}, void * @var{data}, size_t * @var{data_length}, unsigned int * @var{type}, unsigned int @var{indx})
Packit Service 4684c1
@var{session}: is a @code{gnutls_session_t}  type.
Packit Service 4684c1
Packit Service 4684c1
@var{data}: will hold the data
Packit Service 4684c1
Packit Service 4684c1
@var{data_length}: will hold the data length. Must hold the maximum size of data.
Packit Service 4684c1
Packit Service 4684c1
@var{type}: will hold the server name indicator type
Packit Service 4684c1
Packit Service 4684c1
@var{indx}: is the index of the server_name
Packit Service 4684c1
Packit Service 4684c1
This function will allow you to get the name indication (if any), a
Packit Service 4684c1
client has sent.  The name indication may be any of the enumeration
Packit Service 4684c1
gnutls_server_name_type_t.
Packit Service 4684c1
Packit Service 4684c1
If  @code{type} is GNUTLS_NAME_DNS, then this function is to be used by
Packit Service 4684c1
servers that support virtual hosting, and the data will be a null
Packit Service 4684c1
terminated IDNA ACE string (prior to GnuTLS 3.4.0 it was a UTF-8 string).
Packit Service 4684c1
Packit Service 4684c1
If  @code{data} has not enough size to hold the server name
Packit Service 4684c1
GNUTLS_E_SHORT_MEMORY_BUFFER is returned, and  @code{data_length} will
Packit Service 4684c1
hold the required size.
Packit Service 4684c1
Packit Service 4684c1
 @code{indx} is used to retrieve more than one server names (if sent by
Packit Service 4684c1
the client).  The first server name has an index of 0, the second 1
Packit Service 4684c1
and so on.  If no name with the given index exists
Packit Service 4684c1
GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE is returned.
Packit Service 4684c1
Packit Service 4684c1
@strong{Returns:} On success, @code{GNUTLS_E_SUCCESS}  (0) is returned, on UTF-8
Packit Service 4684c1
decoding error @code{GNUTLS_E_IDNA_ERROR}  is returned, otherwise a negative
Packit Service 4684c1
error code is returned.
Packit Service 4684c1
@end deftypefun