TeamTalk 5 Java DLL Version 5.19A

Public Member Functions | Events | List of all members
BearWare.TeamTalk5Srv Class Reference
TeamTalk Server API

Instantiate this class to start a TeamTalk server. More...

Inherits BearWare.TeamTalkSrvBase, and IDisposable.

## Public Member Functions

delegate void | UserLogin (ref ClientErrorMsg lpClientErrorMsg, ref User lpUser, ref UserAccount lpUserAccount)
| Callback when a user is requesting to log on to the server. More...
delegate void | UserChangeNickname (ref ClientErrorMsg lpClientErrorMsg, ref User lpUser, string szNewNickname)
| Callback when a user is requesting to change nickname. More...
delegate void | UserChangeStatus (ref ClientErrorMsg lpClientErrorMsg, ref User lpUser, ref int nNewStatusMode, string szNewStatusMsg)
| Callback when a user is requesting to change status. More...
delegate void | UserCreateUserAccount (ref ClientErrorMsg lpClientErrorMsg, ref User lpUser, ref UserAccount lpUserAccount)
| Callback when a user is requesting to create a new user account. More...
delegate void | UserDeleteUserAccount (ref ClientErrorMsg lpClientErrorMsg, ref User lpUser, string szUsername)
| Callback when a user is requesting to delete a user account. More...
delegate void | UserAddServerBan (ref ClientErrorMsg lpClientErrorMsg, ref User lpBanner, ref User lpBanee)
| Callback when a user is requesting to ban a user. More...
delegate void | UserAddServerBanIPAddress (ref ClientErrorMsg lpClientErrorMsg, ref User lpBanner, string szIPAddress)
| Callback when a user is requesting to ban an IP-address. More...
delegate void | UserDeleteServerBan (ref ClientErrorMsg lpClientErrorMsg, ref User lpUser, string szIPAddress)
| Callback when a user is requesting to remove a ban. More...
delegate void | UserConnected (ref User lpUser)
| Callback when a new user is connecting to the server. More...
delegate void | UserLoggedIn (ref User lpUser)
| Callback when a user has logged in. More...
delegate void | UserLoggedOut (ref User lpUser)
| Callback when a user has logged out. More...
delegate void | UserDisconnected (ref User lpUser)
| Callback when user has disconnected. More...
delegate void | UserTimedout (ref User lpUser)
| Callback when a user's connection has timed out. More...
delegate void | UserKicked (ref User lpKicker, ref User lpKickee, ref Channel lpChannel)
| Callback when a user has been kicked. More...
delegate void | UserBanned (ref User lpBanner, ref User lpBanee, IntPtr lpChannel)
| Callback when a user has been banned. More...
delegate void | UserUnbanned (ref User lpUnbanner, string szIPAddress)
| Callback when a ban is removed. More...
delegate void | UserUpdated (ref User lpUser)
| Callback when a user's properties are being updated. More...
delegate void | UserJoinedChannel (ref User lpUser, ref Channel lpChannel)
| Callback when a user has joined a channel. More...
delegate void | UserLeftChannel (ref User lpUser, ref Channel lpChannel)
| Callback when a user has left a channel. More...
delegate void | UserMoved (ref User lpMover, ref User lpMovee)
| Callback when a user has been moved. More...
delegate void | UserTextMessage (ref User lpUser, ref TextMessage lpTextMessage)
| Callback when a user is sending a text message. More...
delegate void | ChannelCreated (ref Channel lpChannel, ref User lpUser)
| Callback when a new channel has been created. More...
delegate void | ChannelUpdated (ref Channel lpChannel, ref User lpUser)
| Callback when a channel has been updated. More...
delegate void | ChannelRemoved (ref Channel lpChannel, ref User lpUser)
| Callback when channel has been removed. More...
delegate void | FileUploaded (ref RemoteFile lpRemoteFile, ref User lpUser)
| Callback when a new file has been uploaded to a channel. More...
delegate void | FileDownloaded (ref RemoteFile lpRemoteFile, ref User lpUser)
| Callback when a user has downloaded a file. More...
delegate void | FileDeleted (ref RemoteFile lpRemoteFile, ref User lpUser)
| Callback when a user has deleted a file. More...
delegate void | ServerUpdated (ref ServerProperties lpServerProperties, ref User lpUser)
| Callback when a user has updated the server properties. More...
delegate void | SaveServerConfig (ref User lpUser)
| Callback when a user has reguested to save the server configuration. More...
| TeamTalk5Srv ()
| Instantiate TeamTalk server. Call UpdateServer() and MakeChannel() to setup server properties and root channel. More...
| TeamTalk5Srv (Channel lpChannel)
| Instantiate TeamTalk server with a root channel. More...
| TeamTalk5Srv (Channel lpChannel, ServerProperties lpServerProperties)
| Instantiate TeamTalk server with root channel and server properties. More...
Public Member Functions inherited from BearWare.TeamTalkSrvBase
void | Dispose ()
bool | SetEncryptionContext (string szCertificateFile, string szPrivateKeyFile)
| Set certificate and private key for encrypted server. More...
bool | SetEncryptionContext (EncryptionContext lpEncryptionContext)
| Set up encryption context for encrypted server. More...
void | Close ()
| Close TeamTalk server instance. More...
bool | RunEventLoop (int pnWaitMs)
| Run the server's event loop. More...
ClientError | SetChannelFilesRoot (string szFilesRoot, Int64 nMaxDiskUsage, Int64 nDefaultChannelQuota)
| The root folder of where users should upload files to. More...
ClientError | UpdateServer ([In] BearWare.ServerProperties lpServerProperties)
| Set server properties. More...
virtual ClientError | MakeChannel (BearWare.Channel lpChannel)
| Make new channel. More...
ClientError | UpdateChannel (Channel lpChannel)
| Update an existing channel. More...
ClientError | RemoveChannel (int nChannelID)
| Remove a channel. More...
ClientError | AddFileToChannel (string szLocalFilePath, BearWare.RemoteFile lpRemoteFile)
| Add a file to an existing channel. More...
ClientError | RemoveFileFromChannel (RemoteFile lpRemoteFile)
| Remove a file from a channel. More...
ClientError | MoveUser (int nUserID, BearWare.Channel lpChannel)
| Move a user from one channel to another. More...
ClientError | SendTextMessage (BearWare.TextMessage lpTextMessage)
| Send text message from server to clients. More...
bool | StartServer (string szBindIPAddr, int nTcpPort, int nUdpPort, bool bEncrypted)
| Start server on specified IP-address and ports. More...
bool | StartServerSysID (string szBindIPAddr, int nTcpPort, int nUdpPort, bool bEncrypted, string szSystemID)
| Same as StartServer() but with the option of specifying a system-ID. More...
bool | StopServer ()
| Stop server and drop all users. More...

