Fawkes API
Fawkes Development Version
|
Fawkes Plugin Network Handler. More...
#include <>>
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... | |
![]() | |
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... | |
![]() | |
FawkesNetworkHandler (unsigned short int id) | |
Constructor. More... | |
virtual | ~FawkesNetworkHandler () |
Destructor. More... | |
unsigned short int | id () const |
Get the component ID for this handler. More... | |
![]() | |
virtual | ~PluginManagerListener () |
Virtual empty destructor. More... | |
Protected Member Functions | |
virtual void | run () |
Stub to see name in backtrace for easier debugging. More... | |
![]() | |
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 | |
![]() | |
enum | OpMode { OPMODE_CONTINUOUS, OPMODE_WAITFORWAKEUP } |
Thread operation mode. More... | |
enum | CancelState { CANCEL_ENABLED, CANCEL_DISABLED } |
Cancel state. More... | |
![]() | |
static Thread * | current_thread () |
Get the Thread instance of the currently running thread. More... | |
static Thread * | current_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 const unsigned int | FLAG_BAD = 0x00000001 |
Standard thread flag: "thread is bad". More... | |
![]() | |
bool | finalize_prepared |
True if prepare_finalize() has been called and was not stopped with a cancel_finalize(), false otherwise. More... | |
Mutex * | loop_mutex |
Mutex that is used to protect a call to loop(). More... | |
Mutex * | loopinterrupt_antistarve_mutex |
Mutex to avoid starvation when trying to lock loop_mutex. More... | |
Fawkes Plugin Network Handler.
This network handler handles requests of plugin lists and for loading/unloading plugins received over the network.
fawkes::PluginNetworkHandler::PluginNetworkHandler | ( | PluginManager * | manager, |
FawkesNetworkHub * | hub | ||
) |
Constructor.
manager | plugin manager for the actual work |
hub | Fawkes network hub |
Definition at line 66 of file handler.cpp.
References fawkes::FawkesNetworkHub::add_handler(), and fawkes::PluginManager::add_listener().
fawkes::PluginNetworkHandler::~PluginNetworkHandler | ( | ) |
Destructor.
Definition at line 80 of file handler.cpp.
References fawkes::PluginListMessage::append(), fawkes::PluginManager::get_available_plugins(), fawkes::PluginManager::get_loaded_plugins(), fawkes::PluginManager::load(), fawkes::LockList< Type >::lock(), fawkes::PluginManager::lock(), fawkes::LibLogger::log_error(), fawkes::LibLogger::log_warn(), fawkes::MSG_PLUGIN_LOAD_FAILED, fawkes::MSG_PLUGIN_LOADED, fawkes::MSG_PLUGIN_UNLOAD_FAILED, fawkes::MSG_PLUGIN_UNLOADED, fawkes::plugin_loaded_msg_t::name, fawkes::plugin_load_failed_msg_t::name, fawkes::plugin_unload_failed_msg_t::name, fawkes::plugin_unloaded_msg_t::name, fawkes::FawkesNetworkHub::remove_handler(), fawkes::PluginManager::remove_listener(), fawkes::FawkesNetworkHub::send(), fawkes::PluginManager::unload(), fawkes::LockList< Type >::unlock(), and fawkes::PluginManager::unlock().
|
virtual |
Called when a new client connected.
If any actions need to be taken on your side this is the place to do it.
clid | client ID of new client |
Implements fawkes::FawkesNetworkHandler.
Definition at line 370 of file handler.cpp.
|
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!
clid | client ID of disconnected client |
Implements fawkes::FawkesNetworkHandler.
Definition at line 376 of file handler.cpp.
References fawkes::LockList< Type >::remove_locked().
|
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.
msg | message 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().
|
virtual |
Process all network messages that have been received.
Reimplemented from fawkes::Thread.
Definition at line 273 of file handler.cpp.
References fawkes::FawkesNetworkMessage::clid(), fawkes::PluginManager::is_loaded(), fawkes::LockList< Type >::lock(), fawkes::LibLogger::log_error(), fawkes::LibLogger::log_info(), fawkes::MSG_PLUGIN_AVAIL_LIST, fawkes::MSG_PLUGIN_AVAIL_LIST_FAILED, fawkes::MSG_PLUGIN_LIST_AVAIL, fawkes::MSG_PLUGIN_LIST_LOADED, fawkes::MSG_PLUGIN_LOAD, fawkes::MSG_PLUGIN_LOADED_LIST, fawkes::MSG_PLUGIN_LOADED_LIST_FAILED, fawkes::MSG_PLUGIN_SUBSCRIBE_WATCH, fawkes::MSG_PLUGIN_UNLOAD, fawkes::MSG_PLUGIN_UNSUBSCRIBE_WATCH, fawkes::FawkesNetworkMessage::msgid(), fawkes::plugin_load_msg_t::name, fawkes::plugin_unload_msg_t::name, fawkes::Thread::name(), fawkes::FawkesNetworkMessage::payload(), fawkes::FawkesNetworkMessage::payload_size(), fawkes::LockQueue< Type >::pop_locked(), fawkes::LockList< Type >::remove_locked(), fawkes::FawkesNetworkHub::send(), fawkes::LockList< Type >::unlock(), and fawkes::RefCount::unref().
|
virtual |
Plugin loaded event.
plugin_name | name of the plugin that has just been loaded |
Implements fawkes::PluginManagerListener.
Definition at line 382 of file handler.cpp.
|
virtual |
Plugin unloaded event.
plugin_name | name of the plugin that has just been unloaded |
Implements fawkes::PluginManagerListener.
Definition at line 388 of file handler.cpp.
|
inlineprotectedvirtual |
Stub to see name in backtrace for easier debugging.
Reimplemented from fawkes::Thread.
Definition at line 86 of file handler.h.
References fawkes::Thread::run().