Socket addon for handling I/O events. More...

#include <dabc/SocketThread.h>

Inheritance diagram for dabc::SocketIOAddon:

Public Member Functions
void	CancelIOOperations ()
	Method should be used to cancel all running I/O operation of the socket. More...

void	SetSendAddr (const std::string &host="", int port=0)
	Set destination address for all send operations,. More...

	SocketIOAddon (int fd=0, bool isdatagram=false, bool usemsg=true)
	Constructor of SocketIOAddon class. More...

bool	StartNetRecv (void *hdr, unsigned hdrsize, Buffer &buf, BufferSize_t datasize)

bool	StartNetSend (void *hdr, unsigned hdrsize, const Buffer &buf)

bool	StartRecv (Buffer &buf, BufferSize_t datasize)

bool	StartRecv (void *buf, size_t size)

bool	StartRecvHdr (void hdr, unsigned hdrsize, void buf, size_t size)

bool	StartSend (const Buffer &buf)

bool	StartSend (const void buf, unsigned size, const void buf2=0, unsigned size2=0, const void *buf3=0, unsigned size3=0)

virtual	~SocketIOAddon ()
	Destructor of SocketIOAddon class. More...

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
void	AllocateRecvIOV (unsigned size)

void	AllocateSendIOV (unsigned size)

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

struct sockaddr_in &	GetRecvAddr ()
	Method provide address of last receive operation. More...

unsigned	GetRecvSize () const
	Method return size of last buffer read from socket. More...

bool	IsDatagramSocket () const

bool	IsDoingRecv () const

bool	IsDoingSend () const

virtual void	OnRecvCompleted ()
	Method called when receive operation is completed. More...

virtual void	OnSendCompleted ()
	Method called when send operation is completed. More...

virtual void	ProcessEvent (const EventId &)

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	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...

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
bool	fDatagramSocket
	indicate if socket is datagram and all operations should be finished with single call More...

unsigned	fLastRecvSize
	size of last recv operation More...

struct sockaddr_in	fRecvAddr
	source address of last receive operation More...

struct iovec *	fRecvIOV
	receive io vector for scatter list More...

unsigned	fRecvIOVFirst
	number of element in recv IOV where transfer is started More...

unsigned	fRecvIOVNumber
	number of elements in current recv operation More...

unsigned	fRecvIOVSize
	number of elements in recv vector More...

bool	fRecvUseMsg
	use recvmsg for transport More...

struct sockaddr_in	fSendAddr
	optional send address for next send operation More...

struct iovec *	fSendIOV
	sending io vector for gather list More...

unsigned	fSendIOVFirst
	number of element in send IOV where transfer is started More...

unsigned	fSendIOVNumber
	number of elements in current send operation More...

unsigned	fSendIOVSize
	total number of elements in send vector More...

bool	fSendUseAddr
	if true, fSendAddr will be used More...

bool	fSendUseMsg
	use sendmsg for transport More...

bool	fUseMsgOper
	indicate if sendmsg, recvmsg operations should be used, it is must for the datagram sockets More...

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 I/O events.

Definition at line 144 of file SocketThread.h.

Constructor & Destructor Documentation

◆ SocketIOAddon()

dabc::SocketIOAddon::SocketIOAddon	(	int	fd = `0`,
		bool	isdatagram = `false`,
		bool	usemsg = `true`
	)

Constructor of SocketIOAddon class.

Definition at line 251 of file SocketThread.cxx.

◆ ~SocketIOAddon()

dabc::SocketIOAddon::~SocketIOAddon ( )

virtual

Destructor of SocketIOAddon class.

Definition at line 285 of file SocketThread.cxx.

Member Function Documentation

◆ ClassName()

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

inlineprotectedvirtual

Returns class name of the object instance.

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

Reimplemented from dabc::SocketAddon.

Definition at line 176 of file SocketThread.h.

◆ IsDatagramSocket()

bool dabc::SocketIOAddon::IsDatagramSocket ( ) const

inlineprotected

Definition at line 178 of file SocketThread.h.

◆ ProcessEvent()

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

protectedvirtual

Reimplemented from dabc::SocketAddon.

Reimplemented in mbs::ClientTransport.

Definition at line 539 of file SocketThread.cxx.

