Debian Codegraph @

doc/functions/gnutls_alert_send_appropriate

raw
1
2
3
4
5 @deftypefun {int} {gnutls_alert_send_appropriate} (gnutls_session_t @var{session}, int @var{err})
6 @var{session}: is a @code{gnutls_session_t} type.
7
8 @var{err}: is an error code returned by another GnuTLS function
9
10 Sends an alert to the peer depending on the error code returned by
11 a gnutls function. This function will call @code{gnutls_error_to_alert()}
12 to determine the appropriate alert to send.
13
14 This function may also return @code{GNUTLS_E_AGAIN} , or
15 @code{GNUTLS_E_INTERRUPTED} .
16
17 This function historically was always sending an alert to the
18 peer, even if @code{err} was inappropriate to respond with an alert
19 (e.g., @code{GNUTLS_E_SUCCESS} ). Since 3.6.6 this function returns
20 success without transmitting any data on error codes that
21 should not result to an alert.
22
23 @strong{Returns:} On success, @code{GNUTLS_E_SUCCESS} (0) is returned, otherwise
24 an error code is returned.
25 @end deftypefun