Socket addon for handling connection requests on server side. More...

#include <dabc/SocketThread.h>

Inheritance diagram for dabc::SocketServerAddon:

Public Member Functions
virtual const char *	ClassName () const
	Returns class name of the object instance. More...

virtual void	ProcessEvent (const EventId &)

std::string	ServerHostName ()

std::string	ServerId ()

int	ServerPortNumber () const

	SocketServerAddon (int serversocket, const char hostname=nullptr, int portnum=-1, struct addrinfo info=nullptr)

virtual	~SocketServerAddon ()

Public Member Functions inherited from dabc::SocketConnectAddon
virtual void	ObjectCleanup ()
	User method to cleanup object content before it will be destroyed Main motivation is to release any references on other objects to avoid any cross-references and as result deadlocks in objects cleanup. More...

void	SetConnHandler (const WorkerRef &rcv, const std::string &connid)
	Set connection handler. More...

	SocketConnectAddon (int fd)

virtual	~SocketConnectAddon ()

Public Member Functions inherited from dabc::SocketAddon
void	CloseSocket ()

bool	IsDeliverEventsToWorker () const

bool	IsDoingInput () const

bool	IsDoingOutput () const

bool	IsSocket () const

virtual std::string	RequiredThrdClass () const

void	SetDeliverEventsToWorker (bool on=true)

void	SetIOPriority (int prior=1)
	Method defines priority level for socket IO events. More...

void	SetSocket (int fd)

int	Socket () const

	SocketAddon (int fd=-1)

int	TakeSocket ()

int	TakeSocketError ()

virtual	~SocketAddon ()

Public Member Functions inherited from dabc::WorkerAddon
	WorkerAddon (const std::string &name)

virtual	~WorkerAddon ()

Public Member Functions inherited from dabc::Object
bool	AddChild (Object *child, bool withmutex=true) throw ()
	Add object to list of child objects, thread safe More...

bool	AddChildAt (Object *child, unsigned pos, bool withmutex=true)
	Add object to list of child objects at specified position. More...

virtual void	BuildFieldsMap (RecordFieldsMap *cont)
	Fill fields map, which is relevant for the object Objects hierarchy produced from dabc::Manager. More...

virtual bool	Find (ConfigIO &cfg)
	Method to locate object in xml file. More...

Object *	FindChild (const char *name) const
	returns pointer on child object with given name More...

Reference	FindChildRef (const char *name, bool force=false) const throw ()
	returns reference on child object with given name More...

bool	GetAllChildRef (ReferencesVector *vect) const

Object *	GetChild (unsigned n) const
	returns pointer on child object More...

Reference	GetChildRef (unsigned n) const
	returns reference on child object More...

Reference	GetFolder (const std::string &name, bool force=false) throw ()
	Return folder of specified name, no special symbols allowed. More...

const char *	GetName () const
	Returns name of the object, thread safe More...

Object *	GetParent () const
	Returns pointer on parent object, thread safe More...

Reference	GetParentRef () const

bool	IsChildsHidden () const
	Return true if object wants to hide childs from hierarchy scan, thread safe More...

bool	IsHidden () const
	Return true if object wants to be hidden from hierarchy scan, thread safe More...

bool	IsLogging () const
	Return true if object selected for logging, thread safe More...

bool	IsName (const char *str) const
	Checks if object name is same as provided string, thread safe More...

bool	IsName (const char *str, int len) const
	Checks if object name is same as provided, thread safe More...

bool	IsName (const std::string &str) const
	Checks if object name is same as provided string, thread safe More...

bool	IsNameMatch (const std::string &mask) const
	Check if object name match to the mask. More...

bool	IsOwner () const
	Returns true if object is owner of its children, thread safe More...

bool	IsParent (Object *obj) const
	Checks if specified argument is in the list of object parents. More...

bool	IsTopXmlLevel () const
	Return true if object should be searched in the top level of the xml file, thread safe More...

std::string	ItemName (bool compact=true) const
	Produce string, which can be used as name argument in dabc::mgr.FindItem(name) call. More...

