blob: 490c6e078696c13a0cda4357067e322ffa2af9d0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
|
@deftypefun {int} {gnutls_heartbeat_ping} (gnutls_session_t @var{session}, size_t @var{data_size}, unsigned int @var{max_tries}, unsigned int @var{flags})
@var{session}: is a @code{gnutls_session_t} type.
@var{data_size}: is the length of the ping payload.
@var{max_tries}: if flags is @code{GNUTLS_HEARTBEAT_WAIT} then this sets the number of retransmissions. Use zero for indefinite (until timeout).
@var{flags}: if @code{GNUTLS_HEARTBEAT_WAIT} then wait for pong or timeout instead of returning immediately.
This function sends a ping to the peer. If the @code{flags} is set
to @code{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 @code{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, @code{data_size} )+@code{gnutls_record_overhead_size()} +3.
@strong{Returns:} @code{GNUTLS_E_SUCCESS} on success, otherwise a negative error code.
@strong{Since:} 3.1.2
@end deftypefun
|
