]> git.ipfire.org Git - thirdparty/gnutls.git/commitdiff
updated documentation
authorNikos Mavrogiannopoulos <nmav@gnutls.org>
Fri, 25 May 2001 11:56:03 +0000 (11:56 +0000)
committerNikos Mavrogiannopoulos <nmav@gnutls.org>
Fri, 25 May 2001 11:56:03 +0000 (11:56 +0000)
doc/API

diff --git a/doc/API b/doc/API
index 5f6b107ecc86d854a5e3cbc729245b1a2b02f710..0968412dbc45b03c19d3072180961ce43dbd8c25 100644 (file)
--- a/doc/API
+++ b/doc/API
@@ -35,6 +35,10 @@ int gnutls_close(int cd, GNUTLS_STATE state);
 int gnutls_send_hello_request(int cd, GNUTLS_STATE state);
        This function will renegotiate security parameters with the
        client. This should only be called in case of a server.
+       If the client does not wish to renegotiate parameters he
+       will reply with an alert message, thus the return code will be
+       GNUTLS_E_WARNING_ALERT_RECEIVED and the alert will be
+       GNUTLS_NO_RENEGOTIATION.
 
 AlertDescription gnutls_get_last_alert( GNUTLS_STATE state);
        Returns the last alert number received. This function