unsigned	NumChilds () const
	returns number of child objects More...

	Object (const std::string &name, unsigned flags=flIsOwner)
	Resolve problem with child-parent mutex locking. More...

	Object (Reference parent, const std::string &name, unsigned flags=flIsOwner)

virtual void	Print (int lvl=0)
	Print object content on debug output. More...

bool	RemoveChild (Object *child, bool cleanup=true) throw ()
	Detach child from parent object If cleanup==true and parent is owner of child, child will be destroyed. More...

bool	RemoveChildAt (unsigned n, bool cleanup=true) throw ()
	Detach child object from parent at specified position If cleanup==true and object is owner of child, child will be destroyed. More...

bool	RemoveChilds (bool cleanup=true)
	Remove all childs. More...

void	SetLogging (bool on=true)
	Sets logging flag, thread safe More...

virtual	~Object ()

Protected Member Functions
virtual void	OnClientConnected (int fd)

bool	RecreateSocket ()

Protected Member Functions inherited from dabc::SocketAddon
ssize_t	DoRecvBuffer (void *buf, ssize_t len)

ssize_t	DoRecvBufferHdr (void hdr, ssize_t hdrlen, void buf, ssize_t len, void *srcaddr=0, unsigned srcaddrlen=0)

ssize_t	DoSendBuffer (void *buf, ssize_t len)

ssize_t	DoSendBufferHdr (void hdr, ssize_t hdrlen, void buf, ssize_t len, void *tgtaddr=0, unsigned tgtaddrlen=0)

bool	IsDeleteWorkerOnClose () const

virtual void	OnSocketError (int msg, const std::string &info)
	Generic error handler. More...

void	SetDeleteWorkerOnClose (bool on=true)

void	SetDoingInput (bool on=true)
	Call method to indicate that object wants to read data from the socket. More...

void	SetDoingOutput (bool on=true)
	Call method to indicate that worker wants to write data to the socket. More...

Protected Member Functions inherited from dabc::WorkerAddon
bool	ActivateTimeout (double tmout_sec)

void	DeleteAddonItself ()
	This is possibility to delete addon itself, invoking worker command. More...

void	DeleteWorker ()
	This is way to delete worker with addon inclusive. More...

void	FireWorkerEvent (unsigned evid)

virtual long	Notify (const std::string &, int)
	Light-weight command interface, which can be used from worker. More...

virtual void	OnThreadAssigned ()

virtual double	ProcessTimeout (double last_diff)

void	SubmitWorkerCmd (Command cmd)

Protected Member Functions inherited from dabc::Object
virtual void	_ChildsChanged ()
	Method called when new childs are add or old are removed. More...

virtual bool	_DoDeleteItself ()
	This method is called at the moment when DecReference think that object can be destroyed and wants to return true. More...

bool	_IsNormalState ()
	Same as IsNormalState() but without mutex lock - user should lock mutex himself. More...

virtual Object *	CreateInstance (const std::string &name)
	Method used to create new item to be placed as child of the object. More...

void	DeleteThis ()
	Method should be used by the object to delete itself. More...

virtual bool	DestroyByOwnThread ()
	Internal DABC method, used to activate object cleanup via object thread Returns: false - object cannot be cleanup by the thread, true - thread guarantees that DestroyCalledFromOwnThread() will be called from thread context. More...

bool	DestroyCalledFromOwnThread ()
	Internal DABC method, should be called by thread which was requested to destroy object. More...

void	FillFullName (std::string &fullname, Object *upto, bool exclude_top_parent=false) const
	Method used to produce full item name,. More...

bool	GetFlag (unsigned fl) const
	Return value of selected flag, not thread safe More...

bool	IsNormalState ()
	Return true if object is in normal state. More...

unsigned	NumReferences ()
	Return number of references on the object. More...

	Object (const ConstructorPair &pair, unsigned flags=flIsOwner)

