summaryrefslogtreecommitdiffstats
path: root/doc/functions/gnutls_heartbeat_allowed
diff options
context:
space:
mode:
Diffstat (limited to 'doc/functions/gnutls_heartbeat_allowed')
-rw-r--r--doc/functions/gnutls_heartbeat_allowed16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/functions/gnutls_heartbeat_allowed b/doc/functions/gnutls_heartbeat_allowed
new file mode 100644
index 0000000..2cd5836
--- /dev/null
+++ b/doc/functions/gnutls_heartbeat_allowed
@@ -0,0 +1,16 @@
+
+
+
+
+@deftypefun {unsigned} {gnutls_heartbeat_allowed} (gnutls_session_t @var{session}, unsigned int @var{type})
+@var{session}: is a @code{gnutls_session_t} type.
+
+@var{type}: one of @code{GNUTLS_HB_LOCAL_ALLOWED_TO_SEND} and @code{GNUTLS_HB_PEER_ALLOWED_TO_SEND}
+
+This function will check whether heartbeats are allowed
+to be sent or received in this session.
+
+@strong{Returns:} Non zero if heartbeats are allowed.
+
+@strong{Since:} 3.1.2
+@end deftypefun