gnutls\_heartbeat\_ping(3) gnutls gnutls\_heartbeat\_ping(3)

# [NAME](#NAME)

gnutls\_heartbeat\_ping - API function

# [SYNOPSIS](#SYNOPSIS)

**#include <gnutls/gnutls.h>**

**int gnutls\_heartbeat\_ping(gnutls\_session\_t session, size\_t data\_size, unsigned int max\_tries, unsigned int flags);**

# [ARGUMENTS](#ARGUMENTS)

[gnutls\_session\_t session](#gnutls_session_t)

is a **gnutls\_session\_t** type.

[size\_t data\_size](#size_t)

is the length of the ping payload.

[unsigned int max\_tries](#unsigned)

if flags is **GNUTLS\_HEARTBEAT\_WAIT** then this sets the number of retransmissions. Use zero for indefinite (until timeout).

[unsigned int flags](#unsigned~2)

if **GNUTLS\_HEARTBEAT\_WAIT** then wait for pong or timeout instead of returning immediately.

# [DESCRIPTION](#DESCRIPTION)

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.

# [RETURNS](#RETURNS)

**GNUTLS\_E\_SUCCESS** on success, otherwise a negative error code.

# [SINCE](#SINCE)

3.1.2

# [REPORTING BUGS](#REPORTING_BUGS)

Report bugs to <bugs@gnutls.org>.  
Home page: https://www.gnutls.org

# [COPYRIGHT](#COPYRIGHT)

Copyright © 2001-2023 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](#SEE_ALSO)

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/](https://www.gnutls.org/manual/)

3.8.13 gnutls

---

Document: gnutls_heartbeat_ping(3) from gnutls 3.8.13-r3 (Chainguard OS)
Source: https://gitlab.com/gnutls/gnutls