Reference on the dabc::Port class More...

#include <dabc/Port.h>

Inheritance diagram for dabc::PortRef:

Private Member Functions
void	ConfigureOnError (const std::string &action="")
	Configure action in case of error. More...

void	ConfigureReconnect (double period=1., int numtry=-1)
	Configure reconnect parameters More...

bool	Disconnect (bool witherr=false)
	Disconnect port More...

PortRef	GetBindPort ()
	Return reference on the bind port. More...

int	GetSignalingKind ()
	Returns signaling method configured for the port. More...

bool	IsConnected ()
	Returns true if port is connected. More...

bool	IsInput () const
	Returns true if it is input port. More...

bool	IsOutput () const
	Returns true if it is output port. More...

ConnectionRequest	MakeConnReq (const std::string &url, bool isserver=false)
	Create connection request to specified url. More...

unsigned	QueueCapacity () const
	Returns queue capacity of the port. More...

Additional Inherited Members
Public Member Functions inherited from dabc::WorkerRef
bool	CanSubmitCommand () const
	Returns true if command can be submitted to the worker. More...

RecordField	Cfg (const std::string &name, Command cmd=nullptr) const
	Returns configuration record of specified name. More...

bool	Execute (Command cmd, double tmout=-1.)

bool	Execute (const std::string &cmd, double tmout=-1.)

bool	FireEvent (const EventId &ev)

bool	FireEvent (uint16_t evid, uint32_t arg)

bool	HasThread () const
	Returns true when thread is assigned to the worker. More...

bool	IsSameThread (const WorkerRef &ref)
	Returns true if two workers share same thread. More...

bool	MakeThreadForWorker (const std::string &thrdname="")

Parameter	Par (const std::string &name) const
	Returns reference on parameter. More...

bool	Submit (Command cmd)

bool	SyncWorker (double tmout=-1.)
	Synchronize worker with caller thread. More...

ThreadRef	thread ()

std::string	ThreadName () const
	Returns thread name of worker assigned. More...

Public Member Functions inherited from dabc::Reference
bool	AddChild (Object *obj)
	Add child to list of object children. More...

const char *	ClassName () const
	Return class name of referenced object, if object not assigned, returns "---". More...

void	Destroy () throw ()
	Release reference and starts destroyment of referenced object. More...

Reference	FindChild (const char *name) const
	Searches for child in referenced object. More...

bool	GetAllChildRef (ReferencesVector *vect) const
	Return references for all childs. More...

Reference	GetChild (unsigned n) const
	Return reference on child n. More...

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

const char *	GetName () const
	Return name of referenced object, if object not assigned, returns "---". More...

Object *	GetObject () const
	Return pointer on the object. More...

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

Reference	GetParentRef () const
	Returns reference on parent object. More...

bool	IsName (const char *name) const
	Returns true if object name is the same as specified one. More...

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

bool	null () const
	Returns true if reference contains nullptr. More...

unsigned	NumChilds () const
	Return number of childs in referenced object. More...

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

bool	operator! () const
	Returns true if reference contains nullptr. More...

bool	operator!= (const Reference &src) const
	Compare operator - return true if references refer to different object. More...

bool	operator!= (Object *obj) const
	Compare operator - return true if reference refer to different objects. More...

Object *	operator() () const
	Return pointer on the object. More...

Reference &	operator<< (Reference &src) throw ()
	Move operator - reference moved from source to target. More...

Reference &	operator= (const Reference &src) throw ()
	Assignment operator - copy reference. More...

Reference &	operator= (Object *obj) throw ()
	Assignment operator - copy reference. More...

bool	operator== (const Reference &src) const
	Compare operator - return true if references refer to same object. More...

bool	operator== (Object *obj) const
	Compare operator - return true if reference refer to same object. More...

