Photon.NameServer.ClientPeer Class Reference

Inheritance diagram for Photon.NameServer.ClientPeer:

Public Member Functions
	ClientPeer (PhotonApp application, InitRequest initRequest)
virtual void	OnCustomAuthenticationError (ErrorCode errorCode, string debugMessage, IAuthenticateRequest authenticateRequest, SendParameters sendParameters)
virtual void	OnCustomAuthenticationResult (CustomAuthenticationResult customAuthResult, IAuthenticateRequest authenticateRequest, SendParameters sendParameters, object state)
void	OnAuthTimeout (byte authOpCode)
Public Member Functions inherited from Photon.SocketServer.ClientPeer
void	Trace (bool enabled, string tag)
new void	GetTraceStatus (out int traceOptions, out int enableOptions, out string tag)
void	TraceIfEnabledInConnect (string tag)
	Starts tracing if client connected with PeerId 0xFFFE to signal it wants to be traced (e.g. reconnect after an unexpected disconnect) More...
Public Member Functions inherited from Photon.SocketServer.PeerBase
void	Initialize (InitRequest initRequest)
override string	ToString ()
void	Disconnect (int disconnectError=ErrorCodes.Ok)
	Closes the connection. More...
void	AbortConnection ()
	Forces the connection to close immediately. Should only be used if "Disconnect" does not lead to a clean connection shutdown, e.g. in case of an overloaded connection. More...
void	Flush ()
	Flushes all pending data to the socket. More...
byte[]	InitializeEncryption (byte[] otherPartyPublicKey)
	Initializes the peer to receive and send encrypted operations with EncryptionMethod.Sha256Pkcs7. More...
byte[]	InitializeEncryption (byte[] otherPartyPublicKey, EncryptionMethod mode)
	Initializes the peer to receive and send encrypted operations. More...
bool	SetupEncryption (EncryptionData encryptionData, byte channelCount, out short errorCode, out string errorMsg)
SendResult	SendEvent (IEventData eventData, SendParameters sendParameters)
	Sends an IEventData object to the client. More...
SendResult	SendMessage (object message, SendParameters sendParameters)
SendResult	SendOperationResponse (OperationResponse operationResponse, SendParameters sendParameters)
	Sends the operation response to the client. More...
SendResult	SendDisconnectMessage (DisconnectMessage message, SendParameters sendParameters, int disconnectDelay=DefaultDisconnectInterval)
void	GetStats (out int roundTripTime, out int roundTripTimeVariance, out int numFailures)
void	SetDebugString (string message)
string	GetDebugString ()
virtual string	GetHistograms ()
SendResult	SendEventAndDisconnect (IEventData eventData, SendParameters sendParameters, int disconnectDelay=DefaultDisconnectInterval, int disconnectCode=ErrorCodes.Ok)
SendResult	SendMessageAndDisconnect (object message, SendParameters sendParameters, int disconnectDelay=DefaultDisconnectInterval, int disconnectCode=ErrorCodes.Ok)
SendResult	SendOperationResponseAndDisconnect (OperationResponse operationResponse, SendParameters sendParameters, int disconnectDelay=DefaultDisconnectInterval)
	Sends the operation response to the client. More...
void	ScheduleDisconnect (int disconnectError, int delay)
	Schedules disconnect for peer. After this call data will be neither accepted from nor sent to client one of use cases is next: send error info and schedule for disconnect. this will give a chance to error information to reach a client More...
int	GetLastTouch ()
void	SetPrivateCustomTypeCache (CustomTypeCache cache)
	Sets private custom type cache. It is supposed to be used together with plugins. In other case Protocol.TryRegisterCustomType should be used More...
void	SetInboundController (InboundController controller)
void	Dispose ()
	Disposes the peer. More...
void	Trace (bool enabled, object tag)

Public Attributes
IFiber	Fiber => this.RequestFiber
Public Attributes inherited from Photon.SocketServer.PeerBase
bool	Connected => this.ConnectionState == ConnectionState.Connected || this.connectionState == ConnectionState.ScheduledForDisconnect
	Gets a value indicating whether this PeerBase instance is connected. More...
int	ConnectionId => this.UnmanagedPeer.GetConnectionID()
	Gets the connection id. More...
bool	IsConnectionSecure => this.datagramEncryptionUsed || this.NetworkProtocol == NetworkProtocolType.SecureWebSocket
bool	Disposed => this.ConnectionState == ConnectionState.Disposed
	Gets a value indicating whether the peer was disposed. More...
bool	ScheduledForDisconnect => this.connectionState == ConnectionState.ScheduledForDisconnect
IPAddress	LocalIPAddress => string.IsNullOrEmpty(this.LocalIP) ? IPAddress.None : IPAddress.Parse(this.LocalIP)
	Gets the IP Address the client connects to. More...
