Blame doc/manpages/gnutls_error_is_fatal.3

Packit Service 4684c1
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
Packit Service 4684c1
.TH "gnutls_error_is_fatal" 3 "3.6.14" "gnutls" "gnutls"
Packit Service 4684c1
.SH NAME
Packit Service 4684c1
gnutls_error_is_fatal \- API function
Packit Service 4684c1
.SH SYNOPSIS
Packit Service 4684c1
.B #include <gnutls/gnutls.h>
Packit Service 4684c1
.sp
Packit Service 4684c1
.BI "int gnutls_error_is_fatal(int " error ");"
Packit Service 4684c1
.SH ARGUMENTS
Packit Service 4684c1
.IP "int error" 12
Packit Service 4684c1
is a GnuTLS error code, a negative error code
Packit Service 4684c1
.SH "DESCRIPTION"
Packit Service 4684c1
If a GnuTLS function returns a negative error code you may feed that
Packit Service 4684c1
value to this function to see if the error condition is fatal to
Packit Service 4684c1
a TLS session (i.e., must be terminated).
Packit Service 4684c1
Packit Service 4684c1
Note that you may also want to check the error code manually, since some
Packit Service 4684c1
non\-fatal errors to the protocol (such as a warning alert or
Packit Service 4684c1
a rehandshake request) may be fatal for your program.
Packit Service 4684c1
Packit Service 4684c1
This function is only useful if you are dealing with errors from
Packit Service 4684c1
functions that relate to a TLS session (e.g., record layer or handshake
Packit Service 4684c1
layer handling functions).
Packit Service 4684c1
.SH "RETURNS"
Packit Service 4684c1
Non\-zero value on fatal errors or zero on non\-fatal.
Packit Service 4684c1
.SH "REPORTING BUGS"
Packit Service 4684c1
Report bugs to <bugs@gnutls.org>.
Packit Service 4684c1
.br
Packit Service 4684c1
Home page: https://www.gnutls.org
Packit Service 4684c1
Packit Service 4684c1
.SH COPYRIGHT
Packit Service 4684c1
Copyright \(co 2001- Free Software Foundation, Inc., and others.
Packit Service 4684c1
.br
Packit Service 4684c1
Copying and distribution of this file, with or without modification,
Packit Service 4684c1
are permitted in any medium without royalty provided the copyright
Packit Service 4684c1
notice and this notice are preserved.
Packit Service 4684c1
.SH "SEE ALSO"
Packit Service 4684c1
The full documentation for
Packit Service 4684c1
.B gnutls
Packit Service 4684c1
is maintained as a Texinfo manual.
Packit Service 4684c1
If the /usr/share/doc/gnutls/
Packit Service 4684c1
directory does not contain the HTML form visit
Packit Service 4684c1
.B
Packit Service 4684c1
.IP https://www.gnutls.org/manual/
Packit Service 4684c1
.PP