Fawkes API Fawkes Development Version
SkillShellThread Class Reference

Skill shell thread. More...

Inheritance diagram for SkillShellThread:

Public Member Functions

 SkillShellThread (ArgumentParser *argp)
 Constructor. More...
 
 ~SkillShellThread ()
 Destructor. More...
 
virtual void loop ()
 Code to execute in the thread. More...
 
virtual void deregistered (unsigned int id) noexcept
 This handler has been deregistered. More...
 
virtual void inbound_received (FawkesNetworkMessage *m, unsigned int id) noexcept
 Called for incoming messages. More...
 
virtual void connection_died (unsigned int id) noexcept
 Client connection died. More...
 
virtual void connection_established (unsigned int id) noexcept
 Client has established a connection. More...
 
 SkillShellThread (ArgumentParser *argp)
 Constructor. More...
 
 ~SkillShellThread ()
 Destructor. More...
 
virtual void loop ()
 Code to execute in the thread. More...
 
virtual void deregistered (unsigned int id) noexcept
 This handler has been deregistered. More...
 
virtual void inbound_received (FawkesNetworkMessage *m, unsigned int id) noexcept
 Called for incoming messages. More...
 
virtual void connection_died (unsigned int id) noexcept
 Client connection died. More...
 
virtual void connection_established (unsigned int id) noexcept
 Client has established a connection. 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...
 
void add_loop_listener (ThreadLoopListener *loop_listener)
 Add loop listener. More...
 
void remove_loop_listener (ThreadLoopListener *loop_listener)
 Remove loop listener. More...
 
- Public Member Functions inherited from fawkes::FawkesNetworkClientHandler
virtual ~FawkesNetworkClientHandler ()
 Empty virtual destructor. More...
 
virtual void deregistered (unsigned int id) noexcept=0
 This handler has been deregistered. More...
 
virtual void inbound_received (FawkesNetworkMessage *m, unsigned int id) noexcept=0
 Called for incoming messages. More...
 
virtual void connection_died (unsigned int id) noexcept=0
 Client connection died. More...
 
virtual void connection_established (unsigned int id) noexcept=0
 Client has established a connection. 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 () 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 Public Attributes inherited from fawkes::Thread
static const unsigned int FLAG_BAD = 0x00000001
 Standard thread flag: "thread is bad". 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...
 
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...
 
- 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

Skill shell thread.

This thread opens a network connection to a host and uses a RemoteBlackBoard connection to send skill strings for execution. It also shows Skiller log messages and uses the skiller network protocol.

Author
Tim Niemueller

Definition at line 64 of file skilltester.cpp.

Constructor & Destructor Documentation

◆ SkillShellThread() [1/2]

SkillShellThread::SkillShellThread ( ArgumentParser argp)
inlineexplicit

Constructor.

Parameters
argpargument parser

Definition at line 70 of file skilltester.cpp.

References fawkes::FawkesNetworkClient::connect(), fawkes::ArgumentParser::parse_hostport(), and fawkes::FawkesNetworkClient::register_handler().

◆ ~SkillShellThread() [1/2]

SkillShellThread::~SkillShellThread ( )
inline

◆ SkillShellThread() [2/2]

SkillShellThread::SkillShellThread ( ArgumentParser argp)
inlineexplicit

Constructor.

Parameters
argpargument parser

Definition at line 69 of file skillet.cpp.

References fawkes::FawkesNetworkClient::connect(), fawkes::ArgumentParser::parse_hostport(), and fawkes::FawkesNetworkClient::register_handler().

◆ ~SkillShellThread() [2/2]

SkillShellThread::~SkillShellThread ( )
inline

Member Function Documentation

◆ connection_died() [1/2]

virtual void SkillShellThread::connection_died ( unsigned int  id)
inlinevirtualnoexcept

Client connection died.

This method is used to inform handlers that the connection has died for any reason. No more data can be send and no more messages should be enqueued because it is unclear when they would be sent.

Parameters
idthe id of the calling client

Implements fawkes::FawkesNetworkClientHandler.

Definition at line 190 of file skilltester.cpp.

References fawkes::BlackBoard::close().

◆ connection_died() [2/2]

virtual void SkillShellThread::connection_died ( unsigned int  id)
inlinevirtualnoexcept

Client connection died.

This method is used to inform handlers that the connection has died for any reason. No more data can be send and no more messages should be enqueued because it is unclear when they would be sent.

Parameters
idthe id of the calling client

Implements fawkes::FawkesNetworkClientHandler.

Definition at line 201 of file skillet.cpp.

