diff options
Diffstat (limited to 'doc/manpages/gnutls_alert_send.3')
-rw-r--r-- | doc/manpages/gnutls_alert_send.3 | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/manpages/gnutls_alert_send.3 b/doc/manpages/gnutls_alert_send.3 new file mode 100644 index 0000000..c0424d4 --- /dev/null +++ b/doc/manpages/gnutls_alert_send.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_alert_send" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_alert_send \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_alert_send(gnutls_session_t " session ", gnutls_alert_level_t " level ", gnutls_alert_description_t " desc ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_alert_level_t level" 12 +is the level of the alert +.IP "gnutls_alert_description_t desc" 12 +is the alert description +.SH "DESCRIPTION" +This function will send an alert to the peer in order to inform +him of something important (eg. his Certificate could not be verified). +If the alert level is Fatal then the peer is expected to close the +connection, otherwise he may ignore the alert and continue. + +The error code of the underlying record send function will be +returned, so you may also receive \fBGNUTLS_E_INTERRUPTED\fP or +\fBGNUTLS_E_AGAIN\fP as well. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +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. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP |