TeamTalk 5 C-API DLL: ClientKeepAlive Struct Reference

TeamTalk 5 C-API DLL Version 5.18A

Loading...
Searching...
No Matches
Public Attributes | List of all members
ClientKeepAlive Struct Reference
Client/Server Connectivity

Control timers for sending keep alive information to the server. More...

`#include <TeamTalk.h>`

## Public Attributes

INT32 | nConnectionLostMSec
| The duration before the TTInstance should consider the client/server connection lost.
INT32 | nTcpKeepAliveIntervalMSec
| Client instance's interval between automatically doing TT_DoPing() command. Read-only value. Will be half of ServerProperties' `nUserTimeout`.
INT32 | nUdpKeepAliveIntervalMSec

Client instance's interval between sending UDP keep alive packets. The UDP keep alive packets are used to ensure audio, video and desktop streams can be sent from the server to the client immediately. This value must be less than `nConnectionLostMSec`.

INT32 | nUdpKeepAliveRTXMSec

Client instance's interval for retransmitting UDP keep alive packets. If server hasn't responded to UDP keep alive sent at interval `nUdpKeepAliveIntervalMSec` then a new UDP keep alive will be sent at the rate specified by `nUdpKeepAliveRTXMSec`.

INT32 | nUdpConnectRTXMSec

Client instance's interval for retransmitting UDP connect packets. UDP connect packets are only sent when TT_Connect() is initially called. If the server doesn't respond to the client instance's initial UDP connect then a retransmission will be started at the rate of `nUdpConnectRTXMSec`.

INT32 | nUdpConnectTimeoutMSec

The duration before the client instance should give up trying to connect to the server on UDP. When TT_Connect() manages to connect to the server's TCP port then the client will afterwards try to connect on server's UDP port. If the client cannot connect on UDP before the time specified by `nUdpConnectTimeoutMSec` then the client instance will report CLIENTEVENT_CON_FAILED.

## Detailed Description

Control timers for sending keep alive information to the server.

See also
  TT_DoPing()

Definition at line 2707 of file TeamTalk.h.

## Member Data Documentation

## ◆ nConnectionLostMSec

INT32 ClientKeepAlive::nConnectionLostMSec

The duration before the TTInstance should consider the client/server connection lost.

This value must be greater than `nTcpKeepAliveIntervalMSec` and `nUdpKeepAliveIntervalMSec`.

This timeout applies to both the TCP and UDP connection. I.e. `nTcpServerSilenceSec` or `nUdpServerSilenceSec` in ClientStatistics should not exceed `nConnectionLostMSec`.

Definition at line 2719 of file TeamTalk.h.

## ◆ nTcpKeepAliveIntervalMSec

INT32 ClientKeepAlive::nTcpKeepAliveIntervalMSec

Client instance's interval between automatically doing TT_DoPing() command. Read-only value. Will be half of ServerProperties' `nUserTimeout`.

Definition at line 2723 of file TeamTalk.h.

## ◆ nUdpKeepAliveIntervalMSec

INT32 ClientKeepAlive::nUdpKeepAliveIntervalMSec

Client instance's interval between sending UDP keep alive packets. The UDP keep alive packets are used to ensure audio, video and desktop streams can be sent from the server to the client immediately. This value must be less than `nConnectionLostMSec`.

Definition at line 2729 of file TeamTalk.h.

## ◆ nUdpKeepAliveRTXMSec

INT32 ClientKeepAlive::nUdpKeepAliveRTXMSec

Client instance's interval for retransmitting UDP keep alive packets. If server hasn't responded to UDP keep alive sent at interval `nUdpKeepAliveIntervalMSec` then a new UDP keep alive will be sent at the rate specified by `nUdpKeepAliveRTXMSec`.

Definition at line 2735 of file TeamTalk.h.

## ◆ nUdpConnectRTXMSec

INT32 ClientKeepAlive::nUdpConnectRTXMSec

Client instance's interval for retransmitting UDP connect packets. UDP connect packets are only sent when TT_Connect() is initially called. If the server doesn't respond to the client instance's initial UDP connect then a retransmission will be started at the rate of `nUdpConnectRTXMSec`.

Definition at line 2742 of file TeamTalk.h.

## ◆ nUdpConnectTimeoutMSec

INT32 ClientKeepAlive::nUdpConnectTimeoutMSec

The duration before the client instance should give up trying to connect to the server on UDP. When TT_Connect() manages to connect to the server's TCP port then the client will afterwards try to connect on server's UDP port. If the client cannot connect on UDP before the time specified by `nUdpConnectTimeoutMSec` then the client instance will report CLIENTEVENT_CON_FAILED.

Definition at line 2750 of file TeamTalk.h.