Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

ONE::network::ClientProxy Class Reference

Inheritance diagram for ONE::network::ClientProxy:

Inheritance graph
[legend]
List of all members.

Detailed Description

server sided represantative of a client

Author:
Henning Hamer


Public Types

typedef ControlListener * LPtr

Public Member Functions

void addControl (Control *_control)
 Add a control to be dispatched later.
void addControlListener (const LPtr &l)
 ClientProxy ()
void dispatchControlEvents ()
 Distribute the queued Controls using ControlEvents.
 EventDispatcher ()
void fireEvent (ControlEvent &e) const
 notifies all registered listeners
bool getDispatched ()
 Indicate if all queued controls of a disconnected client have been dispatched.
bool getZombie ()
 Indicate if the associated client was lost.
bool isMuted () const
 reflects this dispatcher's muted state.
void removeControlListener (const LPtr &l)
void setDispatched (bool _b)
 Tag ClientProxy when all queued controls of a disconnected client have been dispatched.
void setMuted (bool mute)
 mutes or un-mutes the dispatcher
void setZombie (bool _b)
 Tag ClientProxy when associated client was lost.

Protected Member Functions

void add (const LPtr &l)
 registers a listener
void remove (const LPtr &l)
 de-registers a listener.

Friends

class Server


Member Typedef Documentation

typedef ControlListener * ONE::util::EventDispatcher< ControlEvent , ControlListener , struct ControlRelay >::LPtr [inherited]
 


Constructor & Destructor Documentation

ONE::network::ClientProxy::ClientProxy  ) 
 


Member Function Documentation

void ONE::util::EventDispatcher< ControlEvent , ControlListener , struct ControlRelay >::add const LPtr l  )  [protected, inherited]
 

registers a listener

Parameters:
l a listener

void ONE::network::ClientProxy::addControl Control _control  ) 
 

Add a control to be dispatched later.

Parameters:
_controlP pointer to the control to be added

void ONE::util::ControlDispatcher::addControlListener const LPtr l  )  [inline, inherited]
 

void ONE::network::ClientProxy::dispatchControlEvents  ) 
 

Distribute the queued Controls using ControlEvents.

ONE::util::EventDispatcher< ControlEvent , ControlListener , struct ControlRelay >::EventDispatcher  )  [inherited]
 

void ONE::util::EventDispatcher< ControlEvent , ControlListener , struct ControlRelay >::fireEvent ControlEvent e  )  const [inherited]
 

notifies all registered listeners

The listeners are called in the order in which they were added.
This function is provided primarily for use by subclasses. However, it may also be called from the outside in order to inject events into the system. Note that great care should be taken when doing so. For example, listeners generally rely on the event's source being identical to the instance that passes them around, i.e. this event dispatcher.

Parameters:
e the event to forward to each listener

bool ONE::network::ClientProxy::getDispatched  ) 
 

Indicate if all queued controls of a disconnected client have been dispatched.

Returns:
true if all controls of the disconnected clent werde dispatched

bool ONE::network::ClientProxy::getZombie  ) 
 

Indicate if the associated client was lost.

Returns:
true if according client disconnected

bool ONE::util::EventDispatcher< ControlEvent , ControlListener , struct ControlRelay >::isMuted  )  const [inherited]
 

reflects this dispatcher's muted state.

Returns:
true if the dispatcher is muted, false otherwise

void ONE::util::EventDispatcher< ControlEvent , ControlListener , struct ControlRelay >::remove const LPtr l  )  [protected, inherited]
 

de-registers a listener.

This listener will no longer notify l of events, unless l is registered more than once. If so, a call to this function will only remove the first occurence of l.

Parameters:
l a listener

void ONE::util::ControlDispatcher::removeControlListener const LPtr l  )  [inline, inherited]
 

void ONE::network::ClientProxy::setDispatched bool  _b  ) 
 

Tag ClientProxy when all queued controls of a disconnected client have been dispatched.

void ONE::util::EventDispatcher< ControlEvent , ControlListener , struct ControlRelay >::setMuted bool  mute  )  [inherited]
 

mutes or un-mutes the dispatcher

Muted dispatchers no longer notify their listeners.

void ONE::network::ClientProxy::setZombie bool  _b  ) 
 

Tag ClientProxy when associated client was lost.


Friends And Related Function Documentation

friend class Server [friend]
 


Generated on Wed Sep 7 19:03:25 2005 for ONEngine by  doxygen 1.4.3