Fawkes API  Fawkes Development Version
fawkes::PluginNetworkHandler Class Reference

Fawkes Plugin Network Handler. More...

#include <>>

Inheritance diagram for fawkes::PluginNetworkHandler:

Public Member Functions

 PluginNetworkHandler (PluginManager *manager, FawkesNetworkHub *hub)
 Constructor. More...
 
 ~PluginNetworkHandler ()
 Destructor. More...
 
virtual void handle_network_message (FawkesNetworkMessage *msg)
 Called for incoming messages that are addressed to the correct component ID. More...
 
virtual void client_connected (unsigned int clid)
 Called when a new client connected. More...
 
virtual void client_disconnected (unsigned int clid)
 Called when a client disconnected. More...
 
virtual void loop ()
 Process all network messages that have been received. More...
 
virtual void plugin_loaded (const char *plugin_name)
 Plugin loaded event. More...
 
virtual void plugin_unloaded (const char *plugin_name)
 Plugin unloaded event. More...
 
- Public Member Functions inherited from fawkes::Thread
virtual ~Thread ()
 Virtual destructor. More...
 
virtual void init ()
 Initialize the thread. More...
 
bool prepare_finalize ()
 Prepare finalization. More...
 
virtual bool prepare_finalize_user ()
 Prepare finalization user implementation. More...
 
virtual void finalize ()
 Finalize the thread. 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::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...
 
- Public Member Functions inherited from fawkes::PluginManagerListener
virtual ~PluginManagerListener ()
 Virtual empty destructor. 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...
 

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...
 

Detailed Description

Fawkes Plugin Network Handler.

This network handler handles requests of plugin lists and for loading/unloading plugins received over the network.

Author
Tim Niemueller

Definition at line 54 of file handler.h.

Constructor & Destructor Documentation

◆ PluginNetworkHandler()

fawkes::PluginNetworkHandler::PluginNetworkHandler ( PluginManager manager,
FawkesNetworkHub hub 
)

Constructor.

Parameters
managerplugin manager for the actual work
hubFawkes network hub

Definition at line 66 of file handler.cpp.

References fawkes::FawkesNetworkHub::add_handler(), and fawkes::PluginManager::add_listener().

◆ ~PluginNetworkHandler()

Member Function Documentation

◆ client_connected()

void fawkes::PluginNetworkHandler::client_connected ( unsigned int  clid)
virtual

Called when a new client connected.

If any actions need to be taken on your side this is the place to do it.

Parameters
clidclient ID of new client

Implements fawkes::FawkesNetworkHandler.

Definition at line 370 of file handler.cpp.

◆ client_disconnected()

void fawkes::PluginNetworkHandler::client_disconnected ( unsigned int  clid)
virtual

Called when a client disconnected.

If any actions need to be taken on your side this is the place to do it. Note that you cannot send any further messages to this client!

Parameters
clidclient ID of disconnected client

Implements fawkes::FawkesNetworkHandler.

Definition at line 376 of file handler.cpp.

References fawkes::LockList< Type >::remove_locked().

◆ handle_network_message()

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

Called for incoming messages that are addressed to the correct component ID.

Note that this message should be processed really really fast! A good idea is to enqueue the message in an inbound queue (remember to ref() it!) and then process it in the next run of loop() or wakeup a processing thread.

Parameters
msgmessage to handle. If you want to keep this message you have to ref() it! It is guaranteed that the message will not be erased during the handleNetworkMessage() run, but afterwards no guarantee is made. So if you want to store the message internally for example for later processing you have to reference the message.

Implements fawkes::FawkesNetworkHandler.

Definition at line 361 of file handler.cpp.

References fawkes::LockQueue< Type >::push_locked(), fawkes::RefCount::ref(), and fawkes::Thread::wakeup().

◆ loop()

◆ plugin_loaded()

void fawkes::PluginNetworkHandler::plugin_loaded ( const char *  plugin_name)
virtual

Plugin loaded event.

Parameters
plugin_namename of the plugin that has just been loaded

Implements fawkes::PluginManagerListener.

Definition at line 382 of file handler.cpp.

◆ plugin_unloaded()

void fawkes::PluginNetworkHandler::plugin_unloaded ( const char *  plugin_name)
virtual

Plugin unloaded event.

Parameters
plugin_namename of the plugin that has just been unloaded

Implements fawkes::PluginManagerListener.

Definition at line 388 of file handler.cpp.

◆ run()

virtual void fawkes::PluginNetworkHandler::run ( )
inlineprotectedvirtual

Stub to see name in backtrace for easier debugging.

See also
Thread::run()

Reimplemented from fawkes::Thread.

Definition at line 86 of file handler.h.

References fawkes::Thread::run().


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