src/network/nNetwork.h File Reference

#include "tError.h"
#include "tString.h"
#include "tHeap.h"
#include "tLinkedList.h"
#include "tCallback.h"
#include "nObserver.h"
#include "tException.h"
#include <memory>

Include dependency graph for nNetwork.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	nKillHim
class	nIgnore
class	nVersion
class	nVersionFeature
class	nSendBuffer
class	nBandwidthControl
class	nAverager
	class responsible for calculating averages More...
class	nPingAverager
	averager for pings, detects lag More...
struct	nConnectionInfo
class	nDescriptor
class	nMessage
class	nWaitForAck
class	nCallbackLoginLogout
class	nCallbackAcceptPackedWithoutConnection
class	nCallbackReceivedComplete
class	nCurrentSenderID
class	nMachineDecorator
	a decorator for machines for additional information to attach to them More...
class	nMachine
	class trying to collect information about a certain client, persistent between connections More...
class	nSocketResetInhibitor
	while an object of this class exists, the main network sockets won't get reopened More...
Defines
#define	MAXCLIENTS   16
#define	NET_ID_FIRST   100
Typedefs
typedef double	nTimeAbsolute
typedef double	nTimeRolling
typedef void	nHandler (nMessage &m)
Enumerations
enum	nNetState { nSTANDALONE, nSERVER, nCLIENT }
enum	nConnectError { nOK, nTIMEOUT, nDENIED, nABORT }
enum	nLoginType { Login_Pre0252, Login_Post0252, Login_All }
Functions
void	nReadError (bool critical=true)
nConnectError	sn_GetLastError ()
nNetState	sn_GetNetState ()
void	sn_SetNetState (nNetState x)
void	sn_DisconnectUser (int i, const tOutput &reason, nServerInfoBase *redirectTo=0)
	terminate connection with user i (peacefully)
void	sn_KickUser (int i, const tOutput &reason, REAL severity=1, nServerInfoBase *redirectTo=0)
	throw out user i (violently)
void	sn_GetAdr (int user, tString &name)
unsigned int	sn_GetPort (int user)
unsigned int	sn_GetServerPort ()
int	sn_NumUsers ()
int	sn_MaxUsers ()
int	sn_MessagesPending (int user)
nMessage &	operator>> (nMessage &m, nVersion &ver)
nMessage &	operator<< (nMessage &m, const nVersion &ver)
std::istream &	operator>> (std::istream &s, nVersion &ver)
std::ostream &	operator<< (std::ostream &s, const nVersion &ver)
const nVersion &	sn_MyVersion ()
	the version this progam maximally supports
const nVersion &	sn_CurrentVersion ()
	the version currently supported by all connected players
void	sn_UpdateCurrentVersion ()
	updates the sn_CurrentVersion()
std::istream &	operator>> (std::istream &stream, nAverager &averager)
	read operator for nAveragers
std::ostream &	operator<< (std::ostream &stream, nAverager const &averager)
	write operator for nAveragers
nConnectError	sn_Connect (nAddress const &server, nLoginType loginType=Login_All, nSocket const *socket=NULL)
void	sn_Bend (nAddress const &server)
void	sn_Bend (tString const &server, unsigned int port)
void	RequestInfoHandler (nHandler *handle)
void	sn_Delay ()
	pause a bit, abort pause on network activity
void	sn_Receive ()
void	sn_ReceiveFromControlSocket ()
void	sn_DiscardFromControlSocket ()
void	sn_Sync (REAL timeout, bool sync_sn_netObjects=false, bool otherEnd=true)
void	sn_ConsoleOut (const tOutput &message, int client=-1)
nMessage *	sn_ConsoleOutMessage (const tOutput &message)
void	sn_CenterMessage (const tOutput &message, int client=-1)
void	sn_SendPlanned ()
int	sn_QueueLen (int user)
void	sn_Statistics ()
tString const &	sn_GetMyAddress ()
	return the public IP address and port of this machine, or "*.*.*.*:*" if it is unknown..
bool	sn_IsLANAddress (tString const &address)
	checks wheter a given address is on the user's LAN (or on loopback).
std::auto_ptr< nServerInfoBase >	sn_GetRedirectTo ()
nServerInfoBase *	sn_PeekRedirectTo ()
Variables
nBasicNetworkSystem	sn_BasicNetworkSystem
tString	sn_bigBrotherString
tString	sn_programVersion
tString	sn_serverName
unsigned int	sn_serverPort
const unsigned int	sn_defaultPort
int	sn_defaultDelay
tString	sn_DenyReason
int	sn_maxRateIn
int	sn_maxRateOut
nConnectionInfo	sn_Connections [MAXCLIENTS+2]
int	sn_maxNoAck
int	sn_myNetID

---

Define Documentation

#define MAXCLIENTS   16

Definition at line 103 of file nNetwork.h.

Referenced by eVoteItem::AcceptNewVote(), nServerLag::Balance(), nNetObject::ClearAllDeleted(), nNetObject::ClearKnows(), eLag::Credit(), nNetObject::DoBroadcastExistence(), eVoteItemKick::DoExecute(), eVoteItem::Evaluate(), id_req_handler(), kill_id_hog(), login_callback(), eVoteItem::ReBroadcast(), nNetObject::RelabelOnConnect(), eLag::Report(), nNetObject::RequestSync(), nServerInfo::RunMaster(), se_BroadcastChat(), se_BroadcastChatLine(), se_ReadUser(), se_sendEventNotification(), nServerLag::SetClient(), sg_FullscreenMessage(), sn_GetTimeout(), sn_Sync(), gGame::StateUpdate(), nNetObject::SyncAll(), gGame::SyncState(), eLag::TakeCredit(), nNetObject::~nNetObject(), and nServerInfo::~nServerInfo().

#define NET_ID_FIRST   100

Definition at line 410 of file nNetwork.h.

---

Typedef Documentation

