NAME | SYNOPSIS | ARGUMENTS | DESCRIPTION | RETURNS | SINCE | REPORTING BUGS | COPYRIGHT | SEE ALSO | COLOPHON
gnutls_heartbeat_ping(3) gnutls gnutls_heartbeat_ping(3)
gnutls_heartbeat_ping - API function
#include <gnutls/gnutls.h> int gnutls_heartbeat_ping(gnutls_session_t session, size_t data_size, unsigned int max_tries, unsigned int flags);
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 timeout). unsigned int flags if GNUTLS_HEARTBEAT_WAIT then wait for pong or timeout instead of returning immediately.
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 )+gnutls_record_overhead_size()+3.
GNUTLS_E_SUCCESS on success, otherwise a negative error code.
Report bugs to <email@example.com>. Home page: https://www.gnutls.org
Copyright © 2001- 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.
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 https://www.gnutls.org/manual/
This page is part of the GnuTLS (GnuTLS Transport Layer Security Library) project. Information about the project can be found at ⟨http://www.gnutls.org/⟩. If you have a bug report for this manual page, send it to firstname.lastname@example.org. This page was obtained from the tarball gnutls-3.7.8.tar.xz fetched from ⟨http://www.gnutls.org/download.html⟩ on 2022-12-17. 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 to email@example.com gnutls 3.7.8 gnutls_heartbeat_ping(3)