C# Класс MumbleSharp.BasicMumbleProtocol

A basic mumble protocol which handles events from the server - override the individual handler methods to replace/extend the default behaviour

Наследование: IMumbleProtocol

Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство	Тип	Описание
ChannelDictionary	Channel>.ConcurrentDictionary
UserDictionary	User>.ConcurrentDictionary

Открытые методы

Метод	Описание
BasicMumbleProtocol ( ) : System
ChannelRemove ( ChannelRemove channelRemove ) : void	Server has removed a channel
ChannelState ( ChannelState channelState ) : void	Server has changed some detail of a channel
Close ( ) : void
CodecVersion ( CodecVersion codecVersion ) : void
ContextAction ( ContextAction contextAction ) : void
ContextActionModify ( MumbleProto.ContextActionModify contextActionModify ) : void
EncodedVoice ( byte data, uint userId, long sequence, IVoiceCodec codec, SpeechTarget target ) : void	Received a voice packet from the server
GetCodec ( uint session, SpeechCodecs codec ) : IVoiceCodec	Get a voice decoder for the specified user/codec combination
Initialise ( MumbleConnection connection ) : void	Associates this protocol with an opening mumble connection
PermissionQuery ( PermissionQuery permissionQuery ) : void
Ping ( Ping ping ) : void	Received a ping over the TCP connection
SelectCertificate ( object sender, string targetHost, X509CertificateCollection localCertificates, X509Certificate remoteCertificate, string acceptableIssuers ) : X509Certificate
SendVoice ( ArraySegment pcm, SpeechTarget target, uint targetId ) : void
SendVoiceStop ( ) : void
ServerConfig ( ServerConfig serverConfig ) : void	Some detail of the server configuration has changed
ServerSync ( ServerSync serverSync ) : void	Initial connection to the server
SuggestConfig ( SuggestConfig config ) : void
TextMessage ( TextMessage textMessage ) : void	Received a text message from the server
UdpPing ( byte packet ) : void	Received a UDP ping from the server
UserList ( UserList userList ) : void
UserRemove ( UserRemove userRemove ) : void	A user has been removed from the server (left, kicked or banned)
UserState ( UserState userState ) : void	Server has changed some detail of a user
ValidateCertificate ( object sender, X509Certificate certificate, X509Chain chain, SslPolicyErrors errors ) : bool	Validate the certificate the server sends for itself. By default this will acept all certificates
Version ( MumbleProto.Version version ) : void	Server has sent a version update

Защищенные методы

Метод	Описание
ChannelJoined ( MumbleSharp.Model.Channel channel ) : void
ChannelLeft ( MumbleSharp.Model.Channel channel ) : void
ChannelMessageReceived ( MumbleSharp.Model.ChannelMessage message ) : void
PersonalMessageReceived ( MumbleSharp.Model.PersonalMessage message ) : void
UserJoined ( MumbleSharp.Model.User user ) : void
UserLeft ( MumbleSharp.Model.User user ) : void

Приватные методы

Метод	Описание
EncodingThreadEntry ( ) : void

Описание методов

BasicMumbleProtocol() публичный Метод

public BasicMumbleProtocol ( ) : System
Результат	System

ChannelJoined() защищенный Метод

protected ChannelJoined ( MumbleSharp.Model.Channel channel ) : void
channel	MumbleSharp.Model.Channel
Результат	void

ChannelLeft() защищенный Метод

protected ChannelLeft ( MumbleSharp.Model.Channel channel ) : void
channel	MumbleSharp.Model.Channel
Результат	void

ChannelMessageReceived() защищенный Метод

protected ChannelMessageReceived ( MumbleSharp.Model.ChannelMessage message ) : void
message	MumbleSharp.Model.ChannelMessage
Результат	void

ChannelRemove() публичный Метод

Server has removed a channel

public ChannelRemove ( ChannelRemove channelRemove ) : void
channelRemove	ChannelRemove
Результат	void

ChannelState() публичный Метод

Server has changed some detail of a channel

public ChannelState ( ChannelState channelState ) : void
channelState	ChannelState
Результат	void

Close() публичный Метод

public Close ( ) : void
Результат	void

CodecVersion() публичный Метод

public CodecVersion ( CodecVersion codecVersion ) : void
codecVersion	CodecVersion
Результат	void

ContextAction() публичный Метод

public ContextAction ( ContextAction contextAction ) : void
contextAction	ContextAction
Результат	void

ContextActionModify() публичный Метод

