fawkes::NetworkAcceptorThread Class Reference

Network Acceptor Thread. More...

#include <>>

Inheritance diagram for fawkes::NetworkAcceptorThread:

List of all members.

Public Member Functions
	NetworkAcceptorThread (NetworkIncomingConnectionHandler *handler, unsigned short int port, const char *thread_name="NetworkAcceptorThread")
	Constructor.
	NetworkAcceptorThread (NetworkIncomingConnectionHandler *handler, StreamSocket *socket, const char *thread_name="NetworkAcceptorThread")
	Constructor.
	~NetworkAcceptorThread ()
	Destructor.
virtual void	loop ()
	Thread loop.
Public Member Functions inherited from fawkes::Thread
virtual	~Thread ()
	Virtual destructor.
virtual void	init ()
	Initialize the thread.
bool	prepare_finalize ()
	Prepare finalization.
virtual bool	prepare_finalize_user ()
	Prepare finalization user implementation.
virtual void	finalize ()
	Finalize the thread.
void	cancel_finalize ()
	Cancel finalization.
void	start (bool wait=true)
	Call this method to start the thread.
void	cancel ()
	Cancel a thread.
void	join ()
	Join the thread.
void	detach ()
	Detach the thread.
void	kill (int sig)
	Send signal to a thread.
bool	operator== (const Thread &thread)
	Check if two threads are the same.
void	wakeup ()
	Wake up thread.
void	wakeup (Barrier *barrier)
	Wake up thread and wait for barrier afterwards.
void	wait_loop_done ()
	Wait for the current loop iteration to finish.
OpMode	opmode () const
	Get operation mode.
pthread_t	thread_id () const
	Get ID of thread.
bool	started () const
	Check if thread has been started.
bool	cancelled () const
	Check if thread has been cancelled.
bool	detached () const
	Check if thread has been detached.
bool	running () const
	Check if the thread is running.
bool	waiting () const
	Check if thread is currently waiting for wakeup.
const char *	name () const
	Get name of thread.
void	set_flags (uint32_t flags)
	Set all flags in one go.
void	set_flag (uint32_t flag)
	Set flag for the thread.
void	unset_flag (uint32_t flag)
	Unset flag.
bool	flagged_bad () const
	Check if FLAG_BAD was set.
void	set_delete_on_exit (bool del)
	Set whether the thread should be deleted on exit.
void	set_prepfin_hold (bool hold)
	Hold prepare_finalize().
void	add_notification_listener (ThreadNotificationListener *notification_listener)
	Add notification listener.
void	remove_notification_listener (ThreadNotificationListener *notification_listener)
	Remove notification listener.

Protected Member Functions
virtual void	run ()
	Stub to see name in backtrace for easier debugging.
Protected Member Functions inherited from fawkes::Thread
	Thread (const char *name)
	Constructor.
	Thread (const char *name, OpMode op_mode)
	Constructor.
void	exit ()
	Exit the thread.
void	test_cancel ()
	Set cancellation point.
void	yield ()
	Yield the processor to another thread or process.
void	set_opmode (OpMode op_mode)
	Set operation mode.
void	set_prepfin_conc_loop (bool concurrent=true)
	Set concurrent execution of prepare_finalize() and loop().
void	set_coalesce_wakeups (bool coalesce=true)
	Set wakeup coalescing.
void	set_name (const char *format,...)
	Set name of thread.
virtual void	once ()
	Execute an action exactly once.
bool	wakeup_pending ()
	Check if wakeups are pending.

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 Thread *	current_thread ()
	Get the Thread instance of the currently running thread.
static Thread *	current_thread_noexc () throw ()
	Similar to current_thread, but does never throw an exception.
static pthread_t	current_thread_id ()
	Get the ID of the currently running thread.
static void	init_main ()
	Initialize Thread wrapper instance for main thread.
static void	destroy_main ()
	Destroy main thread wrapper instance.
static void	set_cancel_state (CancelState new_state, CancelState *old_state=0)
	Set the cancel state of the current thread.
Static Public Attributes inherited from fawkes::Thread
static const unsigned int	FLAG_BAD = 0x00000001
	Standard thread flag: "thread is bad".
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.
Mutex *	loop_mutex
	Mutex that is used to protect a call to loop().
Mutex *	loopinterrupt_antistarve_mutex
	Mutex to avoid starvation when trying to lock loop_mutex.

---

Detailed Description

Network Acceptor Thread.

Opens and maintains a server socket and waits for incoming connections. If that happens NetworkConnectionHandler::add_connection() is called.

Author:

Tim Niemueller

Definition at line 34 of file acceptor_thread.h.

---

Constructor & Destructor Documentation

fawkes::NetworkAcceptorThread::NetworkAcceptorThread	(	NetworkIncomingConnectionHandler *	handler,
		unsigned short int	port,
		const char *	thread_name = "NetworkAcceptorThread"
	)

Constructor.

Parameters:

handler	Connection handler for newly accepted incoming connections.
port	port to listen on for incoming connections
thread_name	name of the thread

Exceptions:

SocketException

as thrown by StreamSocket connstructor, bind and listen.

Definition at line 45 of file acceptor_thread.cpp.

References fawkes::Socket::bind(), fawkes::Socket::listen(), and fawkes::Thread::set_prepfin_conc_loop().

fawkes::NetworkAcceptorThread::NetworkAcceptorThread	(	NetworkIncomingConnectionHandler *	handler,
		StreamSocket *	socket,
		const char *	thread_name = "NetworkAcceptorThread"
	)

Constructor.

Parameters:

handler	Connection handler for newly accepted incoming connections.
socket	socket, must already be bound to the desired port. Socket::listen() will be called by the acceptor thread.
thread_name	name of the thread

Exceptions:

SocketException

as thrown by StreamSocket connstructor, bind and listen.

Definition at line 72 of file acceptor_thread.cpp.

References fawkes::Socket::listen(), and fawkes::Thread::set_prepfin_conc_loop().

fawkes::NetworkAcceptorThread::~NetworkAcceptorThread

(

)

Destructor.

Definition at line 92 of file acceptor_thread.cpp.

---

Member Function Documentation

void fawkes::NetworkAcceptorThread::loop ( )

virtual

Thread loop.

Waits on a socket for an incoming connection (blocking accept). If a new connection has been established it is reported to the handler.

Reimplemented from fawkes::Thread.

Definition at line 103 of file acceptor_thread.cpp.

References fawkes::Socket::accept(), and fawkes::NetworkIncomingConnectionHandler::add_connection().

virtual void fawkes::NetworkAcceptorThread::run ( )

inlineprotectedvirtual

Stub to see name in backtrace for easier debugging.

See also:

Thread::run()

Reimplemented from fawkes::Thread.

Definition at line 48 of file acceptor_thread.h.

---

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

• src/libs/netcomm/utils/acceptor_thread.h
• src/libs/netcomm/utils/acceptor_thread.cpp