IPAddress	RemoteIPAddress => string.IsNullOrEmpty(this.RemoteIP) ? IPAddress.None : IPAddress.Parse(this.RemoteIP)
	Gets the client's remote IP address. More...
IFiber	RequestFiber => this.requestFiber
	Gets fiber for incoming messages. More...
bool	LocalIPAddressIsIPv6 => this.LocalIPAddress.AddressFamily == AddressFamily.InterNetworkV6
	If true connection is using a server IPv6 endpoint. More...
bool	IsIPv6ToIPv4Bridged => this.SourceUsingIPv6 && this.LocalIPAddress.AddressFamily != AddressFamily.InterNetworkV6
	If true the client is being bridged (DNS64+NAT64), also SourceUsingIPv6. More...
ProtocolType	ProtocolType => this.protocol.ProtocolType

Protected Member Functions
override void	OnDisconnect (int reasonCode, string reasonDetail)
	The connection was closed. More...
override void	OnOperationRequest (OperationRequest operationRequest, SendParameters sendParameters)
	Incoming OperationRequests are handled here. This method is being enqueued on the PeerBase.RequestFiber. More...
OperationResponse	HandleAuthOnceRequest (OperationRequest operationRequest, SendParameters sendParameters)
OperationResponse	HandleAuthenticateRequest (OperationRequest operationRequest, SendParameters sendParameters)
virtual OperationResponse	HandleAuthenticateRequest (AuthenticateRequest authenticateRequest, SendParameters sendParameters, NetworkProtocolType endpointProtocol)
void	HandleInvalidOperation (Operation operation, SendParameters sendParameters)
void	HandleUnknownOperationCode (OperationRequest operationRequest, SendParameters sendParameters)
virtual void	DoCustomAuthenticationError (ErrorCode errorCode, string debugMessage, IAuthenticateRequest authenticateRequest, SendParameters sendParameters)
virtual void	DoCustomAuthenticationResult (CustomAuthenticationResult customAuthResult, IAuthenticateRequest authenticateRequest, SendParameters sendParameters, AuthSettings authSettings)
virtual void	HandleCustomAuthenticateResult (CustomAuthenticationResult customAuthResult, IAuthenticateRequest authenticateRequest, SendParameters sendParameters, AuthSettings authSettings)
void	SendInternalErrorResponse (OperationRequest operationRequest, SendParameters sendParameters, string msg)
int	GetDisconnectTime ()
int	GetDisconnectTime (int minDisconnectTime, int maxDisconnectTime)
Protected Member Functions inherited from Photon.SocketServer.ClientPeer
	ClientPeer (InitRequest initRequest)
Protected Member Functions inherited from Photon.SocketServer.PeerBase
virtual SendResult	SendData (byte[] data, SendParameters sendParameters)
	Sends bytes to the client. More...
virtual void	OnReceive (byte[] data, SendParameters sendParameters)
	Invoked if incoming data was received for the peer. More...
void	OnMessageInternal (object message, SendParameters sendParameters)
void	OnOperationRequestInternal (OperationRequest operationRequest, SendParameters sendParameters)
virtual void	Dispose (bool disposing)
	Disposes the internal fibers. More...
virtual void	OnSendBufferEmpty ()
	The default behavior of OnSendBufferFull is to disconnect the client. If this behavior is changed (override) the inheritor can pause sending until OnSendBufferEmpty is called. More...
virtual void	OnDeserializationError (byte[] data, RtsMessageType msgType, string debugMessage, short errorCode=ErrorCodes.UnexpectedData, byte opCode=0, Exception exception=null)
	This method is called if incoming data has an unexpected format. Per default this method disconnects the client. Override to change this behavior. More...
OperationRequest	ParseOperationRequest (byte[] data, SendParameters sendParameters)
OperationRequest	ParseInternalOperationRequest (byte[] data, SendParameters sendParameters)
object	ParseMessage (byte[] data, SendParameters sendParameters)
byte[]	ParseRawMessage (byte[] data, SendParameters sendParameters)
void	HandleParseError (byte[] data, SendParameters sendParameters, Exception exception, string errorMsg, short errorCode, RtsMessageType msgType, byte operationCode=0)
void	GetTraceStatus (out int traceOptions, out int enableOptions, out string tag)
void	DisconnectAfterSend (int disconnectCode, int disconnectDelay, SendResult result)
virtual void	OnEncryptionQueueOverload (EncryptionQueueFailureParams failureParams)

