nMachine Class Reference

class trying to collect information about a certain client, persistent between connections More...

#include <nNetwork.h>

Collaboration diagram for nMachine:

[legend]

List of all members.

Public Member Functions
	nMachine ()
	constructor
virtual	~nMachine ()
	destructor
bool	operator== (nMachine const &other) const
	equality operator
bool	operator!= (nMachine const &other) const
	inequality operator
void	OnKick (REAL severity=1)
	call this when you kick a user from this machine, frequent kickees will be banned
void	Ban (REAL time)
	ban users from this machine for the given time
void	Ban (REAL time, tString const &reason)
	ban users from this machine for the given time
REAL	IsBanned () const
	returns the number of seconds users from this machine are currently banned for
void	AddPlayer ()
	call when a player joins from this machine
void	RemovePlayer ()
	call when a player rom this machine leaves
int	GetPlayerCount ()
	returns the number of currently registered players
REAL	GetKicksPerHour (void) const
	Gets averaged kicks per hour of players from this machine.
nMachine const &	GetKicksPerHour (REAL &kph) const
	Gets averaged kicks per hour of players from this machine.
nMachine &	SetIP (tString const &IP)
	Sets IP address of the machine.
tString const &	GetIP (void) const
	Gets IP address of the machine.
nMachine const &	GetIP (tString &IP) const
	Gets IP address of the machine.
tString const &	GetBanReason (void) const
	Gets the reason of the ban.
nMachine const &	GetBanReason (tString &reason) const
	Gets the reason of the ban.
nMachineDecorator *	GetDecorators (void) const
	Gets list of decorators.
nMachine const &	GetDecorators (nMachineDecorator *&decorators) const
	Gets list of decorators.
template<class T>
T *	GetDecorator ()
	returns the first machine decorator of a given type
Static Public Member Functions
static nMachine &	GetMachine (unsigned short userID)
	fetches the machine information of a user
static void	Expire ()
	expires machine information that is no longer needed
static void	KickSpectators ()
	remove clients without players from the server
template<class T>
static T *	GetNextDecorator (nMachineDecorator *run)
	returns the next machine decorator of a given type
Private Member Functions
	nMachine (nMachine const &other)
	copy constructor
nMachine &	operator= (nMachine const &other)
	copy operator
nMachine &	SetDecorators (nMachineDecorator *decorators)
	Sets list of decorators.
Private Attributes
double	lastUsed_
	system time where this machine was last used
double	banned_
	system time until that this machine is banned
tString	banReason_
	reason for a ban
nAverager	kph_
	averaged kicks per hour of players from this machine
int	players_
	number of players coming from this machine currently
REAL	lastPlayerAction_
	time of the last player action
tString	IP_
	IP address of the machine.
nMachineDecorator *	decorators_
	list of decorators
Friends
class	nMachineDecorator
class	nMachinePersistor

---

Detailed Description

class trying to collect information about a certain client, persistent between connections

Definition at line 758 of file nNetwork.h.

---

Constructor & Destructor Documentation

nMachine::nMachine

(

void

)

constructor

