nPingAverager Class Reference

averager for pings, detects lag More...

#include <nNetwork.h>

Collaboration diagram for nPingAverager:

[legend]

List of all members.

Public Member Functions
	nPingAverager ()
	constructor
	~nPingAverager ()
	destructor
	operator REAL () const
	conversion to number == GetPing()
REAL	GetPing () const
	returns the current best estimate for the ping
REAL	GetPingSnail () const
	returns the extremely longterm average ping
REAL	GetPingSlow () const
	returns the longterm average ping
REAL	GetPingFast () const
	returns the shortterm average ping
bool	IsSpiking () const
	returns whether a lag spike is currently in process
void	Timestep (REAL decay)
	lets all values decay, so they can be replaced by new ones
void	Add (REAL value, REAL weight)
	adds a value to the average
void	Add (REAL value)
	adds a value to the average
void	Reset ()
	resets average to zero
nAverager const &	GetSnailAverager (void) const
	Gets extremely slow averager.
nPingAverager const &	GetSnailAverager (nAverager &snail) const
	Gets extremely slow averager.
nAverager const &	GetSlowAverager (void) const
	Gets slow, reliable averager.
nPingAverager const &	GetSlowAverager (nAverager &slow) const
	Gets slow, reliable averager.
nAverager const &	GetFastAverager (void) const
	Gets fast averager for detecting ping spikes.
nPingAverager const &	GetFastAverager (nAverager &fast) const
	Gets fast averager for detecting ping spikes.
Static Public Member Functions
static void	SetWeight (REAL const &weight)
	Sets the default statistical weight.
static REAL	GetWeight (void)
	Gets the default statistical weight.
static void	GetWeight (REAL &weight)
	Gets the default statistical weight.
Protected Member Functions
nPingAverager &	SetSnailAverager (nAverager const &snail)
	Sets very slow averager.
nPingAverager &	SetSlowAverager (nAverager const &slow)
	Sets slow, reliable averager.
nPingAverager &	SetFastAverager (nAverager const &fast)
	Sets fast averager for detecting ping spikes.
Private Attributes
nAverager	snail_
	extremely slow averager
nAverager	slow_
	slow, reliable averager
nAverager	fast_
	fast averager for detecting ping spikes
Static Private Attributes
static REAL	weight_ = 1
	current default weight

---

Detailed Description

averager for pings, detects lag

Definition at line 269 of file nNetwork.h.

---

Constructor & Destructor Documentation

nPingAverager::nPingAverager

(

void

)

constructor

Definition at line 3828 of file nNetwork.cpp.