typedef void nHandler(nMessage &m)

Definition at line 378 of file nNetwork.h.

typedef double nTimeAbsolute

Definition at line 50 of file nNetwork.h.

typedef double nTimeRolling

Definition at line 53 of file nNetwork.h.

---

Enumeration Type Documentation

enum nConnectError

Enumerator:

nOK
nTIMEOUT
nDENIED
nABORT

Definition at line 108 of file nNetwork.h.

{nOK, nTIMEOUT, nDENIED, nABORT}   nConnectError;

enum nLoginType

Enumerator:

Login_Pre0252
Login_Post0252
Login_All

Definition at line 358 of file nNetwork.h.

{
    Login_Pre0252,  // use the login method known to pre-0.2.5.2 versions
    Login_Post0252, // use the newer login method
    Login_All       // first attempt the new one, then the old one
};

enum nNetState

Enumerator:

nSTANDALONE
nSERVER
nCLIENT

Definition at line 107 of file nNetwork.h.

{nSTANDALONE,nSERVER,nCLIENT} nNetState;

---

Function Documentation

void nReadError

(

bool

critical = true

)

Definition at line 2792 of file nNetwork.cpp.

References con.

Referenced by nNOInitialisator< T >::Init(), login_accept_handler(), nNetObject::Object(), nMessage::Read(), nNetObject::Register(), and nConfItemBase::s_GetConfigMessage().

