NET_ISocketGroup Class Reference

#include <NET_SocketGroup.h>

Public Member Functions
virtual	~NET_ISocketGroup ()
const UT_StringHolder &	name () const
	The id of the socket group. More...
virtual void	requestFullShutdown ()=0
	Request that the server shutdown immediatelly and all connections be closed regardless if the connection has things to process. More...
virtual void	requestGracefulShutdown ()=0
	Request the server shutdown slowly and allow all connections to be closed after they have processed whatever it is they need to. More...

Protected Types
using	creator_group_t = UT_SharedPtr< NET_ISocketGroup >(*)(const UT_StringHolder &)

Protected Member Functions
	NET_ISocketGroup (const UT_StringHolder &name)
virtual void	handleExit (const UT_SharedPtr< NET_ISocketGroup > &me)

Static Protected Member Functions
static UT_SharedPtr < NET_ISocketGroup >	newSocketGroup (const UT_StringHolder &name, creator_group_t creator)
static UT_SharedPtr < NET_ISocketGroup >	findSocketGroup (const UT_StringRef &name)
static void	shutdownAll ()

Friends
class	net_SocketGroupRegistry
class	NET_SubSystem

Detailed Description

Interface for grouping sockets together. Typical use case is for web servers where theres a group of server listener sockets.

Definition at line 25 of file NET_SocketGroup.h.

Member Typedef Documentation

using NET_ISocketGroup::creator_group_t = UT_SharedPtr<NET_ISocketGroup> (*)(const UT_StringHolder&)

protected

Definition at line 44 of file NET_SocketGroup.h.

Constructor & Destructor Documentation

virtual NET_ISocketGroup::~NET_ISocketGroup ( )

virtual

NET_ISocketGroup::NET_ISocketGroup ( const UT_StringHolder &  name )

protected

Member Function Documentation

static UT_SharedPtr<NET_ISocketGroup> NET_ISocketGroup::findSocketGroup ( const UT_StringRef &  name )

staticprotected

virtual void NET_ISocketGroup::handleExit ( const UT_SharedPtr< NET_ISocketGroup > &  me )

inlineprotectedvirtual

Definition at line 55 of file NET_SocketGroup.h.

const UT_StringHolder& NET_ISocketGroup::name ( ) const

inline

The id of the socket group.

Definition at line 33 of file NET_SocketGroup.h.

static UT_SharedPtr<NET_ISocketGroup> NET_ISocketGroup::newSocketGroup ( const UT_StringHolder &  name, creator_group_t  creator  )

staticprotected

virtual void NET_ISocketGroup::requestFullShutdown ( )

pure virtual

Request that the server shutdown immediatelly and all connections be closed regardless if the connection has things to process.

virtual void NET_ISocketGroup::requestGracefulShutdown ( )

pure virtual

Request the server shutdown slowly and allow all connections to be closed after they have processed whatever it is they need to.

static void NET_ISocketGroup::shutdownAll ( )

staticprotected

Friends And Related Function Documentation

friend class net_SocketGroupRegistry

friend

Definition at line 58 of file NET_SocketGroup.h.

friend class NET_SubSystem

friend

Definition at line 59 of file NET_SocketGroup.h.

---

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

• NET/NET_SocketGroup.h