Abstract base for multi-threaded network server. More...

#include <NetServer_linux.h>

Inheritance diagram for utl::NetServer:

[legend]

Public Member Functions
	NetServer (size_t maxClients, size_t maxPaused=1, size_t clientsPerThread=1)
	Constructor. More...

virtual void *	run (void *arg=nullptr)
	Run the thread. More...

bool	addServer (ServerSocket *serverSocket)
	Add a server socket. More...

void	listen ()
	Listen for events. More...

void	handlePipeEvent ()
	Process an event on the read end of the pipe. More...

void	handleServerSocketEvent (int fd)
	Process an event on a server socket. More...

void	clientDisconnectAll ()
	Disconnect all clients. More...

void	clientDisconnect (NetServerClient *client)
	Disconnect the given client. More...

Public Member Functions inherited from utl::Thread
virtual const Object &	getKey () const
	Get the key for this object. More...

size_t	id () const
	Get the thread's ID. More...

uint_t	node () const
	Get the thread's assigned node (NUMA). More...

uint_t &	node ()
	Get the thread's assigned node (NUMA). More...

bool	isDetached () const
	Determine whether the thread is detached. More...

void	cancel ()
	Cancel the thread. More...

void *	join (bool deleteSelf=true)
	Join on the thread. More...

void	start (void *arg=nullptr, bool join=true)
	Start the thread. More...

virtual void	pause ()
	Clean up stored state in preparation for re-use. More...

randutils::mt19937_64_rng *	rng ()
	Get the random generator (initialize it if necessary). More...

Public Member Functions inherited from utl::Object
void	clear ()
	Revert to initial state. More...

virtual int	compare (const Object &rhs) const
	Compare with another object. More...

virtual void	copy (const Object &rhs)
	Copy another instance. More...

virtual void	vclone (const Object &rhs)
	Make an exact copy of another instance. More...

virtual void	steal (Object &rhs)
	"Steal" the internal representation from another instance. More...

virtual void	dump (Stream &os, uint_t level=uint_t_max) const
	Dump a human-readable representation of self to the given output stream. More...

void	dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const
	Front-end for dump() that prints the object's class name. More...

bool	hasKey () const
	Determine whether or not the object has a key. More...

virtual const Object &	getProxiedObject () const
	Get the proxied object (= self if none). More...

virtual Object &	getProxiedObject ()
	Get the proxied object (= self if none). More...

virtual size_t	hash (size_t size) const
	Get the hash code for the object. More...

bool	_isA (const RunTimeClass *runTimeClass) const
	Determine whether self's class is a descendent of the given class. More...

virtual String	toString () const
	Return a string representation of self. More...

	operator String () const
	Conversion to String. More...

size_t	allocatedSize () const
	Get the total allocated size of this object. More...

virtual size_t	innerAllocatedSize () const
	Get the "inner" allocated size. More...

virtual void	addOwnedIt (const class FwdIt *it) const
	Notify self that it owns the given iterator. More...

virtual void	removeOwnedIt (const class FwdIt *it) const
	Notify self that the given owned iterator has been destroyed. More...

bool	operator< (const Object &rhs) const
	Less-than operator. More...

bool	operator<= (const Object &rhs) const
	Less-than-or-equal-to operator. More...

bool	operator> (const Object &rhs) const
	Greater-than operator. More...

bool	operator>= (const Object &rhs) const
	Greater-than-or-equal-to operator. More...

bool	operator== (const Object &rhs) const
	Equal-to operator. More...

bool	operator!= (const Object &rhs) const
	Unequal-to operator. More...

void	serializeIn (Stream &is, uint_t mode=ser_default)
	Serialize from an input stream. More...

void	serializeOut (Stream &os, uint_t mode=ser_default) const
	Serialize to an output stream. More...