virtual void	ObjectDestroyed (Object *)
	Method called by the manager when registered dependent object is destroyed Should be used in user class to clear all references on the object to let destroy it. More...

Mutex *	ObjectMutex () const
	Returns mutex, used for protection of Object data members. More...

void	SetAutoDestroy (bool on=true)
	Set autodestroy flag for the object Once enabled, object will be destroyed when last reference will be cleared. More...

void	SetFlag (unsigned fl, bool on=true)
	Change value of selected flag, not thread safe More...

void	SetName (const char *name)
	Changes object name. More...

void	SetNameDirect (const char *name)
	Changes object name disregard of existing references. More...

void	SetOwner (bool on=true)
	Specifies if object will be owner of its new childs. More...

Protected Attributes
struct sockaddr_storage	ai_addr

socklen_t	ai_addrlen {0}

int	ai_family {0}

int	ai_protocol {0}

int	ai_socktype {0}

int	fAcceptErrors {0}

std::string	fServerHostName

int	fServerPortNumber {0}

Protected Attributes inherited from dabc::SocketConnectAddon
std::string	fConnId

WorkerRef	fConnRcv

Protected Attributes inherited from dabc::SocketAddon
bool	fDeleteWorkerOnClose
	if true, worker will be deleted when socket closed or socket in error More...

bool	fDeliverEventsToWorker
	if true, completion events will be delivered to the worker More...

bool	fDoingInput
	true if input data are expected More...

bool	fDoingOutput
	true if data need to be send More...

int	fIOPriority
	priority of socket I/O events, default 1 More...

int	fSocket
	socket handle More...

Protected Attributes inherited from dabc::WorkerAddon
Reference	fWorker

Protected Attributes inherited from dabc::Object
int	fObjectBlock
	counter for blocking calls, as long as non-zero, non of child can be removed More...

ReferencesVector *	fObjectChilds
	list of the child objects More...

unsigned	fObjectFlags
	flag, protected by the mutex More...

Mutex *	fObjectMutex
	mutex protects all private property of the object More...

std::string	fObjectName
	object name More...

Reference	fObjectParent
	reference on the parent object More...

int	fObjectRefCnt
	accounts how many references existing on the object, thread safe More...

Additional Inherited Members
Public Types inherited from dabc::SocketAddon
enum	ESocketEvents { evntSocketRead = Worker::evntFirstAddOn , evntSocketWrite , evntSocketError , evntSocketStartConnect , evntSocketLast , evntSocketRecvInfo = Worker::evntFirstSystem , evntSocketSendInfo , evntSocketErrorInfo , evntSocketCloseInfo , evntSocketLastInfo }

Static Public Member Functions inherited from dabc::Object
static void	Destroy (Object *obj) throw ()
	User method for object destroyment. More...

static void	InspectGarbageCollector ()
	\ brief Methods to inspect how many objects pointers are remained More...

static bool	NameMatch (const std::string &name, const std::string &mask)
	Check if name matches to specified mask. More...

static bool	NameMatchM (const std::string &name, const std::string &mask)
	Check if name matches to specified mask. More...

static unsigned	NumInstances ()
	Static variable counts total number of objects instances. More...

Protected Types inherited from dabc::Object
enum	EFlags { flStateMask = 0x000f , flIsOwner = 0x0010 , flCleanup = 0x0020 , flHasThread = 0x0040 , flAutoDestroy = 0x0080 , flLogging = 0x0100 , flNoMutex = 0x0200 , flHidden = 0x0400 , flChildsHidden = 0x0800 , flTopXmlLevel = 0x1000 }

Static Protected Member Functions inherited from dabc::Object
static ConstructorPair	MakePair (const std::string &fullname, bool withmanager=true)
	Internal DABC method, used to produce pair - object parent and object name, which is typically should be used as argument in class constructor. More...

static ConstructorPair	MakePair (Object *prnt, const std::string &fullname, bool withmanager=true)
	Internal DABC method, used to produce pair - object parent and object name, which is typically should be used as argument in class constructor. More...

