---
name: "gnutls_heartbeat_get_timeout"
section: "3"
platform: "linux"
package: "gnutls"
version: "3.8.13-3"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/gnutls_heartbeat_get_timeout"
---

# gnutls\_heartbeat\_get\_timeout(3)

API function

## NAME

gnutls\_heartbeat\_get\_timeout - API function

## SYNOPSIS

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

**unsigned int gnutls\_heartbeat\_get\_timeout(gnutls\_session\_t** *session***);**

## ARGUMENTS

- gnutls\_session\_t session

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

## DESCRIPTION

This function will return the milliseconds remaining for a retransmission of the previously sent ping message. This function is useful when ping is used in non-blocking mode, to estimate when to call **gnutls\_heartbeat\_ping()** if no packets have been received.

## RETURNS

the remaining time in milliseconds.

## SINCE

3\.1.2

## REPORTING BUGS

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

## 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

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/