#include <yarp/manager/yarpbroker.h>

Inheritance diagram for yarp::manager::YarpBroker:

Public Member Functions
	YarpBroker ()

	~YarpBroker () override

bool	init () override

bool	init (const char szcmd, const char szparam, const char szhost, const char szstdio, const char szworkdir, const char szenv) override

void	fini () override

bool	start () override

bool	stop () override

bool	kill () override

bool	connect (const char from, const char to, const char *carrier, bool persist=false) override
	connection broker More...

bool	disconnect (const char from, const char to, const char *carrier) override

bool	rmconnect (const char from, const char to)

int	running () override

bool	exists (const char *port) override

const char *	requestRpc (const char szport, const char request, double timeout) override

bool	connected (const char from, const char to, const char *carrier) override

const char *	error () override

bool	initialized () override

bool	attachStdout () override

void	detachStdout () override

bool	getSystemInfo (const char *server, yarp::os::SystemInfoSerializer &info)

bool	getAllProcesses (const char *server, ProcessContainer &processes)

bool	getAllPorts (std::vector< std::string > &stingList)

bool	setQos (const char from, const char to, const char qosFrom, const char qosTo)

void	run () override
	Loop function. More...

bool	threadInit () override
	Initialization method. More...

void	threadRelease () override
	Release method. More...

Public Member Functions inherited from yarp::manager::Broker
	Broker ()

virtual	~Broker ()

void	setEventSink (BrokerEventSink *pEventSink)

unsigned int	generateID ()

void	enableWatchDog ()

void	disableWatchDog ()

bool	hasWatchDog ()

void	setDisplay (const char *szDisplay)

const char *	getDisplay () const

Public Member Functions inherited from yarp::os::PeriodicThread
	PeriodicThread (double period, ShouldUseSystemClock useSystemClock=ShouldUseSystemClock::No)
	Constructor. More...

virtual	~PeriodicThread ()

bool	start ()
	Call this to start the thread. More...

void	step ()
	Call this to "step" the thread rather than starting it. More...

void	stop ()
	Call this to stop the thread, this call blocks until the thread is terminated (and releaseThread() called). More...

void	askToStop ()
	Stop the thread. More...

bool	isRunning () const
	Returns true when the thread is started, false otherwise. More...

bool	isSuspended () const
	Returns true when the thread is suspended, false otherwise. More...

bool	setPeriod (double period)
	Set the (new) period of the thread. More...

double	getPeriod () const
	Return the current period of the thread. More...

void	suspend ()
	Suspend the thread, the thread keeps running by doLoop is never executed. More...

void	resume ()
	Resume the thread if previously suspended. More...

void	resetStat ()
	Reset thread statistics. More...

double	getEstimatedPeriod () const
	Return estimated period since last reset. More...

void	getEstimatedPeriod (double &av, double &std) const
	Return estimated period since last reset. More...

unsigned int	getIterations () const
	Return the number of iterations performed since last reset. More...

double	getEstimatedUsed () const
	Return the estimated duration of the run() function since last reset. More...

void	getEstimatedUsed (double &av, double &std) const
	Return estimated duration of the run() function since last reset. More...

int	setPriority (int priority, int policy=-1)
	Set the priority and scheduling policy of the thread, if the OS supports that. More...

int	getPriority () const
	Query the current priority of the thread, if the OS supports that. More...

int	getPolicy () const
	Query the current scheduling policy of the thread, if the OS supports that. More...

Additional Inherited Members
Protected Member Functions inherited from yarp::os::PeriodicThread
virtual void	beforeStart ()
	Called just before a new thread starts. More...

virtual void	afterStart (bool success)
	Called just after a new thread starts (or fails to start), this is executed by the same thread that calls start(). More...

Protected Attributes inherited from yarp::manager::Broker
unsigned int	UNIQUEID

BrokerEventSink *	eventSink

bool	bWithWatchDog

std::string	strDisplay

Detailed Description

Class Broker.

Definition at line 37 of file yarpbroker.h.

Constructor & Destructor Documentation

◆ YarpBroker()

YarpBroker::YarpBroker ( )

Definition at line 44 of file yarpbroker.cpp.

◆ ~YarpBroker()

YarpBroker::~YarpBroker ( )

override

Definition at line 52 of file yarpbroker.cpp.

Member Function Documentation

◆ attachStdout()

bool YarpBroker::attachStdout ( )

overridevirtual

Implements yarp::manager::Broker.

Definition at line 352 of file yarpbroker.cpp.

◆ connect()

bool YarpBroker::connect	(	const char *	from,
		const char *	to,
		const char *	carrier,
		bool	persist = `false`
	)

overridevirtual

connection broker

Implements yarp::manager::Broker.

Definition at line 383 of file yarpbroker.cpp.

◆ connected()

bool YarpBroker::connected	(	const char *	from,
		const char *	to,
		const char *	carrier
	)

overridevirtual

Implements yarp::manager::Broker.

Definition at line 544 of file yarpbroker.cpp.

◆ detachStdout()

void YarpBroker::detachStdout ( )

overridevirtual

Implements yarp::manager::Broker.

Definition at line 357 of file yarpbroker.cpp.

◆ disconnect()

bool YarpBroker::disconnect	(	const char *	from,
		const char *	to,
		const char *	carrier
	)

overridevirtual

Implements yarp::manager::Broker.

Definition at line 445 of file yarpbroker.cpp.