static ConstructorPair	MakePair (Reference prnt, const std::string &fullname, bool withmanager=true)
	Internal DABC method, used to produce pair - object parent and object name, which is typically should be used as argument in class constructor. More...

Detailed Description

Socket addon for handling connection requests on server side.

this object establish server socket, which waits for new connection of course, we do not want to block complete thread for such task :-)

Definition at line 285 of file SocketThread.h.

Constructor & Destructor Documentation

◆ SocketServerAddon()

dabc::SocketServerAddon::SocketServerAddon	(	int	serversocket,
		const char *	hostname = `nullptr`,
		int	portnum = `-1`,
		struct addrinfo *	info = `nullptr`
	)

Definition at line 767 of file SocketThread.cxx.

◆ ~SocketServerAddon()

virtual dabc::SocketServerAddon::~SocketServerAddon ( )

inlinevirtual

Definition at line 302 of file SocketThread.h.

Member Function Documentation

◆ OnClientConnected()

void dabc::SocketServerAddon::OnClientConnected ( int fd )

protectedvirtual

Definition at line 836 of file SocketThread.cxx.

◆ RecreateSocket()

bool dabc::SocketServerAddon::RecreateSocket ( )

protected

Definition at line 854 of file SocketThread.cxx.

◆ ProcessEvent()

void dabc::SocketServerAddon::ProcessEvent ( const EventId & evnt )

virtual

Reimplemented from dabc::SocketAddon.

Definition at line 789 of file SocketThread.cxx.

◆ ServerHostName()

std::string dabc::SocketServerAddon::ServerHostName ( )

inline

Definition at line 306 of file SocketThread.h.

◆ ServerPortNumber()

int dabc::SocketServerAddon::ServerPortNumber ( ) const

inline

Definition at line 307 of file SocketThread.h.

◆ ServerId()

std::string dabc::SocketServerAddon::ServerId ( )

inline

Definition at line 308 of file SocketThread.h.

◆ ClassName()

virtual const char* dabc::SocketServerAddon::ClassName ( ) const

inlinevirtual

Returns class name of the object instance.

In some cases class name used to correctly locate object in xml file

Reimplemented from dabc::SocketConnectAddon.

Definition at line 310 of file SocketThread.h.

Field Documentation

◆ fServerHostName

std::string dabc::SocketServerAddon::fServerHostName

protected

Definition at line 287 of file SocketThread.h.

◆ fServerPortNumber

int dabc::SocketServerAddon::fServerPortNumber {0}

protected

Definition at line 288 of file SocketThread.h.

◆ fAcceptErrors

int dabc::SocketServerAddon::fAcceptErrors {0}

protected

Definition at line 289 of file SocketThread.h.

◆ ai_family

int dabc::SocketServerAddon::ai_family {0}

protected

Definition at line 290 of file SocketThread.h.

◆ ai_socktype

int dabc::SocketServerAddon::ai_socktype {0}

protected

Definition at line 291 of file SocketThread.h.

◆ ai_protocol

int dabc::SocketServerAddon::ai_protocol {0}

protected

Definition at line 292 of file SocketThread.h.

◆ ai_addrlen

socklen_t dabc::SocketServerAddon::ai_addrlen {0}

protected

Definition at line 293 of file SocketThread.h.

◆ ai_addr

struct sockaddr_storage dabc::SocketServerAddon::ai_addr

protected

Definition at line 293 of file SocketThread.h.

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

base/dabc/SocketThread.h
base/src/SocketThread.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SocketServerAddon()

◆ ~SocketServerAddon()

Member Function Documentation

◆ OnClientConnected()

◆ RecreateSocket()

◆ ProcessEvent()

◆ ServerHostName()

◆ ServerPortNumber()

◆ ServerId()

◆ ClassName()

Field Documentation

◆ fServerHostName

◆ fServerPortNumber

◆ fAcceptErrors

◆ ai_family

◆ ai_socktype

◆ ai_protocol

◆ ai_addrlen

◆ ai_addr