RakNet::RakNetStatistics Struct Reference

Network Statisics Usage. More...

#include <RakNetStatistics.h>

List of all members.

Public Member Functions
RakNetStatistics &	operator+= (const RakNetStatistics &other)
Public Attributes
uint64_t	BPSLimitByCongestionControl
	If isLimitedByCongestionControl is true, what is the limit, in bytes per second?
uint64_t	BPSLimitByOutgoingBandwidthLimit
	If isLimitedByOutgoingBandwidthLimit is true, what is the limit, in bytes per second?
uint64_t	bytesInResendBuffer
	How many bytes are waiting in the resend buffer. See also messagesInResendBuffer.
double	bytesInSendBuffer [NUMBER_OF_PRIORITIES]
	For each priority level, how many bytes are waiting to be sent out?
RakNet::TimeUS	connectionStartTime
bool	isLimitedByCongestionControl
bool	isLimitedByOutgoingBandwidthLimit
	Is our current send rate throttled by a call to RakPeer::SetPerConnectionOutgoingBandwidthLimit()?
unsigned int	messageInSendBuffer [NUMBER_OF_PRIORITIES]
	For each priority level, how many messages are waiting to be sent out?
unsigned int	messagesInResendBuffer
float	packetlossLastSecond
	Over the last second, what was our packetloss? This number will range from 0.0 (for none) to 1.0 (for 100%)
float	packetlossTotal
	What is the average total packetloss over the lifetime of the connection?
uint64_t	runningTotal [RNS_PER_SECOND_METRICS_COUNT]
	For each type in RNSPerSecondMetrics, what is the total value over the lifetime of the connection?
uint64_t	valueOverLastSecond [RNS_PER_SECOND_METRICS_COUNT]
	For each type in RNSPerSecondMetrics, what is the value over the last 1 second?

---

Detailed Description

Store Statistics information related to network usage

Definition at line 51 of file RakNetStatistics.h.

---

Member Function Documentation

RakNetStatistics& RakNet::RakNetStatistics::operator+=

(

const RakNetStatistics &

other

)

[inline]

Definition at line 95 of file RakNetStatistics.h.

References bytesInSendBuffer, messageInSendBuffer, NUMBER_OF_PRIORITIES, RakNet::RNS_PER_SECOND_METRICS_COUNT, runningTotal, and valueOverLastSecond.

    {
        unsigned i;
        for (i=0; i < NUMBER_OF_PRIORITIES; i++)
        {
            messageInSendBuffer[i]+=other.messageInSendBuffer[i];
            bytesInSendBuffer[i]+=other.bytesInSendBuffer[i];
        }

        for (i=0; i < RNS_PER_SECOND_METRICS_COUNT; i++)
        {
            valueOverLastSecond[i]+=other.valueOverLastSecond[i];
            runningTotal[i]+=other.runningTotal[i];
        }

        return *this;
    }

---

Member Data Documentation

uint64_t RakNet::RakNetStatistics::BPSLimitByCongestionControl

Definition at line 68 of file RakNetStatistics.h.

uint64_t RakNet::RakNetStatistics::BPSLimitByOutgoingBandwidthLimit

Definition at line 74 of file RakNetStatistics.h.

uint64_t RakNet::RakNetStatistics::bytesInResendBuffer

Definition at line 87 of file RakNetStatistics.h.

double RakNet::RakNetStatistics::bytesInSendBuffer[NUMBER_OF_PRIORITIES]

Definition at line 80 of file RakNetStatistics.h.

Referenced by operator+=().

RakNet::TimeUS RakNet::RakNetStatistics::connectionStartTime

When did the connection start?

See also:

RakNet::GetTimeUS()

Definition at line 61 of file RakNetStatistics.h.

bool RakNet::RakNetStatistics::isLimitedByCongestionControl

Is our current send rate throttled by congestion control? This value should be true if you send more data per second than your bandwidth capacity

Definition at line 65 of file RakNetStatistics.h.

bool RakNet::RakNetStatistics::isLimitedByOutgoingBandwidthLimit

Definition at line 71 of file RakNetStatistics.h.

unsigned int RakNet::RakNetStatistics::messageInSendBuffer[NUMBER_OF_PRIORITIES]

Definition at line 77 of file RakNetStatistics.h.

Referenced by operator+=().

unsigned int RakNet::RakNetStatistics::messagesInResendBuffer

How many messages are waiting in the resend buffer? This includes messages waiting for an ack, so should normally be a small value If the value is rising over time, you are exceeding the bandwidth capacity. See BPSLimitByCongestionControl

Definition at line 84 of file RakNetStatistics.h.

float RakNet::RakNetStatistics::packetlossLastSecond

Definition at line 90 of file RakNetStatistics.h.

float RakNet::RakNetStatistics::packetlossTotal

Definition at line 93 of file RakNetStatistics.h.

uint64_t RakNet::RakNetStatistics::runningTotal[RNS_PER_SECOND_METRICS_COUNT]

Definition at line 57 of file RakNetStatistics.h.

Referenced by operator+=().

uint64_t RakNet::RakNetStatistics::valueOverLastSecond[RNS_PER_SECOND_METRICS_COUNT]

Definition at line 54 of file RakNetStatistics.h.

Referenced by operator+=().

---

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

• RakNetStatistics.h