Fawkes API Fawkes Development Version

PlayerClientThread Class Reference

Player Client Thread. More...

#include "playerc_thread.h"

Inheritance diagram for PlayerClientThread:

List of all members.

Public Types

typedef std::map< std::string,
fawkes::Interface * > 
InterfaceMap
 Map for Fawkes interfaces.
typedef std::map< std::string,
PlayerCc::ClientProxy * > 
ProxyMap
 Map for Player interfaces.
typedef std::list
< PlayerProxyFawkesInterfaceMapper * > 
MapperList
 Map for proxy-interface mappers.

Public Member Functions

 PlayerClientThread ()
 Constructor.
virtual void init ()
 Initialize the thread.
virtual void finalize ()
 Finalize the thread.
virtual void loop ()
 Code to execute in the thread.
void sync_fawkes_to_player ()
 Sync Fawkes to player.

Protected Member Functions

virtual void run ()
 Stub to see name in backtrace for easier debugging.

Detailed Description

Player Client Thread.

This thread connects to the player server and handles messages

Author:
Tim Niemueller

Definition at line 49 of file playerc_thread.h.


Member Typedef Documentation

typedef std::map<std::string, fawkes::Interface *> PlayerClientThread::InterfaceMap

Map for Fawkes interfaces.

Definition at line 60 of file playerc_thread.h.

Map for proxy-interface mappers.

Definition at line 66 of file playerc_thread.h.

typedef std::map<std::string, PlayerCc::ClientProxy *> PlayerClientThread::ProxyMap

Map for Player interfaces.

Definition at line 63 of file playerc_thread.h.


Constructor & Destructor Documentation

PlayerClientThread::PlayerClientThread ( )

Constructor.

Definition at line 47 of file playerc_thread.cpp.


Member Function Documentation

void PlayerClientThread::finalize ( ) [virtual]

Finalize the thread.

This method is executed just before the thread is canceled and destroyed. It is always preceeded by a call to prepare_finalize(). If this is not the case this is a failure. The condition can be checked with the boolean variable finalize_prepared.

This method is meant to be used in conjunction with aspects and to cover thread inter-dependencies. This routine MUST bring the thread into a safe state such that it may be canceled and destroyed afterwards. If there is any reason that this cannot happen make your prepare_finalize() reports so.

This method is called by the thread manager just before the thread is being cancelled. Here you can do whatever steps are necessary just before the thread is cancelled. Note that you thread is still running and might be in the middle of a loop, so it is not a good place to give up on all resources used. Mind segmentation faults that could happen. Protect the area with a mutex that you lock at the beginning of your loop and free in the end, and that you lock at the beginning of finalize and then never unlock. Also not that the finalization may be canceled afterwards. The next thing that happens is that either the thread is canceled and destroyed or that the finalization is canceled and the thread has to run again.

Finalize is called on a thread just before it is deleted. It is guaranteed to be called on a fully initialized thread (if no exception is thrown in init()) (this guarantee holds in the Fawkes framework).

The default implementation does nothing besides throwing an exception if prepare_finalize() has not been called.

Exceptions:
Exceptionthrown if prepare_finalize() has not been called.
See also:
prepare_finalize()
cancel_finalize()

Reimplemented from fawkes::Thread.

Definition at line 232 of file playerc_thread.cpp.

Referenced by init().

void PlayerClientThread::init ( ) [virtual]

Initialize the thread.

This method is meant to be used in conjunction with aspects. Some parts of the initialization may only happen after some aspect of the thread has been initialized. Implement the init method with these actions. It is guaranteed to be called just after all aspects have been initialized and only once in the lifetime of the thread. Throw an exception if any problem occurs and the thread should not run.

Just because your init() routine suceeds and everything looks fine for this thread does not automatically imply that it will run. If it belongs to a group of threads in a ThreadList and any of the other threads fail to initialize then no thread from this group is run and thus this thread will never run. In that situation finalize() is called for this very instance, prepare_finalize() however is not called.

See also:
Fawkes Thread Aspects

Reimplemented from fawkes::Thread.

Definition at line 56 of file playerc_thread.cpp.

References fawkes::Exception::append(), fawkes::ConfigurableAspect::config, finalize(), fawkes::Configuration::get_string(), fawkes::Configuration::get_uint(), and fawkes::Thread::name().

void PlayerClientThread::loop ( ) [virtual]

Code to execute in the thread.

Implement this method to hold the code you want to be executed continously. If you do not implement this method, the default is that the thread will exit. This is useful if you choose to only implement once().

Reimplemented from fawkes::Thread.

Definition at line 286 of file playerc_thread.cpp.

References fawkes::Logger::log_warn(), fawkes::LoggingAspect::logger, and fawkes::Thread::name().

virtual void PlayerClientThread::run ( ) [inline, protected, virtual]

Stub to see name in backtrace for easier debugging.

See also:
Thread::run()

Reimplemented from fawkes::Thread.

Definition at line 77 of file playerc_thread.h.

void PlayerClientThread::sync_fawkes_to_player ( )

Sync Fawkes to player.

This will call all mappers to sync Fawkes interfaces to Player proxies. This is meant to be called by the PlayerF2PThread.

Definition at line 273 of file playerc_thread.cpp.

References fawkes::Logger::log_warn(), fawkes::LoggingAspect::logger, and fawkes::Thread::name().

Referenced by PlayerF2PThread::loop().


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends