epicsThread Class Reference

An OS thread. More...

#include <epicsThread.h>

Public Member Functions
	epicsThread (epicsThreadRunable &, const char *name, unsigned int stackSize, unsigned int priority=epicsThreadPriorityLow)
void	start () throw ()
	Actually start the thread.
void	exitWait () throw ()
	Wait for the thread epicsRunnable::run() to return.
bool	exitWait (const double delay) throw ()
void	resume () throw ()
	cf. epicsThreadResume()
void	getName (char *name, size_t size) const throw ()
	cf. epicsThreadGetName();
epicsThreadId	getId () const throw ()
	cf. epicsThreadGetIdSelf()()
unsigned int	getPriority () const throw ()
	cf. epicsThreadGetPriority()
void	setPriority (unsigned int) throw ()
	cf. epicsThreadSetPriority()
bool	priorityIsEqual (const epicsThread &) const throw ()
bool	isSuspended () const throw ()
bool	isCurrentThread () const throw ()
bool	operator== (const epicsThread &) const throw ()
void	show (unsigned level) const throw ()
	Say something interesting about this thread to stdout.

Static Public Member Functions
static void	exit ()
static void	suspendSelf () throw ()
static void	sleep (double seconds) throw ()
static const char *	getNameSelf () throw ()
static bool	isOkToBlock () throw ()
static void	setOkToBlock (bool isOkToBlock) throw ()

Friends
void	epicsThreadCallEntryPoint (void *)

Detailed Description

A wrapper around the epicsThread* C API.

Note

Threads must be start() ed.

Definition at line 375 of file epicsThread.h.

Constructor & Destructor Documentation

epicsThread::epicsThread	(	epicsThreadRunable &	,
		const char *	name,
		unsigned int	stackSize,
		unsigned int	priority = epicsThreadPriorityLow
	)

Create a new thread with the provided information.

cf. epicsThreadOpts

Note

Threads must be start() ed.

Exceptions

epicsThread::unableToCreateThread

on error.

Member Function Documentation

bool epicsThread::exitWait	(	const double	delay	)
throw	(
	)

Wait for the thread epicsRunnable::run() to return.

Parameters

delay

Wait up to this many seconds.

Returns

true if run() returned. false on timeout.

static void epicsThread::exit ( )

static

Exceptions

A	special exitException which will be caught and ignored.

Note

This exitException doesn't not derive from std::exception

bool epicsThread::isCurrentThread	(		)	const
throw	(
	)

Returns

true if call through this thread's epicsRunnable::run()

---

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

• epicsThread.h