Fawkes API  Fawkes Development Version
ExampleNetworkThread Class Reference

Network thread of example plugin. More...

#include <plugins/examples/basics/net_thread.h>

Inheritance diagram for ExampleNetworkThread:

Public Member Functions

 ExampleNetworkThread (const char *name)
 Constructor. More...
 
virtual ~ExampleNetworkThread ()
 Destructor. More...
 
virtual void init ()
 Initialize thread. More...
 
virtual void finalize ()
 Finalize the thread. More...
 
virtual void loop ()
 Thread loop. More...
 
virtual void handle_network_message (fawkes::FawkesNetworkMessage *msg)
 Handle network message. More...
 
virtual void client_connected (unsigned int clid)
 Client connected. More...
 
virtual void client_disconnected (unsigned int clid)
 Client disconnected. More...
 
- Public Member Functions inherited from fawkes::Thread
virtual ~Thread ()
 Virtual destructor. More...
 
bool prepare_finalize ()
 Prepare finalization. More...
 
virtual bool prepare_finalize_user ()
 Prepare finalization user implementation. More...
 
void cancel_finalize ()
 Cancel finalization. More...
 
void start (bool wait=true)
 Call this method to start the thread. More...
 
void cancel ()
 Cancel a thread. More...
 
void join ()
 Join the thread. More...
 
void detach ()
 Detach the thread. More...
 
void kill (int sig)
 Send signal to a thread. More...
 
bool operator== (const Thread &thread)
 Check if two threads are the same. More...
 
void wakeup ()
 Wake up thread. More...
 
void wakeup (Barrier *barrier)
 Wake up thread and wait for barrier afterwards. More...
 
void wait_loop_done ()
 Wait for the current loop iteration to finish. More...
 
OpMode opmode () const
 Get operation mode. More...
 
pthread_t thread_id () const
 Get ID of thread. More...
 
bool started () const
 Check if thread has been started. More...
 
bool cancelled () const
 Check if thread has been cancelled. More...
 
bool detached () const
 Check if thread has been detached. More...
 
bool running () const
 Check if the thread is running. More...
 
bool waiting () const
 Check if thread is currently waiting for wakeup. More...
 
const char * name () const
 Get name of thread. More...
 
void set_flags (uint32_t flags)
 Set all flags in one go. More...
 
void set_flag (uint32_t flag)
 Set flag for the thread. More...
 
void unset_flag (uint32_t flag)
 Unset flag. More...
 
bool flagged_bad () const
 Check if FLAG_BAD was set. More...
 
void set_delete_on_exit (bool del)
 Set whether the thread should be deleted on exit. More...
 
void set_prepfin_hold (bool hold)
 Hold prepare_finalize(). More...
 
void add_notification_listener (ThreadNotificationListener *notification_listener)
 Add notification listener. More...
 
void remove_notification_listener (ThreadNotificationListener *notification_listener)
 Remove notification listener. More...
 
void notify_of_failed_init ()
 Notify of failed init. More...
 
- Public Member Functions inherited from fawkes::LoggingAspect
 LoggingAspect ()
 Constructor. More...
 
virtual ~LoggingAspect ()
 Virtual empty Destructor. More...
 
void init_LoggingAspect (Logger *logger)
 Set the logger. More...
 
- Public Member Functions inherited from fawkes::Aspect
const std::list< const char * > & get_aspects () const
 Get list of aspect names attached to a aspected thread. More...
 
- Public Member Functions inherited from fawkes::FawkesNetworkAspect
 FawkesNetworkAspect ()
 Constructor. More...
 
virtual ~FawkesNetworkAspect ()
 Virtual empty Destructor. More...
 
void init_FawkesNetworkAspect (FawkesNetworkHub *fnethub)
 Set the logger. More...
 
- Public Member Functions inherited from fawkes::FawkesNetworkHandler
 FawkesNetworkHandler (unsigned short int id)
 Constructor. More...
 
virtual ~FawkesNetworkHandler ()
 Destructor. More...
 
unsigned short int id () const
 Get the component ID for this handler. More...
 

Protected Member Functions

virtual void run ()
 Stub to see name in backtrace for easier debugging. More...
 
- Protected Member Functions inherited from fawkes::Thread
 Thread (const char *name)
 Constructor. More...
 
 Thread (const char *name, OpMode op_mode)
 Constructor. More...
 
void exit ()
 Exit the thread. More...
 
void test_cancel ()
 Set cancellation point. More...
 
void yield ()
 Yield the processor to another thread or process. More...
 
void set_opmode (OpMode op_mode)
 Set operation mode. More...
 
void set_prepfin_conc_loop (bool concurrent=true)
 Set concurrent execution of prepare_finalize() and loop(). More...
 
void set_coalesce_wakeups (bool coalesce=true)
 Set wakeup coalescing. More...
 
void set_name (const char *format,...)
 Set name of thread. More...
 
virtual void once ()
 Execute an action exactly once. More...
 
bool wakeup_pending ()
 Check if wakeups are pending. More...
 