Definition at line 4068 of file nNetwork.cpp.

        : lastUsed_(tSysTimeFloat())
        , banned_(-1)
        , players_(0)
        , decorators_(0)
{

nMachine::~nMachine

(

void

)

[virtual]

destructor

Definition at line 4087 of file nNetwork.cpp.

{
    // destroy and remove the decorators
    while ( decorators_ )
    {
        nMachineDecorator * decorator = decorators_;
        decorator->Remove();

nMachine::nMachine

(

nMachine const &

other

)

[private]

copy constructor

---

Member Function Documentation

bool nMachine::operator==

(

nMachine const &

other

)

const

equality operator

Parameters:

other

the machine to compare with

Returns:

true if they are equal

Definition at line 4109 of file nNetwork.cpp.

{

bool nMachine::operator!=

(

nMachine const &

other

)

const

inequality operator

Parameters:

other

the machine to compare with

Returns:

false if they are equal

Definition at line 4125 of file nNetwork.cpp.

{

nMachine & nMachine::GetMachine

(

unsigned short

userID

)

[static]

fetches the machine information of a user

Parameters:

userID

the user ID to fetch the machine for

Returns:

the machine the user ID belongs to

Definition at line 4166 of file nNetwork.cpp.

Referenced by eVoteItemKick::DoExecute(), nNetObject::DoGetMachine(), FloodProtection(), eVoter::GetVoter(), and ePlayerNetID::MyInitAfterCreation().

{
    // throw out old machines
    Expire();

    // hardcoding: the server itself
    if ( userID == 0 && sn_GetNetState() != nCLIENT )
    {
        static nMachine server;
        return server;
    }

    tASSERT( userID <= MAXCLIENTS+1 );

    if( sn_GetNetState() != nSERVER )
    {
        // invalid ID, return invalid machine (clients don't track machines)
        static nMachine invalid;
        return invalid;
    }

    // get address
    tVERIFY( userID <= MAXCLIENTS+1 );
    if( !sn_Connections[userID].socket )
    {
        // invalid ID, return invalid machine
        static nMachine invalid;
        return invalid;
    }
    tString address;
    peers[ userID ].GetAddress( address );

#ifdef DEBUG_X
    // add client ID so multiple connects from one machine are distinquished
    tString newIP;
    newIP << address << " " << userID;
    address = newIP;
#endif

Here is the caller graph for this function:

void nMachine::Expire

(

void

)

[static]

expires machine information that is no longer needed

Definition at line 4228 of file nNetwork.cpp.

Referenced by rec_peer().

{
    static double lastTime = tSysTimeFloat();
    double time = tSysTimeFloat();
    REAL dt = time - lastTime;
    if (dt <= 60)
        return;
    lastTime = time;

    // iterate over known machines
    nMachineMap & map = sn_GetMachineMap();
    nMachineMap::iterator toErase = map.end();
    for( nMachineMap::iterator iter = map.begin(); iter != map.end(); ++iter )
    {
        // erase last deleted machine
        sn_Erase( map, toErase );

        nMachine & machine = *(*iter).second.machine;

        // advance the kick statistics if the user is not banned and has been active
        if ( time > machine.banned_ && ( machine.lastUsed_ > time - 300 || machine.players_ > 0 ) )
        {
            machine.kph_.Add( 0, dt / 3600 );
            machine.kph_.Timestep( dt / 3600*24 );
        }

        // if the machine is no longer in use, mark it for deletion
        if ( machine.players_ == 0 && machine.lastUsed_ < time - 300.0 && machine.banned_ < time && machine.kph_.GetAverage() < 0.5 )
            toErase = iter;

    }

Here is the caller graph for this function:

void nMachine::KickSpectators

(

void

)

[static]

remove clients without players from the server

Definition at line 4277 of file nNetwork.cpp.

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

{
    double time = tSysTimeFloat();

    // kick spectators
    if ( sn_GetNetState() == nSERVER && sn_spectatorTime > 0 )
    {
        for ( int i = MAXCLIENTS; i >= 1; --i )
        {
            if ( sn_Connections[i].socket )
            {
                nMachine & machine = GetMachine( i );
                if ( machine.players_ == 0 && machine.lastPlayerAction_ + sn_spectatorTime < time )
                {
                    sn_KickUser( i, tOutput("$network_kill_spectator"), 0 );
                }
            }

Here is the caller graph for this function:

void nMachine::OnKick

(

REAL

severity = 1

)

call this when you kick a user from this machine, frequent kickees will be banned

Parameters:

severity

the severity of the offense; 1 is standard.

Definition at line 4317 of file nNetwork.cpp.

Referenced by eVoteItemKick::DoExecute().

{
    // if the user is currently banned, don't count
    if ( banned_ > tSysTimeFloat() )
        return;

    // ban the user a bit, taking the kicks per hour into account
    REAL kph = kph_.GetAverage() - sn_autobanOffset;
    if ( kph > 0 )
    {
        // the faster you get kicked when you turn up, the longer you get banned
        REAL banTime = 60 * kph * sn_autobanFactor;
        Ban( banTime, tString(tOutput( "$network_ban_kick" )) );
    }

    // add it to the statistics
    if ( sn_autobanMaxKPH > 0 )
        kph_.Add( severity * sn_autobanMaxKPH, 2/sn_autobanMaxKPH );

Here is the caller graph for this function:

void nMachine::Ban

(

REAL

time

)

ban users from this machine for the given time

Parameters:

time

time in seconds the ban should be in effect

Definition at line 4351 of file nNetwork.cpp.

Referenced by sn_UnBanConf().

{
    lastUsed_ = tSysTimeFloat();

    // set the banning timeout to the current time plus the given time
    banned_ = tSysTimeFloat() + time;

    if ( sn_printBans )
    {
        if ( time > 0 )
            con << tOutput( "$network_ban", GetIP(), int(time/60), banReason_.Len() > 1 ? banReason_ : tOutput( "$network_ban_noreason" ) );
        else

Here is the caller graph for this function:

void nMachine::Ban	(	REAL	time,
		tString const &	reason
	)

ban users from this machine for the given time

Parameters:

	time	time in seconds the ban should be in effect
	reason	the reason for the ban

Definition at line 4378 of file nNetwork.cpp.

{
    banReason_ = tString();
    if ( reason.Len() > 2 )
        banReason_ = reason;

REAL nMachine::IsBanned

(

void

)

const

returns the number of seconds users from this machine are currently banned for

Returns:

kick time left

Definition at line 4397 of file nNetwork.cpp.

Referenced by nMachinePersistor::SaveMachines().

{
    // test for banning
    double time = tSysTimeFloat();
    if ( time > banned_ )
        return 0;

Here is the caller graph for this function:

void nMachine::AddPlayer

(

void

)

call when a player joins from this machine

Definition at line 4416 of file nNetwork.cpp.

Referenced by ePlayerNetID::RegisterWithMachine().

{
    lastPlayerAction_ = lastUsed_ = tSysTimeFloat();

Here is the caller graph for this function:

void nMachine::RemovePlayer

(

void

)

call when a player rom this machine leaves

Definition at line 4432 of file nNetwork.cpp.

Referenced by ePlayerNetID::UnregisterWithMachine().

{
    lastPlayerAction_ = lastUsed_ = tSysTimeFloat();

    players_--;

Here is the caller graph for this function:

int nMachine::GetPlayerCount

(

void

)

returns the number of currently registered players

Returns:

the number of currently connected players

Definition at line 4451 of file nNetwork.cpp.

{

nMachine& nMachine::operator=

(

nMachine const &

other

)

[private]

copy operator

REAL nMachine::GetKicksPerHour

(

void

)

const

Gets averaged kicks per hour of players from this machine.

Returns:

averaged kicks per hour of players from this machine

Definition at line 4548 of file nNetwork.cpp.

{

nMachine const & nMachine::GetKicksPerHour

(

REAL &

kph

)

const

Gets averaged kicks per hour of players from this machine.

Parameters:

kph

averaged kicks per hour of players from this machine to fill

Returns:

A reference to this to allow chaining

Definition at line 4564 of file nNetwork.cpp.

{

nMachine & nMachine::SetIP

(

tString const &

IP

)

Sets IP address of the machine.

Parameters:

IP

IP address of the machine to set

Returns:

A reference to this to allow chaining

Definition at line 4613 of file nNetwork.cpp.

{
    lastUsed_ = tSysTimeFloat();

tString const & nMachine::GetIP

(

void

)

const

Gets IP address of the machine.

Returns:

IP address of the machine

Definition at line 4580 of file nNetwork.cpp.

Referenced by eVoter::Name(), and se_ListPlayers().

{

Here is the caller graph for this function:

nMachine const & nMachine::GetIP

(

tString &

IP

)

const

Gets IP address of the machine.

Parameters:

IP

IP address of the machine to fill

Returns:

A reference to this to allow chaining

Definition at line 4596 of file nNetwork.cpp.

{

tString const & nMachine::GetBanReason

(

void

)

const

Gets the reason of the ban.

Returns:

Reason of the ban

Definition at line 4631 of file nNetwork.cpp.

Referenced by nMachinePersistor::SaveMachines().

{

Here is the caller graph for this function:

nMachine const & nMachine::GetBanReason

(

tString &

reason

)

const

Gets the reason of the ban.

Parameters:

reason

Reason of the ban to fill

Returns:

A reference to this to allow chaining

Definition at line 4647 of file nNetwork.cpp.

{

nMachineDecorator * nMachine::GetDecorators

(

void

)

const [inline]

Gets list of decorators.

Returns:

list of decorators

Definition at line 1068 of file nNetwork.h.

References decorators_.

Referenced by GetDecorator(), GetQueryMessageStats(), and eVoter::GetVoter().

{
    return this->decorators_;
}

Here is the caller graph for this function:

nMachine const & nMachine::GetDecorators

(

nMachineDecorator *&

decorators

)

const [inline]

Gets list of decorators.

Parameters:

decorators

list of decorators to fill

Returns:

A reference to this to allow chaining

Definition at line 1084 of file nNetwork.h.

References decorators_.

{
    decorators = this->decorators_;
    return *this;
}

template<class T>

static T* nMachine::GetNextDecorator

(

nMachineDecorator *

run

)

[inline, static]

returns the next machine decorator of a given type

Definition at line 813 of file nNetwork.h.

References tListItem< T >::Next().

    {
        while ( run )
        {
            T * ret = dynamic_cast< T * >( run );
            if ( ret )
            {
                return ret;
            }
            run = run->Next();
        }

        return 0;
    }

Here is the call graph for this function:

template<class T>

T* nMachine::GetDecorator

(

)

[inline]

returns the first machine decorator of a given type

Definition at line 829 of file nNetwork.h.

References GetDecorators().

    {
        return GetNextDecorator< T >( GetDecorators() );
    }

Here is the call graph for this function:

nMachine & nMachine::SetDecorators

(

nMachineDecorator *

decorators

)

[inline, private]

Sets list of decorators.

Parameters:

decorators

list of decorators to set

Returns:

A reference to this to allow chaining

Definition at line 1101 of file nNetwork.h.

References decorators_.

{
    this->decorators_ = decorators;
    return *this;
}

---

Friends And Related Function Documentation

friend class nMachineDecorator [friend]

Definition at line 760 of file nNetwork.h.

friend class nMachinePersistor [friend]

Definition at line 761 of file nNetwork.h.

---

Member Data Documentation

double nMachine::lastUsed_ [mutable, private]

system time where this machine was last used

Definition at line 790 of file nNetwork.h.

double nMachine::banned_ [mutable, private]

system time until that this machine is banned

Definition at line 791 of file nNetwork.h.

tString nMachine::banReason_ [private]

reason for a ban

Definition at line 792 of file nNetwork.h.

nAverager nMachine::kph_ [private]

averaged kicks per hour of players from this machine

Definition at line 793 of file nNetwork.h.

Referenced by nMachinePersistor::SaveMachines().

int nMachine::players_ [private]

number of players coming from this machine currently

Definition at line 794 of file nNetwork.h.

REAL nMachine::lastPlayerAction_ [private]

time of the last player action

Definition at line 795 of file nNetwork.h.

tString nMachine::IP_ [private]

IP address of the machine.

Definition at line 797 of file nNetwork.h.

nMachineDecorator* nMachine::decorators_ [private]

list of decorators

Definition at line 798 of file nNetwork.h.

Referenced by GetDecorators(), and SetDecorators().

---

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

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

---