NetInterface Class Reference

#include <NetInterface.h>

Inheritance diagram for NetInterface:

List of all members.

Public Member Functions
	NetInterface ()
virtual	~NetInterface ()
virtual bool	started ()=0
virtual bool	connect (const char *hostName, int portNo)=0
virtual bool	start (int portNo)=0
virtual void	stop ()=0
virtual int	processMessages ()=0
virtual void	setMessageHandler (NetMessageHandlerI *handler)=0
virtual void	disconnectAllClients ()=0
virtual void	disconnectClient (unsigned int client)=0
virtual void	sendMessageServer (NetBuffer &buffer, unsigned int flags=0)=0
virtual void	sendMessageDest (NetBuffer &buffer, unsigned int destination, unsigned int flags=0)=0
Static Public Member Functions
static unsigned int &	getBytesIn ()
static unsigned int &	getBytesOut ()
static unsigned int &	getPings ()
static unsigned int &	getConnects ()
static const char *	getIpName (unsigned int ipAddress)
Static Protected Attributes
static unsigned int	bytesIn_ = 0
static unsigned int	bytesOut_ = 0
static unsigned int	pings_ = 0
static unsigned int	connects_ = 0

---

Detailed Description

Definition at line 27 of file NetInterface.h.

---

Constructor & Destructor Documentation

NetInterface::NetInterface

(

)

Definition at line 29 of file NetInterface.cpp.

NetInterface::~NetInterface

(

)

[virtual]

Definition at line 33 of file NetInterface.cpp.

---

Member Function Documentation

virtual bool NetInterface::started

(

)

[pure virtual]

Implemented in NetLoopBack, NetServerTCP, NetServerTCP2, and NetServerTCP3.

Referenced by ConnectDialog::connected().

virtual bool NetInterface::connect	(	const char *	hostName,
		int	portNo
	)			[pure virtual]

Implemented in NetLoopBack, NetServerTCP, NetServerTCP2, and NetServerTCP3.

Referenced by ConnectDialog::tryLocalConnection(), and ConnectDialog::tryRemoteConnection().

virtual bool NetInterface::start

(

int

portNo

)

[pure virtual]

Implemented in NetLoopBack, NetServerTCP, NetServerTCP2, and NetServerTCP3.

virtual void NetInterface::stop

(

)

[pure virtual]

Implemented in NetLoopBack, NetServerTCP, NetServerTCP2, and NetServerTCP3.

Referenced by ClientConnectionAuthHandler::cancelAuth(), ConnectDialog::connected(), initComs(), and ConnectDialog::simulate().

virtual int NetInterface::processMessages

(

)

[pure virtual]

Implemented in NetLoopBack, NetServerTCP, NetServerTCP2, and NetServerTCP3.

Referenced by ServerCommon::kickDestination(), ServerCommon::kickPlayer(), serverLoop(), and ClientProcessingLoop::simulate().

virtual void NetInterface::setMessageHandler

(

NetMessageHandlerI *

handler

)

[pure virtual]

Implemented in NetLoopBack, NetServerTCP, NetServerTCP2, and NetServerTCP3.

Referenced by initComs(), and startServer().

virtual void NetInterface::disconnectAllClients

(

)

[pure virtual]

Implemented in NetLoopBack, NetServerTCP, NetServerTCP2, and NetServerTCP3.

Referenced by ClientMessageHandler::clientError(), and ClientMain::clientMain().

virtual void NetInterface::disconnectClient

(

unsigned int

client

)

[pure virtual]

Implemented in NetLoopBack, NetServerTCP, NetServerTCP2, and NetServerTCP3.

virtual void NetInterface::sendMessageServer	(	NetBuffer &	buffer,
		unsigned int	flags = 0
	)			[pure virtual]

Implemented in NetLoopBack, NetServerTCP, NetServerTCP2, and NetServerTCP3.

Referenced by ClientKeepAliveSender::send(), and ComsMessageSender::sendToServer().

virtual void NetInterface::sendMessageDest	(	NetBuffer &	buffer,
		unsigned int	destination,
		unsigned int	flags = 0
	)			[pure virtual]

Implemented in NetLoopBack, NetServerTCP, NetServerTCP2, and NetServerTCP3.

Referenced by ComsMessageSender::sendToMultipleClients().

static unsigned int& NetInterface::getBytesIn

(

)

[inline, static]

Definition at line 48 of file NetInterface.h.

References bytesIn_.

Referenced by NetServerTCP3Recv::actualRecvFunc(), NetServerTCP2Destination::checkIncoming(), ServerBrowserInfo::processMessages(), ServerWebHandler::GameHandler::processRequest(), NetServerHTTPProtocolRecv::readBuffer(), NetServerHTTPProtocolSend::readBuffer(), and NetServerTCPScorchedProtocol::readBuffer().

static unsigned int& NetInterface::getBytesOut

(

)

[inline, static]

Definition at line 49 of file NetInterface.h.

References bytesOut_.

Referenced by NetServerTCP3Send::actualSendFunc(), NetServerTCP2Destination::checkOutgoing(), ServerBrowserInfo::processMessages(), ServerWebHandler::GameHandler::processRequest(), NetServerHTTPProtocolRecv::sendBuffer(), NetServerHTTPProtocolSend::sendBuffer(), NetServerTCPScorchedProtocol::sendBuffer(), and NetServerTCP2Destination::sendHeader().

static unsigned int& NetInterface::getPings

(

)

[inline, static]

Definition at line 50 of file NetInterface.h.

References pings_.

Referenced by ServerBrowserInfo::processMessages(), and ServerWebHandler::GameHandler::processRequest().

static unsigned int& NetInterface::getConnects

(

)

[inline, static]

Definition at line 51 of file NetInterface.h.

References connects_.

Referenced by NetServerTCP3::addDestination(), NetServerTCP2::addDestination(), NetServerTCP::pollIncoming(), and ServerWebHandler::GameHandler::processRequest().

const char * NetInterface::getIpName

(

unsigned int

ipAddress

)

[static]

Definition at line 37 of file NetInterface.cpp.

References snprintf.

Referenced by StatsLoggerDatabase::addInfo(), ServerMessageHandler::clientConnected(), ServerMessageHandler::clientDisconnected(), ServerBrowserCollect::fetchLANList(), SecureID::getSecureID(), ServerWebServer::processMessage(), ServerAdminHandler::processMessage(), ServerWebHandler::BannedHandler::processRequest(), ServerWebHandler::PlayerHandler::processRequest(), refreshIdentControls(), ServerBanned::save(), and UniqueIdStore::saveUniqueId().

---

Member Data Documentation

unsigned int NetInterface::bytesIn_ = 0 [static, protected]

Definition at line 55 of file NetInterface.h.

Referenced by getBytesIn().

unsigned int NetInterface::bytesOut_ = 0 [static, protected]

Definition at line 56 of file NetInterface.h.

Referenced by getBytesOut().

unsigned int NetInterface::pings_ = 0 [static, protected]

Definition at line 57 of file NetInterface.h.

Referenced by getPings().

unsigned int NetInterface::connects_ = 0 [static, protected]

Definition at line 58 of file NetInterface.h.

Referenced by getConnects().

---

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

• src/common/net/NetInterface.h
• src/common/net/NetInterface.cpp

---