Documentation ¶
Overview ¶
ApiHolder
TS3ApiExportedMethods ¶
TS3Connection ¶
TS3Listener ¶
TextMessageEvent ¶
A layer for the TS3Query interface. There is a subpackage speedprog.de/ts3api/ts3const that contains constants to use for setabel properties. TODO: BINDINGLIST, find out how it looks with more then one binding
Index ¶
- Constants
- type ApiHolder
- type ChannelCreatedEvent
- func (event *ChannelCreatedEvent) ChannelId() int
- func (event *ChannelCreatedEvent) Codec() int
- func (event *ChannelCreatedEvent) CodecIsUnencrypted() bool
- func (event *ChannelCreatedEvent) CodecLatFactor() int
- func (event *ChannelCreatedEvent) CodecQuality() int
- func (event *ChannelCreatedEvent) Default() bool
- func (event *ChannelCreatedEvent) DeleteDelay() int
- func (event *ChannelCreatedEvent) IconId() string
- func (event *ChannelCreatedEvent) MaxClients() int
- func (event *ChannelCreatedEvent) MaxClientsUnlimited() bool
- func (event *ChannelCreatedEvent) MaxFamilyClients() int
- func (event *ChannelCreatedEvent) MaxFamilyClientsInherited() bool
- func (event *ChannelCreatedEvent) MaxFamilyclientsUnlimited() bool
- func (event *ChannelCreatedEvent) Name() string
- func (event *ChannelCreatedEvent) NamePhonectic() string
- func (event *ChannelCreatedEvent) NeededTalkPower() int
- func (event *ChannelCreatedEvent) Order() int
- func (event *ChannelCreatedEvent) ParentId() int
- func (event *ChannelCreatedEvent) Password() bool
- func (event *ChannelCreatedEvent) Permanent() bool
- func (event *ChannelCreatedEvent) SemiPermanent() bool
- func (event *ChannelCreatedEvent) Topic() string
- type ChannelDeletedEvent
- type ChannelDescriptionChangedEvent
- type ChannelEditedEvent
- type ChannelMovedEvent
- type ChannelPasswordChangedEvent
- type ClientJoinedEvent
- func (event *ClientJoinedEvent) Away() bool
- func (event *ClientJoinedEvent) AwayMsg() string
- func (event *ClientJoinedEvent) Badages() string
- func (event *ClientJoinedEvent) ChannelFromId() int
- func (event *ClientJoinedEvent) ChannelGroupId() int
- func (event *ClientJoinedEvent) ChannelGroupInheritedChannelId() int
- func (event *ClientJoinedEvent) ChannelToId() int
- func (event *ClientJoinedEvent) Country() string
- func (event *ClientJoinedEvent) DatabaseId() int
- func (event *ClientJoinedEvent) Description() string
- func (event *ClientJoinedEvent) FlagAvatar() string
- func (event *ClientJoinedEvent) IconId() int
- func (event *ClientJoinedEvent) Id() int
- func (event *ClientJoinedEvent) InputHardware() int
- func (event *ClientJoinedEvent) InputMuted() bool
- func (event *ClientJoinedEvent) IsChannelCommander() bool
- func (event *ClientJoinedEvent) IsPrioritySpeaker() bool
- func (event *ClientJoinedEvent) IsRecording() bool
- func (event *ClientJoinedEvent) IsTalker() bool
- func (event *ClientJoinedEvent) NeededServerqueryViewPower() int
- func (event *ClientJoinedEvent) Nick() string
- func (event *ClientJoinedEvent) NickPhonetic() string
- func (event *ClientJoinedEvent) OutputHardware() int
- func (event *ClientJoinedEvent) OutputMuted() bool
- func (event *ClientJoinedEvent) OutputOnlyMuted() bool
- func (event *ClientJoinedEvent) ReasonId() int
- func (event *ClientJoinedEvent) ServerGroups() []int
- func (event *ClientJoinedEvent) TalkPower() int
- func (event *ClientJoinedEvent) TalkRequestMsg() string
- func (event *ClientJoinedEvent) TalkRequested() bool
- func (event *ClientJoinedEvent) Type() int
- func (event *ClientJoinedEvent) UID() string
- func (event *ClientJoinedEvent) UnreadMsgs() int
- type ClientLeftEvent
- type ClientMovedEvent
- type Connectioninfo
- type Event
- type HostInfo
- type InstanceInfo
- type InvokerHolder
- type Me
- func (me *Me) ChannelId() int
- func (me *Me) ClientId() int
- func (me *Me) DatabaseId() int
- func (me *Me) LoginName() string
- func (me *Me) Nick() string
- func (me *Me) OriginServerId() int
- func (me *Me) UniqueId() string
- func (me *Me) VirtualServerId() int
- func (me *Me) VirtualServerPort() int
- func (me *Me) VirtualServerUniqueId() string
- type QueryError
- type ServerEditedEvent
- type ServerListEntry
- type Serverinfo
- type TS3Adapter
- func (obs *TS3Adapter) ChannelCreated(event *ChannelCreatedEvent)
- func (obs *TS3Adapter) ChannelDeletedEvent(event *ChannelDeletedEvent)
- func (obs *TS3Adapter) ChannelDescriptionChanged(event *ChannelDescriptionChangedEvent)
- func (obs *TS3Adapter) ChannelEdited(event *ChannelEditedEvent)
- func (obs *TS3Adapter) ChannelMoved(event *ChannelMovedEvent)
- func (obs *TS3Adapter) ChannelPasswordChanged(event *ChannelPasswordChangedEvent)
- func (obs *TS3Adapter) ClientJoined(event *ClientJoinedEvent)
- func (obs *TS3Adapter) ClientLeft(event *ClientLeftEvent)
- func (obs *TS3Adapter) ClientMoved(event *ClientMovedEvent)
- func (obs *TS3Adapter) ServerEdited(event *ServerEditedEvent)
- func (obs *TS3Adapter) TextMessage(msg *TextMessageEvent)
- func (obs *TS3Adapter) TokenUsed(event *TokenUsedEvent)
- type TS3Api
- func (api TS3Api) ClientMove(clid int, cid int)
- func (api TS3Api) Connectioninfo() (conInfo *Connectioninfo, qerr QueryError)
- func (api TS3Api) DoCommand(cmd string) (answersList *list.List, err QueryError)
- func (api TS3Api) Hostinfo() (info *HostInfo, qerr QueryError, err error)
- func (api TS3Api) Instanceedit(properties [][]string) (qerr QueryError)
- func (api TS3Api) Instanceinfo() (info *InstanceInfo, qerr QueryError, err error)
- func (api TS3Api) Login(user, password string) (qerr QueryError)
- func (api TS3Api) Logout() (qerr QueryError)
- func (api TS3Api) Quit()
- func (api TS3Api) RegisterEvent(event string, id int) (err error, qerr QueryError)
- func (api TS3Api) RegisterTS3Listener(listener TS3Listener)
- func (api TS3Api) SelectVirtualServer(serverid int)
- func (api TS3Api) SendTextMessage(targetmode int, target int, msg string) (err error, qerr QueryError)
- func (api TS3Api) ServerCreate(name string, props [][]string) (sid int, port int, token string, qerr QueryError)
- func (api TS3Api) ServerDelete(port int) (qerr QueryError)
- func (api TS3Api) ServerIdGetByPort(port int) (id int, qerr QueryError)
- func (api TS3Api) ServerInfo() (sInfo *Serverinfo, qerr QueryError)
- func (api TS3Api) ServerProcessStop() (qerr QueryError)
- func (api TS3Api) ServerStart(sid int) (qerr QueryError)
- func (api TS3Api) ServerStop(sid int) (qerr QueryError)
- func (api TS3Api) Serverlist(all bool, onlyoffline bool, uid bool) (serverlist list.List, qerr QueryError)
- func (api TS3Api) SetNick(nick string) (qerr QueryError)
- func (api TS3Api) UseById(sid int, virtual bool) (err error, qerr QueryError)
- func (api TS3Api) UseByPort(port int, virtual bool) (qerr QueryError)
- func (api TS3Api) Version() (version string, build uint64, platform string, qerr QueryError)
- func (api TS3Api) WhoAmI() (client *Me, qerr QueryError)
- type TS3Listener
- type TextMessageEvent
- type TokenUsedEvent
- func (event *TokenUsedEvent) ClientDBId() int
- func (event *TokenUsedEvent) ClientId() int
- func (event *TokenUsedEvent) ClientUID() string
- func (event *TokenUsedEvent) Token() string
- func (event *TokenUsedEvent) TokenChannel() int
- func (event *TokenUsedEvent) TokenGroup() int
- func (event *TokenUsedEvent) TokenType() int
Constants ¶
const ( Self = 0 Moved = 1 Timeout = 3 ChannelKick = 4 ServerKick = 5 Ban = 6 LeftOnHisOwn = 8 ServerOrChannelEdited = 10 ServerShutdown = 11 )
const ( MESSAGE_TARGETMODE_CLIENT = 1 MESSAGE_TARGETMODE_CHANNEL = 2 MESSAGE_TARGETMODE_SERVER = 3 )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ChannelCreatedEvent ¶
type ChannelCreatedEvent struct { *ApiHolder *InvokerHolder // contains filtered or unexported fields }
func NewChannelCreatedEvent ¶
func NewChannelCreatedEvent() (event *ChannelCreatedEvent)
func (*ChannelCreatedEvent) ChannelId ¶
func (event *ChannelCreatedEvent) ChannelId() int
func (*ChannelCreatedEvent) Codec ¶
func (event *ChannelCreatedEvent) Codec() int
func (*ChannelCreatedEvent) CodecIsUnencrypted ¶
func (event *ChannelCreatedEvent) CodecIsUnencrypted() bool
func (*ChannelCreatedEvent) CodecLatFactor ¶
func (event *ChannelCreatedEvent) CodecLatFactor() int
func (*ChannelCreatedEvent) CodecQuality ¶
func (event *ChannelCreatedEvent) CodecQuality() int
func (*ChannelCreatedEvent) Default ¶
func (event *ChannelCreatedEvent) Default() bool
func (*ChannelCreatedEvent) DeleteDelay ¶
func (event *ChannelCreatedEvent) DeleteDelay() int
func (*ChannelCreatedEvent) IconId ¶
func (event *ChannelCreatedEvent) IconId() string
func (*ChannelCreatedEvent) MaxClients ¶
func (event *ChannelCreatedEvent) MaxClients() int
func (*ChannelCreatedEvent) MaxClientsUnlimited ¶
func (event *ChannelCreatedEvent) MaxClientsUnlimited() bool
func (*ChannelCreatedEvent) MaxFamilyClients ¶
func (event *ChannelCreatedEvent) MaxFamilyClients() int
func (*ChannelCreatedEvent) MaxFamilyClientsInherited ¶
func (event *ChannelCreatedEvent) MaxFamilyClientsInherited() bool
func (*ChannelCreatedEvent) MaxFamilyclientsUnlimited ¶
func (event *ChannelCreatedEvent) MaxFamilyclientsUnlimited() bool
func (*ChannelCreatedEvent) Name ¶
func (event *ChannelCreatedEvent) Name() string
func (*ChannelCreatedEvent) NamePhonectic ¶
func (event *ChannelCreatedEvent) NamePhonectic() string
func (*ChannelCreatedEvent) NeededTalkPower ¶
func (event *ChannelCreatedEvent) NeededTalkPower() int
func (*ChannelCreatedEvent) Order ¶
func (event *ChannelCreatedEvent) Order() int
func (*ChannelCreatedEvent) ParentId ¶
func (event *ChannelCreatedEvent) ParentId() int
func (*ChannelCreatedEvent) Password ¶
func (event *ChannelCreatedEvent) Password() bool
func (*ChannelCreatedEvent) Permanent ¶
func (event *ChannelCreatedEvent) Permanent() bool
func (*ChannelCreatedEvent) SemiPermanent ¶
func (event *ChannelCreatedEvent) SemiPermanent() bool
func (*ChannelCreatedEvent) Topic ¶
func (event *ChannelCreatedEvent) Topic() string
type ChannelDeletedEvent ¶
type ChannelDeletedEvent struct { *InvokerHolder *ApiHolder // contains filtered or unexported fields }
func NewChannelDeletedEvent ¶
func NewChannelDeletedEvent() (event *ChannelDeletedEvent)
func (*ChannelDeletedEvent) ChannelId ¶
func (event *ChannelDeletedEvent) ChannelId() int
type ChannelDescriptionChangedEvent ¶
type ChannelDescriptionChangedEvent struct { *ApiHolder // contains filtered or unexported fields }
func NewChannelDescripionChangedEvent ¶
func NewChannelDescripionChangedEvent() (event *ChannelDescriptionChangedEvent)
func (*ChannelDescriptionChangedEvent) ChannelId ¶
func (event *ChannelDescriptionChangedEvent) ChannelId() int
type ChannelEditedEvent ¶
type ChannelEditedEvent struct { *InvokerHolder *ApiHolder // contains filtered or unexported fields }
func NewChannelEditedEvent ¶
func NewChannelEditedEvent() (event *ChannelEditedEvent)
func (*ChannelEditedEvent) ChannelId ¶
func (event *ChannelEditedEvent) ChannelId() int
func (*ChannelEditedEvent) ReasonId ¶
func (event *ChannelEditedEvent) ReasonId() int
type ChannelMovedEvent ¶
type ChannelMovedEvent struct { *ApiHolder *InvokerHolder // contains filtered or unexported fields }
func NewChannelMovedEvent ¶
func NewChannelMovedEvent() (event *ChannelMovedEvent)
func (*ChannelMovedEvent) ChannelId ¶
func (event *ChannelMovedEvent) ChannelId() int
func (*ChannelMovedEvent) ChannelParentId ¶
func (event *ChannelMovedEvent) ChannelParentId() int
func (*ChannelMovedEvent) Order ¶
func (event *ChannelMovedEvent) Order() int
func (*ChannelMovedEvent) ReasonId ¶
func (event *ChannelMovedEvent) ReasonId() int
type ChannelPasswordChangedEvent ¶
type ChannelPasswordChangedEvent struct { *ApiHolder // contains filtered or unexported fields }
func NewChannelPasswordChangedEvent ¶
func NewChannelPasswordChangedEvent() (event *ChannelPasswordChangedEvent)
func (*ChannelPasswordChangedEvent) Id ¶
func (event *ChannelPasswordChangedEvent) Id() int
type ClientJoinedEvent ¶
type ClientJoinedEvent struct { *ApiHolder // contains filtered or unexported fields }
func NewClientJoinedEvent ¶
func NewClientJoinedEvent() (event *ClientJoinedEvent)
func (*ClientJoinedEvent) Away ¶
func (event *ClientJoinedEvent) Away() bool
func (*ClientJoinedEvent) AwayMsg ¶
func (event *ClientJoinedEvent) AwayMsg() string
func (*ClientJoinedEvent) Badages ¶
func (event *ClientJoinedEvent) Badages() string
func (*ClientJoinedEvent) ChannelFromId ¶
func (event *ClientJoinedEvent) ChannelFromId() int
func (*ClientJoinedEvent) ChannelGroupId ¶
func (event *ClientJoinedEvent) ChannelGroupId() int
func (*ClientJoinedEvent) ChannelGroupInheritedChannelId ¶
func (event *ClientJoinedEvent) ChannelGroupInheritedChannelId() int
func (*ClientJoinedEvent) ChannelToId ¶
func (event *ClientJoinedEvent) ChannelToId() int
func (*ClientJoinedEvent) Country ¶
func (event *ClientJoinedEvent) Country() string
func (*ClientJoinedEvent) DatabaseId ¶
func (event *ClientJoinedEvent) DatabaseId() int
func (*ClientJoinedEvent) Description ¶
func (event *ClientJoinedEvent) Description() string
func (*ClientJoinedEvent) FlagAvatar ¶
func (event *ClientJoinedEvent) FlagAvatar() string
func (*ClientJoinedEvent) IconId ¶
func (event *ClientJoinedEvent) IconId() int
func (*ClientJoinedEvent) Id ¶
func (event *ClientJoinedEvent) Id() int
func (*ClientJoinedEvent) InputHardware ¶
func (event *ClientJoinedEvent) InputHardware() int
func (*ClientJoinedEvent) InputMuted ¶
func (event *ClientJoinedEvent) InputMuted() bool
func (*ClientJoinedEvent) IsChannelCommander ¶
func (event *ClientJoinedEvent) IsChannelCommander() bool
func (*ClientJoinedEvent) IsPrioritySpeaker ¶
func (event *ClientJoinedEvent) IsPrioritySpeaker() bool
func (*ClientJoinedEvent) IsRecording ¶
func (event *ClientJoinedEvent) IsRecording() bool
func (*ClientJoinedEvent) IsTalker ¶
func (event *ClientJoinedEvent) IsTalker() bool
func (*ClientJoinedEvent) NeededServerqueryViewPower ¶
func (event *ClientJoinedEvent) NeededServerqueryViewPower() int
func (*ClientJoinedEvent) Nick ¶
func (event *ClientJoinedEvent) Nick() string
func (*ClientJoinedEvent) NickPhonetic ¶
func (event *ClientJoinedEvent) NickPhonetic() string
func (*ClientJoinedEvent) OutputHardware ¶
func (event *ClientJoinedEvent) OutputHardware() int
func (*ClientJoinedEvent) OutputMuted ¶
func (event *ClientJoinedEvent) OutputMuted() bool
func (*ClientJoinedEvent) OutputOnlyMuted ¶
func (event *ClientJoinedEvent) OutputOnlyMuted() bool
func (*ClientJoinedEvent) ReasonId ¶
func (event *ClientJoinedEvent) ReasonId() int
func (*ClientJoinedEvent) ServerGroups ¶
func (event *ClientJoinedEvent) ServerGroups() []int
func (*ClientJoinedEvent) TalkPower ¶
func (event *ClientJoinedEvent) TalkPower() int
func (*ClientJoinedEvent) TalkRequestMsg ¶
func (event *ClientJoinedEvent) TalkRequestMsg() string
func (*ClientJoinedEvent) TalkRequested ¶
func (event *ClientJoinedEvent) TalkRequested() bool
func (*ClientJoinedEvent) UID ¶
func (event *ClientJoinedEvent) UID() string
func (*ClientJoinedEvent) UnreadMsgs ¶
func (event *ClientJoinedEvent) UnreadMsgs() int
type ClientLeftEvent ¶
type ClientLeftEvent struct { *InvokerHolder *ApiHolder // contains filtered or unexported fields }
func NewClientLeftEvent ¶
func NewClientLeftEvent() (event *ClientLeftEvent)
func (*ClientLeftEvent) Bantime ¶
func (event *ClientLeftEvent) Bantime() int
func (*ClientLeftEvent) ChannelFromId ¶
func (event *ClientLeftEvent) ChannelFromId() int
func (*ClientLeftEvent) ChannelToId ¶
func (event *ClientLeftEvent) ChannelToId() int
func (*ClientLeftEvent) Id ¶
func (event *ClientLeftEvent) Id() int
func (*ClientLeftEvent) ReasonId ¶
func (event *ClientLeftEvent) ReasonId() int
func (*ClientLeftEvent) ReasonMsg ¶
func (event *ClientLeftEvent) ReasonMsg() string
type ClientMovedEvent ¶
type ClientMovedEvent struct { *ApiHolder *InvokerHolder // contains filtered or unexported fields }
notifyclientmoved ctid=1 reasonid=4 invokerid=9 invokername=SpeedProg invokeruid=8qoQBRqUwyGvQfGc08OUFAarE6Q= reasonmsg=test clid=20
func NewClientMovedEvent ¶
func NewClientMovedEvent() (event *ClientMovedEvent)
func (*ClientMovedEvent) ChannelToId ¶
func (event *ClientMovedEvent) ChannelToId() int
func (*ClientMovedEvent) Ids ¶
func (event *ClientMovedEvent) Ids() []int
func (*ClientMovedEvent) ReasonId ¶
func (event *ClientMovedEvent) ReasonId() int
func (*ClientMovedEvent) ReasonMsg ¶
func (event *ClientMovedEvent) ReasonMsg() string
type Connectioninfo ¶
type Connectioninfo struct { ConnectionFiletransferBandwidthSent uint64 ConnectionFiletransferBandwidthReceived uint64 ConnectionFiletransferBytesSentTotal int ConnectionFiletransferBytesReceivedTotal int ConnectionPacketsSentTotal int ConnectionBytesSentTotal uint64 ConnectionPacketsReceivedTotal int ConnectionBytesReceivedTotal uint64 ConnectionBandwidthSentLastSecondTotal int ConnectionBandwidthSentLastMinuteTotal int ConnectionBandwidthReceivedLastSecondTotal int ConnectionBandwidthReceivedLastMinuteTotal int ConnectionConnectedTime int ConnectionPacketlossTotal float32 ConnectionPing float32 }
type HostInfo ¶
type HostInfo struct { Uptime uint64 TimestampUTC uint64 VirtualserverCount uint VirtualserverTotalMaxClients uint VirtualserverTotalClientsOnline uint VirtualserverTotalChannelsOnline uint FiletransferBandwidthSent uint64 FiletransferBandwidthReceived uint64 FiletransferBytesSentTotal uint64 FiletransferBytesReceivedTotal uint64 PacketsSentTotal uint64 BytesSentTotal uint64 PacketsReceivedTotal uint64 BytesReceivedTotal uint64 BandwidthSendLastSecond uint64 BandwidthSendLastMinute uint64 BandwidthReceivedLastSecond uint64 BandwidthReceivedLastMinute uint64 }
type InstanceInfo ¶
type InstanceInfo struct { DBVersion uint FtPort uint MaxDlBandwidth uint64 MaxUpTotalBandwidth uint64 GuestServerQueryGroup uint QueryFloodCommands uint QueryFloodTime uint QueryBanTime uint TmplSvrAdminGroup uint TmplSvrDefaultGroup uint TmplChAdminGroup uint TmplChDefaultGroup uint PermVersion uint PendingConPerIP uint }
type InvokerHolder ¶
type InvokerHolder struct {
// contains filtered or unexported fields
}
func (*InvokerHolder) InvokerId ¶
func (event *InvokerHolder) InvokerId() int
func (*InvokerHolder) InvokerName ¶
func (event *InvokerHolder) InvokerName() string
func (*InvokerHolder) InvokerUID ¶
func (event *InvokerHolder) InvokerUID() string
type Me ¶
type Me struct {
// contains filtered or unexported fields
}
func (*Me) DatabaseId ¶
func (*Me) OriginServerId ¶
func (*Me) VirtualServerId ¶
func (*Me) VirtualServerPort ¶
func (*Me) VirtualServerUniqueId ¶
type QueryError ¶
type ServerEditedEvent ¶
type ServerEditedEvent struct { *InvokerHolder *ApiHolder // contains filtered or unexported fields }
func NewServerEditedEvent ¶
func NewServerEditedEvent() (event *ServerEditedEvent)
func (*ServerEditedEvent) ReasonId ¶
func (event *ServerEditedEvent) ReasonId() int
func (*ServerEditedEvent) Values ¶
func (event *ServerEditedEvent) Values() string
type ServerListEntry ¶
type ServerListEntry struct { VSId int VSPort int VSStatus string VSClOnline int VSQClOnline int VSMaxCl int VSUTime uint64 VSName string VSAutostart bool VSMachinId int VSUID string }
VSMachinId == -1 => no machin id
type Serverinfo ¶
type Serverinfo struct { VirtualserverUniqueIdentifier string VirtualserverName string VirtualserverWelcomemessage string VirtualserverPlatform string VirtualserverVersion string VirtualserverMaxclients int VirtualserverPassword string VirtualserverClientsonline int VirtualserverChannelsonline int VirtualserverCreated bool VirtualserverUptime int VirtualserverCodecEncryptionMode int VirtualserverHostmessage string VirtualserverHostmessageMode int VirtualserverFilebase string VirtualserverDefaultServerGroup int VirtualserverDefaultChannelGroup int VirtualserverFlagPassword bool VirtualserverDefaultChannelAdminGroup int VirtualserverMaxDownloadTotalBandwidth uint64 VirtualserverMaxUploadTotalBandwidth uint64 VirtualserverComplainAutobanCount int VirtualserverComplainAutobanTime int VirtualserverComplainRemoveTime int VirtualserverMinClientsInChannelBeforeForcedSilence int VirtualserverPrioritySpeakerDimmModificator float32 VirtualserverId int VirtualserverAntifloodPointsTickReduce int VirtualserverAntifloodPointsNeededCommandBlock int VirtualserverAntifloodPointsNeededIpBlock int VirtualserverClientConnections int VirtualserverQueryClientConnections int VirtualserverQueryclientsonline uint64 VirtualserverDownloadQuota uint64 VirtualserverUploadQuota uint64 VirtualserverMonthBytesDownloaded int VirtualserverMonthBytesUploaded int VirtualserverTotalBytesDownloaded uint64 VirtualserverTotalBytesUploaded uint64 VirtualserverPort int VirtualserverAutostart bool VirtualserverMachineId int VirtualserverNeededIdentitySecurityLevel int VirtualserverLogClient bool VirtualserverLogQuery bool VirtualserverLogChannel bool VirtualserverLogPermissions bool VirtualserverLogServer bool VirtualserverLogFiletransfer bool VirtualserverMinClientVersion uint64 VirtualserverNamePhonetic string VirtualserverIconId int VirtualserverReservedSlots uint64 VirtualserverTotalPacketlossSpeech float32 VirtualserverTotalPacketlossKeepalive float32 VirtualserverTotalPacketlossControl float32 VirtualserverTotalPacketlossTotal float32 VirtualserverTotalPing float32 VirtualserverIp string VirtualserverWeblistEnabled bool VirtualserverAskForPrivilegekey bool VirtualserverChannelTempDeleteDelayDefault int VirtualserverStatus string ConnectionFiletransferBandwidthSent uint64 ConnectionFiletransferBandwidthReceived uint64 ConnectionFiletransferBytesSentTotal int ConnectionFiletransferBytesReceivedTotal int ConnectionPacketsSentSpeech int ConnectionBytesSentSpeech uint64 ConnectionPacketsReceivedSpeech int ConnectionBytesReceivedSpeech int ConnectionPacketsSentKeepalive int ConnectionBytesSentKeepalive int ConnectionPacketsReceivedKeepalive int ConnectionBytesReceivedKeepalive int ConnectionPacketsSentControl int ConnectionBytesSentControl int ConnectionPacketsReceivedControl int ConnectionBytesReceivedControl int ConnectionPacketsSentTotal int ConnectionBytesSentTotal uint64 ConnectionPacketsReceivedTotal int ConnectionBytesReceivedTotal uint64 ConnectionBandwidthSentLastSecondTotal int ConnectionBandwidthSentLastMinuteTotal int ConnectionBandwidthReceivedLastSecondTotal int ConnectionBandwidthReceivedLastMinuteTotal int }
type TS3Adapter ¶
type TS3Adapter struct { }
Implemts the TS3Listener interface All methods do nothing Can be embedded into own listeners to avoid needing to add all methods
func (*TS3Adapter) ChannelCreated ¶
func (obs *TS3Adapter) ChannelCreated(event *ChannelCreatedEvent)
func (*TS3Adapter) ChannelDeletedEvent ¶
func (obs *TS3Adapter) ChannelDeletedEvent(event *ChannelDeletedEvent)
func (*TS3Adapter) ChannelDescriptionChanged ¶
func (obs *TS3Adapter) ChannelDescriptionChanged(event *ChannelDescriptionChangedEvent)
func (*TS3Adapter) ChannelEdited ¶
func (obs *TS3Adapter) ChannelEdited(event *ChannelEditedEvent)
func (*TS3Adapter) ChannelMoved ¶
func (obs *TS3Adapter) ChannelMoved(event *ChannelMovedEvent)
func (*TS3Adapter) ChannelPasswordChanged ¶
func (obs *TS3Adapter) ChannelPasswordChanged(event *ChannelPasswordChangedEvent)
func (*TS3Adapter) ClientJoined ¶
func (obs *TS3Adapter) ClientJoined(event *ClientJoinedEvent)
func (*TS3Adapter) ClientLeft ¶
func (obs *TS3Adapter) ClientLeft(event *ClientLeftEvent)
func (*TS3Adapter) ClientMoved ¶
func (obs *TS3Adapter) ClientMoved(event *ClientMovedEvent)
func (*TS3Adapter) ServerEdited ¶
func (obs *TS3Adapter) ServerEdited(event *ServerEditedEvent)
func (*TS3Adapter) TextMessage ¶
func (obs *TS3Adapter) TextMessage(msg *TextMessageEvent)
func (*TS3Adapter) TokenUsed ¶
func (obs *TS3Adapter) TokenUsed(event *TokenUsedEvent)
type TS3Api ¶
type TS3Api struct {
// contains filtered or unexported fields
}
func New ¶
New creates a TS3Api, connecting to the given address. addr should looke like 127.0.0.1:10011. Starts the TS3 Query connection in an other routine. To wait for its ending you can use the given channel.
func (TS3Api) ClientMove ¶
Move client with id clid to channel with id cid.
func (TS3Api) Connectioninfo ¶
func (api TS3Api) Connectioninfo() (conInfo *Connectioninfo, qerr QueryError)
Connection information about the selected virtual server
func (TS3Api) DoCommand ¶
func (api TS3Api) DoCommand(cmd string) (answersList *list.List, err QueryError)
func (TS3Api) Hostinfo ¶
func (api TS3Api) Hostinfo() (info *HostInfo, qerr QueryError, err error)
information about the serverinstance like number of virtual servers, uptime ...
func (TS3Api) Instanceedit ¶
func (api TS3Api) Instanceedit(properties [][]string) (qerr QueryError)
Takes an array of 2 dimensinal arrays representing Serverinstance properties that are editable and the value to set. Valid Properties are found as constants starting with SERVERINSTANCE_ in ts3const.
func (TS3Api) Instanceinfo ¶
func (api TS3Api) Instanceinfo() (info *InstanceInfo, qerr QueryError, err error)
infromation about the instance like, file transfer port ...
func (TS3Api) Login ¶
func (api TS3Api) Login(user, password string) (qerr QueryError)
Login as user with password.
func (TS3Api) Logout ¶
func (api TS3Api) Logout() (qerr QueryError)
Logout. Logging out does not end the connection, you can login again afterwards.
func (TS3Api) Quit ¶
func (api TS3Api) Quit()
Send quit over the query connection. This causes the ts queryserver to end the connection. After using this you can not use this TS3Api object anymore.
func (TS3Api) RegisterEvent ¶
func (api TS3Api) RegisterEvent(event string, id int) (err error, qerr QueryError)
id is ignored for every event except channel id = 0 for channel, stands for all channels Events are: tokenused, textserver, textchannel, textprivate, channel, server
func (TS3Api) RegisterTS3Listener ¶
func (api TS3Api) RegisterTS3Listener(listener TS3Listener)
Register a TS3Listener.
func (TS3Api) SelectVirtualServer ¶
Select a virtualserver by id.
func (TS3Api) SendTextMessage ¶
func (api TS3Api) SendTextMessage(targetmode int, target int, msg string) (err error, qerr QueryError)
Send a textmessage to the given targetmode and target.
CLIENT = 1 : target is a client CHANNEL 2: target is a channel SERVER 3: target is a virtual server
func (TS3Api) ServerCreate ¶
func (api TS3Api) ServerCreate(name string, props [][]string) (sid int, port int, token string, qerr QueryError)
For properties appart from the server name, look in ts3const package
func (TS3Api) ServerDelete ¶
func (api TS3Api) ServerDelete(port int) (qerr QueryError)
delets a virtual server
func (TS3Api) ServerIdGetByPort ¶
func (api TS3Api) ServerIdGetByPort(port int) (id int, qerr QueryError)
get server id from port
func (TS3Api) ServerInfo ¶
func (api TS3Api) ServerInfo() (sInfo *Serverinfo, qerr QueryError)
Configuration information about the selected virtual server
func (TS3Api) ServerProcessStop ¶
func (api TS3Api) ServerProcessStop() (qerr QueryError)
Stops the server process, be carefull using this, you won't be able to start it again using query api because it is gone.
func (TS3Api) ServerStart ¶
func (api TS3Api) ServerStart(sid int) (qerr QueryError)
Starts the virtual server with the given sid
func (TS3Api) ServerStop ¶
func (api TS3Api) ServerStop(sid int) (qerr QueryError)
Stops the virtual server with the given sid
func (TS3Api) Serverlist ¶
func (api TS3Api) Serverlist(all bool, onlyoffline bool, uid bool) (serverlist list.List, qerr QueryError)
A list of virtual servers and informations about them Gives a list.List of struct ServerListEntry
func (TS3Api) UseById ¶
func (api TS3Api) UseById(sid int, virtual bool) (err error, qerr QueryError)
select a virtual server by id
func (TS3Api) UseByPort ¶
func (api TS3Api) UseByPort(port int, virtual bool) (qerr QueryError)
select a virtual server by port
func (TS3Api) Version ¶
func (api TS3Api) Version() (version string, build uint64, platform string, qerr QueryError)
server verion, build and platform
func (TS3Api) WhoAmI ¶
func (api TS3Api) WhoAmI() (client *Me, qerr QueryError)
Get informations about your self, like your id.
type TS3Listener ¶
type TS3Listener interface { ClientJoined(event *ClientJoinedEvent) ClientLeft(event *ClientLeftEvent) ServerEdited(event *ServerEditedEvent) ChannelDescriptionChanged(event *ChannelDescriptionChangedEvent) ChannelPasswordChanged(event *ChannelPasswordChangedEvent) ChannelMoved(event *ChannelMovedEvent) ChannelEdited(event *ChannelEditedEvent) ChannelCreated(event *ChannelCreatedEvent) ChannelDeletedEvent(event *ChannelDeletedEvent) ClientMoved(event *ClientMovedEvent) TextMessage(event *TextMessageEvent) TokenUsed(event *TokenUsedEvent) }
type TextMessageEvent ¶
type TextMessageEvent struct { *ApiHolder *InvokerHolder // contains filtered or unexported fields }
func NewTextMessageEvent ¶
func NewTextMessageEvent() (event *TextMessageEvent)
func (*TextMessageEvent) Msg ¶
func (event *TextMessageEvent) Msg() string
func (*TextMessageEvent) Target ¶
func (event *TextMessageEvent) Target() int
func (*TextMessageEvent) Targetmode ¶
func (event *TextMessageEvent) Targetmode() int
type TokenUsedEvent ¶
type TokenUsedEvent struct { *ApiHolder // contains filtered or unexported fields }
func NewTokenUsedEvent ¶
func NewTokenUsedEvent() (event *TokenUsedEvent)
func (*TokenUsedEvent) ClientDBId ¶
func (event *TokenUsedEvent) ClientDBId() int
func (*TokenUsedEvent) ClientId ¶
func (event *TokenUsedEvent) ClientId() int
func (*TokenUsedEvent) ClientUID ¶
func (event *TokenUsedEvent) ClientUID() string
func (*TokenUsedEvent) Token ¶
func (event *TokenUsedEvent) Token() string
func (*TokenUsedEvent) TokenChannel ¶
func (event *TokenUsedEvent) TokenChannel() int
func (*TokenUsedEvent) TokenGroup ¶
func (event *TokenUsedEvent) TokenGroup() int
func (*TokenUsedEvent) TokenType ¶
func (event *TokenUsedEvent) TokenType() int
0 Server Group, 1 Channel Group
Source Files ¶
- ApiHolder.go
- ChannelCreatedEvent.go
- ChannelDeletedEvent.go
- ChannelDescriptionChangedEvent.go
- ChannelEditedEvent.go
- ChannelMovedEvent.go
- ChannelPasswordChangedEvent.go
- ClientJoinedEvent.go
- ClientLeftEvent.go
- ClientMovedEvent.go
- Connectioninfo.go
- Event.go
- EventConstants.go
- InvokerHolder.go
- Me.go
- ServerEditedEvent.go
- ServerListEntry.go
- Serverinfo.go
- TS3Adapter.go
- TS3ApiExportedMethods.go
- TS3Connection.go
- TS3Listener.go
- TextMessageEvent.go
- TokenUsedEvent.go
- ts3api.go