{

nPingAverager::~nPingAverager

(

void

)

destructor

Definition at line 3842 of file nNetwork.cpp.

---

Member Function Documentation

nPingAverager::operator REAL

(

void

)

const

conversion to number == GetPing()

Returns:

our best estimate for the ping

Definition at line 3911 of file nNetwork.cpp.

{

REAL nPingAverager::GetPing

(

void

)

const

returns the current best estimate for the ping

Returns:

our best estimate for the ping

Definition at line 3856 of file nNetwork.cpp.

Referenced by GameLoop(), nServerLag::Ping(), eTimer::ReadSync(), and sn_GetTimeout().

{
    // collect data
    // determine the lowest guessed value for variance.
    // lag spikes should not contribute here too much.
    REAL variance = 1;
    {
        REAL snailVariance = this->snail_.GetDataVariance();
        REAL slowVariance = this->slow_.GetDataVariance();
        REAL fastVariance = this->fast_.GetDataVariance();
        variance = variance < snailVariance ? variance : snailVariance;
        variance = variance < slowVariance ? variance : slowVariance;
        variance = variance < fastVariance ? variance : fastVariance;
    }

    REAL pingSnail  = this->GetPingSnail();
    REAL pingSlow   = this->GetPingSlow();
    REAL pingFast   = this->GetPingFast();

    // the proposed return value: defaults to the snail ping, it flucuates the least
    REAL pingReturn = pingSnail;

    // return slow average if that differs from the snail one by at least one standard deviation
    if ( ( pingSlow - pingReturn ) * ( pingSlow - pingReturn ) > variance )
    {
        // but clamp it to sane values
        if ( pingSlow > pingReturn * 2 )
            pingSlow = pingReturn * 2;

        pingReturn = pingSlow;
    }

    // same for fast ping
    if ( ( pingFast - pingReturn ) * ( pingFast - pingReturn ) > variance )
    {
        if ( pingFast > pingReturn * 2 )
            pingFast = pingReturn * 2;

        pingReturn = pingFast;
    }

Here is the caller graph for this function:

REAL nPingAverager::GetPingSnail

(

void

)

const

returns the extremely longterm average ping

Returns:

extremely longterm ping average

Definition at line 3926 of file nNetwork.cpp.

{

REAL nPingAverager::GetPingSlow

(

void

)

const

returns the longterm average ping

Returns:

longterm ping average

Definition at line 3941 of file nNetwork.cpp.

{

REAL nPingAverager::GetPingFast

(

void

)

const

returns the shortterm average ping

Returns:

shortterm ping average

Definition at line 3956 of file nNetwork.cpp.

{

bool nPingAverager::IsSpiking

(

void

)

const

returns whether a lag spike is currently in process

Returns:

true if unusual high fluctuations exist in the ping

Definition at line 3971 of file nNetwork.cpp.

{

void nPingAverager::Timestep

(

REAL

decay

)

lets all values decay, so they can be replaced by new ones

Parameters:

decay

time since last timestep

Definition at line 3987 of file nNetwork.cpp.

Referenced by ready_handler().

{
    snail_.Timestep( decay * .02 );

Here is the caller graph for this function:

void nPingAverager::Add	(	REAL	value,
		REAL	weight
	)

adds a value to the average

Parameters:

	value	the value to add
	weight	the value's statistical weight

Definition at line 4005 of file nNetwork.cpp.

{
    // add value to both averagers
    snail_.Add( value, weight );

void nPingAverager::Add

(

REAL

value

)

adds a value to the average

Parameters:

value

the value to add with default weight

Definition at line 4023 of file nNetwork.cpp.

{

void nPingAverager::Reset

(

void

)

resets average to zero

Definition at line 4038 of file nNetwork.cpp.

{
    snail_.Reset();
    slow_. Reset();
    fast_. Reset();

    // fill in some low weight values
    Add( 1, .000001 );
    Add( 0, .000001 );

    // pin snail averager close to zero

void nPingAverager::SetWeight

(

REAL const &

weight

)

[inline, static]

Sets the default statistical weight.

Parameters:

weight

the default statistical weight to set

Definition at line 893 of file nNetwork.h.

References weight_.

Referenced by gGame::GameLoop(), and gGame::StateUpdate().

{
    weight_ = weight;
}

Here is the caller graph for this function:

REAL nPingAverager::GetWeight

(

void

)

[inline, static]

Gets the default statistical weight.

Returns:

the default statistical weight

Definition at line 863 of file nNetwork.h.

References weight_.

{
    return weight_;
}

void nPingAverager::GetWeight

(

REAL &

weight

)

[inline, static]

Gets the default statistical weight.

Parameters:

weight

the default statistical weight to fill

Definition at line 878 of file nNetwork.h.

References weight_.

{
    weight = weight_;
}

nAverager const & nPingAverager::GetSnailAverager

(

void

)

const [inline]

Gets extremely slow averager.

Returns:

slow, reliable averager

Definition at line 908 of file nNetwork.h.

References snail_.

Referenced by sn_GetTimeout(), and gCycleMovement::TimestepCore().

{
    return this->snail_;
}

Here is the caller graph for this function:

nPingAverager const & nPingAverager::GetSnailAverager

(

nAverager &

snail

)

const [inline]

Gets extremely slow averager.

Parameters:

snail

very slow averager to fill

Returns:

A reference to this to allow chaining

Definition at line 924 of file nNetwork.h.

References snail_.

{
    snail = this->snail_;
    return *this;
}

nAverager const & nPingAverager::GetSlowAverager

(

void

)

const [inline]

Gets slow, reliable averager.

Returns:

slow, reliable averager

Definition at line 956 of file nNetwork.h.

References slow_.

Referenced by GameLoop().

{
    return this->slow_;
}

Here is the caller graph for this function:

nPingAverager const & nPingAverager::GetSlowAverager

(

nAverager &

slow

)

const [inline]

Gets slow, reliable averager.

Parameters:

slow

slow, reliable averager to fill

Returns:

A reference to this to allow chaining

Definition at line 972 of file nNetwork.h.

References slow_.

{
    slow = this->slow_;
    return *this;
}

nAverager const & nPingAverager::GetFastAverager

(

void

)

const [inline]

Gets fast averager for detecting ping spikes.

Returns:

fast averager for detecting ping spikes

Definition at line 1005 of file nNetwork.h.

References fast_.

Referenced by eTimer::ReadSync().

{
    return this->fast_;
}

Here is the caller graph for this function:

nPingAverager const & nPingAverager::GetFastAverager

(

nAverager &

fast

)

const [inline]

Gets fast averager for detecting ping spikes.

Parameters:

fast

fast averager for detecting ping spikes to fill

Returns:

A reference to this to allow chaining

Definition at line 1021 of file nNetwork.h.

References fast_.

{
    fast = this->fast_;
    return *this;
}

nPingAverager & nPingAverager::SetSnailAverager

(

nAverager const &

snail

)

[inline, protected]

Sets very slow averager.

Parameters:

snail

very slow averager to set

Returns:

A reference to this to allow chaining

Definition at line 941 of file nNetwork.h.

References snail_.

{
    this->snail_ = snail;
    return *this;
}

nPingAverager & nPingAverager::SetSlowAverager

(

nAverager const &

slow

)

[inline, protected]

Sets slow, reliable averager.

Parameters:

slow

slow, reliable averager to set

Returns:

A reference to this to allow chaining

Definition at line 989 of file nNetwork.h.

References slow_.

{
    this->slow_ = slow;
    return *this;
}

nPingAverager & nPingAverager::SetFastAverager

(

nAverager const &

fast

)

[inline, protected]

Sets fast averager for detecting ping spikes.

Parameters:

fast

fast averager for detecting ping spikes to set

Returns:

A reference to this to allow chaining

Definition at line 1038 of file nNetwork.h.

References fast_.

{
    this->fast_ = fast;
    return *this;
}

---

Member Data Documentation

nAverager nPingAverager::snail_ [private]

extremely slow averager

Definition at line 287 of file nNetwork.h.

Referenced by GetSnailAverager(), and SetSnailAverager().

nAverager nPingAverager::slow_ [private]

slow, reliable averager

Definition at line 288 of file nNetwork.h.

Referenced by GetSlowAverager(), and SetSlowAverager().

nAverager nPingAverager::fast_ [private]

fast averager for detecting ping spikes

Definition at line 289 of file nNetwork.h.

Referenced by GetFastAverager(), and SetFastAverager().

REAL nPingAverager::weight_ = 1 [static, private]

current default weight

Definition at line 290 of file nNetwork.h.

Referenced by GetWeight(), and SetWeight().

---

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

• src/network/nNetwork.h
• src/network/nNetwork.cpp

---