◆ error()

const char * YarpBroker::error ( )

overridevirtual

Implements yarp::manager::Broker.

Definition at line 760 of file yarpbroker.cpp.

◆ exists()

bool YarpBroker::exists ( const char * port )

overridevirtual

Implements yarp::manager::Broker.

Definition at line 494 of file yarpbroker.cpp.

◆ fini()

void YarpBroker::fini ( )

overridevirtual

Implements yarp::manager::Broker.

Definition at line 57 of file yarpbroker.cpp.

◆ getAllPorts()

bool YarpBroker::getAllPorts ( std::vector< std::string > & stingList )

Definition at line 613 of file yarpbroker.cpp.

◆ getAllProcesses()

bool YarpBroker::getAllProcesses	(	const char *	server,
		ProcessContainer &	processes
	)

Definition at line 644 of file yarpbroker.cpp.

◆ getSystemInfo()

bool YarpBroker::getSystemInfo	(	const char *	server,
		yarp::os::SystemInfoSerializer &	info
	)

Definition at line 555 of file yarpbroker.cpp.

◆ init() [1/2]

bool YarpBroker::init ( )

overridevirtual

Implements yarp::manager::Broker.

Reimplemented in yarp::manager::ScriptYarprunBroker, and yarp::manager::ScriptYarprunBroker.

Definition at line 64 of file yarpbroker.cpp.

◆ init() [2/2]

bool YarpBroker::init	(	const char *	szcmd,
		const char *	szparam,
		const char *	szhost,
		const char *	szstdio,
		const char *	szworkdir,
		const char *	szenv
	)

overridevirtual

Implements yarp::manager::Broker.

Reimplemented in yarp::manager::YarpdevYarprunBroker.

Definition at line 88 of file yarpbroker.cpp.

◆ initialized()

bool yarp::manager::YarpBroker::initialized ( )

inlineoverridevirtual

Implements yarp::manager::Broker.

Definition at line 59 of file yarpbroker.h.

◆ kill()

bool YarpBroker::kill ( )

overridevirtual

Implements yarp::manager::Broker.

Definition at line 269 of file yarpbroker.cpp.

◆ requestRpc()

const char * YarpBroker::requestRpc	(	const char *	szport,
		const char *	request,
		double	timeout
	)

overridevirtual

Implements yarp::manager::Broker.

Definition at line 502 of file yarpbroker.cpp.

◆ rmconnect()

bool YarpBroker::rmconnect	(	const char *	from,
		const char *	to
	)

Definition at line 688 of file yarpbroker.cpp.

◆ run()

void YarpBroker::run ( )

overridevirtual

Loop function.

This is the thread itself. The thread calls the run() function every <period> ms. At the end of each run, the thread will sleep the amounth of time required, taking into account the time spent inside the loop function. Example: requested period is 10ms, the run() function take 3ms to be executed, the thread will sleep for 7ms.

Note: after each run is completed, the thread will call a yield() in order to facilitate other threads to run.

Implements yarp::os::PeriodicThread.

Definition at line 799 of file yarpbroker.cpp.

◆ running()

int YarpBroker::running ( )

overridevirtual

Implements yarp::manager::Broker.

Definition at line 318 of file yarpbroker.cpp.

◆ setQos()

bool YarpBroker::setQos	(	const char *	from,
		const char *	to,
		const char *	qosFrom,
		const char *	qosTo
	)

Definition at line 702 of file yarpbroker.cpp.

◆ start()

bool YarpBroker::start ( )

overridevirtual

Implements yarp::manager::Broker.

Definition at line 181 of file yarpbroker.cpp.

◆ stop()

bool YarpBroker::stop ( )

overridevirtual

Implements yarp::manager::Broker.

Definition at line 222 of file yarpbroker.cpp.

◆ threadInit()

bool YarpBroker::threadInit ( )

overridevirtual

Initialization method.

The thread executes this function when it starts and before "run". This is a good place to perform initialization tasks that need to be done by the thread itself (device drivers initialization, memory allocation etc). If the function returns false the thread quits and never calls "run". The return value of threadInit() is notified to the class and passed as a parameter to afterStart(). Note that afterStart() is called by the same thread that is executing the "start" method.

Reimplemented from yarp::os::PeriodicThread.

Definition at line 774 of file yarpbroker.cpp.

◆ threadRelease()

void YarpBroker::threadRelease ( )

overridevirtual

Release method.

The thread executes this function once when it exits, after the last "run". This is a good place to release resources that were initialized in threadInit() (release memory, and device driver resources).

Reimplemented from yarp::os::PeriodicThread.

Definition at line 810 of file yarpbroker.cpp.

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

src/libYARP_manager/src/yarp/manager/yarpbroker.h
src/libYARP_manager/src/yarp/manager/yarpbroker.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ YarpBroker()

◆ ~YarpBroker()

Member Function Documentation

◆ attachStdout()

◆ connect()

◆ connected()

◆ detachStdout()

◆ disconnect()

◆ error()

◆ exists()

◆ fini()

◆ getAllPorts()

◆ getAllProcesses()

◆ getSystemInfo()

◆ init() [1/2]

◆ init() [2/2]

◆ initialized()

◆ kill()

◆ requestRpc()

◆ rmconnect()

◆ run()

◆ running()

◆ setQos()

◆ start()

◆ stop()

◆ threadInit()

◆ threadRelease()