Blame doc/manpages/gnutls_record_get_direction.3

Packit aea12f
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
Packit aea12f
.TH "gnutls_record_get_direction" 3 "3.6.8" "gnutls" "gnutls"
Packit aea12f
.SH NAME
Packit aea12f
gnutls_record_get_direction \- API function
Packit aea12f
.SH SYNOPSIS
Packit aea12f
.B #include <gnutls/gnutls.h>
Packit aea12f
.sp
Packit aea12f
.BI "int gnutls_record_get_direction(gnutls_session_t " session ");"
Packit aea12f
.SH ARGUMENTS
Packit aea12f
.IP "gnutls_session_t session" 12
Packit aea12f
is a \fBgnutls_session_t\fP type.
Packit aea12f
.SH "DESCRIPTION"
Packit aea12f
This function is useful to determine whether a GnuTLS function was interrupted
Packit aea12f
while sending or receiving, so that \fBselect()\fP or \fBpoll()\fP may be called appropriately.
Packit aea12f
Packit aea12f
It provides information about the internals of the record
Packit aea12f
protocol and is only useful if a prior gnutls function call,
Packit aea12f
e.g.  \fBgnutls_handshake()\fP, was interrupted and returned
Packit aea12f
\fBGNUTLS_E_INTERRUPTED\fP or \fBGNUTLS_E_AGAIN\fP. After such an interrupt
Packit aea12f
applications may call \fBselect()\fP or \fBpoll()\fP before restoring the
Packit aea12f
interrupted GnuTLS function.
Packit aea12f
Packit aea12f
This function's output is unreliable if you are using the same
Packit aea12f
 \fIsession\fP in different threads for sending and receiving.
Packit aea12f
.SH "RETURNS"
Packit aea12f
0 if interrupted while trying to read data, or 1 while trying to write data.
Packit aea12f
.SH "REPORTING BUGS"
Packit aea12f
Report bugs to <bugs@gnutls.org>.
Packit aea12f
.br
Packit aea12f
Home page: https://www.gnutls.org
Packit aea12f
Packit aea12f
.SH COPYRIGHT
Packit aea12f
Copyright \(co 2001-2019 Free Software Foundation, Inc., and others.
Packit aea12f
.br
Packit aea12f
Copying and distribution of this file, with or without modification,
Packit aea12f
are permitted in any medium without royalty provided the copyright
Packit aea12f
notice and this notice are preserved.
Packit aea12f
.SH "SEE ALSO"
Packit aea12f
The full documentation for
Packit aea12f
.B gnutls
Packit aea12f
is maintained as a Texinfo manual.
Packit aea12f
If the /usr/share/doc/gnutls/
Packit aea12f
directory does not contain the HTML form visit
Packit aea12f
.B
Packit aea12f
.IP https://www.gnutls.org/manual/
Packit aea12f
.PP