diff options
author | Nikos Mavrogiannopoulos <nmav@redhat.com> | 2016-06-24 11:01:35 +0200 |
---|---|---|
committer | Nikos Mavrogiannopoulos <nmav@redhat.com> | 2016-06-24 11:01:35 +0200 |
commit | b35eada879f618299270280a84e7633adecfd511 (patch) | |
tree | a78156752295cc93a2a68a2c57a171f9c40f29a1 /doc | |
parent | e91efbc50ba36be45919cdd6bc38a54367e65447 (diff) | |
download | gnutls-b35eada879f618299270280a84e7633adecfd511.tar.gz |
doc: mention the boolean functions in the gnutls API
Diffstat (limited to 'doc')
-rw-r--r-- | doc/cha-gtls-app.texi | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/doc/cha-gtls-app.texi b/doc/cha-gtls-app.texi index 5dd8ae08d5..edb3d32e72 100644 --- a/doc/cha-gtls-app.texi +++ b/doc/cha-gtls-app.texi @@ -82,12 +82,15 @@ resumed one, and will share the same session ID with the previous one. @node Error handling @subsection Error handling -In @acronym{GnuTLS} most functions return an integer type as a result. -In almost all cases a zero or a positive number means success, and a -negative number indicates failure, or a situation that some action has -to be taken. Thus negative error codes may be fatal or not. - -Fatal errors terminate the connection immediately and further sends +There two types of @acronym{GnuTLS} functions. One type returns +a boolean true (non-zero) or false (zero) value, which are set +to return an unsigned integer type. The other type returns a +signed integer type with zero indicating success and a negative +value indicating failure. + +For certain operations such as TLS handshake and TLS packet receive +there is the notion of fatal and non-fatal error codes. +Fatal errors terminate the TLS session immediately and further sends and receives will be disallowed. Such an example is @code{GNUTLS_@-E_@-DECRYPTION_@-FAILED}. Non-fatal errors may warn about something, i.e., a warning alert was received, or indicate the some |