gnutls_alert_send

Section: gnutls (3)
Updated: 2.8.5
Index Return to Main Contents
 

NAME

gnutls_alert_send - send an alert message to the peer  

SYNOPSIS

#include <gnutls/gnutls.h>

int gnutls_alert_send(gnutls_session_t session, gnutls_alert_level_t level, gnutls_alert_description_t desc);  

ARGUMENTS

gnutls_session_t session
is a gnutls_session_t structure.
gnutls_alert_level_t level
is the level of the alert
gnutls_alert_description_t desc
is the alert description
 

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 GNUTLS_E_INTERRUPTED or GNUTLS_E_AGAIN as well.  

RETURNS

On success, GNUTLS_E_SUCCESS (0) is returned, otherwise an error code is returned.  

REPORTING BUGS

Report bugs to <bug-gnutls@gnu.org>. GnuTLS home page: http://www.gnu.org/software/gnutls/ General help using GNU software: http://www.gnu.org/gethelp/  

COPYRIGHT

Copyright © 2008 Free Software Foundation.
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

The full documentation for gnutls is maintained as a Texinfo manual. If the info and gnutls programs are properly installed at your site, the command
info gnutls

should give you access to the complete manual.