virtual void	serialize (Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize to or from a stream. More...

void	serializeOutBoxed (Stream &os, uint_t mode=ser_default) const
	Serialize a boxed object to an output stream. More...

Public Member Functions inherited from utl::NamedObjectMI
	NamedObjectMI ()
	Constructor.

	NamedObjectMI (const String &name)
	Constructor. More...

void	clear ()
	Clear the name. More...

const String &	getName () const
	Get the name. More...

const String *	getNamePtr () const
	Get the address of the name. More...

void	setName (const String &name)
	Set the name. More...

Protected Member Functions
virtual NetServerClient *	clientMake (FDstream *socket, const InetHostAddress &addr)
	Make a new client object. More...

NetServerClient *	clientFind (int fd) const
	Find a client by its file descriptor. More...

virtual void	onClientConnect (NetServerClient *client)=0
	Notify of a new client connection. More...

virtual void	onClientDisconnect (NetServerClient *client)=0
	Disconnect a client. More...

virtual bool	exiting () const
	Is it time for the server to stop?

Protected Member Functions inherited from utl::FlagsMI
	FlagsMI ()
	Constructor. More...

virtual	~FlagsMI ()
	Destructor. More...

void	copyFlags (const FlagsMI &rhs)
	Copy the given flags. More...

void	copyFlags (const FlagsMI &rhs, uint_t lsb, uint_t msb)
	Copy (some of) the given flags. More...

void	copyFlags (uint64_t flags, uint_t lsb, uint_t msb)
	Copy (some of) the given flags. More...

bool	getFlag (uint_t flagNum) const
	Get a user-defined flag. More...

void	setFlag (uint_t flagNum, bool val)
	Set a user-defined flag. More...

uint64_t	getFlagsNumber (uint64_t mask, uint64_t shift=0)
	Get a multi-bit value in the flags data (which is stored as one 64-bit integer). More...

void	setFlagsNumber (uint64_t mask, uint64_t shift, uint64_t num)
	Set a multi-bit value in the flags data (which is stored as one 64-bit integer). More...

uint64_t	getFlags () const
	Get the flags. More...

void	setFlags (uint64_t flags)
	Set the flags. More...

Additional Inherited Members
Static Public Member Functions inherited from utl::Thread
static Thread *	get ()
	Get a pointer to the current thread's Thread object. More...

static thread_handle_t	handle ()
	Get a handle to the current thread. More...

static void	testCancel ()
	Test for cancellation. More...

static void	yield ()
	Yield the processor to allow another thread to run. More...

static ulong_t	tlsNew ()
	Return a newly created TLS key. More...

static void *	tlsGet (ulong_t key)
	Get the value of a key in TLS. More...

static void	tlsSet (ulong_t key, void *value)
	Set the value of a key in TLS. More...

Static Public Member Functions inherited from utl::Object
static Object *	serializeInNullable (Stream &is, uint_t mode=ser_default)
	Serialize a nullptr-able object from an input stream. More...

static void	serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default)
	Serialize a nullptr-able object to an output stream. More...

static void	serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a nullptr-able object to or from a stream. More...

static Object *	serializeInBoxed (Stream &is, uint_t mode=ser_default)
	Serialize a boxed object from an input stream. More...

static void	serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a boxed object to or from a stream. More...

Detailed Description

Abstract base for multi-threaded network server.

Author: Adam McKee

Definition at line 39 of file NetServer_linux.h.

Constructor & Destructor Documentation

◆ NetServer()

utl::NetServer::NetServer	(	size_t	maxClients,
		size_t	maxPaused = `1`,
		size_t	clientsPerThread = `1`
	)

inline

Constructor.

Parameters

maxClients	max. simultaneous clients
maxPaused	(optional : 1) maximum number of paused clients
clientsPerThread	(optional : 1) number of clients handled by each thread

Definition at line 51 of file NetServer_linux.h.

References utl::deInit(), utl::init(), and utl::size_t_max.

Member Function Documentation

◆ run()

virtual void* utl::NetServer::run ( void * arg = nullptr )

virtual

Run the thread.

run() is essentially the thread's main(); it does whatever the thread was created to do. You will need to override this virtual method in your derived class.

Parameters

arg	user-defined thread parameter

Returns: the thread's return value

Implements utl::Thread.

◆ addServer()

bool utl::NetServer::addServer ( ServerSocket * serverSocket )

Add a server socket.

Parameters

serverSocket server socket

◆ listen()

void utl::NetServer::listen ( )

Listen for events.

◆ handlePipeEvent()

void utl::NetServer::handlePipeEvent ( )

Process an event on the read end of the pipe.

◆ handleServerSocketEvent()

void utl::NetServer::handleServerSocketEvent ( int fd )

Process an event on a server socket.

◆ clientDisconnectAll()

void utl::NetServer::clientDisconnectAll ( )

Disconnect all clients.

◆ clientDisconnect()

void utl::NetServer::clientDisconnect ( NetServerClient * client )

Disconnect the given client.

Parameters

client client to be disconnected

◆ clientMake()

virtual NetServerClient* utl::NetServer::clientMake	(	FDstream *	socket,
		const InetHostAddress &	addr
	)

protectedvirtual

Make a new client object.

Parameters

socket	client socket
addr	client address

◆ clientFind()

NetServerClient* utl::NetServer::clientFind ( int fd ) const

protected

Find a client by its file descriptor.

◆ onClientConnect()

virtual void utl::NetServer::onClientConnect ( NetServerClient * client )

protectedpure virtual

Notify of a new client connection.

Parameters

client newly connected client

Implemented in utl::FastCGIserver.

◆ onClientDisconnect()

virtual void utl::NetServer::onClientDisconnect ( NetServerClient * client )

protectedpure virtual

Disconnect a client.

Parameters

client client to disconnect

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

NetServer_linux.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NetServer()

Member Function Documentation

◆ run()

◆ addServer()

◆ listen()

◆ handlePipeEvent()

◆ handleServerSocketEvent()

◆ clientDisconnectAll()

◆ clientDisconnect()

◆ clientMake()

◆ clientFind()

◆ onClientConnect()

◆ onClientDisconnect()