void	Print (int lvl=0, const char *from=0) const
	Show on debug output content of reference. More...

	Reference (const Reference &src) throw ()
	Copy constructor, if source is transient than source reference will be emptied. More...

	Reference (Object *obj=nullptr)
	Constructor, creates reference on the object. More...

std::string	RelativeName (const dabc::Reference &topitem)
	Produce name, which can be used to find item, calling topitem.FindChild(). More...

void	Release () throw ()
	Releases reference on the object. More...

bool	RemoveChild (const char *name, bool cleanup=true)
	Remove child with given name and return reference on that child. More...

bool	RemoveChilds (bool cleanup=true)
	Remove all childs in referenced object If cleanup true (default) and object is owner, all objects will be destroyed. 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	SetObject (Object *obj, bool withmutex=true)
	Direct set of object to reference. More...

Reference	Take ()
	Copy reference to output object. More...

virtual	~Reference ()
	Destructor, releases reference on the object. More...

Protected Member Functions inherited from dabc::Reference
bool	AcquireRefWithoutMutex (Reference &ref)
	Special method, which allows to generate new reference when object mutex is locked. More...

void	Assign (const Reference &src)
	Method used in copy constructor and assigned operations. More...

Mutex *	ObjectMutex () const

template<class T >
bool	verify_object (Object src, T &tgt)
	Method used in reference constructor/assignments to verify is object is suitable. More...

Protected Attributes inherited from dabc::Reference
Object *	fObj
	pointer on the object More...

Detailed Description

Reference on the dabc::Port class

Provides interface to the port functionality from outside module.

Definition at line 195 of file Port.h.

Member Function Documentation

◆ IsInput()

bool dabc::PortRef::IsInput ( ) const

inlineprivate

Returns true if it is input port.

Definition at line 199 of file Port.h.

◆ IsOutput()

bool dabc::PortRef::IsOutput ( ) const

inlineprivate

Returns true if it is output port.

Definition at line 202 of file Port.h.

◆ QueueCapacity()

unsigned dabc::PortRef::QueueCapacity ( ) const

inlineprivate

Returns queue capacity of the port.

Definition at line 205 of file Port.h.

◆ GetSignalingKind()

int dabc::PortRef::GetSignalingKind ( )

private

Returns signaling method configured for the port.

Definition at line 223 of file Port.cxx.

◆ IsConnected()

bool dabc::PortRef::IsConnected ( )

private

Returns true if port is connected.

Definition at line 250 of file Port.cxx.

◆ Disconnect()

bool dabc::PortRef::Disconnect ( bool witherr = false )

private

Disconnect port

Definition at line 233 of file Port.cxx.

◆ GetBindPort()

dabc::PortRef dabc::PortRef::GetBindPort ( )

private

Return reference on the bind port.

Definition at line 242 of file Port.cxx.

◆ ConfigureOnError()

void dabc::PortRef::ConfigureOnError ( const std::string & action = "" )

inlineprivate

Configure action in case of error.

Definition at line 220 of file Port.h.

◆ ConfigureReconnect()

void dabc::PortRef::ConfigureReconnect	(	double	period = `1.`,
		int	numtry = `-1`
	)

inlineprivate

Configure reconnect parameters

Definition at line 224 of file Port.h.

◆ MakeConnReq()

dabc::ConnectionRequest dabc::PortRef::MakeConnReq	(	const std::string &	url,
		bool	isserver = `false`
	)

private

Create connection request to specified url.

If connection to other dabc port is specified, isserver flag should identify which side is server and which is client during connection establishing TODO: one should try in future avoid isserver flag completely, it can be ruled later by connection manager

Definition at line 259 of file Port.cxx.

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

base/dabc/Port.h
base/src/Port.cxx

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ IsInput()

◆ IsOutput()

◆ QueueCapacity()

◆ GetSignalingKind()

◆ IsConnected()

◆ Disconnect()

◆ GetBindPort()

◆ ConfigureOnError()

◆ ConfigureReconnect()

◆ MakeConnReq()