TeamTalk 5 Java DLL Version 5.15A
Loading...
Searching...
No Matches
Public Attributes | List of all members
BearWare.ServerProperties Struct Reference
Server Administration

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

Public Attributes

string szServerName
 The server's name.
 
string szMOTD
 The message of the day. Read-only property. Use szMOTDRaw to update this property.
 
string szMOTDRaw
 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.
 
int nMaxUsers
 The maximum number of users allowed on the server. A user with admin account can ignore this.
 
int nMaxLoginAttempts
 The maximum number of logins with wrong password before banning user's IP-address.
 
int nMaxLoginsPerIPAddress
 The maximum number of users allowed to log in with the same IP-address. 0 means disabled.
 
int 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.
 
int 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.
 
int 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.
 
int 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.
 
int 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.
 
bool bAutoSave
 Whether the server automatically saves changes.
 
int nTcpPort
 The server's TCP port.
 
int nUdpPort
 The server's UDP port.
 
int nUserTimeout
 The number of seconds before a user who hasn't responded to keepalives will be kicked off the server.
 
string szServerVersion
 The server version.
 
string szServerProtocolVersion
 The version of the server's protocol.
 
int nLoginDelayMSec
 Number of msec before an IP-address can make another login attempt. If less than this amount then TeamTalkBase.DoLogin() will result in BearWare.ClientError.CMDERR_MAX_LOGINS_PER_IPADDRESS_EXCEEDED. Zero means disabled.
 
string szAccessToken
 A randomly generated 256 bit access token created by the server to identify the login session. Read-only property.
 
ServerLogEvent 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 TeamTalkBase.DoLogin()

See also
TeamTalkBase.DoUpdateServer
TeamTalkBase.GetServerProperties
TeamTalkBase.DoLogin
UserRight

Definition at line 1888 of file TeamTalk.cs.

Member Data Documentation

◆ szServerName

string BearWare.ServerProperties.szServerName

The server's name.

Definition at line 1892 of file TeamTalk.cs.

◆ szMOTD

string BearWare.ServerProperties.szMOTD

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

Definition at line 1896 of file TeamTalk.cs.

◆ szMOTDRaw

string BearWare.ServerProperties.szMOTDRaw

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 1906 of file TeamTalk.cs.

◆ nMaxUsers

int BearWare.ServerProperties.nMaxUsers

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

Definition at line 1909 of file TeamTalk.cs.

◆ nMaxLoginAttempts

int BearWare.ServerProperties.nMaxLoginAttempts

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

Definition at line 1912 of file TeamTalk.cs.

◆ nMaxLoginsPerIPAddress

int BearWare.ServerProperties.nMaxLoginsPerIPAddress

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

Definition at line 1915 of file TeamTalk.cs.

◆ nMaxVoiceTxPerSecond

int BearWare.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 1919 of file TeamTalk.cs.

◆ nMaxVideoCaptureTxPerSecond

int BearWare.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 1924 of file TeamTalk.cs.

◆ nMaxMediaFileTxPerSecond

int BearWare.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 1928 of file TeamTalk.cs.

◆ nMaxDesktopTxPerSecond

int BearWare.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 1932 of file TeamTalk.cs.

◆ nMaxTotalTxPerSecond

int BearWare.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 1936 of file TeamTalk.cs.

◆ bAutoSave

bool BearWare.ServerProperties.bAutoSave

Whether the server automatically saves changes.

Definition at line 1938 of file TeamTalk.cs.

◆ nTcpPort

int BearWare.ServerProperties.nTcpPort

The server's TCP port.

Definition at line 1940 of file TeamTalk.cs.

◆ nUdpPort

int BearWare.ServerProperties.nUdpPort

The server's UDP port.

Definition at line 1942 of file TeamTalk.cs.

◆ nUserTimeout

int BearWare.ServerProperties.nUserTimeout

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

Definition at line 1945 of file TeamTalk.cs.

◆ szServerVersion

string BearWare.ServerProperties.szServerVersion

The server version.

Definition at line 1948 of file TeamTalk.cs.

◆ szServerProtocolVersion

string BearWare.ServerProperties.szServerProtocolVersion

The version of the server's protocol.

Definition at line 1951 of file TeamTalk.cs.

◆ nLoginDelayMSec

int BearWare.ServerProperties.nLoginDelayMSec

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

Also checkout nMaxLoginAttempts and nMaxLoginsPerIPAddress.

Definition at line 1960 of file TeamTalk.cs.

◆ szAccessToken

string BearWare.ServerProperties.szAccessToken

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

Definition at line 1965 of file TeamTalk.cs.

◆ uServerLogEvents

ServerLogEvent BearWare.ServerProperties.uServerLogEvents

The events that are logged on the server.

uServerLogEvents is set after TeamTalkBase.OnCmdServerUpdate() during login.

See also
TeamTalkBase.DoLogin()

Definition at line 1971 of file TeamTalk.cs.