Fawkes API
Fawkes Development Version
|
Receive incoming ProtoBuf messages and pass them on to the BlackboardManager for publication to the appropriate blackboard interface. More...
#include <protobuf_thread.h>
Classes | |
struct | incoming_message |
Wrapper for a ProtoBuf message and its metadata. More... | |
Public Member Functions | |
ProtobufThead () | |
Empty-initialization constructor. More... | |
virtual | ~ProtobufThead () override |
Destructor. More... | |
bool | pb_queue_incoming () |
incoming_message | pb_queue_pop () |
long int | peer_create (const std::string &host, int port) |
Enable protobuf peer. More... | |
long int | peer_create_local (const std::string &host, int send_to_port, int recv_on_port) |
Enable protobuf peer. More... | |
long int | peer_create_crypto (const std::string &host, int port, const std::string &crypto_key="", const std::string &cipher="") |
Enable protobuf peer. More... | |
long int | peer_create_local_crypto (const std::string &host, int send_to_port, int recv_on_port, const std::string &crypto_key="", const std::string &cipher="") |
Enable protobuf peer. More... | |
void | peer_destroy (long int peer_id) |
Disable peer. More... | |
void | send (long int peer_id, std::shared_ptr< google::protobuf::Message > msg) |
Send a ProtoBuf message to the given peer. More... | |
void | set_bb_manager (BlackboardManager *bb_manager) |
Deferred initialization of the pointer to the BlackboardManager. More... | |
fawkes::BlackBoard * | get_blackboard () |
Helper to give ProtoBuf converters access to the BlackBoard instance in use. More... | |
![]() | |
virtual | ~Thread () |
Virtual destructor. 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... | |
void | add_loop_listener (ThreadLoopListener *loop_listener) |
Add loop listener. More... | |
void | remove_loop_listener (ThreadLoopListener *loop_listener) |
Remove loop listener. More... | |
![]() | |
LoggingAspect () | |
Constructor. More... | |
virtual | ~LoggingAspect () |
Virtual empty Destructor. More... | |
void | init_LoggingAspect (Logger *logger) |
Set the logger. More... | |
![]() | |
const std::list< const char * > & | get_aspects () const |
Get list of aspect names attached to a aspected thread. More... | |
![]() | |
ConfigurableAspect () | |
Constructor. More... | |
virtual | ~ConfigurableAspect () |
Virtual empty Destructor. More... | |
void | init_ConfigurableAspect (Configuration *config) |
Set the configuration It is guaranteed that this is called for a configurable thread before Thread::start() is called (when running regularly inside Fawkes). More... | |
![]() | |
BlackBoardAspect (const char *owner=NULL) | |
Constructor. More... | |
virtual | ~BlackBoardAspect () |
Virtual empty destructor. More... | |
void | init_BlackBoardAspect (BlackBoard *bb) |
Init BlackBoard aspect. More... | |
Protected Member Functions | |
virtual void | init () override |
Initialize the thread. 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... | |
virtual void | run () |
Code to execute in the thread. 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... | |
virtual void | loop () |
Code to execute in the thread. More... | |
bool | wakeup_pending () |
Check if wakeups are pending. More... | |
![]() | |
void | add_aspect (const char *name) |
Add an aspect to a thread. 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 () noexcept |
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 std::string | current_thread_name () |
Get the name of the current thread. More... | |
static void | current_thread_name (const std::string &thread_name) |
Set the name of the current 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... | |
![]() | |
Logger * | logger |
This is the Logger member used to access the logger. More... | |
![]() | |
Configuration * | config |
This is the Configuration member used to access the configuration. More... | |
![]() | |
BlackBoard * | blackboard |
This is the BlackBoard instance you can use to interact with the BlackBoard. More... | |
Receive incoming ProtoBuf messages and pass them on to the BlackboardManager for publication to the appropriate blackboard interface.
Definition at line 51 of file protobuf_thread.h.
protoboard::ProtobufThead::ProtobufThead | ( | ) |
Empty-initialization constructor.
Definition at line 38 of file protobuf_thread.cpp.
|
overridevirtual |
Destructor.
Definition at line 46 of file protobuf_thread.cpp.
|
inline |
Helper to give ProtoBuf converters access to the BlackBoard instance in use.
Definition at line 118 of file protobuf_thread.h.
References fawkes::BlackBoardAspect::blackboard.
|
overrideprotectedvirtual |
Initialize the thread.
This method is meant to be used in conjunction with aspects. Some parts of the initialization may only happen after some aspect of the thread has been initialized. Implement the init method with these actions. It is guaranteed to be called just after all aspects have been initialized and only once in the lifetime of the thread. Throw an exception if any problem occurs and the thread should not run.
Just because your init() routine suceeds and everything looks fine for this thread does not automatically imply that it will run. If it belongs to a group of threads in a ThreadList and any of the other threads fail to initialize then no thread from this group is run and thus this thread will never run. In that situation finalize() is called for this very instance, prepare_finalize() however is not called.
Reimplemented from fawkes::Thread.
Definition at line 52 of file protobuf_thread.cpp.
References fawkes::Thread::name().
bool protoboard::ProtobufThead::pb_queue_incoming | ( | ) |
Definition at line 62 of file protobuf_thread.cpp.
Referenced by protoboard::BlackboardManager::loop().
ProtobufThead::incoming_message protoboard::ProtobufThead::pb_queue_pop | ( | ) |
Definition at line 69 of file protobuf_thread.cpp.
Referenced by protoboard::BlackboardManager::loop().
long int protoboard::ProtobufThead::peer_create | ( | const std::string & | address, |
int | port | ||
) |
Enable protobuf peer.
address | IP address to send messages to |
port | UDP port to send and receive messages |
Definition at line 141 of file protobuf_thread.cpp.
References peer_create_local_crypto().
Referenced by protoboard::BlackboardManager::handle_message().
long int protoboard::ProtobufThead::peer_create_crypto | ( | const std::string & | address, |
int | port, | ||
const std::string & | crypto_key = "" , |
||
const std::string & | cipher = "" |
||
) |
Enable protobuf peer.
address | IP address to send messages to |
port | UDP port to send and receive messages |
crypto_key | encryption key |
cipher | cipher suite, see BufferEncryptor for supported types |
Definition at line 127 of file protobuf_thread.cpp.
References peer_create_local_crypto().
Referenced by protoboard::BlackboardManager::handle_message().
long int protoboard::ProtobufThead::peer_create_local | ( | const std::string & | address, |
int | send_to_port, | ||
int | recv_on_port | ||
) |
Enable protobuf peer.
address | IP address to send messages to |
send_to_port | UDP port to send messages to |
recv_on_port | UDP port to receive messages on, 0 to use the same as the send_port |
Definition at line 153 of file protobuf_thread.cpp.
References peer_create_local_crypto().
Referenced by protoboard::BlackboardManager::handle_message().
long int protoboard::ProtobufThead::peer_create_local_crypto | ( | const std::string & | address, |
int | send_to_port, | ||
int | recv_on_port, | ||
const std::string & | crypto_key = "" , |
||
const std::string & | cipher = "" |
||
) |
Enable protobuf peer.
address | IP address to send messages to |
send_to_port | UDP port to send messages to |
recv_on_port | UDP port to receive messages on, 0 to use the same as the send_port |
crypto_key | encryption key |
cipher | cipher suite, see BufferEncryptor for supported types |
Definition at line 86 of file protobuf_thread.cpp.
Referenced by protoboard::BlackboardManager::handle_message(), peer_create(), peer_create_crypto(), and peer_create_local().
void protoboard::ProtobufThead::peer_destroy | ( | long int | peer_id | ) |
Disable peer.
peer_id | ID of the peer to destroy |
Definition at line 162 of file protobuf_thread.cpp.
void protoboard::ProtobufThead::send | ( | long int | peer_id, |
std::shared_ptr< google::protobuf::Message > | msg | ||
) |
Send a ProtoBuf message to the given peer.
peer_id | The peer to send to |
msg | The message |
Definition at line 186 of file protobuf_thread.cpp.
References fawkes::Logger::log_warn(), fawkes::LoggingAspect::logger, and fawkes::Thread::name().
|
inline |
Deferred initialization of the pointer to the BlackboardManager.
bb_manager | the BlackboardManager to use |
Definition at line 108 of file protobuf_thread.h.
Referenced by ProtoboardPlugin< IfaceManagerTs >::ProtoboardPlugin().