- Protected Member Functions inherited from fawkes::Aspect
void add_aspect (const char *name)
 Add an aspect to a thread. More...
 

Additional Inherited Members

- Public Types inherited from fawkes::Thread
enum  OpMode { OPMODE_CONTINUOUS, OPMODE_WAITFORWAKEUP }
 Thread operation mode. More...
 
enum  CancelState { CANCEL_ENABLED, CANCEL_DISABLED }
 Cancel state. More...
 
- Static Public Member Functions inherited from fawkes::Thread
static Threadcurrent_thread ()
 Get the Thread instance of the currently running thread. More...
 
static Threadcurrent_thread_noexc () throw ()
 Similar to current_thread, but does never throw an exception. More...
 
static pthread_t current_thread_id ()
 Get the ID of the currently running thread. More...
 
static void init_main ()
 Initialize Thread wrapper instance for main thread. More...
 
static void destroy_main ()
 Destroy main thread wrapper instance. More...
 
static void set_cancel_state (CancelState new_state, CancelState *old_state=0)
 Set the cancel state of the current thread. More...
 
- Static Public Attributes inherited from fawkes::Thread
static const unsigned int FLAG_BAD = 0x00000001
 Standard thread flag: "thread is bad". More...
 
- Protected Attributes inherited from fawkes::Thread
bool finalize_prepared
 True if prepare_finalize() has been called and was not stopped with a cancel_finalize(), false otherwise. More...
 
Mutexloop_mutex
 Mutex that is used to protect a call to loop(). More...
 
Mutexloopinterrupt_antistarve_mutex
 Mutex to avoid starvation when trying to lock loop_mutex. More...
 
- Protected Attributes inherited from fawkes::LoggingAspect
Loggerlogger
 This is the Logger member used to access the logger. More...
 
- Protected Attributes inherited from fawkes::FawkesNetworkAspect
FawkesNetworkHubfnethub
 This is the Fawkes network hub member used to access the Fawkes network protocol. More...
 

Detailed Description

Network thread of example plugin.

Author
Tim Niemueller

Definition at line 31 of file net_thread.h.

Constructor & Destructor Documentation

◆ ExampleNetworkThread()

ExampleNetworkThread::ExampleNetworkThread ( const char *  name)

Constructor.

Parameters
namethread name

Definition at line 39 of file net_thread.cpp.

◆ ~ExampleNetworkThread()

ExampleNetworkThread::~ExampleNetworkThread ( )
virtual

Destructor.

Definition at line 47 of file net_thread.cpp.

Member Function Documentation

◆ client_connected()

void ExampleNetworkThread::client_connected ( unsigned int  clid)
virtual

Client connected.

Ignored.

Parameters
clidclient ID

Implements fawkes::FawkesNetworkHandler.

Definition at line 121 of file net_thread.cpp.

References fawkes::Logger::log_info(), and fawkes::LoggingAspect::logger.

◆ client_disconnected()

void ExampleNetworkThread::client_disconnected ( unsigned int  clid)
virtual

Client disconnected.

If the client was a subscriber it is removed.

Parameters
clidclient ID

Implements fawkes::FawkesNetworkHandler.

Definition at line 132 of file net_thread.cpp.

References fawkes::Logger::log_info(), and fawkes::LoggingAspect::logger.

◆ finalize()

void ExampleNetworkThread::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 68 of file net_thread.cpp.

References fawkes::FawkesNetworkAspect::fnethub, fawkes::Logger::log_info(), fawkes::LoggingAspect::logger, and fawkes::FawkesNetworkHub::remove_handler().

◆ handle_network_message()

void ExampleNetworkThread::handle_network_message ( fawkes::FawkesNetworkMessage msg)
virtual

◆ init()

void ExampleNetworkThread::init ( )
virtual

Initialize thread.

This method is called just after all aspects have been initialized but before the thread is run. Here we add this thread as a handler to the Fawkes network hub. This cannot happen in the constructor as fnethandler has not been initialized at that time.

See also
Thread::init()
Fawkes Thread Aspects

Reimplemented from fawkes::Thread.

Definition at line 61 of file net_thread.cpp.

References fawkes::FawkesNetworkHub::add_handler(), and fawkes::FawkesNetworkAspect::fnethub.

◆ loop()

void ExampleNetworkThread::loop ( )
virtual

Thread loop.

Nothing to do here since nobody will every wake us up (we do not have the BlockedTimingAspect nor does any other thread wake us up). This is ok because everything is done in the network handler call.

Note that in general incoming messages should be parsed and appropriate actions enqueued. Then in the next loop iteration you process these incoming messages. This is the best way to avoid strange behavior and low latencies in network message handling.

As an example for this see the FawkesConfigManager.

See also
FawkesConfigManager

Reimplemented from fawkes::Thread.

Definition at line 90 of file net_thread.cpp.

◆ run()

virtual void ExampleNetworkThread::run ( )
inlineprotectedvirtual

Stub to see name in backtrace for easier debugging.

See also
Thread::run()

Reimplemented from fawkes::Thread.

Definition at line 52 of file net_thread.h.


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