diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 07:33:12 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 07:33:12 +0000 |
| commit | 36082a2fe36ecd800d784ae44c14f1f18c66a7e9 (patch) | |
| tree | 6c68e0c0097987aff85a01dabddd34b862309a7c /doc/manpages/gnutls_heartbeat_get_timeout.3 | |
| parent | Initial commit. (diff) | |
| download | gnutls28-36082a2fe36ecd800d784ae44c14f1f18c66a7e9.tar.xz gnutls28-36082a2fe36ecd800d784ae44c14f1f18c66a7e9.zip | |
Adding upstream version 3.7.9.upstream/3.7.9upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/manpages/gnutls_heartbeat_get_timeout.3')
| -rw-r--r-- | doc/manpages/gnutls_heartbeat_get_timeout.3 | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/manpages/gnutls_heartbeat_get_timeout.3 b/doc/manpages/gnutls_heartbeat_get_timeout.3 new file mode 100644 index 0000000..0998b8c --- /dev/null +++ b/doc/manpages/gnutls_heartbeat_get_timeout.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_heartbeat_get_timeout" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_heartbeat_get_timeout \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned int gnutls_heartbeat_get_timeout(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "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 \fBgnutls_heartbeat_ping()\fP +if no packets have been received. +.SH "RETURNS" +the remaining time in milliseconds. +.SH "SINCE" +3.1.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.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 /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP |