fawkes::FawkesNetworkServerClientSendThread Class Reference
[Fawkes Network Communication]

Sending thread for a Fawkes client connected to the server. More...

#include <netcomm/fawkes/server_client_thread.h>

Inheritance diagram for fawkes::FawkesNetworkServerClientSendThread:

Inheritance graph
[legend]

List of all members.


Public Member Functions

 FawkesNetworkServerClientSendThread (StreamSocket *s, FawkesNetworkServerClientThread *parent)
 Constructor.
 ~FawkesNetworkServerClientSendThread ()
 Destructor.
virtual void loop ()
 Code to execute in the thread.
void enqueue (FawkesNetworkMessage *msg)
 Enqueue message to outbound queue.
void wait_for_all_sent ()
 Wait until all data has been sent.

Protected Member Functions

virtual void run ()
 Stub to see name in backtrace for easier debugging.

Detailed Description

Sending thread for a Fawkes client connected to the server.

This thread is spawned for each client connected to the server to handle the server-side sending

Author:
Tim Niemueller

Definition at line 47 of file server_client_thread.cpp.

Constructor & Destructor Documentation

fawkes::FawkesNetworkServerClientSendThread::FawkesNetworkServerClientSendThread ( StreamSocket *  s,
FawkesNetworkServerClientThread *  parent 
) [inline]

Constructor.

Parameters:
s client stream socket
parent parent FawkesNetworkServerClientThread instance

Definition at line 55 of file server_client_thread.cpp.

fawkes::FawkesNetworkServerClientSendThread::~FawkesNetworkServerClientSendThread (  )  [inline]

Destructor.

Definition at line 69 of file server_client_thread.cpp.

References fawkes::RefCount::unref().

Member Function Documentation

void fawkes::FawkesNetworkServerClientSendThread::enqueue ( FawkesNetworkMessage *  msg  )  [inline]

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:
msg message to enqueue

Definition at line 112 of file server_client_thread.cpp.

References fawkes::Mutex::lock(), fawkes::RefCount::ref(), fawkes::Mutex::unlock(), and fawkes::Thread::wakeup().

Referenced by fawkes::FawkesNetworkServerClientThread::enqueue().

virtual void fawkes::FawkesNetworkServerClientSendThread::loop (  )  [inline, virtual]

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

References fawkes::FawkesNetworkServerClientThread::alive(), fawkes::FawkesNetworkServerClientThread::connection_died(), fawkes::Thread::exit(), fawkes::Mutex::lock(), fawkes::FawkesNetworkTransceiver::send(), and fawkes::Mutex::unlock().

virtual void fawkes::FawkesNetworkServerClientSendThread::run (  )  [inline, protected, virtual]

Stub to see name in backtrace for easier debugging.

See also:
Thread::run()

Reimplemented from fawkes::Thread.

Definition at line 131 of file server_client_thread.cpp.

void fawkes::FawkesNetworkServerClientSendThread::wait_for_all_sent (  )  [inline]

Wait until all data has been sent.

Definition at line 124 of file server_client_thread.cpp.

References fawkes::Mutex::lock(), fawkes::Thread::loop_mutex, and fawkes::Mutex::unlock().

Referenced by fawkes::FawkesNetworkServerClientThread::force_send().

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