TeamTalk 5 C-API DLL Version 5.15A
Loading...
Searching...
No Matches
ServerProperties Struct Reference

A struct containing the properties of the server's settings. More...

#include <TeamTalk.h>

Public Attributes

TTCHAR szServerName [TT_STRLEN]
 The server's name.
 
TTCHAR szMOTD [TT_STRLEN]
 The message of the day. Read-only property. Use szMOTDRaw to update this property.
 
TTCHAR szMOTDRaw [TT_STRLEN]
 The message of the day including variables. The result of the szMOTDRaw string will be displayed in szMOTD. When updating the MOTD the variables %users% (number of users), %admins% (number of admins), %uptime% (hours, minutes and seconds the server has been online), %voicetx% (KBytes transmitted), %voicerx% (KBytes received) and %lastuser% (nickname of last user to log on to the server) as part of the MOTD.
 
INT32 nMaxUsers
 The maximum number of users allowed on the server. A user with admin account can ignore this.
 
INT32 nMaxLoginAttempts
 The maximum number of logins with wrong password before banning user's IP-address.
 
INT32 nMaxLoginsPerIPAddress
 The maximum number of users allowed to log in with the same IP-address. 0 means disabled.
 
INT32 nMaxVoiceTxPerSecond
 The maximum number of bytes per second which the server will allow for voice packets. If this value is exceeded the server will start dropping audio packets. 0 = disabled.
 
INT32 nMaxVideoCaptureTxPerSecond
 The maximum number of bytes per second which the server will allow for video input packets. If this value is exceeded the server will start dropping video packets. 0 = disabled.
 
INT32 nMaxMediaFileTxPerSecond
 The maximum number of bytes per second which the server will allow for media file packets. If this value is exceeded the server will start dropping media file packets. 0 = disabled.
 
INT32 nMaxDesktopTxPerSecond
 The maximum number of bytes per second which the server will allow for desktop packets. If this value is exceeded the server will start dropping desktop packets. 0 = disabled.
 
INT32 nMaxTotalTxPerSecond
 The amount of bytes per second which the server will allow for packet forwarding. If this value is exceeded the server will start dropping packets. 0 = disabled.
 
TTBOOL bAutoSave
 Whether the server automatically saves changes.
 
INT32 nTcpPort
 The server's TCP port.
 
INT32 nUdpPort
 The server's UDP port.
 
INT32 nUserTimeout
 The number of seconds before a user who hasn't responded to keepalives will be kicked off the server.
 
TTCHAR szServerVersion [TT_STRLEN]
 The server version. Read-only property.
 
TTCHAR szServerProtocolVersion [TT_STRLEN]
 The version of the server's protocol. Read-only property.
 
INT32 nLoginDelayMSec
 Number of msec before an IP-address can make another login attempt. If less than this amount then TT_DoLogin() will result in CMDERR_MAX_LOGINS_PER_IPADDRESS_EXCEEDED. Zero means disabled.
 
TTCHAR szAccessToken [TT_STRLEN]
 A randomly generated 256 bit access token created by the server to identify the login session.
 
ServerLogEvents uServerLogEvents
 The events that are logged on the server.
 

Detailed Description

A struct containing the properties of the server's settings.

The server properties is available after a successful call to TT_DoLogin

See also
TT_DoUpdateServer
TT_GetServerProperties
TT_Login
UserRight

Definition at line 1797 of file TeamTalk.h.

Member Data Documentation

◆ szServerName

TTCHAR ServerProperties::szServerName[TT_STRLEN]

The server's name.

Definition at line 1800 of file TeamTalk.h.

◆ szMOTD

TTCHAR ServerProperties::szMOTD[TT_STRLEN]

The message of the day. Read-only property. Use szMOTDRaw to update this property.

Definition at line 1803 of file TeamTalk.h.

◆ szMOTDRaw

TTCHAR ServerProperties::szMOTDRaw[TT_STRLEN]

The message of the day including variables. The result of the szMOTDRaw string will be displayed in szMOTD. When updating the MOTD the variables %users% (number of users), %admins% (number of admins), %uptime% (hours, minutes and seconds the server has been online), %voicetx% (KBytes transmitted), %voicerx% (KBytes received) and %lastuser% (nickname of last user to log on to the server) as part of the MOTD.

