Orxonox  0.0.5 Codename: Arcturus
Public Member Functions | Static Public Member Functions | List of all members
orxonox::ClientConnectionListener Class Referenceabstract

An abstract base class. More...

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

Inheritance diagram for orxonox::ClientConnectionListener:
orxonox::Listable orxonox::Identifiable orxonox::MovableEntity orxonox::PlayerManager orxonox::Script orxonox::TrafficControl orxonox::DodgeRaceCube orxonox::ExplosionChunk orxonox::ExplosionPart orxonox::GravityBomb orxonox::JumpEnemy orxonox::JumpItem orxonox::JumpPlatform orxonox::JumpProjectile orxonox::MineProjectile orxonox::OrxyRoadCube orxonox::PongBall orxonox::Projectile orxonox::SOBCoin orxonox::SOBFireball orxonox::SOBGumba orxonox::SOBMushroom orxonox::SOBTube orxonox::TetrisStone orxonox::TowerDefenseField orxonox::WagnisProjectile

Public Member Functions

 ClientConnectionListener ()
 Constructor Register the object. More...
 
virtual ~ClientConnectionListener ()
 
virtual void clientConnected (unsigned int clientID)=0
 
virtual void clientDisconnected (unsigned int clientID)=0
 
- 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...
 
ContextgetContext () 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 voidgetDerivedPointer (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...
 
IdentifiergetIdentifier () 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...
 

Static Public Member Functions

static void broadcastClientConnected (unsigned int clientID)
 Call clientConnected() on all ClientConnectionListeners. More...
 
static void broadcastClientDisconnected (unsigned int clientID)
 Call clientDisconnected() on all ClientConnectionListeners. More...
 

Detailed Description

An abstract base class.

Derived classes must implement clientConnected() and clientDisconnected().

Constructor & Destructor Documentation

orxonox::ClientConnectionListener::ClientConnectionListener ( )

Constructor Register the object.

virtual orxonox::ClientConnectionListener::~ClientConnectionListener ( )
inlinevirtual

Member Function Documentation

void orxonox::ClientConnectionListener::broadcastClientConnected ( unsigned int  clientID)
static

Call clientConnected() on all ClientConnectionListeners.

Parameters
clientIDThe ID of the newly connected client
void orxonox::ClientConnectionListener::broadcastClientDisconnected ( unsigned int  clientID)
static

Call clientDisconnected() on all ClientConnectionListeners.

Parameters
clientIDThe ID of the newly disconnected client
virtual void orxonox::ClientConnectionListener::clientConnected ( unsigned int  clientID)
pure virtual
virtual void orxonox::ClientConnectionListener::clientDisconnected ( unsigned int  clientID)
pure virtual

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