Photon Server API
Public Member Functions | Public Attributes | Protected Member Functions | Properties | List of all members
Photon.LoadBalancing.LoadShedding.LatencyMonitor Class Reference
Inheritance diagram for Photon.LoadBalancing.LoadShedding.LatencyMonitor:
Photon.SocketServer.ServerToServer.S2SPeerBase Photon.LoadBalancing.LoadShedding.ILatencyMonitor Photon.SocketServer.PeerBase

Public Member Functions

 LatencyMonitor (GameApplication application, IRpcProtocol protocol, IPhotonPeer nativePeer, byte operationCode, int maxHistoryLength, int intervalMs, WorkloadController workloadController)
 
- Public Member Functions inherited from Photon.SocketServer.ServerToServer.S2SPeerBase
SendResult InitializeEncryption ()
 Initializes the peer to receive and send encrypted operations. More...
 
SendResult SendOperationRequest (OperationRequest operationRequest, SendParameters sendParameters)
 Sends an operation request. More...
 
- Public Member Functions inherited from Photon.SocketServer.PeerBase
void Initialize (InitRequest initRequest)
 
override string ToString ()
 
void Disconnect ()
 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...
 
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...
 
void GetStats (out int roundTripTime, out int roundTripTimeVariance, out int numFailures)
 
void SetDebugString (string message)
 
int GetLastTouch ()
 
void SetPrivateCustomTypeCache (CustomTypeCache cache)
 Sets private custom type cache. It is supposed to be used together with plugins. In other case Proptocol.TryRegisterCustomType should be used More...
 
void Dispose ()
 Disposes the peer. More...
 

Public Attributes

readonly GameApplication Application
 

Protected Member Functions

override void Dispose (bool disposing)
 Disposes the internal fibers. More...
 
override void OnDisconnect (DisconnectReason reasonCode, string reasonDetail)
 The connection was closed. More...
 
override void OnEvent (IEventData eventData, SendParameters sendParameters)
 Called when an EventData was received. More...
 
override void OnOperationRequest (OperationRequest operationRequest, SendParameters sendParameters)
 Incoming OperationRequests are handled here. This method is being enqueued on the PeerBase.RequestFiber. More...
 
override void OnOperationResponse (OperationResponse operationResponse, SendParameters sendParameters)
 Called when an OperationResponse was received. More...
 
- Protected Member Functions inherited from Photon.SocketServer.ServerToServer.S2SPeerBase
 S2SPeerBase (InitResponse response)
 Initializes a new instance of the S2SPeerBase class. More...
 
override void OnReceive (byte[] data, SendParameters sendParameters)
 Invoked if incoming data was received for the peer. More...
 
virtual void OnInitializeEcryptionCompleted (short resultCode, string debugMessage)
 Invoked if an initialize encryption request was completed. More...
 
- Protected Member Functions inherited from Photon.SocketServer.PeerBase
virtual SendResult SendData (byte[] data, SendParameters sendParameters)
 Sends bytes to the client. 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 OnUnexpectedDataReceived (byte[] data, string debugMessage)
 This method is called if incoming data has an unexpected format. Per default this method disconnects the client. Override to change this behavior. More...
 

Properties

int AverageLatencyMs [get]
 
int LastLatencyMs [get]
 
- Properties inherited from Photon.SocketServer.PeerBase
ConnectionState ConnectionState [get, set]
 Gets the ConnectionState for this instance. More...
 
bool Connected [get]
 Gets a value indicating whether this PeerBase instance is connected. More...
 
int ConnectionId [get]
 Gets the connection id. More...
 
bool Disposed [get]
 Gets a value indicating whether the peer was disposed. More...
 
string LocalIP [get]
 Gets the IP the client connects to. More...
 
IPAddress LocalIPAddress [get]
 Gets the IP Address 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...
 
IPAddress RemoteIPAddress [get]
 Gets the client's remote IP address. More...
 
int RemotePort [get]
 Gets the port the client connects from. More...
 
IFiber RequestFiber [get]
 Gets fiber for incoming messages. 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 LocalIPAddressIsIPv6 [get]
 If true connection is using a server IPv6 endpoint. More...
 
bool SourceUsingIPv6 [get]
 If true the peer is using IPv6 to connect to the server, if the server enpoint used is not IPv6 (LocalIPAddressIsIPv6) it means the client is beeing bridged (DNS64+NAT64), also IsIPv6ToIPv4Bridged. More...
 
bool IsIPv6ToIPv4Bridged [get]
 If true the client is beeing bridged (DNS64+NAT64), also SourceUsingIPv6. More...
 
- Properties inherited from Photon.LoadBalancing.LoadShedding.ILatencyMonitor
int AverageLatencyMs [get]
 

Constructor & Destructor Documentation

Photon.LoadBalancing.LoadShedding.LatencyMonitor.LatencyMonitor ( GameApplication  application,
IRpcProtocol  protocol,
IPhotonPeer  nativePeer,
byte  operationCode,
int  maxHistoryLength,
int  intervalMs,
WorkloadController  workloadController 
)
inline

Member Function Documentation

override void Photon.LoadBalancing.LoadShedding.LatencyMonitor.Dispose ( bool  disposing)
inlineprotectedvirtual

Disposes the internal fibers.

Parameters
disposingTrue if called from Dispose().

Reimplemented from Photon.SocketServer.PeerBase.

override void Photon.LoadBalancing.LoadShedding.LatencyMonitor.OnDisconnect ( DisconnectReason  reasonCode,
string  reasonDetail 
)
inlineprotectedvirtual

The connection was closed.

Implements Photon.SocketServer.PeerBase.

override void Photon.LoadBalancing.LoadShedding.LatencyMonitor.OnEvent ( IEventData  eventData,
SendParameters  sendParameters 
)
inlineprotectedvirtual

Called when an EventData was received.

Parameters
eventDataThe event data.
sendParametersThe send Parameters.

Implements Photon.SocketServer.ServerToServer.S2SPeerBase.

override void Photon.LoadBalancing.LoadShedding.LatencyMonitor.OnOperationRequest ( OperationRequest  operationRequest,
SendParameters  sendParameters 
)
inlineprotectedvirtual

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

Parameters
operationRequestThe operation Request.
sendParametersThe send parameters.

Implements Photon.SocketServer.PeerBase.

override void Photon.LoadBalancing.LoadShedding.LatencyMonitor.OnOperationResponse ( OperationResponse  operationResponse,
SendParameters  sendParameters 
)
inlineprotectedvirtual

Called when an OperationResponse was received.

Parameters
operationResponseThe operation response.
sendParametersThe send Parameters.

Implements Photon.SocketServer.ServerToServer.S2SPeerBase.

Member Data Documentation

readonly GameApplication Photon.LoadBalancing.LoadShedding.LatencyMonitor.Application

Property Documentation

int Photon.LoadBalancing.LoadShedding.LatencyMonitor.AverageLatencyMs
get
int Photon.LoadBalancing.LoadShedding.LatencyMonitor.LastLatencyMs
get