TeamTalk 5 .NET DLL: BearWare.TeamTalk5Srv Class Reference

TeamTalk 5 .NET DLL Version 5.18A

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

## Events

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

## 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.
| 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.