Fawkes API
Fawkes Development Version
|
BlackBoard Network Handler. More...
#include <>>
Public Member Functions | |
BlackBoardNetworkHandler (BlackBoard *blackboard, FawkesNetworkHub *hub) | |
Constructor. | |
~BlackBoardNetworkHandler () | |
Destructor. | |
virtual void | handle_network_message (FawkesNetworkMessage *msg) |
Handle network message. | |
virtual void | client_connected (unsigned int clid) |
Client connected. | |
virtual void | client_disconnected (unsigned int clid) |
Client disconnected. | |
virtual void | loop () |
Process all network messages that have been received. | |
![]() | |
virtual | ~Thread () |
Virtual destructor. | |
virtual void | init () |
Initialize the thread. | |
bool | prepare_finalize () |
Prepare finalization. | |
virtual bool | prepare_finalize_user () |
Prepare finalization user implementation. | |
virtual void | finalize () |
Finalize the thread. | |
void | cancel_finalize () |
Cancel finalization. | |
void | start (bool wait=true) |
Call this method to start the thread. | |
void | cancel () |
Cancel a thread. | |
void | join () |
Join the thread. | |
void | detach () |
Detach the thread. | |
void | kill (int sig) |
Send signal to a thread. | |
bool | operator== (const Thread &thread) |
Check if two threads are the same. | |
void | wakeup () |
Wake up thread. | |
void | wakeup (Barrier *barrier) |
Wake up thread and wait for barrier afterwards. | |
void | wait_loop_done () |
Wait for the current loop iteration to finish. | |
OpMode | opmode () const |
Get operation mode. | |
pthread_t | thread_id () const |
Get ID of thread. | |
bool | started () const |
Check if thread has been started. | |
bool | cancelled () const |
Check if thread has been cancelled. | |
bool | detached () const |
Check if thread has been detached. | |
bool | running () const |
Check if the thread is running. | |
bool | waiting () const |
Check if thread is currently waiting for wakeup. | |
const char * | name () const |
Get name of thread. | |
void | set_flags (uint32_t flags) |
Set all flags in one go. | |
void | set_flag (uint32_t flag) |
Set flag for the thread. | |
void | unset_flag (uint32_t flag) |
Unset flag. | |
bool | flagged_bad () const |
Check if FLAG_BAD was set. | |
void | set_delete_on_exit (bool del) |
Set whether the thread should be deleted on exit. | |
void | set_prepfin_hold (bool hold) |
Hold prepare_finalize(). | |
void | add_notification_listener (ThreadNotificationListener *notification_listener) |
Add notification listener. | |
void | remove_notification_listener (ThreadNotificationListener *notification_listener) |
Remove notification listener. | |
![]() | |
FawkesNetworkHandler (unsigned short int id) | |
Constructor. | |
virtual | ~FawkesNetworkHandler () |
Destructor. | |
unsigned short int | id () const |
Get the component ID for this handler. |
Protected Member Functions | |
virtual void | run () |
Stub to see name in backtrace for easier debugging. | |
![]() | |
Thread (const char *name) | |
Constructor. | |
Thread (const char *name, OpMode op_mode) | |
Constructor. | |
void | exit () |
Exit the thread. | |
void | test_cancel () |
Set cancellation point. | |
void | yield () |
Yield the processor to another thread or process. | |
void | set_opmode (OpMode op_mode) |
Set operation mode. | |
void | set_prepfin_conc_loop (bool concurrent=true) |
Set concurrent execution of prepare_finalize() and loop(). | |
void | set_coalesce_wakeups (bool coalesce=true) |
Set wakeup coalescing. | |
void | set_name (const char *format,...) |
Set name of thread. | |
virtual void | once () |
Execute an action exactly once. | |
bool | wakeup_pending () |
Check if wakeups are pending. |
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. | |
static Thread * | current_thread_noexc () throw () |
Similar to current_thread, but does never throw an exception. | |
static pthread_t | current_thread_id () |
Get the ID of the currently running thread. | |
static void | init_main () |
Initialize Thread wrapper instance for main thread. | |
static void | destroy_main () |
Destroy main thread wrapper instance. | |
static void | set_cancel_state (CancelState new_state, CancelState *old_state=0) |
Set the cancel state of the current thread. | |
![]() | |
static const unsigned int | FLAG_BAD = 0x00000001 |
Standard thread flag: "thread is bad". | |
![]() | |
bool | finalize_prepared |
True if prepare_finalize() has been called and was not stopped with a cancel_finalize(), false otherwise. | |
Mutex * | loop_mutex |
Mutex that is used to protect a call to loop(). | |
Mutex * | loopinterrupt_antistarve_mutex |
Mutex to avoid starvation when trying to lock loop_mutex. |
BlackBoard Network Handler.
This class provides a network handler that can be registered with the FawkesServerThread to handle client requests to a BlackBoard instance.
fawkes::BlackBoardNetworkHandler::BlackBoardNetworkHandler | ( | BlackBoard * | blackboard, |
FawkesNetworkHub * | hub | ||
) |
Constructor.
blackboard | BlackBoard instance to provide network access to |
hub | Fawkes network hub |
Definition at line 57 of file handler.cpp.
References fawkes::FawkesNetworkHub::add_handler().
fawkes::BlackBoardNetworkHandler::~BlackBoardNetworkHandler | ( | ) |
Destructor.
Definition at line 71 of file handler.cpp.
References fawkes::LockQueue< Type >::clear(), fawkes::BlackBoard::close(), and fawkes::FawkesNetworkHub::remove_handler().
|
virtual |
Client connected.
Ignored.
clid | client ID |
Implements fawkes::FawkesNetworkHandler.
Definition at line 395 of file handler.cpp.
|
virtual |
Client disconnected.
If the client had opened any interfaces these are closed.
clid | client ID |
Implements fawkes::FawkesNetworkHandler.
Definition at line 405 of file handler.cpp.
References fawkes::BlackBoard::close(), fawkes::LockMap< KeyType, ValueType, LessKey >::erase_locked(), fawkes::LockMap< KeyType, ValueType, LessKey >::lock(), fawkes::LibLogger::log_debug(), and fawkes::LockMap< KeyType, ValueType, LessKey >::unlock().
|
virtual |
Handle network message.
The message is put into the inbound queue and processed in processAfterLoop().
msg | message |
Implements fawkes::FawkesNetworkHandler.
Definition at line 383 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 88 of file handler.cpp.
References fawkes::BlackBoardInterfaceListContent::append_interface(), fawkes::BB_ERR_HASH_MISMATCH, fawkes::BB_ERR_UNKNOWN_ERR, fawkes::BB_ERR_UNKNOWN_TYPE, fawkes::BB_ERR_WRITER_EXISTS, fawkes::FawkesNetworkMessage::clid(), fawkes::BlackBoard::close(), fawkes::bb_idata_msg_t::data_size, fawkes::bb_imessage_msg_t::data_size, fawkes::Message::datasize(), fawkes::bb_iopen_msg_t::hash, fawkes::Interface::hash(), fawkes::bb_imessage_msg_t::hops, fawkes::bb_iopen_msg_t::id, fawkes::bb_ilistreq_msg_t::id_pattern, fawkes::BlackBoard::list(), fawkes::BlackBoard::list_all(), fawkes::LockMap< KeyType, ValueType, LessKey >::lock(), fawkes::LibLogger::log_debug(), fawkes::LibLogger::log_error(), fawkes::LibLogger::log_warn(), fawkes::FawkesNetworkMessage::msg(), fawkes::bb_imessage_msg_t::msg_type, fawkes::FawkesNetworkMessage::msgid(), fawkes::bb_imessage_msg_t::msgid, fawkes::BlackBoard::open_for_reading(), fawkes::BlackBoard::open_for_writing(), fawkes::FawkesNetworkMessage::payload(), fawkes::LockQueue< Type >::pop_locked(), fawkes::FawkesNetworkHub::send(), fawkes::Interface::serial(), fawkes::bb_iserial_msg_t::serial, fawkes::bb_idata_msg_t::serial, fawkes::bb_imessage_msg_t::serial, fawkes::Message::set_from_chunk(), fawkes::Message::set_hops(), fawkes::Message::set_id(), fawkes::bb_iopen_msg_t::type, fawkes::bb_ilistreq_msg_t::type_pattern, fawkes::LockMap< KeyType, ValueType, LessKey >::unlock(), and fawkes::RefCount::unref().
|
inlineprotectedvirtual |
Stub to see name in backtrace for easier debugging.
Reimplemented from fawkes::Thread.