YARP
Yet Another Robot Platform
Public Member Functions | Protected Attributes | List of all members
yarp::manager::Broker Class Referenceabstract

Class Broker. More...

#include <yarp/manager/broker.h>

+ Inheritance diagram for yarp::manager::Broker:

Public Member Functions

 Broker ()
 
virtual ~Broker ()
 
void setEventSink (BrokerEventSink *pEventSink)
 
virtual bool init ()=0
 
virtual bool init (const char *szcmd, const char *szparam, const char *szhost, const char *szstdio, const char *szworkdir, const char *szenv)=0
 
virtual void fini ()=0
 
virtual bool start ()=0
 
virtual bool stop ()=0
 
virtual bool kill ()=0
 
virtual bool connect (const char *from, const char *to, const char *carrier, bool persist=false)=0
 
virtual bool disconnect (const char *from, const char *to, const char *carrier)=0
 
virtual int running ()=0
 
virtual bool exists (const char *port)=0
 
virtual const char * requestRpc (const char *szport, const char *request, double timeout=0.0)=0
 
virtual bool connected (const char *from, const char *to, const char *carrier)=0
 
virtual const char * error ()=0
 
virtual bool initialized ()=0
 
virtual bool attachStdout ()=0
 
virtual void detachStdout ()=0
 
unsigned int generateID ()
 
void enableWatchDog ()
 
void disableWatchDog ()
 
bool hasWatchDog ()
 
void setDisplay (const char *szDisplay)
 
const char * getDisplay () const
 

Protected Attributes

unsigned int UNIQUEID
 
BrokerEventSink * eventSink
 
bool bWithWatchDog
 
std::string strDisplay
 

Detailed Description

Class Broker.

Definition at line 34 of file broker.h.

Constructor & Destructor Documentation

◆ Broker()

Broker::Broker ( )

Definition at line 15 of file broker.cpp.

◆ ~Broker()

Broker::~Broker ( )
virtualdefault

Member Function Documentation

◆ attachStdout()

virtual bool yarp::manager::Broker::attachStdout ( )
pure virtual

Implemented in yarp::manager::YarpBroker, and yarp::manager::LocalBroker.

◆ connect()

virtual bool yarp::manager::Broker::connect ( const char *  from,
const char *  to,
const char *  carrier,
bool  persist = false 
)
pure virtual

Implemented in yarp::manager::YarpBroker, and yarp::manager::LocalBroker.

◆ connected()

virtual bool yarp::manager::Broker::connected ( const char *  from,
const char *  to,
const char *  carrier 
)
pure virtual

Implemented in yarp::manager::YarpBroker, and yarp::manager::LocalBroker.

◆ detachStdout()

virtual void yarp::manager::Broker::detachStdout ( )
pure virtual

Implemented in yarp::manager::YarpBroker, and yarp::manager::LocalBroker.

◆ disableWatchDog()

void yarp::manager::Broker::disableWatchDog ( )
inline

Definition at line 65 of file broker.h.

◆ disconnect()

virtual bool yarp::manager::Broker::disconnect ( const char *  from,
const char *  to,
const char *  carrier 
)
pure virtual

Implemented in yarp::manager::YarpBroker, and yarp::manager::LocalBroker.

◆ enableWatchDog()

void yarp::manager::Broker::enableWatchDog ( )
inline

Definition at line 64 of file broker.h.

◆ error()

virtual const char* yarp::manager::Broker::error ( )
pure virtual

Implemented in yarp::manager::YarpBroker, and yarp::manager::LocalBroker.

◆ exists()

virtual bool yarp::manager::Broker::exists ( const char *  port)
pure virtual

Implemented in yarp::manager::YarpBroker, and yarp::manager::LocalBroker.

◆ fini()

virtual void yarp::manager::Broker::fini ( )
pure virtual

Implemented in yarp::manager::YarpBroker, and yarp::manager::LocalBroker.

◆ generateID()

unsigned int Broker::generateID ( )

Definition at line 29 of file broker.cpp.

◆ getDisplay()

const char* yarp::manager::Broker::getDisplay ( ) const
inline

Definition at line 69 of file broker.h.

◆ hasWatchDog()

bool yarp::manager::Broker::hasWatchDog ( )
inline

Definition at line 66 of file broker.h.

◆ init() [1/2]

virtual bool yarp::manager::Broker::init ( )
pure virtual

Implemented in yarp::manager::ScriptYarprunBroker, yarp::manager::ScriptLocalBroker, yarp::manager::YarpBroker, yarp::manager::ScriptYarprunBroker, yarp::manager::ScriptLocalBroker, and yarp::manager::LocalBroker.

◆ init() [2/2]

virtual bool yarp::manager::Broker::init ( const char *  szcmd,
const char *  szparam,
const char *  szhost,
const char *  szstdio,
const char *  szworkdir,
const char *  szenv 
)
pure virtual

Implemented in yarp::manager::YarpdevYarprunBroker, yarp::manager::YarpdevLocalBroker, yarp::manager::YarpBroker, yarp::manager::ScriptYarprunBroker, yarp::manager::ScriptLocalBroker, and yarp::manager::LocalBroker.

◆ initialized()

virtual bool yarp::manager::Broker::initialized ( )
pure virtual

Implemented in yarp::manager::YarpBroker, and yarp::manager::LocalBroker.

◆ kill()

virtual bool yarp::manager::Broker::kill ( )
pure virtual

Implemented in yarp::manager::YarpBroker, and yarp::manager::LocalBroker.

◆ requestRpc()

virtual const char* yarp::manager::Broker::requestRpc ( const char *  szport,
const char *  request,
double  timeout = 0.0 
)
pure virtual

Implemented in yarp::manager::YarpBroker, and yarp::manager::LocalBroker.

◆ running()

virtual int yarp::manager::Broker::running ( )
pure virtual

Implemented in yarp::manager::YarpBroker, and yarp::manager::LocalBroker.

◆ setDisplay()

void yarp::manager::Broker::setDisplay ( const char *  szDisplay)
inline

Definition at line 67 of file broker.h.

◆ setEventSink()

void Broker::setEventSink ( BrokerEventSink *  pEventSink)

Definition at line 24 of file broker.cpp.

◆ start()

virtual bool yarp::manager::Broker::start ( )
pure virtual

Implemented in yarp::manager::YarpBroker, and yarp::manager::LocalBroker.

◆ stop()

virtual bool yarp::manager::Broker::stop ( )
pure virtual

Implemented in yarp::manager::YarpBroker, and yarp::manager::LocalBroker.

Member Data Documentation

◆ bWithWatchDog

bool yarp::manager::Broker::bWithWatchDog
protected

Definition at line 73 of file broker.h.

◆ eventSink

BrokerEventSink* yarp::manager::Broker::eventSink
protected

Definition at line 72 of file broker.h.

◆ strDisplay

std::string yarp::manager::Broker::strDisplay
protected

Definition at line 74 of file broker.h.

◆ UNIQUEID

unsigned int yarp::manager::Broker::UNIQUEID
protected

Definition at line 71 of file broker.h.

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