Fawkes API  Fawkes Development Version
fawkes::FawkesNetworkClientSendThread Class Reference

Fawkes network client send thread. More...

Inheritance diagram for fawkes::FawkesNetworkClientSendThread:

Public Member Functions

 FawkesNetworkClientSendThread (StreamSocket *s, FawkesNetworkClient *parent)
 Constructor. More...
 
 ~FawkesNetworkClientSendThread ()
 Destructor. More...
 
virtual void once ()
 Execute an action exactly once. More...
 
virtual void loop ()
 Code to execute in the thread. More...
 
void force_send ()
 Force sending of messages. More...
 
void enqueue (FawkesNetworkMessage *message)
 Enqueue message to send and take ownership. 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...
 

Protected Member Functions

virtual void run ()
 Stub to see name in backtrace for easier debugging. 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...
 
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...
 
bool wakeup_pending ()
 Check if wakeups are pending. 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 () 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 Public Attributes inherited from fawkes::Thread
static const unsigned int FLAG_BAD = 0x00000001
 Standard thread flag: "thread is bad". 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

Fawkes network client send thread.

Spawned by the FawkesNetworkClient to handle outgoing traffic.

Author
Tim Niemueller

Definition at line 65 of file client.cpp.

Constructor & Destructor Documentation

◆ FawkesNetworkClientSendThread()

fawkes::FawkesNetworkClientSendThread::FawkesNetworkClientSendThread ( StreamSocket s,
FawkesNetworkClient parent 
)
inline

Constructor.

Parameters
sclient stream socket
parentparent FawkesNetworkClient instance

Definition at line 73 of file client.cpp.

◆ ~FawkesNetworkClientSendThread()

fawkes::FawkesNetworkClientSendThread::~FawkesNetworkClientSendThread ( )
inline

Destructor.

Definition at line 87 of file client.cpp.

References fawkes::RefCount::unref().

Member Function Documentation

◆ enqueue()

void fawkes::FawkesNetworkClientSendThread::enqueue ( FawkesNetworkMessage message)
inline

Enqueue message to send and take ownership.

This method takes ownership of the message. If you want to use the message after enqueing you must reference:

message->ref();
send_slave->enqueue(message);
// message can now still be used

Without extra referencing the message may not be used after enqueuing.

Parameters
messagemessage to send

Definition at line 151 of file client.cpp.

◆ force_send()

void fawkes::FawkesNetworkClientSendThread::force_send ( )
inline

Force sending of messages.

All messages are sent out immediately, if loop is not running already anyway.

Definition at line 132 of file client.cpp.

◆ loop()

virtual void fawkes::FawkesNetworkClientSendThread::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 106 of file client.cpp.

References fawkes::FawkesNetworkTransceiver::send(), and fawkes::LockQueue< Type >::unlock().

◆ once()

virtual void fawkes::FawkesNetworkClientSendThread::once ( )
inlinevirtual

Execute an action exactly once.

This code is executed once and only once right after the thread is started before loop() is called. This is useful if you want to implement an one-shot background job. Just implement once() and leave loop() untouched. Start the thread and detach it and it will just do its job and then die automatically. If you use set_delete_on_exit(true) even the Thread instance will be automatically deleted.

Reimplemented from fawkes::Thread.

Definition at line 101 of file client.cpp.

◆ run()

virtual void fawkes::FawkesNetworkClientSendThread::run ( )
inlineprotectedvirtual

Stub to see name in backtrace for easier debugging.

See also
Thread::run()

Reimplemented from fawkes::Thread.

Definition at line 161 of file client.cpp.

References fawkes::Thread::run().


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