#include <NetworkInterface.h>

Inherited by Network.

Public Member Functions
virtual	~NetworkInterface ()

virtual void	init (void)=0
	Initialize the network.

virtual void	reset (void)=0
	Re-initialize the network.

virtual void	update (void)=0
	Updates the network.

virtual void	liteupdate (void)=0
	does a lightweight update for passing messages around.

virtual void	setLocalAddress (UnsignedInt ip, UnsignedInt port)=0
	Tell the network what local ip and port to bind to.

virtual Bool	isFrameDataReady (void)=0
	Are the commands for the next frame available?

virtual void	parseUserList (const GameInfo *game)=0
	Parse a userlist, creating connections.

virtual void	startGame (void)=0
	Sets the network game frame counter to -1.

virtual UnsignedInt	getRunAhead (void)=0
	Get the current RunAhead value.

virtual UnsignedInt	getFrameRate (void)=0
	Get the current allowed frame rate.

virtual UnsignedInt	getPacketArrivalCushion (void)=0
	Get the smallest packet arrival cushion since this was last called.

virtual void	sendChat (UnicodeString text, Int playerMask)=0
	Send a chat line using the normal system.

virtual void	sendDisconnectChat (UnicodeString text)=0
	Send a chat line using the disconnect manager.

virtual void	sendFile (AsciiString path, UnsignedByte playerMask, UnsignedShort commandID)=0

virtual UnsignedShort	sendFileAnnounce (AsciiString path, UnsignedByte playerMask)=0

virtual Int	getFileTransferProgress (Int playerID, AsciiString path)=0

virtual Bool	areAllQueuesEmpty (void)=0

virtual void	quitGame ()=0
	Quit the game right now.

virtual void	selfDestructPlayer (Int index)=0

virtual void	voteForPlayerDisconnect (Int slot)=0
	register a vote towards this player's disconnect.

virtual Bool	isPacketRouter (void)=0

virtual Real	getIncomingBytesPerSecond (void)=0

virtual Real	getIncomingPacketsPerSecond (void)=0

virtual Real	getOutgoingBytesPerSecond (void)=0

virtual Real	getOutgoingPacketsPerSecond (void)=0

virtual Real	getUnknownBytesPerSecond (void)=0

virtual Real	getUnknownPacketsPerSecond (void)=0

virtual void	updateLoadProgress (Int percent)=0

virtual void	loadProgressComplete (void)=0

virtual void	sendTimeOutGameStart (void)=0

virtual UnsignedInt	getLocalPlayerID ()=0

virtual UnicodeString	getPlayerName (Int playerNum)=0

virtual Int	getNumPlayers ()=0

virtual Int	getAverageFPS ()=0

virtual Int	getSlotAverageFPS (Int slot)=0

virtual void	attachTransport (Transport *transport)=0

virtual void	initTransport ()=0

virtual Bool	sawCRCMismatch ()=0

virtual void	setSawCRCMismatch ()=0

virtual Bool	isPlayerConnected (Int playerID)=0

virtual void	notifyOthersOfCurrentFrame ()=0
	Tells all the other players what frame we are on.

virtual void	notifyOthersOfNewFrame (UnsignedInt frame)=0
	Tells all the other players that we are on a new frame.

virtual Int	getExecutionFrame ()=0
	Returns the next valid frame for simultaneous command execution.

virtual UnsignedInt	getPingFrame ()=0

virtual Int	getPingsSent ()=0

virtual Int	getPingsRecieved ()=0

Public Member Functions inherited from SubsystemInterface
	SubsystemInterface ()

virtual	~SubsystemInterface ()

virtual void	postProcessLoad ()

virtual void	draw (void)

void	UPDATE (void)

void	DRAW (void)

AsciiString	getName (void)

void	setName (AsciiString name)

Static Public Member Functions
static NetworkInterface *	createNetwork (void)

Additional Inherited Members
Protected Attributes inherited from SubsystemInterface
AsciiString	m_name

Detailed Description

Interface definition for the Network.

Definition at line 53 of file NetworkInterface.h.

Constructor & Destructor Documentation

◆ ~NetworkInterface()

virtual NetworkInterface::~NetworkInterface ( )

inlinevirtual

Definition at line 58 of file NetworkInterface.h.

Member Function Documentation

◆ areAllQueuesEmpty()

virtual Bool NetworkInterface::areAllQueuesEmpty ( void )

pure virtual

Implemented in Network.

◆ attachTransport()

virtual void NetworkInterface::attachTransport ( Transport * transport )

pure virtual

