Sha256: 39adcac9c4d2de9b651df9f3bdb339399417ba35d09bc921702022c865782236

Contents?: true

Size: 1.93 KB

Versions: 2

Compression:

Stored size: 1.93 KB

Contents

.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gnutls_heartbeat_ping" 3 "3.1.11" "gnutls" "gnutls"
.SH NAME
gnutls_heartbeat_ping \- API function
.SH SYNOPSIS
.B #include <gnutls/gnutls.h>
.sp
.BI "int gnutls_heartbeat_ping(gnutls_session_t " session ", size_t " data_size ", unsigned int " max_tries ", unsigned int " flags ");"
.SH ARGUMENTS
.IP "gnutls_session_t session" 12
is a \fBgnutls_session_t\fP structure.
.IP "size_t data_size" 12
is the length of the ping payload.
.IP "unsigned int max_tries" 12
if flags is \fBGNUTLS_HEARTBEAT_WAIT\fP then this sets the number of retransmissions. Use zero for indefinite (until timeout).
.IP "unsigned int flags" 12
if \fBGNUTLS_HEARTBEAT_WAIT\fP then wait for pong or timeout instead of returning immediately.
.SH "DESCRIPTION"
This function sends a ping to the peer. If the  \fIflags\fP is set
to \fBGNUTLS_HEARTBEAT_WAIT\fP then it waits for a reply from the peer.

Note that it is highly recommended to use this function with the
flag \fBGNUTLS_HEARTBEAT_WAIT\fP, or you need to handle retransmissions
and timeouts manually.
.SH "RETURNS"
\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code.
.SH "SINCE"
3.1.2
.SH "REPORTING BUGS"
Report bugs to <bug-gnutls@gnu.org>.
.br
General guidelines for reporting bugs: http://www.gnu.org/gethelp/
.br
GnuTLS home page: http://www.gnu.org/software/gnutls/

.SH COPYRIGHT
Copyright \(co 2012 Free Software Foundation, Inc..
.br
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.
.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.
As an alternative you may obtain the manual from:
.IP
.B http://www.gnu.org/software/gnutls/manual/
.PP

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
glib2-2.0.2-x86-mingw32 vendor/local/share/man/man3/gnutls_heartbeat_ping.3
glib2-2.0.1-x86-mingw32 vendor/local/share/man/man3/gnutls_heartbeat_ping.3