gnutls_handshake man page on DragonFly
[printable version]
gnutls_handshake(3) gnutls gnutls_handshake(3)
NAME
gnutls_handshake - API function
SYNOPSIS
#include <gnutls/gnutls.h>
int gnutls_handshake(gnutls_session_t session);
ARGUMENTS
gnutls_session_t session
is a gnutls_session_t structure.
DESCRIPTION
This function does the handshake of the TLS/SSL protocol, and initial‐
izes the TLS connection.
This function will fail if any problem is encountered, and will return
a negative error code. In case of a client, if the client has asked to
resume a session, but the server couldn't, then a full handshake will
be performed.
The non-fatal errors expected by this function are: GNUTLS_E_INTER‐
RUPTED, GNUTLS_E_AGAIN, GNUTLS_E_WARNING_ALERT_RECEIVED, and
GNUTLS_E_GOT_APPLICATION_DATA, the latter only in a case of rehand‐
shake.
The former two interrupt the handshake procedure due to the lower layer
being interrupted, and the latter because of an alert that may be sent
by a server (it is always a good idea to check any received alerts). On
these errors call this function again, until it returns 0; cf.
gnutls_record_get_direction() and gnutls_error_is_fatal(). In DTLS ses‐
sions the non-fatal error GNUTLS_E_LARGE_PACKET is also possible, and
indicates that the MTU should be adjusted.
If this function is called by a server after a rehandshake request then
GNUTLS_E_GOT_APPLICATION_DATA or GNUTLS_E_WARNING_ALERT_RECEIVED may be
returned. Note that these are non fatal errors, only in the specific
case of a rehandshake. Their meaning is that the client rejected the
rehandshake request or in the case of GNUTLS_E_GOT_APPLICATION_DATA it
could also mean that some data were pending.
RETURNS
GNUTLS_E_SUCCESS on success, otherwise a negative error code.
REPORTING BUGS
Report bugs to <bugs@gnutls.org>.
Home page: http://www.gnutls.org
COPYRIGHT
Copyright © 2001-2014 Free Software Foundation, Inc..
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 /usr/share/doc/gnutls/ directory does not contain the HTML form
visit
http://www.gnutls.org/manual/
gnutls 3.3.17 gnutls_handshake(3)
[top]
List of man pages available for DragonFly
Copyright (c) for man pages and the logo by the respective OS vendor.
For those who want to learn more, the polarhome community provides shell access and support.
[legal]
[privacy]
[GNU]
[policy]
[cookies]
[netiquette]
[sponsors]
[FAQ]
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
|
Vote for polarhome
|