Definition at line 1812 of file TeamTalk.h.

◆ nMaxUsers

INT32 ServerProperties::nMaxUsers

The maximum number of users allowed on the server. A user with admin account can ignore this.

Definition at line 1815 of file TeamTalk.h.

◆ nMaxLoginAttempts

INT32 ServerProperties::nMaxLoginAttempts

The maximum number of logins with wrong password before banning user's IP-address.

Definition at line 1818 of file TeamTalk.h.

◆ nMaxLoginsPerIPAddress

INT32 ServerProperties::nMaxLoginsPerIPAddress

The maximum number of users allowed to log in with the same IP-address. 0 means disabled.

Definition at line 1821 of file TeamTalk.h.

◆ nMaxVoiceTxPerSecond

INT32 ServerProperties::nMaxVoiceTxPerSecond

The maximum number of bytes per second which the server will allow for voice packets. If this value is exceeded the server will start dropping audio packets. 0 = disabled.

Definition at line 1825 of file TeamTalk.h.

◆ nMaxVideoCaptureTxPerSecond

INT32 ServerProperties::nMaxVideoCaptureTxPerSecond

The maximum number of bytes per second which the server will allow for video input packets. If this value is exceeded the server will start dropping video packets. 0 = disabled.

Definition at line 1830 of file TeamTalk.h.

◆ nMaxMediaFileTxPerSecond

INT32 ServerProperties::nMaxMediaFileTxPerSecond

The maximum number of bytes per second which the server will allow for media file packets. If this value is exceeded the server will start dropping media file packets. 0 = disabled.

Definition at line 1834 of file TeamTalk.h.

◆ nMaxDesktopTxPerSecond

INT32 ServerProperties::nMaxDesktopTxPerSecond

The maximum number of bytes per second which the server will allow for desktop packets. If this value is exceeded the server will start dropping desktop packets. 0 = disabled.

Definition at line 1838 of file TeamTalk.h.

◆ nMaxTotalTxPerSecond

INT32 ServerProperties::nMaxTotalTxPerSecond

The amount of bytes per second which the server will allow for packet forwarding. If this value is exceeded the server will start dropping packets. 0 = disabled.

Definition at line 1842 of file TeamTalk.h.

◆ bAutoSave

TTBOOL ServerProperties::bAutoSave

Whether the server automatically saves changes.

Definition at line 1844 of file TeamTalk.h.

◆ nTcpPort

INT32 ServerProperties::nTcpPort

The server's TCP port.

Definition at line 1846 of file TeamTalk.h.

◆ nUdpPort

INT32 ServerProperties::nUdpPort

The server's UDP port.

Definition at line 1848 of file TeamTalk.h.

◆ nUserTimeout

INT32 ServerProperties::nUserTimeout

The number of seconds before a user who hasn't responded to keepalives will be kicked off the server.

Definition at line 1851 of file TeamTalk.h.

◆ szServerVersion

TTCHAR ServerProperties::szServerVersion[TT_STRLEN]

The server version. Read-only property.

Definition at line 1853 of file TeamTalk.h.

◆ szServerProtocolVersion

TTCHAR ServerProperties::szServerProtocolVersion[TT_STRLEN]

The version of the server's protocol. Read-only property.

Definition at line 1856 of file TeamTalk.h.

◆ nLoginDelayMSec

INT32 ServerProperties::nLoginDelayMSec

Number of msec before an IP-address can make another login attempt. If less than this amount then TT_DoLogin() will result in CMDERR_MAX_LOGINS_PER_IPADDRESS_EXCEEDED. Zero means disabled.

Also checkout nMaxLoginAttempts and nMaxLoginsPerIPAddress.

Definition at line 1865 of file TeamTalk.h.

◆ szAccessToken

TTCHAR ServerProperties::szAccessToken[TT_STRLEN]

A randomly generated 256 bit access token created by the server to identify the login session.

The szAccessToken is available after receiving CLIENTEVENT_CON_SUCCESS.

Read-only property.

Definition at line 1873 of file TeamTalk.h.

◆ uServerLogEvents

ServerLogEvents ServerProperties::uServerLogEvents

The events that are logged on the server.

uServerLogEvents is set after CLIENTEVENT_CMD_SERVER_UPDATE during login.

See also
TT_DoLogin()

Definition at line 1879 of file TeamTalk.h.