RunTerminator Class Reference

#include <yarp/run/impl/RunReadWrite.h>

Inheritance diagram for RunTerminator:

Public Member Functions
	RunTerminator (RunStdio *pStdio)
	~RunTerminator ()
void	run () override
	Main body of the new thread. More...
void	exit ()
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...
virtual bool	threadInit ()
	Initialization method. More...
virtual void	threadRelease ()
	Release method. 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...

Protected Attributes
FILE *	fwait
FILE *	fpost
RunStdio *	mStdio

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

Detailed Description

Definition at line 79 of file RunReadWrite.h.

Constructor & Destructor Documentation

RunTerminator()

RunTerminator::RunTerminator ( RunStdio *  pStdio )

inline

Definition at line 85 of file RunReadWrite.h.

~RunTerminator()

RunTerminator::~RunTerminator ( )

inline

Definition at line 101 of file RunReadWrite.h.

Member Function Documentation

exit()

void RunTerminator::exit ( )

inline

Definition at line 123 of file RunReadWrite.h.

run()

void RunTerminator::run ( )

inlineoverridevirtual

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 109 of file RunReadWrite.h.

Member Data Documentation

fpost

FILE * RunTerminator::fpost

protected

Definition at line 134 of file RunReadWrite.h.

fwait

FILE* RunTerminator::fwait

protected

Definition at line 134 of file RunReadWrite.h.

mStdio

RunStdio* RunTerminator::mStdio

protected

Definition at line 135 of file RunReadWrite.h.

---

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

• src/libYARP_run/src/yarp/run/impl/RunReadWrite.h