public ContextActionModify ( MumbleProto.ContextActionModify contextActionModify ) : void
contextActionModify	MumbleProto.ContextActionModify
Результат	void

EncodedVoice() публичный Метод

Received a voice packet from the server

public EncodedVoice ( byte data, uint userId, long sequence, IVoiceCodec codec, SpeechTarget target ) : void
data	byte
userId	uint
sequence	long
codec	IVoiceCodec
target	SpeechTarget
Результат	void

GetCodec() публичный Метод

Get a voice decoder for the specified user/codec combination

public GetCodec ( uint session, SpeechCodecs codec ) : IVoiceCodec
session	uint
codec	SpeechCodecs
Результат	IVoiceCodec

Initialise() публичный Метод

Associates this protocol with an opening mumble connection

public Initialise ( MumbleConnection connection ) : void
connection	MumbleConnection
Результат	void

PermissionQuery() публичный Метод

public PermissionQuery ( PermissionQuery permissionQuery ) : void
permissionQuery	PermissionQuery
Результат	void

PersonalMessageReceived() защищенный Метод

protected PersonalMessageReceived ( MumbleSharp.Model.PersonalMessage message ) : void
message	MumbleSharp.Model.PersonalMessage
Результат	void

Ping() публичный Метод

Received a ping over the TCP connection

public Ping ( Ping ping ) : void
ping	Ping
Результат	void

SelectCertificate() публичный Метод

public SelectCertificate ( object sender, string targetHost, X509CertificateCollection localCertificates, X509Certificate remoteCertificate, string acceptableIssuers ) : X509Certificate
sender	object
targetHost	string
localCertificates	System.Security.Cryptography.X509Certificates.X509CertificateCollection
remoteCertificate	System.Security.Cryptography.X509Certificates.X509Certificate
acceptableIssuers	string
Результат	System.Security.Cryptography.X509Certificates.X509Certificate

SendVoice() публичный Метод

public SendVoice ( ArraySegment pcm, SpeechTarget target, uint targetId ) : void
pcm	ArraySegment
target	SpeechTarget
targetId	uint
Результат	void

SendVoiceStop() публичный Метод

public SendVoiceStop ( ) : void
Результат	void

ServerConfig() публичный Метод

Some detail of the server configuration has changed

public ServerConfig ( ServerConfig serverConfig ) : void
serverConfig	ServerConfig
Результат	void

ServerSync() публичный Метод

Initial connection to the server

public ServerSync ( ServerSync serverSync ) : void
serverSync	ServerSync
Результат	void

SuggestConfig() публичный Метод

public SuggestConfig ( SuggestConfig config ) : void
config	SuggestConfig
Результат	void

TextMessage() публичный Метод

Received a text message from the server

public TextMessage ( TextMessage textMessage ) : void
textMessage	TextMessage
Результат	void

UdpPing() публичный Метод

Received a UDP ping from the server

public UdpPing ( byte packet ) : void
packet	byte
Результат	void

UserJoined() защищенный Метод

protected UserJoined ( MumbleSharp.Model.User user ) : void
user	MumbleSharp.Model.User
Результат	void

UserLeft() защищенный Метод

protected UserLeft ( MumbleSharp.Model.User user ) : void
user	MumbleSharp.Model.User
Результат	void

UserList() публичный Метод

public UserList ( UserList userList ) : void
userList	UserList
Результат	void

UserRemove() публичный Метод

A user has been removed from the server (left, kicked or banned)

public UserRemove ( UserRemove userRemove ) : void
userRemove	UserRemove
Результат	void

UserState() публичный Метод

Server has changed some detail of a user

public UserState ( UserState userState ) : void
userState	UserState
Результат	void

ValidateCertificate() публичный Метод

Validate the certificate the server sends for itself. By default this will acept *all* certificates

public ValidateCertificate ( object sender, X509Certificate certificate, X509Chain chain, SslPolicyErrors errors ) : bool
sender	object
certificate	System.Security.Cryptography.X509Certificates.X509Certificate
chain	System.Security.Cryptography.X509Certificates.X509Chain
errors	SslPolicyErrors
Результат	bool

Version() публичный Метод

Server has sent a version update

public Version ( MumbleProto.Version version ) : void
version	MumbleProto.Version
Результат	void

Описание свойств

ChannelDictionary защищенное свойство

protected ConcurrentDictionary ChannelDictionary
Результат	Channel>.ConcurrentDictionary

UserDictionary защищенное свойство

protected ConcurrentDictionary UserDictionary
Результат	User>.ConcurrentDictionary