Photon .NET Client API
Public Member Functions | Properties | List of all members
ExitGames.Client.Photon.TrafficStatsGameLevel Class Reference

Only in use as long as PhotonPeer.TrafficStatsEnabled = true; More...

Public Member Functions

void ResetMaximumCounters ()
 Resets the values that can be maxed out, like LongestDeltaBetweenDispatching. See remarks. More...
 
override string ToString ()
 
string ToStringVitalStats ()
 

Properties

int OperationByteCount [get, set]
 Gets sum of outgoing operations in bytes. More...
 
int OperationCount [get, set]
 Gets count of outgoing operations. More...
 
int ResultByteCount [get, set]
 Gets sum of byte-cost of incoming operation-results. More...
 
int ResultCount [get, set]
 Gets count of incoming operation-results. More...
 
int EventByteCount [get, set]
 Gets sum of byte-cost of incoming events. More...
 
int EventCount [get, set]
 Gets count of incoming events. More...
 
int LongestOpResponseCallback [get, set]
 Gets longest time it took to complete a call to OnOperationResponse (in your code). If such a callback takes long, it will lower the network performance and might lead to timeouts. More...
 
byte LongestOpResponseCallbackOpCode [get, set]
 Gets OperationCode that causes the LongestOpResponseCallback. See that description. More...
 
int LongestEventCallback [get, set]
 Gets longest time a call to OnEvent (in your code) took. If such a callback takes long, it will lower the network performance and might lead to timeouts. More...
 
byte LongestEventCallbackCode [get, set]
 Gets EventCode that caused the LongestEventCallback. See that description. More...
 
int LongestDeltaBetweenDispatching [get, set]
 Gets longest time between subsequent calls to DispatchIncomginCommands in milliseconds. Note: This is not a crucial timing for the networking. Long gaps just add "local lag" to events that are available already. More...
 
int LongestDeltaBetweenSending [get, set]
 Gets longest time between subsequent calls to SendOutgoingCommands in milliseconds. Note: This is a crucial value for network stability. Without calling SendOutgoingCommands, nothing will be sent to the server, who might time out this client. More...
 
int DispatchCalls [get]
 Gets number of calls of DispatchIncomingCommands. More...
 
int DispatchIncomingCommandsCalls [get, set]
 Gets number of calls of DispatchIncomingCommands. More...
 
int SendOutgoingCommandsCalls [get, set]
 Gets number of calls of SendOutgoingCommands. More...
 
int TotalByteCount [get]
 Gets sum of byte-cost of all "logic level" messages. More...
 
int TotalMessageCount [get]
 Gets sum of counted "logic level" messages. More...
 
int TotalIncomingByteCount [get]
 Gets sum of byte-cost of all incoming "logic level" messages. More...
 
int TotalIncomingMessageCount [get]
 Gets sum of counted incoming "logic level" messages. More...
 
int TotalOutgoingByteCount [get]
 Gets sum of byte-cost of all outgoing "logic level" messages (= OperationByteCount). More...
 
int TotalOutgoingMessageCount [get]
 Gets sum of counted outgoing "logic level" messages (= OperationCount). More...
 

Detailed Description

Only in use as long as PhotonPeer.TrafficStatsEnabled = true;

Member Function Documentation

void ExitGames.Client.Photon.TrafficStatsGameLevel.ResetMaximumCounters ( )
inline

Resets the values that can be maxed out, like LongestDeltaBetweenDispatching. See remarks.

Set to 0: LongestDeltaBetweenDispatching, LongestDeltaBetweenSending, LongestEventCallback, LongestEventCallbackCode, LongestOpResponseCallback, LongestOpResponseCallbackOpCode. Also resets internal values: timeOfLastDispatchCall and timeOfLastSendCall (so intervals are tracked correctly).

override string ExitGames.Client.Photon.TrafficStatsGameLevel.ToString ( )
inline
string ExitGames.Client.Photon.TrafficStatsGameLevel.ToStringVitalStats ( )
inline

Property Documentation

int ExitGames.Client.Photon.TrafficStatsGameLevel.DispatchCalls
get

Gets number of calls of DispatchIncomingCommands.

int ExitGames.Client.Photon.TrafficStatsGameLevel.DispatchIncomingCommandsCalls
getset

Gets number of calls of DispatchIncomingCommands.

int ExitGames.Client.Photon.TrafficStatsGameLevel.EventByteCount
getset

Gets sum of byte-cost of incoming events.

int ExitGames.Client.Photon.TrafficStatsGameLevel.EventCount
getset

Gets count of incoming events.

int ExitGames.Client.Photon.TrafficStatsGameLevel.LongestDeltaBetweenDispatching
getset

Gets longest time between subsequent calls to DispatchIncomginCommands in milliseconds. Note: This is not a crucial timing for the networking. Long gaps just add "local lag" to events that are available already.

int ExitGames.Client.Photon.TrafficStatsGameLevel.LongestDeltaBetweenSending
getset

Gets longest time between subsequent calls to SendOutgoingCommands in milliseconds. Note: This is a crucial value for network stability. Without calling SendOutgoingCommands, nothing will be sent to the server, who might time out this client.

int ExitGames.Client.Photon.TrafficStatsGameLevel.LongestEventCallback
getset

Gets longest time a call to OnEvent (in your code) took. If such a callback takes long, it will lower the network performance and might lead to timeouts.

byte ExitGames.Client.Photon.TrafficStatsGameLevel.LongestEventCallbackCode
getset

Gets EventCode that caused the LongestEventCallback. See that description.

int ExitGames.Client.Photon.TrafficStatsGameLevel.LongestOpResponseCallback
getset

Gets longest time it took to complete a call to OnOperationResponse (in your code). If such a callback takes long, it will lower the network performance and might lead to timeouts.

byte ExitGames.Client.Photon.TrafficStatsGameLevel.LongestOpResponseCallbackOpCode
getset

Gets OperationCode that causes the LongestOpResponseCallback. See that description.

int ExitGames.Client.Photon.TrafficStatsGameLevel.OperationByteCount
getset

Gets sum of outgoing operations in bytes.

int ExitGames.Client.Photon.TrafficStatsGameLevel.OperationCount
getset

Gets count of outgoing operations.

int ExitGames.Client.Photon.TrafficStatsGameLevel.ResultByteCount
getset

Gets sum of byte-cost of incoming operation-results.

int ExitGames.Client.Photon.TrafficStatsGameLevel.ResultCount
getset

Gets count of incoming operation-results.

int ExitGames.Client.Photon.TrafficStatsGameLevel.SendOutgoingCommandsCalls
getset

Gets number of calls of SendOutgoingCommands.

int ExitGames.Client.Photon.TrafficStatsGameLevel.TotalByteCount
get

Gets sum of byte-cost of all "logic level" messages.

int ExitGames.Client.Photon.TrafficStatsGameLevel.TotalIncomingByteCount
get

Gets sum of byte-cost of all incoming "logic level" messages.

int ExitGames.Client.Photon.TrafficStatsGameLevel.TotalIncomingMessageCount
get

Gets sum of counted incoming "logic level" messages.

int ExitGames.Client.Photon.TrafficStatsGameLevel.TotalMessageCount
get

Gets sum of counted "logic level" messages.

int ExitGames.Client.Photon.TrafficStatsGameLevel.TotalOutgoingByteCount
get

Gets sum of byte-cost of all outgoing "logic level" messages (= OperationByteCount).

int ExitGames.Client.Photon.TrafficStatsGameLevel.TotalOutgoingMessageCount
get

Gets sum of counted outgoing "logic level" messages (= OperationCount).


The documentation for this class was generated from the following file: