#include <dabc/Worker.h>

Inheritance diagram for dabc::WorkerAddon:

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

virtual std::string	RequiredThrdClass () const

	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
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 void	ProcessEvent (const EventId &)

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

Friends
class	Thread

class	Worker

class	WorkerAddonRef

Additional Inherited Members
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

Generic addon for dabc::Worker.

Definition at line 49 of file Worker.h.

Constructor & Destructor Documentation

◆ WorkerAddon()

dabc::WorkerAddon::WorkerAddon ( const std::string & name )

Definition at line 27 of file Worker.cxx.

◆ ~WorkerAddon()

dabc::WorkerAddon::~WorkerAddon ( )

virtual

Reimplemented in verbs::WorkerAddon.

Definition at line 34 of file Worker.cxx.

Member Function Documentation

◆ ObjectCleanup()

void dabc::WorkerAddon::ObjectCleanup ( )

protectedvirtual

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.

Method is called in context of thread, to which object belongs to. If user redefines this method, he is responsible to call method of parent class

Reimplemented from dabc::Object.

Reimplemented in mbs::ClientTransport, and dabc::SocketConnectAddon.

Definition at line 39 of file Worker.cxx.

◆ ProcessEvent()

virtual void dabc::WorkerAddon::ProcessEvent ( const EventId & )

inlineprotectedvirtual

Reimplemented in dabc::SocketClientAddon, dabc::SocketServerAddon, dabc::SocketIOAddon, dabc::SocketAddon, verbs::WorkerAddon, mbs::ClientTransport, and hadaq::NewAddon.

Definition at line 60 of file Worker.h.

◆ DeleteWorker()

void dabc::WorkerAddon::DeleteWorker ( )

protected

This is way to delete worker with addon inclusive.

Definition at line 44 of file Worker.cxx.

◆ DeleteAddonItself()

void dabc::WorkerAddon::DeleteAddonItself ( )

protected

This is possibility to delete addon itself, invoking worker command.

Definition at line 50 of file Worker.cxx.

◆ SubmitWorkerCmd()

void dabc::WorkerAddon::SubmitWorkerCmd ( Command cmd )

protected

Definition at line 73 of file Worker.cxx.

◆ FireWorkerEvent()

void dabc::WorkerAddon::FireWorkerEvent ( unsigned evid )

protected

Definition at line 56 of file Worker.cxx.

◆ OnThreadAssigned()

virtual void dabc::WorkerAddon::OnThreadAssigned ( )

inlineprotectedvirtual

Reimplemented in verbs::ProtocolAddon, mbs::ServerOutputAddon, mbs::DaqStatusAddon, mbs::ClientTransport, aqua::ClientOutput, dabc::SocketProtocolAddon, and dabc::SocketClientAddon.

Definition at line 73 of file Worker.h.

◆ ActivateTimeout()

bool dabc::WorkerAddon::ActivateTimeout ( double tmout_sec )

protected

Definition at line 62 of file Worker.cxx.

◆ ProcessTimeout()

virtual double dabc::WorkerAddon::ProcessTimeout ( double last_diff )

inlineprotectedvirtual

Reimplemented in dabc::SocketClientAddon, aqua::ClientOutput, verbs::ProtocolAddon, mbs::ServerOutputAddon, mbs::DaqStatusAddon, and mbs::ClientTransport.

Definition at line 79 of file Worker.h.

◆ Notify()

virtual long dabc::WorkerAddon::Notify	(	const std::string &	,
		int
	)

inlineprotectedvirtual

Light-weight command interface, which can be used from worker.

Reimplemented in verbs::VerbsNetworkInetrface, hadaq::NewAddon, and dabc::SocketNetworkInetrface.

Definition at line 82 of file Worker.h.

◆ ClassName()

virtual const char* dabc::WorkerAddon::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::Object.

Reimplemented in verbs::WorkerAddon, dabc::SocketClientAddon, dabc::SocketServerAddon, dabc::SocketConnectAddon, dabc::SocketIOAddon, and dabc::SocketAddon.

Definition at line 86 of file Worker.h.

◆ RequiredThrdClass()

virtual std::string dabc::WorkerAddon::RequiredThrdClass ( ) const

inlinevirtual

Reimplemented in verbs::WorkerAddon, and dabc::SocketAddon.

Definition at line 88 of file Worker.h.

Friends And Related Function Documentation

◆ Thread

friend class Thread

friend

Definition at line 51 of file Worker.h.

◆ Worker

friend class Worker

friend

Definition at line 52 of file Worker.h.

◆ WorkerAddonRef

friend class WorkerAddonRef

friend

Definition at line 53 of file Worker.h.

Field Documentation

◆ fWorker

Reference dabc::WorkerAddon::fWorker

protected

Definition at line 56 of file Worker.h.

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

base/dabc/Worker.h
plugins/verbs/src/Worker.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WorkerAddon()

◆ ~WorkerAddon()

Member Function Documentation

◆ ObjectCleanup()

◆ ProcessEvent()

◆ DeleteWorker()

◆ DeleteAddonItself()

◆ SubmitWorkerCmd()

◆ FireWorkerEvent()

◆ OnThreadAssigned()

◆ ActivateTimeout()

◆ ProcessTimeout()

◆ Notify()

◆ ClassName()

◆ RequiredThrdClass()

Friends And Related Function Documentation

◆ Thread

◆ Worker

◆ WorkerAddonRef

Field Documentation

◆ fWorker