Implemented in Network.

◆ createNetwork()

NetworkInterface * NetworkInterface::createNetwork ( void )

static

This creates a network object and returns it.

Definition at line 259 of file Network.cpp.

◆ getAverageFPS()

virtual Int NetworkInterface::getAverageFPS ( )

pure virtual

Implemented in Network.

◆ getExecutionFrame()

virtual Int NetworkInterface::getExecutionFrame ( )

pure virtual

Returns the next valid frame for simultaneous command execution.

Implemented in Network.

◆ getFileTransferProgress()

virtual Int NetworkInterface::getFileTransferProgress	(	Int	playerID,
		AsciiString	path )

pure virtual

Implemented in Network.

◆ getFrameRate()

virtual UnsignedInt NetworkInterface::getFrameRate ( void )

pure virtual

Get the current allowed frame rate.

Implemented in Network.

◆ getIncomingBytesPerSecond()

virtual Real NetworkInterface::getIncomingBytesPerSecond ( void )

pure virtual

Implemented in Network.

◆ getIncomingPacketsPerSecond()

virtual Real NetworkInterface::getIncomingPacketsPerSecond ( void )

pure virtual

Implemented in Network.

◆ getLocalPlayerID()

virtual UnsignedInt NetworkInterface::getLocalPlayerID ( )

pure virtual

Implemented in Network.

◆ getNumPlayers()

virtual Int NetworkInterface::getNumPlayers ( )

pure virtual

Implemented in Network.

◆ getOutgoingBytesPerSecond()

virtual Real NetworkInterface::getOutgoingBytesPerSecond ( void )

pure virtual

Implemented in Network.

◆ getOutgoingPacketsPerSecond()

virtual Real NetworkInterface::getOutgoingPacketsPerSecond ( void )

pure virtual

Implemented in Network.

◆ getPacketArrivalCushion()

virtual UnsignedInt NetworkInterface::getPacketArrivalCushion ( void )

pure virtual

Get the smallest packet arrival cushion since this was last called.

Implemented in Network.

◆ getPingFrame()

virtual UnsignedInt NetworkInterface::getPingFrame ( )

pure virtual

Implemented in Network.

◆ getPingsRecieved()

virtual Int NetworkInterface::getPingsRecieved ( )

pure virtual

Implemented in Network.

◆ getPingsSent()

virtual Int NetworkInterface::getPingsSent ( )

pure virtual

Implemented in Network.

◆ getPlayerName()

virtual UnicodeString NetworkInterface::getPlayerName ( Int playerNum )

pure virtual

Implemented in Network.

◆ getRunAhead()

virtual UnsignedInt NetworkInterface::getRunAhead ( void )

pure virtual

Get the current RunAhead value.

Implemented in Network.

◆ getSlotAverageFPS()

virtual Int NetworkInterface::getSlotAverageFPS ( Int slot )

pure virtual

Implemented in Network.

◆ getUnknownBytesPerSecond()

virtual Real NetworkInterface::getUnknownBytesPerSecond ( void )

pure virtual

Implemented in Network.

◆ getUnknownPacketsPerSecond()

virtual Real NetworkInterface::getUnknownPacketsPerSecond ( void )

pure virtual

Implemented in Network.

◆ init()

virtual void NetworkInterface::init ( void )

pure virtual

Initialize the network.

Implements SubsystemInterface.

Implemented in Network.

◆ initTransport()

virtual void NetworkInterface::initTransport ( )

pure virtual

Implemented in Network.

◆ isFrameDataReady()

virtual Bool NetworkInterface::isFrameDataReady ( void )

pure virtual

Are the commands for the next frame available?

Implemented in Network.

◆ isPacketRouter()

virtual Bool NetworkInterface::isPacketRouter ( void )

pure virtual

Implemented in Network.

◆ isPlayerConnected()

virtual Bool NetworkInterface::isPlayerConnected ( Int playerID )

pure virtual

Implemented in Network.

◆ liteupdate()

virtual void NetworkInterface::liteupdate ( void )

pure virtual

does a lightweight update for passing messages around.

Implemented in Network.

◆ loadProgressComplete()

virtual void NetworkInterface::loadProgressComplete ( void )

pure virtual

Implemented in Network.

◆ notifyOthersOfCurrentFrame()

virtual void NetworkInterface::notifyOthersOfCurrentFrame ( )

pure virtual

Tells all the other players what frame we are on.

Implemented in Network.

◆ notifyOthersOfNewFrame()

virtual void NetworkInterface::notifyOthersOfNewFrame ( UnsignedInt frame )