References fawkes::BlackBoard::close().

◆ connection_established() [1/2]

virtual void SkillShellThread::connection_established ( unsigned int  id)
inlinevirtualnoexcept

Client has established a connection.

Whenever the client establishes a connection this is signaled to handlers with this method. You can register to a client at any time, you may even enqueue messages to a client while the connection is dead. If the client at some point gets connected again, the messages will then be send out in one go. You should use this in your application though to only send data if the connection is alive and you should let the user know about the connection status.

Parameters
idthe id of the calling client

Implements fawkes::FawkesNetworkClientHandler.

Definition at line 207 of file skilltester.cpp.

◆ connection_established() [2/2]

virtual void SkillShellThread::connection_established ( unsigned int  id)
inlinevirtualnoexcept

Client has established a connection.

Whenever the client establishes a connection this is signaled to handlers with this method. You can register to a client at any time, you may even enqueue messages to a client while the connection is dead. If the client at some point gets connected again, the messages will then be send out in one go. You should use this in your application though to only send data if the connection is alive and you should let the user know about the connection status.

Parameters
idthe id of the calling client

Implements fawkes::FawkesNetworkClientHandler.

Definition at line 218 of file skillet.cpp.

◆ deregistered() [1/2]

virtual void SkillShellThread::deregistered ( unsigned int  id)
inlinevirtualnoexcept

This handler has been deregistered.

This is called when this handler is deregistered from the FawkesNetworkClient. Sometimes you may not want to allow this and post a big fat warning into the log.

Parameters
idthe id of the calling client

Implements fawkes::FawkesNetworkClientHandler.

Definition at line 180 of file skilltester.cpp.

◆ deregistered() [2/2]

virtual void SkillShellThread::deregistered ( unsigned int  id)
inlinevirtualnoexcept

This handler has been deregistered.

This is called when this handler is deregistered from the FawkesNetworkClient. Sometimes you may not want to allow this and post a big fat warning into the log.

Parameters
idthe id of the calling client

Implements fawkes::FawkesNetworkClientHandler.

Definition at line 191 of file skillet.cpp.

◆ inbound_received() [1/2]

virtual void SkillShellThread::inbound_received ( FawkesNetworkMessage m,
unsigned int  id 
)
inlinevirtualnoexcept

Called for incoming messages.

This is called when an incoming message has been received. If this method was called one or more times then the a previously carried out wait(cid) call will continue.

Parameters
mMessage to handle
idthe id of the calling client

Implements fawkes::FawkesNetworkClientHandler.

Definition at line 185 of file skilltester.cpp.

◆ inbound_received() [2/2]

virtual void SkillShellThread::inbound_received ( FawkesNetworkMessage m,
unsigned int  id 
)
inlinevirtualnoexcept

Called for incoming messages.

This is called when an incoming message has been received. If this method was called one or more times then the a previously carried out wait(cid) call will continue.

Parameters
mMessage to handle
idthe id of the calling client

Implements fawkes::FawkesNetworkClientHandler.

Definition at line 196 of file skillet.cpp.

◆ loop() [1/2]

virtual void SkillShellThread::loop ( )
inlinevirtual

Code to execute in the thread.

Implement this method to hold the code you want to be executed continously. If you do not implement this method, the default is that the thread will exit. This is useful if you choose to only implement once().

Reimplemented from fawkes::Thread.

Definition at line 116 of file skilltester.cpp.

References fawkes::FawkesNetworkClient::connect(), fawkes::FawkesNetworkClient::connected(), fawkes::FawkesNetworkClient::disconnect(), fawkes::Thread::exit(), fawkes::ArgumentParser::items(), fawkes::Interface::msgq_enqueue(), fawkes::ArgumentParser::num_items(), fawkes::BlackBoard::open_for_reading(), and fawkes::Exception::print_trace().

◆ loop() [2/2]

virtual void SkillShellThread::loop ( )
inlinevirtual

Code to execute in the thread.

Implement this method to hold the code you want to be executed continously. If you do not implement this method, the default is that the thread will exit. This is useful if you choose to only implement once().

Reimplemented from fawkes::Thread.

Definition at line 115 of file skillet.cpp.

References fawkes::FawkesNetworkClient::connect(), fawkes::FawkesNetworkClient::connected(), fawkes::FawkesNetworkClient::disconnect(), fawkes::Thread::exit(), fawkes::ArgumentParser::items(), fawkes::Interface::msgq_enqueue(), fawkes::ArgumentParser::num_items(), fawkes::BlackBoard::open_for_reading(), and fawkes::Exception::print_trace().


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