summaryrefslogtreecommitdiffstats
path: root/doc/functions/gnutls_error_to_alert
diff options
context:
space:
mode:
Diffstat (limited to 'doc/functions/gnutls_error_to_alert')
-rw-r--r--doc/functions/gnutls_error_to_alert20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/functions/gnutls_error_to_alert b/doc/functions/gnutls_error_to_alert
new file mode 100644
index 0000000..3fa8f84
--- /dev/null
+++ b/doc/functions/gnutls_error_to_alert
@@ -0,0 +1,20 @@
+
+
+
+
+@deftypefun {int} {gnutls_error_to_alert} (int @var{err}, int * @var{level})
+@var{err}: is a negative integer
+
+@var{level}: the alert level will be stored there
+
+Get an alert depending on the error code returned by a gnutls
+function. All alerts sent by this function should be considered
+fatal. The only exception is when @code{err} is @code{GNUTLS_E_REHANDSHAKE} ,
+where a warning alert should be sent to the peer indicating that no
+renegotiation will be performed.
+
+If there is no mapping to a valid alert the alert to indicate
+internal error (@code{GNUTLS_A_INTERNAL_ERROR} ) is returned.
+
+@strong{Returns:} the alert code to use for a particular error code.
+@end deftypefun