pure virtual

Tells all the other players that we are on a new frame.

Implemented in Network.

◆ parseUserList()

virtual void NetworkInterface::parseUserList ( const GameInfo * game )

pure virtual

Parse a userlist, creating connections.

Implemented in Network.

◆ quitGame()

virtual void NetworkInterface::quitGame ( )

pure virtual

Quit the game right now.

Implemented in Network.

◆ reset()

virtual void NetworkInterface::reset ( void )

pure virtual

Re-initialize the network.

Implements SubsystemInterface.

Implemented in Network.

◆ sawCRCMismatch()

virtual Bool NetworkInterface::sawCRCMismatch ( )

pure virtual

Implemented in Network.

◆ selfDestructPlayer()

virtual void NetworkInterface::selfDestructPlayer ( Int index )

pure virtual

Implemented in Network.

◆ sendChat()

virtual void NetworkInterface::sendChat	(	UnicodeString	text,
		Int	playerMask )

pure virtual

Send a chat line using the normal system.

Implemented in Network.

◆ sendDisconnectChat()

virtual void NetworkInterface::sendDisconnectChat ( UnicodeString text )

pure virtual

Send a chat line using the disconnect manager.

Implemented in Network.

◆ sendFile()

virtual void NetworkInterface::sendFile	(	AsciiString	path,
		UnsignedByte	playerMask,
		UnsignedShort	commandID )

pure virtual

Implemented in Network.

◆ sendFileAnnounce()

virtual UnsignedShort NetworkInterface::sendFileAnnounce	(	AsciiString	path,
		UnsignedByte	playerMask )

pure virtual

Implemented in Network.

◆ sendTimeOutGameStart()

virtual void NetworkInterface::sendTimeOutGameStart ( void )

pure virtual

Implemented in Network.

◆ setLocalAddress()

virtual void NetworkInterface::setLocalAddress	(	UnsignedInt	ip,
		UnsignedInt	port )

pure virtual

Tell the network what local ip and port to bind to.

Implemented in Network.

◆ setSawCRCMismatch()

virtual void NetworkInterface::setSawCRCMismatch ( )

pure virtual

Implemented in Network.

◆ startGame()

virtual void NetworkInterface::startGame ( void )

pure virtual

Sets the network game frame counter to -1.

Implemented in Network.

◆ update()

virtual void NetworkInterface::update ( void )

pure virtual

Updates the network.

Implements SubsystemInterface.

Implemented in Network.

◆ updateLoadProgress()

virtual void NetworkInterface::updateLoadProgress ( Int percent )

pure virtual

Implemented in Network.

◆ voteForPlayerDisconnect()

virtual void NetworkInterface::voteForPlayerDisconnect ( Int slot )

pure virtual

register a vote towards this player's disconnect.

Implemented in Network.

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

Code/GameEngine/Include/GameNetwork/NetworkInterface.h
Code/GameEngine/Source/GameNetwork/Network.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~NetworkInterface()

Member Function Documentation

◆ areAllQueuesEmpty()

◆ attachTransport()

◆ createNetwork()

◆ getAverageFPS()

◆ getExecutionFrame()

◆ getFileTransferProgress()

◆ getFrameRate()

◆ getIncomingBytesPerSecond()

◆ getIncomingPacketsPerSecond()

◆ getLocalPlayerID()

◆ getNumPlayers()

◆ getOutgoingBytesPerSecond()

◆ getOutgoingPacketsPerSecond()

◆ getPacketArrivalCushion()

◆ getPingFrame()

◆ getPingsRecieved()

◆ getPingsSent()

◆ getPlayerName()

◆ getRunAhead()

◆ getSlotAverageFPS()

◆ getUnknownBytesPerSecond()

◆ getUnknownPacketsPerSecond()

◆ init()

◆ initTransport()

◆ isFrameDataReady()

◆ isPacketRouter()

◆ isPlayerConnected()

◆ liteupdate()

◆ loadProgressComplete()

◆ notifyOthersOfCurrentFrame()

◆ notifyOthersOfNewFrame()

◆ parseUserList()

◆ quitGame()

◆ reset()

◆ sawCRCMismatch()

◆ selfDestructPlayer()

◆ sendChat()

◆ sendDisconnectChat()

◆ sendFile()

◆ sendFileAnnounce()

◆ sendTimeOutGameStart()

◆ setLocalAddress()

◆ setSawCRCMismatch()

◆ startGame()

◆ update()

◆ updateLoadProgress()

◆ voteForPlayerDisconnect()