Sha256: 573a3a08990024cbc474fec5e43bcec0fae0b690315c6b950a4a701a39346344

Contents?: true

Size: 1.87 KB

Versions: 4

Compression:

Stored size: 1.87 KB

Contents

.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gnutls_handshake" 3 "2.4.2" "gnutls" "gnutls"
.SH NAME
gnutls_handshake \- This is the main function in the handshake protocol.
.SH SYNOPSIS
.B #include <gnutls/gnutls.h>
.sp
.BI "int gnutls_handshake(gnutls_session_t " session ");"
.SH ARGUMENTS
.IP "gnutls_session_t session" 12
is a \fBgnutls_session_t\fP structure.
.SH "DESCRIPTION"
This function does the handshake of the TLS/SSL protocol, and
initializes 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 such as \fBGNUTLS_E_AGAIN\fP and
\fBGNUTLS_E_INTERRUPTED\fP interrupt the handshake procedure, which
should be later be resumed.  Call this function again, until it
returns 0; cf.  \fBgnutls_record_get_direction()\fP and
\fBgnutls_error_is_fatal()\fP.

If this function is called by a server after a rehandshake request
then \fBGNUTLS_E_GOT_APPLICATION_DATA\fP or
\fBGNUTLS_E_WARNING_ALERT_RECEIVED\fP 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.
.SH "RETURNS"
\fBGNUTLS_E_SUCCESS\fP on success, otherwise an error.
.SH "REPORTING BUGS"
Report bugs to <bug-gnutls@gnu.org>.
.SH COPYRIGHT
Copyright \(co 2008 Free Software Foundation.
.br
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
.SH "SEE ALSO"
The full documentation for
.B gnutls
is maintained as a Texinfo manual.  If the
.B info
and
.B gnutls
programs are properly installed at your site, the command
.IP
.B info gnutls
.PP
should give you access to the complete manual.

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
glib2-1.1.8-x86-mingw32 vendor/local/share/man/man3/gnutls_handshake.3
glib2-1.1.7-x86-mingw32 vendor/local/share/man/man3/gnutls_handshake.3
glib2-1.1.6-x86-mingw32 vendor/local/share/man/man3/gnutls_handshake.3
glib2-1.1.5-x86-mingw32 vendor/local/share/man/man3/gnutls_handshake.3