Static Protected Member Functions
static Dictionary< byte, object >	GetEncryptionData (AuthenticationToken unencryptedToken)
static byte	GetAuthOpCode (bool authOnce)
Static Protected Member Functions inherited from Photon.SocketServer.PeerBase
static bool	NeedSendErrorLog (SendResult sendResult)

Protected Attributes
readonly PhotonApp	application
string	authenticatedApplicationId
bool	authOnceUsed
readonly int	MinDisconnectTime = Settings.Default.MinDisconnectTime
readonly int	MaxDisconnectTime = Settings.Default.MaxDisconnectTime
int	NumberAuthRequests
int	MaxNumberAuthRequests = 3
Protected Attributes inherited from Photon.SocketServer.PeerBase
readonly object	SyncRoot = new object()
	object for synchronization More...
CustomTypeCache	privateCustomTypeCache
PeerMetaDataContext	metaDataContext

Static Protected Attributes
static readonly LogCountGuard	customAuthIsNotSetupLogGuard = new LogCountGuard(new TimeSpan(0, 0, 1))
Static Protected Attributes inherited from Photon.SocketServer.PeerBase
static readonly ILogger	sendErrorLog = LogManager.GetLogger("Photon.ErrorLog.PeerSendError")

Properties
string	UserId [get, set]
IDisposable	AuthTimeoutTimer [get, set]
Properties inherited from Photon.SocketServer.PeerBase
ConnectionState	ConnectionState [get, set]
	Gets the ConnectionState for this instance. More...
string	LocalIP [get]
	Gets the IP the client connects to. More...
int	LocalPort [get]
	Gets the port the client connects to. More...
NetworkProtocolType	NetworkProtocol [get]
	Gets the network protocol type used by the peer. More...
IRpcProtocol	Protocol [get, set]
	Gets the used IRpcProtocol protocol. More...
string	RemoteIP [get]
	Gets the client's remote IP address. More...
int	RemotePort [get]
	Gets the port the client connects from. More...
int	RoundTripTime [get, protected set]
	Gets the last round trip time for this peer. More...
int	RoundTripTimeVariance [get, protected set]
	Gets the last round trip time variance for this peer. More...
int	NumFailures [get, protected set]
bool	SourceUsingIPv6 [get]
	If true the peer is using IPv6 to connect to the server, if the server endpoint used is not IPv6 (LocalIPAddressIsIPv6) it means the client is being bridged (DNS64+NAT64), also IsIPv6ToIPv4Bridged. More...
bool	ClientUsingDebugLib [get]
byte	SdkId [get]
byte	PlatformId [get]
Version	ClientVersion [get, protected set]
DateTime	CreationTime = DateTime.Now [get]
PeerType	PeerType [get]
	Under laying native peer type More...
InboundController	PrivateInboundController [get]
int	LastErrorCode [get]
	last error code that we was sent/set though this peer More...
Properties inherited from Photon.Common.Authentication.ICustomAuthPeer
int	ConnectionId [get]
string	UserId [get, set]
Properties inherited from Photon.Common.Authentication.IAuthTimeoutCheckerClient
IDisposable	AuthTimeoutTimer [get, set]
IFiber	Fiber [get]

Additional Inherited Members
Static Public Attributes inherited from Photon.SocketServer.PeerBase
const int	DefaultDisconnectInterval = 5_000

Constructor & Destructor Documentation

ClientPeer()

Photon.NameServer.ClientPeer.ClientPeer ( PhotonApp  application, InitRequest  initRequest  )

inline

Member Function Documentation

DoCustomAuthenticationError()

virtual void Photon.NameServer.ClientPeer.DoCustomAuthenticationError ( ErrorCode  errorCode, string  debugMessage, IAuthenticateRequest  authenticateRequest, SendParameters  sendParameters  )

inlineprotectedvirtual

DoCustomAuthenticationResult()

virtual void Photon.NameServer.ClientPeer.DoCustomAuthenticationResult ( CustomAuthenticationResult  customAuthResult, IAuthenticateRequest  authenticateRequest, SendParameters  sendParameters, AuthSettings  authSettings  )

inlineprotectedvirtual

GetAuthOpCode()

static byte Photon.NameServer.ClientPeer.GetAuthOpCode ( bool  authOnce )

inlinestaticprotected

GetDisconnectTime() [1/2]

int Photon.NameServer.ClientPeer.GetDisconnectTime ( )

inlineprotected

GetDisconnectTime() [2/2]

int Photon.NameServer.ClientPeer.GetDisconnectTime ( int  minDisconnectTime, int  maxDisconnectTime  )

inlineprotected

GetEncryptionData()

static Dictionary<byte, object> Photon.NameServer.ClientPeer.GetEncryptionData ( AuthenticationToken  unencryptedToken )