## Events

UserLogin | OnUserLogin
| Register using UserLogin delegate. More...
UserChangeNickname | OnUserChangeNickname
| Register using UserChangeNickname delegate. More...
UserChangeStatus | OnUserChangeStatus
| Register using UserChangeStatus delegate. More...
UserCreateUserAccount | OnUserCreateUserAccount
| Register using UserCreateUserAccount delegate. More...
UserDeleteUserAccount | OnUserDeleteUserAccount
| Register using UserCreateUserAccount delegate. More...
UserAddServerBan | OnUserAddServerBan
| Register using UserAddServerBan delegate. More...
UserAddServerBanIPAddress | OnUserAddServerBanIPAddress
| Register using UserAddServerBan delegate. More...
UserDeleteServerBan | OnUserDeleteServerBan
| Register using UserAddServerBanIPAddress delegate. More...
UserConnected | OnUserConnected
| Register using UserConnected delegate. More...
UserLoggedIn | OnUserLoggedIn
| Register using UserLoggedIn delegate. More...
UserLoggedOut | OnUserLoggedOut
| Register using UserLoggedOut delegate. More...
UserDisconnected | OnUserDisconnected
| Register using UserDisconnected delegate. More...
UserTimedout | OnUserTimedout
| Register using UserTimedout delegate. More...
UserKicked | OnUserKicked
| Register using UserKicked delegate. More...
UserBanned | OnUserBanned
| Register using UserBanned delegate. More...
UserUnbanned | OnUserUnbanned
| Register using UserUnbanned delegate. More...
UserUpdated | OnUserUpdated
| Register using UserUpdated delegate. More...
UserJoinedChannel | OnUserJoinedChannel
| Register using UserJoinedChannel delegate. More...
UserLeftChannel | OnUserLeftChannel
| Register using UserLeftChannel delegate. More...
UserMoved | OnUserMoved
| Register using UserMoved delegate. More...
UserTextMessage | OnUserTextMessage
| Register using UserTextMessage delegate. More...
ChannelCreated | OnChannelCreated
| Register using ChannelCreated delegate. More...
ChannelUpdated | OnChannelUpdated
| Register using ChannelUpdated delegate. More...
ChannelRemoved | OnChannelRemoved
| Register using ChannelRemoved delegate. More...
FileUploaded | OnFileUploaded
| Register using FileUploaded delegate. More...
FileDownloaded | OnFileDownloaded
| Register using FileDownloaded delegate. More...
FileDeleted | OnFileDeleted
| Register using FileDeleted delegate. More...
ServerUpdated | OnServerUpdated
| Register using ServerUpdated delegate. More...
SaveServerConfig | OnSaveServerConfig
| Register using SaveServerConfig delegate. More...

## Additional Inherited Members

Static Public Member Functions inherited from BearWare.TeamTalkSrvBase
static string | GetVersion ()
Protected Member Functions inherited from BearWare.TeamTalkSrvBase
| TeamTalkSrvBase ()
| Create new TeamTalk server instance. More...
| TeamTalkSrvBase (Channel lpChannel)
| TeamTalkSrvBase (Channel lpChannel, ServerProperties lpServerProperties)

## Detailed Description

Instantiate this class to start a TeamTalk server.

These are the steps to start a TeamTalk server:

- First call TeamTalk5Srv.SetEncryptionContext() to setup encryption.
- Second call TeamTalk5Srv.UpdateServer() to setup server properties.
- Third call TeamTalk5Srv.MakeChannel() to create the root channel.

See also
  TeamTalk5Srv.StartServer()

Definition at line 43 of file TeamTalkSrv.cs.