Fawkes API  Fawkes Development Version
fawkes::FawkesNetworkServerClientThread Class Reference

Fawkes Network Client Thread for server. More...

#include <netcomm/fawkes/server_client_thread.h>

Inheritance diagram for fawkes::FawkesNetworkServerClientThread:

Public Member Functions

 FawkesNetworkServerClientThread (StreamSocket *s, FawkesNetworkServerThread *parent)
 Constructor. More...
 
 ~FawkesNetworkServerClientThread ()
 Destructor. More...
 
virtual void once ()
 Execute an action exactly once. More...
 
virtual void loop ()
 Thread loop. More...
 
unsigned int clid () const
 Get client ID. More...
 
void set_clid (unsigned int client_id)
 Set client ID. More...
 
bool alive () const
 Check aliveness of connection. More...
 
void enqueue (FawkesNetworkMessage *msg)
 Enqueue message to outbound queue. More...
 
void force_send ()
 Force sending of all pending outbound messages. More...
 
void connection_died ()
 Connection died notification. 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 Thread for server.

The FawkesNetworkServerThread spawns an instance of this class for every incoming connection. It is then used to handle the client. The thread will start another thread, an instance of FawkesNetworkServerClientSendThread. This will be used to handle all outgoing traffic.

Author
Tim Niemueller

Definition at line 40 of file server_client_thread.h.

Constructor & Destructor Documentation

◆ FawkesNetworkServerClientThread()

fawkes::FawkesNetworkServerClientThread::FawkesNetworkServerClientThread ( StreamSocket s,
FawkesNetworkServerThread parent 
)

Constructor.

Parameters
ssocket to client
parentparent network thread

Definition at line 163 of file server_client_thread.cpp.

References fawkes::Thread::set_prepfin_conc_loop().

◆ ~FawkesNetworkServerClientThread()

fawkes::FawkesNetworkServerClientThread::~FawkesNetworkServerClientThread ( )

Destructor.

Definition at line 180 of file server_client_thread.cpp.

References fawkes::Thread::cancel(), and fawkes::Thread::join().

Member Function Documentation

◆ alive()

bool fawkes::FawkesNetworkServerClientThread::alive ( ) const

Check aliveness of connection.

Returns
true if connection is still alive, false otherwise.

Definition at line 302 of file server_client_thread.cpp.

Referenced by fawkes::FawkesNetworkServerClientSendThread::loop().

◆ clid()

unsigned int fawkes::FawkesNetworkServerClientThread::clid ( ) const

Get client ID.

The client ID can be used to send replies.

Returns
client ID

Definition at line 195 of file server_client_thread.cpp.

◆ connection_died()

void fawkes::FawkesNetworkServerClientThread::connection_died ( )

Connection died notification.

To be called only be the send slave thread.

Definition at line 324 of file server_client_thread.cpp.

References fawkes::Thread::wakeup().

Referenced by fawkes::FawkesNetworkServerClientSendThread::loop().

◆ enqueue()

void fawkes::FawkesNetworkServerClientThread::enqueue ( FawkesNetworkMessage msg)

Enqueue message to outbound queue.

This enqueues the given message to the outbound queue. The message will be send in the next loop iteration.

Parameters
msgmessage to enqueue

Definition at line 292 of file server_client_thread.cpp.

References fawkes::FawkesNetworkServerClientSendThread::enqueue().

◆ force_send()

void fawkes::FawkesNetworkServerClientThread::force_send ( )

Force sending of all pending outbound messages.

This is a blocking operation. The current poll will be interrupted by sending a signal to this thread (and ignoring it) and then wait for the sending to finish.

Definition at line 314 of file server_client_thread.cpp.

References fawkes::FawkesNetworkServerClientSendThread::wait_for_all_sent().

◆ loop()

void fawkes::FawkesNetworkServerClientThread::loop ( )
virtual

Thread loop.

The client thread loop polls on the socket for 10 ms (wait for events on the socket like closed connection or data that can be read). If any event occurs it is processed. If the connection died or any other error occured the thread is cancelled and the parent FawkesNetworkThread is woken up to carry out any action that is needed when a client dies. If data is available for reading thedata is received and dispatched via recv(). Afterwards the outbound message queue is processed and alle messages are sent. This is also done if the operation could block (POLL_OUT is not honored).

Reimplemented from fawkes::Thread.

Definition at line 260 of file server_client_thread.cpp.

References fawkes::Socket::poll(), fawkes::Socket::POLL_ERR, fawkes::Socket::POLL_HUP, fawkes::Socket::POLL_IN, fawkes::Socket::POLL_RDHUP, and fawkes::Thread::wakeup().

◆ once()

void fawkes::FawkesNetworkServerClientThread::once ( )
virtual

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 241 of file server_client_thread.cpp.

References fawkes::Thread::start().

◆ run()

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

Stub to see name in backtrace for easier debugging.

See also
Thread::run()

Reimplemented from fawkes::Thread.

Definition at line 59 of file server_client_thread.h.

References fawkes::Thread::run().

◆ set_clid()


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