◆ AllocateSendIOV()

void dabc::SocketIOAddon::AllocateSendIOV ( unsigned size )

protected

Definition at line 333 of file SocketThread.cxx.

◆ AllocateRecvIOV()

void dabc::SocketIOAddon::AllocateRecvIOV ( unsigned size )

protected

Definition at line 348 of file SocketThread.cxx.

◆ IsDoingSend()

bool dabc::SocketIOAddon::IsDoingSend ( ) const

inlineprotected

Definition at line 185 of file SocketThread.h.

◆ IsDoingRecv()

bool dabc::SocketIOAddon::IsDoingRecv ( ) const

inlineprotected

Definition at line 186 of file SocketThread.h.

◆ OnSendCompleted()

virtual void dabc::SocketIOAddon::OnSendCompleted ( )

inlineprotectedvirtual

Method called when send operation is completed.

Reimplemented in mbs::ServerOutputAddon, mbs::ClientTransport, aqua::ClientOutput, dabc::SocketProtocolAddon, and dabc::SocketNetworkInetrface.

Definition at line 189 of file SocketThread.h.

◆ OnRecvCompleted()

virtual void dabc::SocketIOAddon::OnRecvCompleted ( )

inlineprotectedvirtual

Method called when receive operation is completed.

Reimplemented in mbs::ServerOutputAddon, mbs::DaqStatusAddon, mbs::ClientTransport, aqua::ClientOutput, dabc::SocketProtocolAddon, and dabc::SocketNetworkInetrface.

Definition at line 195 of file SocketThread.h.

◆ GetRecvAddr()

struct sockaddr_in& dabc::SocketIOAddon::GetRecvAddr ( )

inlineprotected

Method provide address of last receive operation.

Definition at line 201 of file SocketThread.h.

◆ GetRecvSize()

unsigned dabc::SocketIOAddon::GetRecvSize ( ) const

inlineprotected

Method return size of last buffer read from socket.

Useful only for datagram sockets, which can reads complete packet at once

Definition at line 205 of file SocketThread.h.

◆ SetSendAddr()

void dabc::SocketIOAddon::SetSendAddr	(	const std::string &	host = `""`,
		int	port = `0`
	)

Set destination address for all send operations,.

Can be only specified for datagram sockets

Definition at line 301 of file SocketThread.cxx.

◆ StartSend() [1/2]

bool dabc::SocketIOAddon::StartSend	(	const void *	buf,
		unsigned	size,
		const void *	buf2 = `0`,
		unsigned	size2 = `0`,
		const void *	buf3 = `0`,
		unsigned	size3 = `0`
	)

Definition at line 363 of file SocketThread.cxx.

◆ StartRecv() [1/2]

bool dabc::SocketIOAddon::StartRecv	(	void *	buf,
		size_t	size
	)

Definition at line 409 of file SocketThread.cxx.

◆ StartRecvHdr()

bool dabc::SocketIOAddon::StartRecvHdr	(	void *	hdr,
		unsigned	hdrsize,
		void *	buf,
		size_t	size
	)

Definition at line 422 of file SocketThread.cxx.

◆ StartSend() [2/2]

bool dabc::SocketIOAddon::StartSend ( const Buffer & buf )

Definition at line 414 of file SocketThread.cxx.

◆ StartRecv() [2/2]

bool dabc::SocketIOAddon::StartRecv	(	Buffer &	buf,
		BufferSize_t	datasize
	)

Definition at line 454 of file SocketThread.cxx.

◆ StartNetRecv()

bool dabc::SocketIOAddon::StartNetRecv	(	void *	hdr,
		unsigned	hdrsize,
		Buffer &	buf,
		BufferSize_t	datasize
	)

Definition at line 459 of file SocketThread.cxx.

◆ StartNetSend()

bool dabc::SocketIOAddon::StartNetSend	(	void *	hdr,
		unsigned	hdrsize,
		const Buffer &	buf
	)

Definition at line 503 of file SocketThread.cxx.

◆ CancelIOOperations()

void dabc::SocketIOAddon::CancelIOOperations ( )

Method should be used to cancel all running I/O operation of the socket.

Should be used for instance when worker want to be deleted

Definition at line 759 of file SocketThread.cxx.

