YARP
Yet Another Robot Platform
yarp::manager::LocalBroker Class Reference

Class LocalBroker. More...

#include <yarp/manager/localbroker.h>

+ Inheritance diagram for yarp::manager::LocalBroker:

Public Types

enum  WindowMode {
  WINDOW_HIDDEN =0 ,
  WINDOW_VISIBLE =1 ,
  WINDOW_MINIMIZED =2
}
 

Public Member Functions

 LocalBroker ()
 
virtual ~LocalBroker ()
 
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
 
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
 
void setWindowMode (WindowMode m)
 Define if the application will be visible or not. More...
 
void run () override
 Main body of the new thread. 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::Thread
 Thread ()
 Constructor. More...
 
virtual ~Thread ()
 Destructor. More...
 
virtual void onStop ()
 Call-back, called while halting the thread (before join). More...
 
bool start ()
 Start the new thread running. More...
 
bool stop ()
 Stop the thread. More...
 
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...
 
bool isStopping ()
 Returns true if the thread is stopping (Thread::stop has been called). More...
 
bool isRunning ()
 Returns true if the thread is running (Thread::start has been called successfully and the thread has not stopped). More...
 
long int getKey ()
 Get a unique identifier for the thread. 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 ()
 Query the current priority of the thread, if the OS supports that. More...
 
int getPolicy ()
 Query the current scheduling policy of the thread, if the OS supports that. More...
 
bool join (double seconds=-1)
 The function returns when the thread execution has completed. More...
 
void setOptions (int stackSize=0)
 Set the stack size for the new thread. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from yarp::os::Thread
static int getCount ()
 Check how many threads are running. More...
 
static long int getKeyOfCaller ()
 Get a unique identifier for the calling thread. More...
 
static void yield ()
 Reschedule the execution of current thread, allowing other threads to run. More...
 
static void setDefaultStackSize (int stackSize)
 Set the default stack size for all threads created after this point. More...
 
- Protected Attributes inherited from yarp::manager::Broker
unsigned int UNIQUEID
 
BrokerEventSinkeventSink
 
bool bWithWatchDog
 
std::string strDisplay
 

Detailed Description

Class LocalBroker.

Definition at line 34 of file localbroker.h.

Member Enumeration Documentation

◆ WindowMode

Enumerator
WINDOW_HIDDEN 
WINDOW_VISIBLE 
WINDOW_MINIMIZED 

Definition at line 38 of file localbroker.h.

Constructor & Destructor Documentation

◆ LocalBroker()

LocalBroker::LocalBroker ( )

Definition at line 141 of file localbroker.cpp.

◆ ~LocalBroker()

LocalBroker::~LocalBroker ( )
virtual

Definition at line 150 of file localbroker.cpp.

Member Function Documentation

◆ attachStdout()

bool LocalBroker::attachStdout ( )
overridevirtual

Implements yarp::manager::Broker.

Definition at line 510 of file localbroker.cpp.

◆ connect()

bool LocalBroker::connect ( const char *  from,
const char *  to,
const char *  carrier,
bool  persist = false 
)
overridevirtual

connection broker

Implements yarp::manager::Broker.

Definition at line 359 of file localbroker.cpp.

◆ connected()

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

Implements yarp::manager::Broker.

Definition at line 496 of file localbroker.cpp.

◆ detachStdout()

void LocalBroker::detachStdout ( )
overridevirtual

Implements yarp::manager::Broker.

Definition at line 523 of file localbroker.cpp.

◆ disconnect()

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

Implements yarp::manager::Broker.

Definition at line 399 of file localbroker.cpp.

◆ error()

const char * LocalBroker::error ( )
overridevirtual

Implements yarp::manager::Broker.

Definition at line 505 of file localbroker.cpp.

◆ exists()

bool LocalBroker::exists ( const char *  port)
overridevirtual

Implements yarp::manager::Broker.

Definition at line 443 of file localbroker.cpp.

◆ fini()

void LocalBroker::fini ( )
overridevirtual

Implements yarp::manager::Broker.

Definition at line 155 of file localbroker.cpp.

◆ init() [1/2]

bool LocalBroker::init ( )
overridevirtual

Implements yarp::manager::Broker.

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

Definition at line 162 of file localbroker.cpp.

◆ init() [2/2]

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

◆ initialized()

bool yarp::manager::LocalBroker::initialized ( )
inlineoverridevirtual

Implements yarp::manager::Broker.

Definition at line 64 of file localbroker.h.

◆ kill()

bool LocalBroker::kill ( )
overridevirtual

Implements yarp::manager::Broker.

Definition at line 309 of file localbroker.cpp.

◆ requestRpc()

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

Implements yarp::manager::Broker.

Definition at line 449 of file localbroker.cpp.

◆ run()

void LocalBroker::run ( )
overridevirtual

Main body of the new thread.

Override this method to do what you want. After Thread::start is called, this method will start running in a separate thread. It is important that this method either keeps checking Thread::isStopping to see if it should stop, or you override the Thread::onStop method to interact with it in some way to shut the new thread down. There is no really reliable, portable way to stop a thread cleanly unless that thread cooperates.

Implements yarp::os::Thread.

Definition at line 544 of file localbroker.cpp.

◆ running()

int LocalBroker::running ( )
overridevirtual

Implements yarp::manager::Broker.

Definition at line 344 of file localbroker.cpp.

◆ setWindowMode()

void LocalBroker::setWindowMode ( WindowMode  m)

Define if the application will be visible or not.

Definition at line 590 of file localbroker.cpp.

◆ start()

bool LocalBroker::start ( )
overridevirtual

Implements yarp::manager::Broker.

Definition at line 250 of file localbroker.cpp.

◆ stop()

bool LocalBroker::stop ( )
overridevirtual

Implements yarp::manager::Broker.

Definition at line 276 of file localbroker.cpp.

◆ threadInit()

bool LocalBroker::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::Thread.

Definition at line 538 of file localbroker.cpp.

◆ threadRelease()

void LocalBroker::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::Thread.

Definition at line 585 of file localbroker.cpp.


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