inlinestaticprotected

HandleAuthenticateRequest() [1/2]

virtual OperationResponse Photon.NameServer.ClientPeer.HandleAuthenticateRequest ( AuthenticateRequest  authenticateRequest, SendParameters  sendParameters, NetworkProtocolType  endpointProtocol  )

inlineprotectedvirtual

HandleAuthenticateRequest() [2/2]

OperationResponse Photon.NameServer.ClientPeer.HandleAuthenticateRequest ( OperationRequest  operationRequest, SendParameters  sendParameters  )

inlineprotected

HandleAuthOnceRequest()

OperationResponse Photon.NameServer.ClientPeer.HandleAuthOnceRequest ( OperationRequest  operationRequest, SendParameters  sendParameters  )

inlineprotected

HandleCustomAuthenticateResult()

virtual void Photon.NameServer.ClientPeer.HandleCustomAuthenticateResult ( CustomAuthenticationResult  customAuthResult, IAuthenticateRequest  authenticateRequest, SendParameters  sendParameters, AuthSettings  authSettings  )

inlineprotectedvirtual

HandleInvalidOperation()

void Photon.NameServer.ClientPeer.HandleInvalidOperation ( Operation  operation, SendParameters  sendParameters  )

inlineprotected

HandleUnknownOperationCode()

void Photon.NameServer.ClientPeer.HandleUnknownOperationCode ( OperationRequest  operationRequest, SendParameters  sendParameters  )

inlineprotected

OnAuthTimeout()

void Photon.NameServer.ClientPeer.OnAuthTimeout ( byte  authOpCode )

inline

Implements Photon.Common.Authentication.IAuthTimeoutCheckerClient.

OnCustomAuthenticationError()

virtual void Photon.NameServer.ClientPeer.OnCustomAuthenticationError ( ErrorCode  errorCode, string  debugMessage, IAuthenticateRequest  authenticateRequest, SendParameters  sendParameters  )

inlinevirtual

Implements Photon.Common.Authentication.ICustomAuthPeer.

OnCustomAuthenticationResult()

virtual void Photon.NameServer.ClientPeer.OnCustomAuthenticationResult ( CustomAuthenticationResult  customAuthResult, IAuthenticateRequest  authenticateRequest, SendParameters  sendParameters, object  state  )

inlinevirtual

Implements Photon.Common.Authentication.ICustomAuthPeer.

OnDisconnect()

override void Photon.NameServer.ClientPeer.OnDisconnect ( int  reasonCode, string  reasonDetail  )

inlineprotectedvirtual

The connection was closed.

Implements Photon.SocketServer.PeerBase.

OnOperationRequest()

override void Photon.NameServer.ClientPeer.OnOperationRequest ( OperationRequest  operationRequest, SendParameters  sendParameters  )

inlineprotectedvirtual

Incoming OperationRequests are handled here. This method is being enqueued on the PeerBase.RequestFiber.

Parameters

operationRequest	The operation Request.
sendParameters	The send parameters.

Implements Photon.SocketServer.PeerBase.

SendInternalErrorResponse()

void Photon.NameServer.ClientPeer.SendInternalErrorResponse ( OperationRequest  operationRequest, SendParameters  sendParameters, string  msg  )

inlineprotected

Member Data Documentation

application

readonly PhotonApp Photon.NameServer.ClientPeer.application

protected

authenticatedApplicationId

string Photon.NameServer.ClientPeer.authenticatedApplicationId

protected

authOnceUsed

bool Photon.NameServer.ClientPeer.authOnceUsed

protected

customAuthIsNotSetupLogGuard

readonly LogCountGuard Photon.NameServer.ClientPeer.customAuthIsNotSetupLogGuard = new LogCountGuard(new TimeSpan(0, 0, 1))

staticprotected

Fiber

IFiber Photon.NameServer.ClientPeer.Fiber => this.RequestFiber

MaxDisconnectTime

readonly int Photon.NameServer.ClientPeer.MaxDisconnectTime = Settings.Default.MaxDisconnectTime

protected

MaxNumberAuthRequests

int Photon.NameServer.ClientPeer.MaxNumberAuthRequests = 3

protected

MinDisconnectTime

readonly int Photon.NameServer.ClientPeer.MinDisconnectTime = Settings.Default.MinDisconnectTime

protected

NumberAuthRequests

int Photon.NameServer.ClientPeer.NumberAuthRequests

protected

Property Documentation

AuthTimeoutTimer

IDisposable Photon.NameServer.ClientPeer.AuthTimeoutTimer

getset

UserId

string Photon.NameServer.ClientPeer.UserId

getset