#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/libraries/network/WANDiscovery.h>

Inheritance diagram for orxonox::WANDiscovery:

Public Member Functions
	WANDiscovery ()
	constructor More...

	~WANDiscovery ()
	destructor More...

void	discover ()
	ask server for server list More...

std::string	getMSAddress ()

std::string	getServerListItemIP (unsigned int index)

std::string	getServerListItemName (unsigned int index)

std::string	getServerListItemPlayerNumber (unsigned int index)

std::string	getServerListItemRTT (unsigned int index)

int	rhandler (char addr, ENetEvent ev)

void	setConfigValues ()
	Function used for the configuration file parameter update. More...

Public Member Functions inherited from orxonox::Configurable
	Configurable ()

void	setConfigValues ()
	Function to collect the SetConfigValue-macro calls. More...

Public Member Functions inherited from orxonox::Listable
	Listable ()
	Constructor: Allocates space in the element list. More...

	Listable (Context *context)
	Constructor: Allocates space in the element list and assigns the context. More...

virtual	~Listable ()
	Destructor: Removes the object from the object-lists. More...

Context *	getContext () const

void	setContext (Context *context)
	Changes the context. More...

void	unregisterObject ()
	Removes this object from the object-lists. More...

Public Member Functions inherited from orxonox::Identifiable
	Identifiable ()
	Constructor: Sets the default values. More...

virtual	~Identifiable ()

ORX_FORCEINLINE void *	getDerivedPointer (unsigned int classID)
	Returns a valid pointer of any derived type that is registered in the class hierarchy. More...

template<class T >
ORX_FORCEINLINE T *	getDerivedPointer (unsigned int classID)
	Version of getDerivedPointer with template. More...

template<class T >
ORX_FORCEINLINE const T *	getDerivedPointer (unsigned int classID) const
	Const version of getDerivedPointer with template. More...

Identifier *	getIdentifier () const
	Returns the Identifier of the object. More...

bool	isA (const Identifier *identifier)
	Returns true if the object's class is of the given type or a derivative. More...

template<class B >
bool	isA (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is of the given type or a derivative. More...

bool	isA (const Identifiable *object)
	Returns true if the object's class is of the given type or a derivative. More...

bool	isChildOf (const Identifier *identifier)
	Returns true if the object's class is a child of the given type. More...

template<class B >
bool	isChildOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a child of the given type. More...

bool	isChildOf (const Identifiable *object)
	Returns true if the object's class is a child of the given type. More...

bool	isDirectChildOf (const Identifier *identifier)
	Returns true if the object's class is a direct child of the given type. More...

template<class B >
bool	isDirectChildOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a direct child of the given type. More...

bool	isDirectChildOf (const Identifiable *object)
	Returns true if the object's class is a direct child of the given type. More...

bool	isDirectParentOf (const Identifier *identifier)
	Returns true if the object's class is a direct parent of the given type. More...

template<class B >
bool	isDirectParentOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a direct parent of the given type. More...

bool	isDirectParentOf (const Identifiable *object)
	Returns true if the object's class is a direct child of the given type. More...

bool	isExactlyA (const Identifier *identifier)
	Returns true if the object's class is exactly of the given type. More...

template<class B >
bool	isExactlyA (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is exactly of the given type. More...

bool	isExactlyA (const Identifiable *object)
	Returns true if the object's class is exactly of the given type. More...

bool	isParentOf (const Identifier *identifier)
	Returns true if the object's class is a parent of the given type. More...

template<class B >
bool	isParentOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a parent of the given type. More...

bool	isParentOf (const Identifiable *object)
	Returns true if the object's class is a parent of the given type. More...

Public Attributes
MasterServerComm	msc
	Master server communications object. More...

std::vector< packet::ServerInformation >	servers_
	game server list More...

Private Attributes
std::string	msaddress
	master server address More...

Constructor & Destructor Documentation

orxonox::WANDiscovery::WANDiscovery ( )

constructor

orxonox::WANDiscovery::~WANDiscovery ( )

destructor

Member Function Documentation

void orxonox::WANDiscovery::discover ( )

ask server for server list

std::string orxonox::WANDiscovery::getMSAddress ( )

inline

Returns: Address of the master server

Get the master server address

std::string orxonox::WANDiscovery::getServerListItemIP ( unsigned int index )

Parameters

index Index to get the IP of

Returns: The IP of the server

Get the IP of the server at index index.

std::string orxonox::WANDiscovery::getServerListItemName ( unsigned int index )

Parameters

index Index to get the name of

Returns: The name of the server

Get the name of the server at index index.

std::string orxonox::WANDiscovery::getServerListItemPlayerNumber ( unsigned int index )

Parameters

index Index to get the RTT of

Returns: The number of players on the server

Get the number of players on the server

std::string orxonox::WANDiscovery::getServerListItemRTT ( unsigned int index )

Parameters

index Index to get the RTT of

Returns: The RTT of the server

Get the RTT of the server at index index.

int orxonox::WANDiscovery::rhandler	(	char *	addr,
		ENetEvent *	ev
	)

void orxonox::WANDiscovery::setConfigValues ( void )

Function used for the configuration file parameter update.

Member Data Documentation

std::string orxonox::WANDiscovery::msaddress

private

master server address

MasterServerComm orxonox::WANDiscovery::msc

Master server communications object.

std::vector<packet::ServerInformation> orxonox::WANDiscovery::servers_

game server list

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

libraries/network/WANDiscovery.h
libraries/network/WANDiscovery.cc

Public Member Functions

Public Attributes

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation