gnutls_heartbeat_ping(3)           gnutls           gnutls_heartbeat_ping(3)

NAME         top

       gnutls_heartbeat_ping - API function

SYNOPSIS         top

       #include <gnutls/gnutls.h>

       int gnutls_heartbeat_ping(gnutls_session_t session, size_t data_size,
       unsigned int max_tries, unsigned int flags);

ARGUMENTS         top

       gnutls_session_t session
                   is a gnutls_session_t type.

       size_t data_size
                   is the length of the ping payload.

       unsigned int max_tries
                   if flags is GNUTLS_HEARTBEAT_WAIT then this sets the
                   number of retransmissions. Use zero for indefinite (until

       unsigned int flags
                   if GNUTLS_HEARTBEAT_WAIT then wait for pong or timeout
                   instead of returning immediately.

DESCRIPTION         top

       This function sends a ping to the peer. If the  flags is set to
       GNUTLS_HEARTBEAT_WAIT then it waits for a reply from the peer.

       Note that it is highly recommended to use this function with the flag
       GNUTLS_HEARTBEAT_WAIT, or you need to handle retransmissions and
       timeouts manually.

       The total TLS data transmitted as part of the ping message are given
       by the following formula: MAX(16,  data_size

RETURNS         top

       GNUTLS_E_SUCCESS on success, otherwise a negative error code.

SINCE         top


REPORTING BUGS         top

       Report bugs to <>.
       Home page:

COPYRIGHT         top

       Copyright © 2001-2018 Free Software Foundation, Inc., and others.
       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         top

       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 

COLOPHON         top

       This page is part of the GnuTLS (GnuTLS Transport Layer Security
       Library) project.  Information about the project can be found at 
       ⟨⟩.  If you have a bug report for this manual
       page, send it to  This page was obtained from the
       tarball gnutls-3.6.2.tar.xz fetched from
       ⟨⟩ on 2018-04-30.  If you discover
       any rendering problems in this HTML version of the page, or you
       believe there is a better or more up-to-date source for the page, or
       you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page), send a mail

gnutls                              3.6.2           gnutls_heartbeat_ping(3)