Inheritance diagram for TrafficStats:

Collaboration diagram for TrafficStats:

Public Member Functions
virtual	~TrafficStats (void)

int	getPackageHeaderSize (void) const

int	getReliableCommandCount (void) const

int	getUnreliableCommandCount (void) const

int	getFragmentCommandCount (void) const

int	getControlCommandCount (void) const

int	getTotalPacketCount (void) const

int	getTotalCommandsInPackets (void) const

int	getReliableCommandBytes (void) const

int	getUnreliableCommandBytes (void) const

int	getFragmentCommandBytes (void) const

int	getControlCommandBytes (void) const

int	getTotalCommandCount (void) const

int	getTotalCommandBytes (void) const

int	getTotalPacketBytes (void) const

int	getTimestampOfLastAck (void) const

int	getTimestampOfLastReliableCommand (void) const

virtual Common::JString &	toString (Common::JString &retStr, bool withTypes=false) const

virtual JString &	toString (JString &retStr, bool withTypes=false) const=0

JString	toString (bool withTypes=false) const

Public Member Functions inherited from ToString
virtual	~ToString (void)

virtual JString	typeToString (void) const

JString	toString (bool withTypes=false) const

Detailed Description

This class provides network traffic statistics.

See also: PhotonPeer::getTrafficStatsEnabled(), PhotonPeer::setTrafficStatsEnabled(), PhotonPeer::getTrafficStatsElapsedMs(), PhotonPeer::getTrafficStatsIncoming(), PhotonPeer::getTrafficStatsOutgoing()

Constructor & Destructor Documentation

◆ ~TrafficStats()

~TrafficStats ( void )

virtual

Destructor.

Member Function Documentation

◆ getPackageHeaderSize()

int getPackageHeaderSize ( void ) const

Returns: the byte-size of per-package headers.

◆ getReliableCommandCount()

int getReliableCommandCount ( void ) const

Returns: the reliable commands that are created/received by this client, ignoring repeats (the out command count can be higher that this due to repeats).

◆ getUnreliableCommandCount()

int getUnreliableCommandCount ( void ) const

Returns: the unreliable commands that are created/received by this client.

◆ getFragmentCommandCount()

int getFragmentCommandCount ( void ) const

Remarks: Commands get fragmented, when UDP is used and they are to big to fit into a single UDP packet.

Returns: the fragments for fragmented commands that are created/received by this client.

◆ getControlCommandCount()

int getControlCommandCount ( void ) const

Remarks: The returned value includes connect, disconnect, verify connect, pings and acknowledgments for reliable commands.

Returns: the control commands that are created/received by this client under the hood to administer the connection.

◆ getTotalPacketCount()

int getTotalPacketCount ( void ) const

Returns: the overall packets that are in created/received by this client.

◆ getTotalCommandsInPackets()

int getTotalCommandsInPackets ( void ) const

Returns: the overall commands that are created/received by this client. For fragmented commands each fragment counts separately.

◆ getReliableCommandBytes()

int getReliableCommandBytes ( void ) const

Returns: the bytes of the reliable commands that are created/received by this client, ignoring repeats (the count of actually outgoing bytes can be higher than this due to repeats).

◆ getUnreliableCommandBytes()

int getUnreliableCommandBytes ( void ) const

Returns: the bytes of the unreliable commands that are created/received by this client.

◆ getFragmentCommandBytes()

int getFragmentCommandBytes ( void ) const

Remarks: Commands get fragmented, when UDP is used and they are to big to fit into a single UDP packet.

Returns: the bytes of the fragments for fragmented commands that are created/received by this client.

◆ getControlCommandBytes()

int getControlCommandBytes ( void ) const

Remarks: Control commands include connect, disconnect, verify connect, pings and acknowledgments for reliable commands.

Returns: the bytes of the control commands that are created/received by this client under the hood to administer the connection.

◆ getTotalCommandCount()

int getTotalCommandCount ( void ) const

Returns: the sum of the return values of getReliableCommandCount(), getUnreliableCommandCount(), getFragmentCommandCount() and getControlCommandCount()

◆ getTotalCommandBytes()

int getTotalCommandBytes ( void ) const

Returns: the sum of the return values of getReliableCommandBytes(), getUnreliableCommandBytes(), getFragmentCommandBytes() and getControlCommandBytes()

◆ getTotalPacketBytes()

int getTotalPacketBytes ( void ) const

Returns: the count of bytes as traffic, excluding UDP/TCP headers (42 bytes / x bytes).

◆ getTimestampOfLastAck()

int getTimestampOfLastAck ( void ) const

Returns: the timestamp of the last incoming ACK that has been read (every PhotonPeer::getTimePingInterval() milliseconds this client sends a PING which must be ACKd by the server).

◆ getTimestampOfLastReliableCommand()

int getTimestampOfLastReliableCommand ( void ) const

Returns: the timestamp of the last incoming reliable command (every second we expect a PING).

◆ toString() [1/3]

JString & toString	(	Common::JString &	retStr,
		bool	withTypes = `false`
	)		const

virtual

Remarks: The cost of this function depends a lot on implementation details of the implementing subclasses, but for container classes this function can become quite expensive, if the instance contains huge amounts of data, as its cost for many container class implementations increases disproportionately high to the size of the payload.

Parameters

retStr	reference to a string, to store the return-value in; the information, which is generated by this function, will be attached at the end of any eventually existing previous content of the string
withTypes	set to true, to include type information in the generated string

Returns: a JString representation of the instance and its contents for debugging purposes.

Implements ToString.

◆ toString() [2/3]

toString

Remarks: The cost of this function depends a lot on implementation details of the implementing subclasses, but for container classes this function can become quite expensive, if the instance contains huge amounts of data, as its cost for many container class implementations increases disproportionately high to the size of the payload.

Parameters

retStr	reference to a string, to store the return-value in; the information, which is generated by this function, will be attached at the end of any eventually existing previous content of the string
withTypes	set to true, to include type information in the generated string

Returns: a JString representation of the instance and its contents for debugging purposes.

◆ toString() [3/3]

JString toString

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

withTypes set to true, to include type information in the generated string

Returns: a JString representation of the instance and its contents for debugging purposes.

See also: JString

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~TrafficStats()

Member Function Documentation

◆ getPackageHeaderSize()

◆ getReliableCommandCount()

◆ getUnreliableCommandCount()

◆ getFragmentCommandCount()

◆ getControlCommandCount()

◆ getTotalPacketCount()

◆ getTotalCommandsInPackets()

◆ getReliableCommandBytes()

◆ getUnreliableCommandBytes()

◆ getFragmentCommandBytes()

◆ getControlCommandBytes()

◆ getTotalCommandCount()

◆ getTotalCommandBytes()

◆ getTotalPacketBytes()

◆ getTimestampOfLastAck()

◆ getTimestampOfLastReliableCommand()

◆ toString() [1/3]

◆ toString() [2/3]

◆ toString() [3/3]