Field Documentation

◆ fDatagramSocket

bool dabc::SocketIOAddon::fDatagramSocket

protected

indicate if socket is datagram and all operations should be finished with single call

Definition at line 146 of file SocketThread.h.

◆ fUseMsgOper

bool dabc::SocketIOAddon::fUseMsgOper

protected

indicate if sendmsg, recvmsg operations should be used, it is must for the datagram sockets

Definition at line 147 of file SocketThread.h.

◆ fSendUseMsg

bool dabc::SocketIOAddon::fSendUseMsg

protected

use sendmsg for transport

Definition at line 150 of file SocketThread.h.

◆ fSendIOV

struct iovec* dabc::SocketIOAddon::fSendIOV

protected

sending io vector for gather list

Definition at line 151 of file SocketThread.h.

◆ fSendIOVSize

unsigned dabc::SocketIOAddon::fSendIOVSize

protected

total number of elements in send vector

Definition at line 152 of file SocketThread.h.

◆ fSendIOVFirst

unsigned dabc::SocketIOAddon::fSendIOVFirst

protected

number of element in send IOV where transfer is started

Definition at line 153 of file SocketThread.h.

◆ fSendIOVNumber

unsigned dabc::SocketIOAddon::fSendIOVNumber

protected

number of elements in current send operation

Definition at line 154 of file SocketThread.h.

◆ fSendAddr

struct sockaddr_in dabc::SocketIOAddon::fSendAddr

protected

optional send address for next send operation

Definition at line 154 of file SocketThread.h.

◆ fSendUseAddr

bool dabc::SocketIOAddon::fSendUseAddr

protected

if true, fSendAddr will be used

Definition at line 156 of file SocketThread.h.

◆ fRecvUseMsg

bool dabc::SocketIOAddon::fRecvUseMsg

protected

use recvmsg for transport

Definition at line 159 of file SocketThread.h.

◆ fRecvIOV

struct iovec* dabc::SocketIOAddon::fRecvIOV

protected

receive io vector for scatter list

Definition at line 160 of file SocketThread.h.

◆ fRecvIOVSize

unsigned dabc::SocketIOAddon::fRecvIOVSize

protected

number of elements in recv vector

Definition at line 161 of file SocketThread.h.

◆ fRecvIOVFirst

unsigned dabc::SocketIOAddon::fRecvIOVFirst

protected

number of element in recv IOV where transfer is started

Definition at line 162 of file SocketThread.h.

◆ fRecvIOVNumber

unsigned dabc::SocketIOAddon::fRecvIOVNumber

protected

number of elements in current recv operation

Definition at line 163 of file SocketThread.h.

◆ fRecvAddr

struct sockaddr_in dabc::SocketIOAddon::fRecvAddr

protected

source address of last receive operation

Definition at line 163 of file SocketThread.h.

◆ fLastRecvSize

unsigned dabc::SocketIOAddon::fLastRecvSize

protected

size of last recv operation

Definition at line 165 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

◆ SocketIOAddon()

◆ ~SocketIOAddon()

Member Function Documentation

◆ ClassName()

◆ IsDatagramSocket()

◆ ProcessEvent()

◆ AllocateSendIOV()

◆ AllocateRecvIOV()

◆ IsDoingSend()

◆ IsDoingRecv()

◆ OnSendCompleted()

◆ OnRecvCompleted()

◆ GetRecvAddr()

◆ GetRecvSize()

◆ SetSendAddr()

◆ StartSend() [1/2]

◆ StartRecv() [1/2]

◆ StartRecvHdr()

◆ StartSend() [2/2]

◆ StartRecv() [2/2]

◆ StartNetRecv()

◆ StartNetSend()

◆ CancelIOOperations()

Field Documentation

◆ fDatagramSocket

◆ fUseMsgOper

◆ fSendUseMsg

◆ fSendIOV

◆ fSendIOVSize

◆ fSendIOVFirst

◆ fSendIOVNumber

◆ fSendAddr

◆ fSendUseAddr

◆ fRecvUseMsg

◆ fRecvIOV

◆ fRecvIOVSize

◆ fRecvIOVFirst

◆ fRecvIOVNumber

◆ fRecvAddr

◆ fLastRecvSize