Fawkes API
Fawkes Development Version
|
Fawkes Plugin Network Handler. More...
#include <>>
Public Member Functions | |
PluginNetworkHandler (PluginManager *manager, FawkesNetworkHub *hub, Mutex *mutex=NULL) | |
Constructor. | |
~PluginNetworkHandler () | |
Destructor. | |
virtual void | handle_network_message (FawkesNetworkMessage *msg) |
Called for incoming messages that are addressed to the correct component ID. | |
virtual void | client_connected (unsigned int clid) |
Called when a new client connected. | |
virtual void | client_disconnected (unsigned int clid) |
Called when a client disconnected. | |
virtual void | loop () |
Process all network messages that have been received. | |
virtual void | plugin_loaded (const char *plugin_name) |
Plugin loaded event. | |
virtual void | plugin_unloaded (const char *plugin_name) |
Plugin unloaded event. | |
Protected Member Functions | |
virtual void | run () |
Stub to see name in backtrace for easier debugging. |
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, | ||
Mutex * | mutex = NULL |
||
) |
Constructor.
manager | plugin manager for the actual work |
hub | Fawkes network hub |
mutex | mutex that will be used to protect loading and unloading of plugins. |
Definition at line 68 of file handler.cpp.
References fawkes::PluginManager::add_listener(), and fawkes::FawkesNetworkHub::add_handler().
fawkes::PluginNetworkHandler::~PluginNetworkHandler | ( | ) |
Destructor.
Definition at line 84 of file handler.cpp.
References fawkes::FawkesNetworkHub::remove_handler(), and fawkes::PluginManager::remove_listener().
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.
clid | client ID of new client |
Implements fawkes::FawkesNetworkHandler.
Definition at line 374 of file handler.cpp.
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!
clid | client ID of disconnected client |
Implements fawkes::FawkesNetworkHandler.
Definition at line 380 of file handler.cpp.
References fawkes::LockList::remove_locked().
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.
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 365 of file handler.cpp.
References fawkes::RefCount::ref(), fawkes::LockQueue::push_locked(), and fawkes::Thread::wakeup().
void fawkes::PluginNetworkHandler::loop | ( | ) | [virtual] |
Process all network messages that have been received.
Reimplemented from fawkes::Thread.
Definition at line 277 of file handler.cpp.
References fawkes::FawkesNetworkMessage::msgid(), fawkes::MSG_PLUGIN_LOAD, fawkes::FawkesNetworkMessage::payload_size(), fawkes::LibLogger::log_error(), fawkes::FawkesNetworkMessage::payload(), fawkes::Thread::name(), fawkes::plugin_load_msg_t::name, fawkes::PluginManager::is_loaded(), fawkes::LibLogger::log_info(), fawkes::FawkesNetworkMessage::clid(), fawkes::MSG_PLUGIN_UNLOAD, fawkes::plugin_unload_msg_t::name, fawkes::MSG_PLUGIN_LIST_AVAIL, fawkes::LibLogger::log_debug(), fawkes::FawkesNetworkHub::send(), fawkes::MSG_PLUGIN_AVAIL_LIST, fawkes::MSG_PLUGIN_AVAIL_LIST_FAILED, fawkes::MSG_PLUGIN_LIST_LOADED, fawkes::MSG_PLUGIN_LOADED_LIST, fawkes::MSG_PLUGIN_LOADED_LIST_FAILED, fawkes::MSG_PLUGIN_SUBSCRIBE_WATCH, fawkes::LockList::lock(), fawkes::LockList::unlock(), fawkes::MSG_PLUGIN_UNSUBSCRIBE_WATCH, fawkes::LockList::remove_locked(), fawkes::RefCount::unref(), and fawkes::LockQueue::pop_locked().
void fawkes::PluginNetworkHandler::plugin_loaded | ( | const char * | plugin_name | ) | [virtual] |
Plugin loaded event.
plugin_name | name of the plugin that has just been loaded |
Implements fawkes::PluginManagerListener.
Definition at line 386 of file handler.cpp.
void fawkes::PluginNetworkHandler::plugin_unloaded | ( | const char * | plugin_name | ) | [virtual] |
Plugin unloaded event.
plugin_name | name of the plugin that has just been unloaded |
Implements fawkes::PluginManagerListener.
Definition at line 392 of file handler.cpp.
virtual void fawkes::PluginNetworkHandler::run | ( | ) | [inline, protected, virtual] |
Stub to see name in backtrace for easier debugging.
Reimplemented from fawkes::Thread.