{
    // st_Breakpoint();
#ifndef NOEXCEPT
    if ( critical )
        throw nKillHim();
    else
        throw nIgnore();
#else
    con << "\nI told you not to use PGCC! Now we need to leave the\n"
    << "system in an undefined state. The progam will crash now.\n"

Here is the caller graph for this function:

std::ostream& operator<<	(	std::ostream &	stream,
		nAverager const &	averager
	)

write operator for nAveragers

Parameters:

	stream	stream to write to
	averager	averager to write

Returns:

stream for chaining

Definition at line 3813 of file nNetwork.cpp.

{

std::ostream& operator<<	(	std::ostream &	s,
		const nVersion &	ver
	)

Definition at line 334 of file nNetwork.cpp.

{
    s << ver.Min() << " ";
    s << ver.Max();

nMessage& operator<<	(	nMessage &	m,
		const nVersion &	ver
	)

Definition at line 315 of file nNetwork.cpp.

{
    m << ver.Min();
    m << ver.Max();

std::istream& operator>>	(	std::istream &	stream,
		nAverager &	averager
	)

read operator for nAveragers

Parameters:

	stream	stream to read to
	averager	averager to read

Returns:

stream for chaining

Definition at line 3796 of file nNetwork.cpp.

{

std::istream& operator>>	(	std::istream &	s,
		nVersion &	ver
	)

Definition at line 323 of file nNetwork.cpp.

{
    int min,max;
    s >> min;
    s >> max;

    ver = nVersion( min, max );

nMessage& operator>>	(	nMessage &	m,
		nVersion &	ver
	)

Definition at line 304 of file nNetwork.cpp.

{
    int min,max;
    m >> min;
    m >> max;

    ver = nVersion( min, max );

void RequestInfoHandler

(

nHandler *

handle

)

Definition at line 1370 of file nNetwork.cpp.

                                         {

void sn_Bend	(	tString const &	server,
		unsigned int	port
	)

Definition at line 2623 of file nNetwork.cpp.

{
    // fill address info
    nAddress address;
    address.SetHostname( server );
    address.SetPort( port );

    // delegate

void sn_Bend

(

nAddress const &

server

)

Definition at line 2615 of file nNetwork.cpp.

References nCLIENT, nSTANDALONE, sn_GetNetState(), and sn_SetNetState().

Referenced by nServerInfo::NetReadThis(), and nServerInfo::QueryServer().

{
    if ((sn_GetNetState() == nSTANDALONE))
        sn_SetNetState(nCLIENT);

Here is the call graph for this function:

Here is the caller graph for this function:

void sn_CenterMessage	(	const tOutput &	message,
		int	client = -1
	)

Definition at line 2911 of file nNetwork.cpp.

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

                                                  {
    tString message(o);

    tJUST_CONTROLLED_PTR< nMessage > m=new nMessage(client_cen_nd);
    *m << message;
    if (client<0){
        m->BroadCast();
        con.CenterDisplay(message);
    }
    else if (client==sn_myNetID)
        con.CenterDisplay(message);

Here is the caller graph for this function:

nConnectError sn_Connect	(	nAddress const &	server,
		nLoginType	loginType = Login_All,
		nSocket const *	socket = NULL
	)

Definition at line 2634 of file nNetwork.cpp.

Referenced by client(), nServerInfoBase::Connect(), and ntest().

                                                                                                 {
    sn_DenyReason = "";

    // reset redirection
    sn_redirectTo.release();

    // pings in the beginning of the login are not really representative
    nPingAverager::SetWeight(.0001);

    // net_hostport = sn_clientPort;

    sn_SetNetState(nSTANDALONE);
    sn_SetNetState(nCLIENT);

    // set user requested socket
    if ( socket )
        sn_Connections[0].socket = socket;

    sn_Connections[0].ping.Reset();

    peers[0] = server;

    reset_last_acks(0);
    nCallbackLoginLogout::UserLoggedOut(0);
    sn_Connections[0].sendBuffer_.Clear();

    tASSERT( sn_Connections[0].socket );

    // sn_Connections[0].socket->Connect( peers[0] ); // useless
    sn_Connections[0].bandwidthControl_.SetRate( sn_maxRateOut );

    sn_myNetID=0; // MAXCLIENTS+1; // reset network id

    // first, get all pending messages
    sn_Receive();
    sn_Receive();
    sn_Receive();

    // reset version control until the true value is given by the server.
    sn_currentVersion = nVersion(0,0);

    // Login stuff.....
    tJUST_CONTROLLED_PTR< nMessage > mess;
    if ( loginType != Login_Pre0252 )
    {
        mess=new nMessage(login_2);
        mess->Write(sn_maxRateIn);

        unsigned short bb = big_brother;
        mess->Write( bb );
        if ( bb ){
            (*mess) << sn_bigBrotherString;
            big_brother=false;
        }
    }
    else
    {
        mess=new nMessage(login);
        mess->Write(sn_maxRateIn);

        // send (worthless) big brother string
        if (big_brother)
        {
            (*mess) << sn_bigBrotherString;
        }
        else
        {
            (*mess) << tString("");
        }

        big_brother=false;
    }

    // write our version
    (*mess) << sn_MyVersion();
    
    // write our supported authentication methods
    (*mess) << nKrawall::nMethod::SupportedMethods();
    
    // write a random salt
    nKrawall::RandomSalt( loginSalt );
    nKrawall::WriteScrambledPassword( loginSalt, *mess );

    mess->ClearMessageID();
    mess->SendImmediately(0,false);
    nMessage::SendCollected(0);

    con << tOutput("$network_login_process");

    login_failed=false;
    login_succeeded=false;

    nTimeRolling timeout=tSysTimeFloat()+5;

    static REAL resend = .25;
    nTimeAbsolute nextSend = tSysTimeFloat() + resend/5;
    while(sn_GetNetState()==nCLIENT && tSysTimeFloat()<timeout &&
            !login_failed && !login_succeeded){
        if ( tSysTimeFloat() > nextSend )
        {
            // con << "retrying...\n";
            nextSend = tSysTimeFloat() + resend;
            mess->SendImmediately(0,false);
            nMessage::SendCollected(0);
        }

        tAdvanceFrame(10000);
        sn_Receive();
        sn_SendPlanned();

        // check for user abort
        if ( tConsole::Idle() )
        {
            con << tOutput("$network_login_failed_abort");
            sn_SetNetState(nSTANDALONE);
            return nABORT;
        }
    }
    if (login_failed)
    {
        con << tOutput("$network_login_failed");
        sn_SetNetState(nSTANDALONE);
        return nDENIED;
    }
    else if (tSysTimeFloat()>=timeout || sn_GetNetState()!=nCLIENT){
        if ( loginType == Login_All )
        {
            return      sn_Connect( server, Login_Pre0252, socket );
        }
        else
        {
            con << tOutput("$network_login_failed_timeout");
            sn_SetNetState(nSTANDALONE);
            return nTIMEOUT;
        }
    }
    else{
        nCallbackLoginLogout::UserLoggedIn(0);

        tOutput mess;
        mess.SetTemplateParameter(1, sn_myNetID);
        mess << "$network_login_success";
        con << mess;
        con << tOutput("$network_login_sync");
        sn_Sync(40);
        con << tOutput("$network_login_relabeling");
        con << tOutput("$network_login_sync2");
        sn_Sync(40,true);
        con << tOutput("$network_login_done");

        // marginalize past ping values
        nPingAverager::SetWeight(1);

        return nOK;

Here is the caller graph for this function:

void sn_ConsoleOut	(	const tOutput &	message,
		int	client = -1
	)

Definition at line 2883 of file nNetwork.cpp.

Referenced by eVoteItem::AcceptNewVote(), eTeam::AddPlayer(), eTeam::AddScore(), ePlayerNetID::AddScore(), gGame::Analysis(), eVoteItem::BroadcastMessage(), eChatSpamTester::Check(), nSpamProtection::CheckSpam(), eVoteItem::CheckValid(), ePlayerNetID::CreateNewTeam(), eVoteItemKick::DoCheckValid(), eVoteItemHarm::DoCheckValid(), ePlayerNetID::FindPlayerByName(), eVoteItem::GetControlMessage(), eVoter::GetVoter(), eVoter::HandleChat(), nDescriptor::HandleMessage(), eTeam::Invite(), IsSilencedWithWarning(), gCycle::KillAt(), gBaseZoneHack::OnVanish(), eVoteItem::ReBroadcast(), ePlayerNetID::ReceiveControlNet(), eTeam::RemovePlayer(), se_CancelAllVotes(), se_ChatMe(), se_ChatMsg(), se_ChatShuffle(), se_ChatTeam(), se_ChatTeamLeave(), se_FindPlayerInChatCommand(), se_LoginWanted(), se_rubyEval(), se_SendTo(), eTeam::SetLocked(), ePlayerNetID::SetTeam(), ePlayerNetID::SetTeamWish(), sg_CreateWinDeathZone(), sg_FullscreenMessage(), sg_TopologyPoliceKill(), eTeam::Shuffle(), StartNewMatch(), gGame::StateUpdate(), ePlayerNetID::Suspend(), ePlayerNetID::TeamChangeAllowed(), gBaseZoneHack::Timestep(), eTeam::UnInvite(), ePlayerNetID::Update(), update_settings(), eTeam::UpdateAppearance(), ePlayerNetID::UpdateName(), ePlayerNetID::UpdateTeam(), and ePlayerNetID::WaitToLeaveChat().

                                               {
    //  tString message(o);

    tJUST_CONTROLLED_PTR< nMessage > m = sn_ConsoleOutMessage( o );

    if (client<0){
        m->BroadCast();
        con << o;
    }
    else if (client==sn_myNetID)
    {
        con << o;
    }

nMessage* sn_ConsoleOutMessage

(

const tOutput &

message

)

Definition at line 2859 of file nNetwork.cpp.

Referenced by se_OldChatMessage().

{
    tString message(o);
    message  << "0xffffff";

    // truncate message to 1.4K, a safe size for all UDP packets
    static const int maxLen = 1400;
    static bool recurse = true;
    if ( message.Len() > maxLen && recurse )
    {
        recurse = false;
        tERR_WARN( "Long console message truncated.");

        message.SetLen( maxLen+1 );
        message[maxLen]='\0';
        recurse = false;
    }

    nMessage* m=new nMessage(sn_ConsoleOut_nd);
    *m << message;

Here is the caller graph for this function:

const nVersion& sn_CurrentVersion

(

)

the version currently supported by all connected players

Definition at line 240 of file nNetwork.cpp.

Referenced by nServerInfo::DoGetFrom(), and nConfItemVersionWatcher::DoWritable().

{

Here is the caller graph for this function:

void sn_Delay

(

)

pause a bit, abort pause on network activity

Definition at line 134 of file nNetwork.cpp.

Referenced by ConnectToServerCore(), gGame::NetSyncIdle(), and sn_Sync().

{
    sn_BasicNetworkSystem.Select( sn_defaultDelay / 1000000.0 );
    tAdvanceFrame();

Here is the caller graph for this function:

void sn_DiscardFromControlSocket

(

)

Definition at line 2440 of file nNetwork.cpp.

References nSocket::Read(), and nConnectionInfo::socket.

Referenced by sg_Receive().

{
    // new facts: pending incoming data on the control socket causes the idle loops
    // to use 100% CPU time, we need to fetch and discard the data instead of ignoring it.
    if ( sn_Connections[0].socket )
    {
        int8 buff[2];
        nAddress addrFrom;
        sn_Connections[0].socket->Read( reinterpret_cast<int8 *>(buff),0, addrFrom);

Here is the call graph for this function:

Here is the caller graph for this function:

void sn_DisconnectUser	(	int	i,
		const tOutput &	reason,
		nServerInfoBase *	redirectTo = 0
	)

terminate connection with user i (peacefully)

Definition at line 3167 of file nNetwork.cpp.

Referenced by Cheater(), nDescriptor::HandleMessage(), kill_id_hog(), logout_handler(), ePlayerNetID::MyInitAfterCreation(), rec_peer(), req_info_handler(), and nServerInfo::RunMaster().

{
    // don't be daft and kill yourself, server!
    if ( i == 0 && sn_GetNetState() == nSERVER )
    {
        tERR_WARN( "Server tried to disconnect from itself." );
        return;
    }

    // clients can only disconnect from the server
    if ( i != 0 && sn_GetNetState() == nCLIENT )
    {
        tERR_ERROR( "Client tried to disconnect from another client: impossible and a bad idea." );
        return;
    }

    // anything to do at all?
    if (!sn_Connections[i].socket)
    {
        return;
    }

Here is the caller graph for this function:

void sn_GetAdr	(	int	user,
		tString &	name
	)

Definition at line 3424 of file nNetwork.cpp.

Referenced by FinishHandlePasswordRequest(), GetSenderData(), nServerInfo::GiveSmallServerInfo(), and nServerInfoBase::NetReadThis().

                         : 0;
}

void sn_GetAdr(int user,  tString& name)

Here is the caller graph for this function:

nConnectError sn_GetLastError

(

)

Definition at line 457 of file nNetwork.cpp.

References nOK.

Referenced by ConnectToServerCore().

{
    nConnectError ret = sn_Error;
    sn_Error = nOK;

Here is the caller graph for this function:

tString const& sn_GetMyAddress

(

)

return the public IP address and port of this machine, or "*.*.*.*:*" if it is unknown..

Definition at line 64 of file nNetwork.cpp.

                                     :*");
tString const & sn_GetMyAddress()
{
    return sn_myAddress;

nNetState sn_GetNetState

(

)

Definition at line 2453 of file nNetwork.cpp.

Referenced by eVoteItem::AcceptNewVote(), gCycle::Act(), gNetPlayerWall::ActionOnQuit(), gCycle::ActionOnQuit(), Activate(), gCycleChatBot::Activate(), nConfItemVersionWatcher::AdaptVersion(), gCycleMovement::AddDestination(), eTeam::AddPlayer(), eTeam::AddScore(), gEnemyInfluence::AddSensor(), gEnemyInfluence::AddWall(), gGame::Analysis(), blocks(), gNetPlayerWall::BlowHole(), nMessage::BroadCast(), eVoteItem::BroadcastMessage(), gCycleMovement::CalculateAcceleration(), eVoteItem::CheckValid(), client(), ConnectToServerCore(), gCycleMovement::CopyFrom(), gNetPlayerWall::CopyIntoGrid(), ePlayerNetID::CreateNewTeam(), ePlayerNetID::CreateNewTeamWish(), ePlayerNetID::CreateVoter(), eLag::Credit(), gCycle::Die(), nNetObject::DoBroadcastExistence(), eVoteItemKick::DoCheckValid(), eVoteItemHarm::DoCheckValid(), eVoteItemHarmServerControlled::DoFillFromMessage(), eVoteItem::DoFillFromMessage(), eVoteItemHarmServerControlled::DoFillToMessage(), eVoteItem::DoFillToMessage(), gCycle::DoTurn(), ePlayerNetID::Enemies(), eNetGameObject::eNetGameObject(), eTeam::Enforce(), eMenuItemKick::Enter(), eTimer::eTimer(), eVoteItemServerControlled::Evaluate(), eVoteItem::Evaluate(), exit_game_objects(), eVoteItem::FillFromMessage(), eGameObject::FindCurrentFace(), first_fill_ids(), GameLoop(), gGame::GameLoop(), nServerInfo::GetBigServerInfoMaster(), eVoteItem::GetControlMessage(), nServerInfo::GetFromLAN(), nServerInfo::GetFromLANContinuously(), nServerInfo::GetFromMaster(), gGame::gGame(), gNetPlayerWall::gNetPlayerWall(), handle_chat_client(), nAuthentication::HandlePasswordRequest(), id_req_handler(), ingame_menu_cleanup(), nNOInitialisator< T >::Init(), init_game_camera(), init_game_objects(), eVoter::IsSpamming(), eTimer::IsSynced(), gCycle::Kill(), gCycle::KillAt(), eNetGameObject::LagThreshold(), ePlayer::LogIn(), login_accept_handler(), login_callback(), login_ignore_handler(), LoginLogout(), MainMenu(), gCamera::MyInit(), gCycle::MyInitAfterCreation(), ePlayerNetID::MyInitAfterCreation(), net_clear_handler(), net_control_handler(), net_sync_handler(), new_destination_handler(), next_free(), next_free_server_nokill(), nNetObject::nNetObject(), gGame::NoLongerGoOn(), ntest(), nWaitForAck::nWaitForAck(), nNetObject::Object(), gCycleMovement::OnNotifyNewDestination(), gCycle::OnNotifyNewDestination(), gCycle::OnRemoveFromGame(), nConfItemVersionWatcher::OnVersionChange(), gParser::parseSetting(), gParser::parseZoneArthemis_v1(), gCycle::PassEdge(), eTimer::pause(), eTeam::PlayerMayJoin(), nNetObject::ReadSync(), eTeam::ReadSync(), eVoteItem::ReBroadcast(), rec_peer(), eNetGameObject::ReceiveControl(), nNetObject::ReceiveControlNet(), nNetObject::Register(), nNetObject::RelabelOnConnect(), ePlayerNetID::RemoveChatbots(), eTeam::RemovePlayer(), gCycle::Render(), req_id_handler(), nNetObject::RequestSync(), gCycle::RequestSyncAll(), gCycle::RequestSyncOwner(), eTimer::Reset(), eTeam::ResetScore(), gAIPlayer::RightBeforeDeath(), nConfItemBase::s_GetConfigMessage(), nConfItemBase::s_SendConfig(), se_CancelAllVotes(), se_GetPing(), se_HandleNewServerVote(), se_NeedsServer(), se_OptionalNameFilters(), se_PauseGameTimer(), se_receiveLagMessage(), se_rubyEval(), se_WantLogin(), nMessage::Send(), ePlayer::SendAuthNames(), nConfItemBase::SendConfig(), eNetGameObject::SendControl(), nMessage::SendImmediately(), server(), ePlayerNetID::SetChatting(), zShape::setColor(), ePlayerNetID::SetDefaultTeam(), ePlayerNetID::SetName(), eNetGameObject::SetPlayer(), zShape::setRotation2(), eTeam::SetScore(), gGame::SetState(), ePlayerNetID::SetTeam(), ePlayerNetID::SetTeamWish(), sg_Deprecated(), sg_DropTempWall(), sg_KillFutureWalls(), sg_ParseMap(), sg_Receive(), sg_RespawnPlayer(), sg_TopologyPoliceKill(), sg_UseAntiLagSliding(), sn_Bend(), sn_ConsoleOut_handler(), sn_Sync(), eVoter::Spam(), StartNewMatch(), gGame::StateUpdate(), sync_msg_handler(), nNetObject::SyncAll(), gCycle::SyncEnemy(), gGame::SyncState(), eTimer::SyncTime(), nServerInfo::TellMasterAboutMe(), gAIPlayer::ThinkCloseCombat(), gBaseZoneHack::Timestep(), gCycleMovement::Timestep(), gCycle::Timestep(), eNetGameObject::Timestep(), gCycleMovement::TimestepCore(), gCycle::TimestepCore(), eGameObject::TimestepThis(), eGameObject::TimestepThisWrapper(), gNetPlayerWall::Update(), ePlayerNetID::Update(), update_settings(), eTeam::UpdateAppearance(), ePlayerNetID::UpdateName(), eTeam::UpdateProperties(), ePlayerNetID::UpdateTeam(), eVoter::VotingPossible(), nConfItemBase::Writable(), nNetObject::WriteSync(), eVoteItemServerControlled::~eVoteItemServerControlled(), and nNetObject::~nNetObject().

                          {

unsigned int sn_GetPort

(

int

user

)

Definition at line 3429 of file nNetwork.cpp.

Referenced by GetSenderData(), and nServerInfo::GiveSmallServerInfo().

{

Here is the caller graph for this function:

std::auto_ptr< nServerInfoBase > sn_GetRedirectTo

(

)

Definition at line 1376 of file nNetwork.cpp.

Referenced by ConnectToServer().

{

Here is the caller graph for this function:

unsigned int sn_GetServerPort

(

)

Definition at line 3434 of file nNetwork.cpp.

Referenced by nServerInfoBase::DoGetFrom(), and nServerInfo::TellMasterAboutMe().

{

Here is the caller graph for this function:

bool sn_IsLANAddress

(

tString const &

address

)

checks wheter a given address is on the user's LAN (or on loopback).

Definition at line 70 of file nNetwork.cpp.

Referenced by login_accept_handler().

{
    if ( address.StartsWith("127.") || address.StartsWith("10.") || address.StartsWith("192.168.") )
    {
        // easy LANs. Accept the client sent IP, we don't know our own LAN address.
        return true;
    }

    if( address.StartsWith( "172." ) && address[6] == '.' )
    {
        // more complicated LAN :)
        int second = address.SubStr(4,2).ToInt();
        if ( 16 <= second && second < 32 )
        {
            return true;
        }
    }

    return false;

Here is the caller graph for this function:

void sn_KickUser	(	int	i,
		const tOutput &	reason,
		REAL	severity = 1,
		nServerInfoBase *	redirectTo = 0
	)

throw out user i (violently)

Definition at line 3152 of file nNetwork.cpp.

Referenced by nSpamProtection::CheckSpam(), ePlayerNetID::RemoveChatbots(), and se_VoteKickUser().

{
    // print it
    con << tOutput( "$network_kill_log", i, reason );

    // log it
    if ( severity > 0 )
    {
        nMachine::GetMachine(i).OnKick( severity );
    }

Here is the caller graph for this function:

int sn_MaxUsers

(

)

Definition at line 3463 of file nNetwork.cpp.

Referenced by nServerInfo::DoGetFrom().

{

Here is the caller graph for this function:

int sn_MessagesPending

(

int

user

)

Definition at line 3468 of file nNetwork.cpp.

Referenced by client(), and nServerInfo::RunMaster().

{

Here is the caller graph for this function:

const nVersion& sn_MyVersion

(

)

the version this progam maximally supports

Definition at line 235 of file nNetwork.cpp.

Referenced by nServerInfo::CalcScore(), nServerInfo::Compatibility(), and nConfItemVersionWatcher::OnVersionChange().

{

Here is the caller graph for this function:

int sn_NumUsers

(

)

Definition at line 3453 of file nNetwork.cpp.

{

nServerInfoBase* sn_PeekRedirectTo

(

)

Definition at line 1381 of file nNetwork.cpp.

Referenced by sg_NetworkError().

{

Here is the caller graph for this function:

int sn_QueueLen

(

int

user

)

Definition at line 3268 of file nNetwork.cpp.

Referenced by sn_Sync().

                         {

Here is the caller graph for this function:

void sn_Receive

(

)

Definition at line 3092 of file nNetwork.cpp.

Referenced by client(), nServerInfo::DoQueryAll(), nServerInfo::GetFromLAN(), nServerInfo::GetFromMaster(), main(), next_free(), ntest(), nNetObject::Object(), gBrowserMenuItem::RenderBackground(), nServerInfo::RunMaster(), server(), sg_Receive(), sn_Sync(), and nServerInfo::TellMasterAboutMe().

                 {
    /*
      static bool reentry=false;
      if (reentry)
      return;
      reentry=true;
    */

    netTime=tSysTimeFloat();
    //  new_id=0;
    sn_Connections[MAXCLIENTS+1].ping.Reset();

    // create the ack messages (not required, is done on demand later)
    /*
    int i;
    for(i=0;i<=MAXCLIENTS+1;i++)
        if(sn_Connections[i].ackMess==NULL)
            sn_Connections[i].ackMess=new nAckMessage();
    */


    switch (current_state){
    case nSERVER:
        {
            memset( &peers[0], 0, sizeof(sockaddr) );

            // listen on all sockets
            nSocketListener const & listener = sn_BasicNetworkSystem.GetListener();
            for ( nSocketListener::iterator i = listener.begin(); i != listener.end(); ++i )
            {
                // clear peer info used for receiving
                memset( &peers[MAXCLIENTS+1], 0, sizeof(sockaddr) );

                if((sn_Connections[MAXCLIENTS+1].socket = (*i).CheckNewConnection() ) != NULL)
                    rec_peer(MAXCLIENTS+1);
            }
        }
        // z-man: after much thought, the server does also need to listen to the
        // network control socket. .... Thinking again, it's only important for the master
        // servers, and they call rec_peer(0) separately.
        break;

    case nCLIENT:
        rec_peer(0);
        break;

    case nSTANDALONE:
    default:
        break;
    }

    /*
        // scedule regular messages
        REAL dt = sn_SendPlanned1();

        // actually resend messages

Here is the caller graph for this function:

void sn_ReceiveFromControlSocket

(

)

Definition at line 2434 of file nNetwork.cpp.

References rec_peer().

Referenced by main().

{

Here is the call graph for this function:

Here is the caller graph for this function:

void sn_SendPlanned

(

)

Definition at line 3070 of file nNetwork.cpp.

Referenced by client(), ConnectToServerCore(), nServerInfo::DoQueryAll(), gGame::GameLoop(), nServerInfo::GetFromLAN(), nServerInfo::GetFromMaster(), main(), gGame::NetSync(), next_free(), ntest(), nNetObject::Object(), gBrowserMenuItem::RenderBackground(), nServerInfo::RunMaster(), server(), sn_Sync(), and nServerInfo::TellMasterAboutMe().

{
    // propagate messages to buffers
    REAL dt = sn_SendPlanned1();

    // schedule the acks: send them if it's possible (bandwith limit) or if there already is a packet in the pipe.
    for(int i=0;i<=MAXCLIENTS+1;i++)
        if(sn_Connections[i].socket && sn_Connections[i].ackMess && !sn_Connections[i].ackMess->End()
                //      && sn_ackAckPending[i] <= 1+sn_Connections[].ackMess[i]->DataLen()
                && ( sn_Connections[i].bandwidthControl_.CanSend() || sn_Connections[i].sendBuffer_.Len() > 0 )
          ){
            sn_Connections[i].ackMess->SendImmediately(i, false);
            sn_Connections[i].ackMess=NULL;
        }

    // schedule lost messages for resending
    nWaitForAck::Resend();

Here is the caller graph for this function:

void sn_SetNetState

(

nNetState

x

)

Definition at line 2529 of file nNetwork.cpp.

Referenced by client(), ConnectToServerCore(), nServerInfo::GetFromLAN(), nServerInfo::GetFromLANContinuously(), nServerInfo::GetFromLANContinuouslyStop(), nServerInfo::GetFromMaster(), main(), ntest(), Poll(), ret_to_MainMenu(), server(), sg_HostGame(), singlePlayer_game(), sn_Bend(), and nServerInfo::TellMasterAboutMe().

                                {
    static bool reentry=false;
    if(!reentry && x!=current_state){
        sn_UpdateCurrentVersion();

        //if (x == nSERVER)
        unsigned int net_hostport = sn_serverPort;

        // save/load machines on entering/leaving server mode
        if ( x == nSERVER )
            sn_LoadMachines();
        else if ( current_state == nSERVER )
            if ( !tRecorder::IsPlayingBack() )
                sn_SaveMachines();

        reentry=true;
        if (x!=nSTANDALONE)
        {
            if (x==nCLIENT)
            {
                sn_DisconnectAll();
            }
            else
            {
                sn_myNetID=0;
            }

            if (!sn_Connections[0].socket)
                sn_Connections[0].socket=sn_BasicNetworkSystem.Init();
            // bool success = true;
            if (x == nSERVER)
            {
                // bool success =
                sn_Listen( net_hostport, net_hostip ) ||    // first try: do it according to user specs
                sn_Listen( net_hostport, tString( "ANY" ) ) ||         // second try: bind to generic IP
                sn_Listen( net_hostport, tString( "ALL" ) );           // last try: bind to all available IPs

#ifdef DEDICATED
                // save host port that worked, otherwise it may change from the port sent to the master server
                sn_serverPort = net_hostport;
#endif
            }
        }
        else
        {
            clear_owners();
            for(int i=MAXCLIENTS+1;i>=0;i--){
                if(sn_Connections[i].socket){
                    if (i==0 && current_state!=nSERVER)
                    { // logout: fire and forget
                        con << tOutput("$network_logout_process");
                        for(int j=3;j>=0;j--){ // just to make sure
                            nMessage *lo=new nMessage(logout);
                            lo->Write(static_cast<unsigned short>(sn_myNetID));
                            lo->ClearMessageID();
                            lo->SendImmediately(0, false);
                            nMessage::SendCollected(0);
                            tDelay(1000);
                        }
                        con << tOutput("$network_logout_done");

                        sn_myNetID=0; // MAXCLIENTS+1; // reset network id
                    }
                }
                sn_DisconnectUserNoWarn(i, "$network_kill_shutdown");
            }

            sn_Connections[0].socket = 0;

            // shutdown network system to get new socket
            if ( !sn_noReset )
                sn_BasicNetworkSystem.Shutdown();
        }

        current_state=x;
        reentry=false;
    }

Here is the caller graph for this function:

void sn_Statistics

(

)

Definition at line 3340 of file nNetwork.cpp.

References con, dt, REAL, tOutput::SetTemplateParameter(), and tSysTimeFloat().

Referenced by gGame::StateUpdate().

{
    nTimeRolling time = tSysTimeFloat();
    REAL dt = time - sn_StatsTime;
    sn_StatsTime = time;

    if (dt > 0 && (sn_SentPackets || sn_SentBytes))
    {
        tOutput o;
        o.SetTemplateParameter(1,dt);
        o.SetTemplateParameter(2,sn_SentBytes);
        o.SetTemplateParameter(3,sn_SentPackets);
        o.SetTemplateParameter(4,sn_SentBytes/dt);
        o.SetTemplateParameter(5,sn_ReceivedBytes);
        o.SetTemplateParameter(6,sn_ReceivedPackets);
        o.SetTemplateParameter(7,sn_ReceivedBytes/dt);
        o << "$network_statistics1";
        o << "$network_statistics2";
        o << "$network_statistics3";

        con << o;
    }

    sn_SentPackets = 0;
    sn_SentBytes   = 0;

Here is the call graph for this function:

Here is the caller graph for this function:

void sn_Sync	(	REAL	timeout,
		bool	sync_sn_netObjects = false,
		bool	otherEnd = true
	)

Definition at line 1901 of file nNetObject.cpp.

References MAXCLIENTS, nCLIENT, nSERVER, nConnectionInfo::PacketLoss(), REAL, sn_Connections, sn_Delay(), sn_GetNetState(), sn_QueueLen(), sn_Receive(), sn_SendPlanned(), nVersionFeature::Supported(), sync_nd, nNetObject::SyncAll(), and tSysTimeFloat().

Referenced by gGame::StateUpdate(), sync_msg_handler(), and gGame::SyncState().

                                                                 {
    nTimeAbsolute endTime=timeout+tSysTimeFloat();

#ifdef DEBUG
    //con << "Start sync...\n";
#endif

    if (sn_GetNetState()==nCLIENT){
        // repeat as often as packet loss suggests: of 100 packets, we want a single lost packet left probability of 1%.
        REAL failureProbability = 1;
        while ( failureProbability > .0001 && timeout > .01 )
        {
            failureProbability *= sn_Connections[0].PacketLoss();
            // con << failureProbability << "\n";

            // server responding to sync request message
            static nVersionFeature sg_ServerSync( 10 );

            // ask server when we're fully synced from his side
            sync_ack[0]=true;
            if ( sg_ServerSync.Supported( 0 ) && otherEnd )
            {
                tJUST_CONTROLLED_PTR< nMessage > m=new nMessage(sync_nd);
                *m << timeout;
                m->Write(sync_sn_netObjects);
                m->Write(c_sync);
                m->Send(0);
                sync_ack[0]=false;
            }
            else
            {
                // repeating the procedure is useless anyway
                failureProbability = 0;
            }

            // wait for all packets to be sent and the sync ack packet to be received
            while ( sn_Connections[0].socket && ( sync_ack[0] == false || sn_Connections[0].ackPending>0 || sn_QueueLen(0)) &&
                    tSysTimeFloat()<endTime){
                sn_Delay();
                sn_Receive();
                if (sync_sn_netObjects)
                    nNetObject::SyncAll();
                sn_SendPlanned();
            }

            // decrease timeout for next try
            timeout *= .5;
            endTime=timeout+tSysTimeFloat();
        }
    }
    else if (sn_GetNetState()==nSERVER){
        for (int user=MAXCLIENTS;user>0;user--){
            sync_ack[user]=false;
            if (sn_Connections[user].socket){
                tJUST_CONTROLLED_PTR< nMessage > m=new nMessage(sync_nd);
                *m << timeout;
                m->Write(sync_sn_netObjects);
                m->Write(c_sync);
                m->Send(user);
            }
        }

        bool goon=true;
        while (goon){
            sn_Delay();
            sn_Receive();
            if (sync_sn_netObjects)
                nNetObject::SyncAll();
            sn_SendPlanned();

            goon=false;
            for (int user=MAXCLIENTS;user>0;user--)
            {
                if (sn_Connections[user].socket &&
                        (!sync_ack[user] || sn_Connections[user].ackPending>0 || sn_QueueLen(user)))
                {
                    goon=true;
                }
            }

            if (tSysTimeFloat()>endTime)
            {
                goon=false;
            }
        }
    }

#ifdef DEBUG
    //con << "Stop sync.\n";
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

void sn_UpdateCurrentVersion

(

)

updates the sn_CurrentVersion()

Definition at line 393 of file nNetwork.cpp.

Referenced by nConfItemVersionWatcher::OnChange().

{
    // update the current version from the native version and the versions of all attached clients

    // allow maximally sn_MaxBackwardsCompatibility old versions to connect
    int min = sn_myVersion.Max() - sn_MaxBackwardsCompatibility;
    if ( min < sn_myVersion.Min() )
        min = sn_myVersion.Min();

    // disable features that are too new
    int max = sn_myVersion.Max() - sn_newFeatureDelay;
    if ( max < min )
        max = min;

    nVersion version( min, max );

    // ask configuration if version is OK
    nConfItemVersionWatcher::AdaptVersion( version );

    nVersion maxVersion = version;

    if ( sn_GetNetState() == nCLIENT )
    {
        sn_currentVersion = version;
        return;
    }

    for ( int i = MAXCLIENTS; i>0; --i )
    {
        const nConnectionInfo& info = sn_Connections[i];
        if ( info.socket )
        {
            if ( ! version.Merge( version, info.version ) )
            {
                // kick user; it has gotten incompatible.
                static bool recurse = true;
                if ( recurse )
                {
                    recurse = false;
                    sn_DisconnectUser( i, "$network_kill_incompatible" );
                    recurse = true;
                }

                version = maxVersion;
            }
        }
    }

    // inform configuration of changes
    nConfItemVersionWatcher::OnVersionChange( version );

    if ( version != sn_currentVersion )
    {
        sn_currentVersion = version;

        nMessage* m = tNEW( nMessage )( versionControl );
        (*m) << version;

        m->BroadCast();

Here is the caller graph for this function:

---

Variable Documentation

nBasicNetworkSystem sn_BasicNetworkSystem

Definition at line 3473 of file nNetwork.cpp.

Referenced by main(), sg_HostGame(), sn_Listen(), nServerInfo::TellMasterAboutMe(), update_settings(), and gNetIdler::Wait().

tString sn_bigBrotherString

Definition at line 99 of file nNetwork.cpp.

Referenced by ConnectToServerCore(), and main().

nConnectionInfo sn_Connections[MAXCLIENTS+2]

Definition at line 206 of file nNetwork.cpp.

Referenced by eVoteItem::AcceptNewVote(), nServerLag::Balance(), Cheater(), nNetObject::ClearAllDeleted(), gNetPlayerWall::CopyIntoGrid(), ePlayerNetID::CreateVoter(), nNetObject::DoBroadcastExistence(), ePlayerNetID::ePlayerNetID(), GameLoop(), nServerInfo::GetBigServerInfoCommon(), nServerInfo::GiveBigServerInfo(), nServerInfo::GiveSmallServerInfo(), next_free(), nNetObject::Object(), nServerLag::Ping(), eTimer::ReadSync(), ready_handler(), gNetPlayerWall::RealWallReceived(), eVoteItem::ReBroadcast(), nServerInfo::RunMaster(), se_BroadcastChat(), se_BroadcastChatLine(), se_GetPing(), se_ReadUser(), se_sendEventNotification(), sg_FullscreenMessage(), sn_GetTimeout(), sn_Sync(), gGame::StateUpdate(), nNetObject::SyncAll(), gGame::SyncState(), nServerInfo::TellMasterAboutMe(), gCycleMovement::TimestepCore(), and gCycle::TimestepCore().

int sn_defaultDelay

Definition at line 131 of file nNetwork.cpp.

Referenced by Render().

const unsigned int sn_defaultPort

Definition at line 115 of file nNetwork.cpp.

tString sn_DenyReason

Definition at line 1433 of file nNetwork.cpp.

Referenced by ConnectToServerCore(), and sg_NetworkError().

int sn_maxNoAck

Definition at line 192 of file nNetwork.cpp.

Referenced by nNetObject::SyncAll().

int sn_maxRateIn

Definition at line 140 of file nNetwork.cpp.

Referenced by net_options().

int sn_maxRateOut

Definition at line 141 of file nNetwork.cpp.

Referenced by net_options().

int sn_myNetID

Definition at line 491 of file nNetwork.cpp.

Referenced by nNetObject::ClearKnows(), nNetObject::DoBroadcastExistence(), gCycle::DoTurn(), gCycle::EdgeIsDangerous(), new_destination_handler(), nNetObject::nNetObject(), gCycleMovement::OnNotifyNewDestination(), gCycle::OnNotifyNewDestination(), nNetObject::Owner(), gCycle::ReadSync(), gNetPlayerWall::RealWallReceived(), nNetObject::RelabelOnConnect(), nNetObject::RequestSync(), se_ChatState(), se_GetLocalPlayer(), se_GetPing(), eNetGameObject::SendControl(), ePlayerNetID::SetTeamWish(), nNetObject::SyncAll(), gCycle::SyncEnemy(), eNetGameObject::SyncIsNew(), gCycle::Timestep(), eNetGameObject::Timestep(), ePlayerNetID::Update(), and nNetObject::~nNetObject().

tString sn_programVersion

Referenced by nServerInfo::DoGetFrom(), main(), and MainMenu().

tString sn_serverName

Referenced by nServerInfo::DoGetFrom(), and sg_HostGameMenu().

unsigned int sn_serverPort

Definition at line 116 of file nNetwork.cpp.

Referenced by main(), and sg_HostGameMenu().

---