#include <Thread.h>

Inheritance diagram for nidas::util::Thread:

[legend]

Public Types
enum	runStatus { RUN_CANCELED = -1 , RUN_OK = 0 , NOT_RUNNING = 1 , RUN_EXCEPTION = 2 }
	Values that can be returned by run method. More...

enum	SchedPolicy { NU_THREAD_OTHER =SCHED_OTHER , NU_THREAD_FIFO =SCHED_FIFO , NU_THREAD_RR =SCHED_RR }

Public Member Functions
	Thread (const std::string &name, bool detached=false)
	Constructor for a thread, giving it a name.

virtual	~Thread ()
	Thread destructor.

virtual void	start ()
	Start the thread running, meaning execute the run method in a separate thread.

virtual int	join ()
	The calling thread joins this thread, waiting until the thread finishes, which means either that the run() method returned, the thread called pthread_exit() or the thread was cancelled.

virtual void	kill (int sig)
	Send a signal to this thread.

virtual void	cancel ()
	Cancel this thread.

virtual void	interrupt ()
	Interrupt this thread.

virtual bool	isInterrupted () const
	Return true when this thread has been interrupted.

virtual bool	isRunning () const
	Is this thread running?

virtual bool	isJoined () const
	Has this thread been joined?

virtual bool	isDetached () const
	Is this a detached thread.

bool	isCancelEnabled () const
	Return true if the cancel state of this thread is PTHREAD_CANCEL_ENABLE.

bool	isCancelDeferred () const
	Return true if the cancel type of this thread is PTHREAD_CANCEL_DEFERRED.

const std::string &	getName () const throw ()
	Return the name of this thread.

const std::string &	getFullName () throw ()
	Return a name with a bunch of descriptive fields, specifying whether it is detached, the real-time priority, etc.

bool	setRealTimeRoundRobinPriority (int val)

bool	setRealTimeFIFOPriority (int val)

bool	setNonRealTimePriority ()

void	setThreadScheduler (enum SchedPolicy policy, int priority)

void	blockSignal (int)
	Block a signal in this thread.

void	unblockSignal (int)
	Install a signal handler and unblock the signal.

virtual int	run ()=0
	The method which will run in its own thread.

Static Public Member Functions
static Thread *	currentThread ()
	Return the thread object for the current thread.

static pthread_t	currentThreadId ()

static Thread *	lookupThread (pthread_t id)

static const std::string &	currentName ()
	Convenience routine to return the name for the current thread, or a string indicating that the name of the thread is unknown.

static std::string	getPolicyString (int policy)
	Convenience function to return a string for the given scheduler policy: "Non-RT", "RT:FIFO", "RT:RR" or "RT:Unknown".

static int	test (int argc, char **argv)
	a test method.

Protected Member Functions
void	setCancelEnabled (bool val)
	Set the cancel state for this thread - false means cancel requests are ignored.

void	setCancelDeferred (bool val)
	Set the cancel type for this thread.

pthread_t	getId () const

void	testCancel () const
	Check if we have been cancelled.

virtual bool	amInterrupted () const
	Call testCancel, and return true when this thread has been interrupted.

Private Member Functions
virtual void	signalHandler (int, siginfo_t *)
	Signal handler function for this thread.

virtual int	pRun ()

void	setThreadSchedulerNolock (enum SchedPolicy policy, int priority)
	Set the scheduler policy and priority for this thread, then call setThreadSchedulerNolock() to effect the settings if the thread is running.

void	setThreadSchedulerNolock ()
	If the thread is running, set the scheduling policy according to the current policy and priority attributes in this Thread.

void	makeFullName ()

void	registerThread ()
	Register this current thread with a static registry of threads by id.

void	unregisterThread ()

void	unsetId ()

Thread &	operator= (const Thread &x)=delete
	Copy and assignment not needed so not supported.

	Thread (const Thread &x)=delete

Static Private Member Functions
static void *	thr_run (void *me)

static void *	thr_run_detached (void *me)

static void	thr_cleanup (void *me)

static void	thr_cleanup_delete (void *me)

static void	thr_add_sig (int sig)

static void	sigAction (int sig, siginfo_t si, void vptr)

Private Attributes
Mutex	_mutex
	Mutex for accessing _id.

std::string	_name

std::string	_fullname

pthread_t	_id

bool	_running

std::atomic< bool >	_interrupted

bool	_cancel_enabled

bool	_cancel_deferred

Exception *	_exception
	Exception thrown by run method.

bool	_detached

SchedPolicy	_policy

int	_priority

sigset_t	_blockedSignals

sigset_t	_unblockedSignals

Static Private Attributes
static std::string	unknownName = std::string("unknown")

Member Enumeration Documentation

◆ runStatus

enum nidas::util::Thread::runStatus

Values that can be returned by run method.

User can define other values greater than RUN_EXCEPTION. These values are then returned by int join(). Note that PTHREAD_CANCELLED is -1

Enumerator
RUN_CANCELED
RUN_OK
NOT_RUNNING
RUN_EXCEPTION

◆ SchedPolicy

enum nidas::util::Thread::SchedPolicy

Enumerator
NU_THREAD_OTHER
NU_THREAD_FIFO
NU_THREAD_RR

Constructor & Destructor Documentation

◆ Thread() [1/2]

Thread::Thread	(	const std::string &	name,
		bool	detached = false )

Constructor for a thread, giving it a name.

This does not start a processor thread. Use the Thread::start() method to start the processor thread. By default, SIGINT, SIGTERM and SIGHUP signals will be blocked when the thread starts. Use unblockSignal(sig) to unblock them if desired.

References _blockedSignals, and _unblockedSignals.

◆ ~Thread()

Thread::~Thread ( )

virtual

Thread destructor.

The destructor does not join or cancel a thread.

Users should not invoke the destructor of a detached thread after it has been started. Detached threads call their own destructor when finished.

The following comments pertain to non-deattached threads.

A thread shouldn't be running at the time of destruction.

Non-detached threads also should have been joined before the destructor is called.

This destructor will complain to cerr if either of the two above situations exists. These situations are errors on the part of the user of Thread and should be corrected.

References _detached, _exception, getName(), isJoined(), isRunning(), and PLOG.

◆ Thread() [2/2]

nidas::util::Thread::Thread ( const Thread & x )

privatedelete

Member Function Documentation

◆ amInterrupted()

bool Runnable::amInterrupted ( ) const

protectedvirtualinherited

Call testCancel, and return true when this thread has been interrupted.

This is protected because it should only called within the run method of the thread.

References nidas::util::Runnable::isInterrupted(), and nidas::util::Runnable::testCancel().

Referenced by nidas::core::Looper::run(), nidas::core::SampleOutputRequestThread::run(), and nidas::core::DSMServerStat::run().

◆ blockSignal()

void Thread::blockSignal ( int sig )

Block a signal in this thread.

This method is usually called before this Thread has started. If this Thread is currently running, then this method is only effective if called from this Thread, i.e. from its own run() method.

Because SIGINT, SIGTERM and SIGHUP are typically caught in the main thread, they are blocked by default in a Thread. Call unblockSignal(sig) if you want to catch them in a Thread.

References _blockedSignals, _unblockedSignals, currentThread(), isRunning(), and thr_add_sig().

Referenced by nidas::dynld::UDPSampleOutput::ConnectionMonitor::ConnectionMonitor(), nidas::core::ServerSocket::ConnectionThread::ConnectionThread(), nidas::core::DerivedDataReader::DerivedDataReader(), nidas::util::McSocketListener::McSocketListener(), nidas::util::McSocketMulticaster< SocketTT >::McSocketMulticaster(), nidas::core::SensorHandler::SensorHandler(), nidas::core::SensorOpener::SensorOpener(), nidas::dynld::RawSampleService::Worker::Worker(), nidas::core::XmlRpcThread::XmlRpcThread(), and nidas::dynld::UDPSampleOutput::XMLSocketListener::XMLSocketListener().

◆ cancel()

void Thread::cancel ( )

virtual

Cancel this thread.

Exceptions

Exception

References _id, _mutex, nidas::util::Exception::errnoToString(), and getName().

◆ currentName()

static const std::string & nidas::util::Thread::currentName ( )

inlinestatic

Convenience routine to return the name for the current thread, or a string indicating that the name of the thread is unknown.

References currentThread(), and unknownName.

Referenced by nidas::util::Logger::msg().

◆ currentThread()

Thread * Thread::currentThread ( )

static

Return the thread object for the current thread.

Returns null if not found.

References currentThreadId(), and lookupThread().

Referenced by blockSignal(), currentName(), sigAction(), and unblockSignal().

◆ currentThreadId()

pthread_t Thread::currentThreadId ( )

static

Referenced by currentThread(), and sigAction().

◆ getFullName()

const std::string & Thread::getFullName	(		)
throw	(	)

Return a name with a bunch of descriptive fields, specifying whether it is detached, the real-time priority, etc.

References _fullname.

Referenced by pRun().

◆ getId()

pthread_t nidas::util::Thread::getId ( ) const

inlineprotected

References _id, and _mutex.

Referenced by isJoined(), join(), and nidas::core::Looper::removeClient().

◆ getName()

const std::string & Thread::getName	(		)	const
throw	(	)

Return the name of this thread.

References _name.

Referenced by cancel(), nidas::core::SensorHandler::PolledDSMSensor::checkTimeout(), nidas::core::SensorHandler::PolledDSMSensor::close(), nidas::core::SensorHandler::PolledDSMSensor::handlePollEvents(), nidas::core::SampleSorter::heapDecrement(), nidas::core::XmlRpcThread::interrupt(), nidas::core::SamplePipeline::join(), join(), kill(), nidas::core::FsMountWorkerThread::run(), nidas::core::SampleSorter::run(), nidas::util::ThreadJoiner::run(), setThreadSchedulerNolock(), start(), nidas::core::SampleSorter::~SampleSorter(), and ~Thread().

◆ getPolicyString()

string Thread::getPolicyString ( int policy )

static

Convenience function to return a string for the given scheduler policy: "Non-RT", "RT:FIFO", "RT:RR" or "RT:Unknown".

References NU_THREAD_FIFO, NU_THREAD_OTHER, and NU_THREAD_RR.

Referenced by makeFullName().

◆ interrupt()

void Thread::interrupt ( )

virtual

Interrupt this thread.

This sets a boolean which can be tested with isInterrupted(). It is up to the run() implementation to return when interrupted. This is a "soft" request to terminate the thread.

What follows is a discussion of when to use cancel(), kill(), or interrupt() to terminate a thread.

If you can consistently check the state of isInterrupted() in the run method, and return if it is true, at a time interval which is an acceptable amount of time to wait for the thread to terminate, then using interrupt() should work well.

If the run method does I/O, then things are usually a bit more complicated.

If all I/O is guaranteed to finish quickly, which is a rare situation, or is done with a timeout, such as using select/poll with a timeout before every read/write, then one could still use interrupt() as above, and the thread will terminate within the timeout period.

If the thread does blocking I/O operations, and the I/O might block for a period of time longer than you're willing to wait for the thread to terminate, then you need to use kill(sig) or cancel().

If a signal is sent to the thread with kill(sig) while the thread is blocking on an I/O operation, the I/O will immediately return with an errno of EINTR, and one could then return from the run method, after any necessary cleanup.

However there is a possibility that the signal could be missed. In order to make sure you receive a signal, you must block it, so that any received signals are held as pending, and then atomically unblock it with pselect/ppoll/epoll_pwait before performing the I/O operation.

If you do not use I/O timeouts, or kill(sig) with pselect/ppoll/epoll_pwait, or other tricks such as writing to a pipe that is watched with select/poll in the run method, then using cancel() is the only way to guarantee that your thread will terminate in an acceptable amount of time.

All NIDAS Threads support deferred cancelation. Immediate asynchronous cancellation is not fully supported (and is very hard to get right). Deferred cancelation means that cancellation is delayed until the thread next calls a system function that is a cancellation point. At that point the thread run method will simply terminate without any return value from the system function, and then execute any cleanup methods that may have been registered with pthread_cleanup_push.

A list of cancellation points is provided in the pthreads(7) man page. Cancellation points are typically I/O operations, waits or sleeps.

This immediate thread termination can be a problem if there is a possibility that your objects could be left in a bad state, such as with a mutex locked, though it isn't generally a good practice to hold mutexes during a time-consuming I/O operation, wait or sleep.

One should check the run method to see if the state of the objects is OK if execution stops at any of the cancellation points. Note that logging a message, or writing to cerr is a cancellation point. Typically there is error/exception handling associated with an I/O operation. Ensuring the state is OK upon a cancellation is similar to preparation for a fatal I/O error that requires a return of the run method. One can use setCancelEnabled() to defer cancellation.

One can use pthread_cleanup_push and pthread_cleanup_pop to register cleanup routines that are called when a thread is cancelled if special handling is required.

Implements nidas::util::Runnable.

Reimplemented in nidas::core::DerivedDataReader, nidas::core::SampleBuffer, nidas::core::SampleOutputRequestThread, nidas::core::SampleSorter, nidas::core::SensorHandler, nidas::core::SensorOpener, nidas::core::Socket::ConnectionThread, nidas::core::ServerSocket::ConnectionThread, nidas::core::XmlRpcThread, nidas::dynld::raf::SyncServer, nidas::dynld::RawSampleService::Worker, nidas::dynld::UDPSampleOutput::VariableListWorker, nidas::dynld::UDPSampleOutput::XMLSocketListener, nidas::dynld::XMLConfigService::Worker, nidas::util::McSocketListener, nidas::util::McSocketMulticaster< SocketTT >, and nidas::util::ThreadRunnable.

References _interrupted, and _mutex.

Referenced by nidas::dynld::UDPSampleOutput::close(), nidas::core::DSMEngine::interrupt(), nidas::core::SamplePipeline::interrupt(), nidas::util::McSocketListener::interrupt(), nidas::core::SamplePipeline::join(), nidas::core::Looper::removeClient(), and nidas::dynld::UDPSampleOutput::~UDPSampleOutput().

◆ isCancelDeferred()

bool Thread::isCancelDeferred ( ) const

Return true if the cancel type of this thread is PTHREAD_CANCEL_DEFERRED.

References _cancel_deferred.

◆ isCancelEnabled()

bool Thread::isCancelEnabled ( ) const

Return true if the cancel state of this thread is PTHREAD_CANCEL_ENABLE.

References _cancel_enabled.

◆ isDetached()

virtual bool nidas::util::Thread::isDetached ( ) const

inlinevirtual

Is this a detached thread.

References _detached.

◆ isInterrupted()

virtual bool nidas::util::Thread::isInterrupted ( ) const

inlinevirtual

◆ isJoined()

virtual bool nidas::util::Thread::isJoined ( ) const

inlinevirtual

Has this thread been joined?

References getId().

Referenced by nidas::core::FsMount::cancel(), nidas::core::SensorHandler::join(), nidas::core::SampleBuffer::~SampleBuffer(), nidas::core::SampleSorter::~SampleSorter(), and ~Thread().

◆ isRunning()

virtual bool nidas::util::Thread::isRunning ( ) const

inlinevirtual

Is this thread running?

References _mutex, and _running.

Referenced by blockSignal(), nidas::core::FsMount::cancel(), nidas::dynld::UDPSampleOutput::XMLSocketListener::checkWorkers(), nidas::dynld::UDPSampleOutput::close(), nidas::core::SamplePipeline::join(), nidas::core::DSMServerApp::killStatusThread(), nidas::core::Looper::removeClient(), nidas::core::ServerSocket::requestConnection(), nidas::core::SensorHandler::run(), nidas::core::Looper::setupClientMaps(), unblockSignal(), nidas::core::SampleBuffer::~SampleBuffer(), nidas::core::SampleSorter::~SampleSorter(), ~Thread(), and nidas::dynld::UDPSampleOutput::~UDPSampleOutput().

◆ join()

int Thread::join ( )

virtual

The calling thread joins this thread, waiting until the thread finishes, which means either that the run() method returned, the thread called pthread_exit() or the thread was cancelled.

The return value is the int return value of the run method, or PTHREAD_CANCELED (-1). If the run method threw an Exception, it will be caught and then re-thrown by join.

Exceptions

Exception

Reimplemented in nidas::core::SensorHandler.

References _exception, _id, _mutex, nidas::util::Exception::errnoToString(), getId(), getName(), RUN_EXCEPTION, and RUN_OK.

Referenced by nidas::dynld::UDPSampleOutput::XMLSocketListener::checkWorkers(), nidas::dynld::UDPSampleOutput::close(), nidas::dynld::UDPSampleOutput::XMLSocketListener::fireWorkers(), nidas::core::SamplePipeline::join(), nidas::core::SensorHandler::join(), nidas::core::DSMEngine::joinDataThreads(), nidas::core::DSMServerApp::killStatusThread(), nidas::core::DSMEngine::killXmlRpcThread(), nidas::core::DSMServerApp::killXmlRpcThread(), nidas::core::Looper::removeClient(), nidas::util::ThreadJoiner::run(), nidas::core::SampleBuffer::~SampleBuffer(), nidas::core::SampleSorter::~SampleSorter(), nidas::core::ServerSocket::~ServerSocket(), and nidas::dynld::UDPSampleOutput::~UDPSampleOutput().

◆ kill()

void Thread::kill ( int sig )

virtual

Send a signal to this thread.

Exceptions

Exception

References _id, _mutex, nidas::util::Exception::errnoToString(), and getName().

Referenced by nidas::core::FsMount::cancel(), nidas::core::DerivedDataReader::interrupt(), nidas::core::SensorHandler::interrupt(), nidas::core::SensorOpener::interrupt(), nidas::core::XmlRpcThread::interrupt(), nidas::util::McSocketListener::interrupt(), nidas::core::DSMServerApp::killStatusThread(), nidas::core::SensorHandler::scheduleAdd(), nidas::core::SensorHandler::scheduleClose(), nidas::core::SensorHandler::scheduleClose(), nidas::core::SensorHandler::scheduleReopen(), and nidas::core::SensorHandler::sensorIsOpen().

◆ lookupThread()

Thread * Thread::lookupThread ( pthread_t id )

static

Referenced by currentThread(), and nidas::util::LogContextState::threadName().

◆ makeFullName()

void Thread::makeFullName ( )

private

References _cancel_deferred, _cancel_enabled, _detached, _fullname, _id, _name, and getPolicyString().

Referenced by start().

◆ operator=()

Thread & nidas::util::Thread::operator= ( const Thread & x )

privatedelete

Copy and assignment not needed so not supported.

◆ pRun()

int Thread::pRun ( )

privatevirtual

References _blockedSignals, _exception, _mutex, _unblockedSignals, nidas::util::Exception::clone(), getFullName(), ILOG, nidas::util::Mutex::lock(), nidas::util::Runnable::run(), RUN_EXCEPTION, setThreadSchedulerNolock(), and nidas::util::Mutex::unlock().

◆ registerThread()

void Thread::registerThread ( )

private

Register this current thread with a static registry of threads by id.

Thread::registerThread (new Thread ("Main"));

References _id.

Referenced by start().

◆ run()

virtual int nidas::util::Runnable::run ( )

pure virtualinherited

The method which will run in its own thread.

This method must be supplied by the Runnable or Thread subclass.

Exceptions

Exception

Implemented in WriterThread, ServerThread, DataWriter, PSI, TestSource, Sender, ModemLineSetter, ModemLineMonitor, nidas::core::DerivedDataReader, nidas::core::DSMEngineIntf, nidas::core::DSMServerIntf, nidas::core::FsMountWorkerThread, nidas::core::Looper, nidas::core::SampleBuffer, nidas::core::SampleOutputRequestThread, nidas::core::SampleSorter, nidas::core::SensorHandler, nidas::core::SensorOpener, nidas::core::Socket::ConnectionThread, nidas::core::ServerSocket::ConnectionThread, nidas::core::StatusListener, nidas::core::DSMEngineStat, nidas::core::DSMServerStat, nidas::dynld::raf::SyncServer, nidas::dynld::RawSampleService::Worker, nidas::dynld::UDPSampleOutput::VariableListWorker, nidas::dynld::UDPSampleOutput::ConnectionMonitor, nidas::dynld::UDPSampleOutput::XMLSocketListener, nidas::dynld::XMLConfigService::Worker, nidas::util::McSocketListener, nidas::util::McSocketMulticaster< SocketTT >, nidas::util::ThreadRunnable, and nidas::util::ThreadJoiner.

Referenced by pRun(), nidas::util::ThreadRunnable::run(), and start().

◆ setCancelDeferred()

void Thread::setCancelDeferred ( bool val )

protected

Set the cancel type for this thread.

true means cancel requests are deferred until the next cancellation point. false means they occur instantly. This is protected, it should be called only from a thread's own run method. See the pthreads(7) man page for a list of the cancellation points.

Note: non-deferred canceling is difficult to get right. It has not been tested with this class, and is not recommended.

References _cancel_deferred.

◆ setCancelEnabled()

void Thread::setCancelEnabled ( bool val )

protected

Set the cancel state for this thread - false means cancel requests are ignored.

See pthread_setcancelstate. This is protected, it should be called only from a thread's own run method.

References _cancel_enabled.

◆ setNonRealTimePriority()

bool Thread::setNonRealTimePriority ( )

Exceptions

Exception

References NU_THREAD_OTHER, and setThreadScheduler().

◆ setRealTimeFIFOPriority()

bool Thread::setRealTimeFIFOPriority ( int val )

Exceptions

Exception

References NU_THREAD_FIFO, and setThreadScheduler().

Referenced by nidas::core::DSMEngine::openSensors(), nidas::core::SamplePipeline::procinit(), and nidas::core::SamplePipeline::rawinit().

◆ setRealTimeRoundRobinPriority()

bool Thread::setRealTimeRoundRobinPriority ( int val )

Exceptions

Exception

References NU_THREAD_RR, and setThreadScheduler().

◆ setThreadScheduler()

void Thread::setThreadScheduler	(	enum SchedPolicy	policy,
		int	priority )

Exceptions

Exception

References _mutex, and setThreadSchedulerNolock().

Referenced by nidas::dynld::RawSampleService::connect(), setNonRealTimePriority(), setRealTimeFIFOPriority(), and setRealTimeRoundRobinPriority().

◆ setThreadSchedulerNolock() [1/2]

void Thread::setThreadSchedulerNolock ( )

private

If the thread is running, set the scheduling policy according to the current policy and priority attributes in this Thread.

Warn but continue if realtime priority cannot be set, otherwise raise Exception.

Exceptions

Exception

References _id, _policy, _priority, ELOG, nidas::util::Exception::errnoToString(), getName(), NU_THREAD_FIFO, NU_THREAD_RR, and WLOG.

Referenced by pRun(), setThreadScheduler(), and setThreadSchedulerNolock().

◆ setThreadSchedulerNolock() [2/2]

void Thread::setThreadSchedulerNolock	(	enum SchedPolicy	policy,
		int	priority )

private

Set the scheduler policy and priority for this thread, then call setThreadSchedulerNolock() to effect the settings if the thread is running.

Exceptions

Exception

References _policy, _priority, and setThreadSchedulerNolock().

◆ sigAction()

void Thread::sigAction	(	int	sig,
		siginfo_t *	si,
		void *	vptr )

staticprivate

References currentThread(), currentThreadId(), and DLOG.

Referenced by thr_add_sig().

◆ signalHandler()

virtual void nidas::util::Thread::signalHandler	(	int	,
		siginfo_t *	)

inlineprivatevirtual

Signal handler function for this thread.

The default handler just sets _interrupt to true, so that amInterrupted() or isInterrupted() will return true. Derived classes can override this method for custom signal handling. However, derived classes are limited in what they can do in their signal handler. Specifically, from the pthread_cond_signal man page:

"It is not safe to use the pthread_cond_signal() function in a signal handler that is invoked asynchronously."

Therefore do not call Cond::signal() from a signal handler.

Reimplemented in nidas::core::SensorHandler.

References _interrupted.

◆ start()

void Thread::start ( )

virtual

Start the thread running, meaning execute the run method in a separate thread.

Exceptions

Exception

References _detached, _id, _interrupted, _mutex, _running, nidas::util::Exception::errnoToString(), getName(), makeFullName(), registerThread(), nidas::util::Runnable::run(), thr_run(), and thr_run_detached().

Referenced by nidas::dynld::RawSampleService::connect(), nidas::dynld::XMLConfigAllService::connected(), nidas::dynld::XMLConfigService::connected(), nidas::dynld::raf::SyncServer::getTimeWindow(), main(), nidas::core::FsMount::mount(), nidas::core::DSMEngine::openSensors(), nidas::core::SamplePipeline::procinit(), nidas::core::SamplePipeline::rawinit(), nidas::core::Socket::requestConnection(), nidas::core::ServerSocket::requestConnection(), nidas::core::DSMEngine::run(), nidas::core::SensorHandler::run(), nidas::dynld::UDPSampleOutput::XMLSocketListener::run(), nidas::dynld::raf::SyncServer::setTimeWindow(), nidas::core::Looper::setupClientMaps(), nidas::core::DSMServerApp::startStatusThread(), nidas::core::DSMEngine::startXmlRpcThread(), and nidas::core::DSMServerApp::startXmlRpcThread().

◆ test()

int Thread::test	(	int	argc,
		char **	argv )

static

a test method.

◆ testCancel()

void nidas::util::Runnable::testCancel ( ) const

inlineprotectedinherited

Check if we have been cancelled.

Calls pthread_testcancel. This is protected since it only checks the current thread - i.e. it must be called within the run method. Since it just calls pthread_testcancel, it is a cancellation point.

Referenced by nidas::util::Runnable::amInterrupted(), and TestSource::run().

◆ thr_add_sig()

void Thread::thr_add_sig ( int sig )

staticprivate

References sigAction().

Referenced by blockSignal(), and unblockSignal().

◆ thr_cleanup()

void Thread::thr_cleanup ( void * me )

staticprivate

References ILOG.

Referenced by thr_run().

◆ thr_cleanup_delete()

void Thread::thr_cleanup_delete ( void * me )

staticprivate

References _mutex, and nidas::util::Mutex::lock().

Referenced by thr_run_detached().

◆ thr_run()

void * Thread::thr_run ( void * me )

staticprivate

References thr_cleanup().

Referenced by start().

◆ thr_run_detached()

void * Thread::thr_run_detached ( void * me )

staticprivate

References thr_cleanup_delete().

Referenced by start().

◆ unblockSignal()

void Thread::unblockSignal ( int sig )

Install a signal handler and unblock the signal.

The signal handler will log a message about the receipt of the signal at severity LOG_INFO using the nidas::util::Logger. Then, if the signal handler is being invoked from a registered Thread, the virtual method signalHandler() for that Thread will be called.

The signal handler is installed with the sigaction() system call, and will be the action for the given signal in all threads, including the main() thread. If other threads do not wish to take action on a given signal, they should call blockSignal(sig). Or they can define their own signalHandler() method.

After installing the signal handler, the signal is added to those that are unblocked for the thread, or if the Thread is not yet running, the signal will be unblocked in the thread once it runs.

As with blockSignal(), this method is typically called on this Thread before it has started. If this Thread has started, then the signal will only be unblocked if the method is called from this Thread, i.e. from its own run() method.

To install a signal handler, and then block the signal so that it is held as pending until it is later unblocked, typically with pselect(), or sigwaitinfo(), do:

void Thread::run() 
{
    // get the existing signal mask
    sigset_t sigmask;
    pthread_sigmask(SIG_BLOCK,NULL,&sigmask);
    // remove SIGUSR1 from the mask passed to pselect
    sigdelset(&sigmask,SIGUSR1);
    
    for (;;) {
        pselect(nfd,&readfds,0,0,0,&sigmask);
        ...
    }
}
...
thread.unblockSignal(SIGUSR1);
thread.blockSignal(SIGUSR1);
thread.start();
...
try {
    if (thread.isRunning()) {
        thread.kill(SIGUSR1);
        thread.join()
    }
}

References _blockedSignals, _unblockedSignals, currentThread(), isRunning(), and thr_add_sig().

Referenced by nidas::core::DerivedDataReader::DerivedDataReader(), nidas::core::FsMountWorkerThread::FsMountWorkerThread(), nidas::core::StatusListener::StatusListener(), nidas::core::StatusThread::StatusThread(), nidas::dynld::XMLConfigService::Worker::Worker(), nidas::core::XmlRpcThread::XmlRpcThread(), and nidas::dynld::UDPSampleOutput::XMLSocketListener::XMLSocketListener().

◆ unregisterThread()

void Thread::unregisterThread ( )

private

References _id.

◆ unsetId()

void nidas::util::Thread::unsetId ( )

inlineprivate

References _id, and _mutex.

Member Data Documentation

◆ _blockedSignals

sigset_t nidas::util::Thread::_blockedSignals

private

Referenced by blockSignal(), pRun(), Thread(), and unblockSignal().

◆ _cancel_deferred

bool nidas::util::Thread::_cancel_deferred

private

Referenced by isCancelDeferred(), makeFullName(), and setCancelDeferred().

◆ _cancel_enabled

bool nidas::util::Thread::_cancel_enabled

private

Referenced by isCancelEnabled(), makeFullName(), and setCancelEnabled().

◆ _detached

bool nidas::util::Thread::_detached

private

Referenced by isDetached(), makeFullName(), start(), and ~Thread().

◆ _exception

Exception* nidas::util::Thread::_exception

private

Exception thrown by run method.

Referenced by join(), pRun(), and ~Thread().

◆ _fullname

std::string nidas::util::Thread::_fullname

private

Referenced by getFullName(), and makeFullName().

◆ _id

pthread_t nidas::util::Thread::_id

private

Referenced by cancel(), getId(), join(), kill(), makeFullName(), registerThread(), setThreadSchedulerNolock(), start(), unregisterThread(), and unsetId().

◆ _interrupted

std::atomic<bool> nidas::util::Thread::_interrupted

private

Referenced by interrupt(), isInterrupted(), signalHandler(), and start().

◆ _mutex

Mutex nidas::util::Thread::_mutex

mutableprivate

Mutex for accessing _id.

Referenced by cancel(), getId(), interrupt(), isInterrupted(), isRunning(), join(), kill(), pRun(), setThreadScheduler(), start(), thr_cleanup_delete(), and unsetId().

◆ _name

std::string nidas::util::Thread::_name

private

Referenced by getName(), and makeFullName().

◆ _policy

SchedPolicy nidas::util::Thread::_policy

private

Referenced by setThreadSchedulerNolock(), and setThreadSchedulerNolock().

◆ _priority

int nidas::util::Thread::_priority

private

Referenced by setThreadSchedulerNolock(), and setThreadSchedulerNolock().

◆ _running

bool nidas::util::Thread::_running

private

Referenced by isRunning(), and start().

◆ _unblockedSignals

sigset_t nidas::util::Thread::_unblockedSignals

private

Referenced by blockSignal(), pRun(), Thread(), and unblockSignal().

◆ unknownName

std::string Thread::unknownName = std::string("unknown")

staticprivate

Referenced by currentName().

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

nidas/util/Thread.h
nidas/util/Thread.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Member Enumeration Documentation

◆ runStatus

◆ SchedPolicy

Constructor & Destructor Documentation

◆ Thread() [1/2]

◆ ~Thread()

◆ Thread() [2/2]

Member Function Documentation

◆ amInterrupted()

◆ blockSignal()

◆ cancel()

◆ currentName()

◆ currentThread()

◆ currentThreadId()

◆ getFullName()

◆ getId()

◆ getName()

◆ getPolicyString()

◆ interrupt()

◆ isCancelDeferred()

◆ isCancelEnabled()

◆ isDetached()

◆ isInterrupted()

◆ isJoined()

◆ isRunning()

◆ join()

◆ kill()

◆ lookupThread()

◆ makeFullName()

◆ operator=()

◆ pRun()

◆ registerThread()

◆ run()

◆ setCancelDeferred()

◆ setCancelEnabled()

◆ setNonRealTimePriority()

◆ setRealTimeFIFOPriority()

◆ setRealTimeRoundRobinPriority()

◆ setThreadScheduler()

◆ setThreadSchedulerNolock() [1/2]

◆ setThreadSchedulerNolock() [2/2]

◆ sigAction()

◆ signalHandler()

◆ start()

◆ test()

◆ testCancel()

◆ thr_add_sig()

◆ thr_cleanup()

◆ thr_cleanup_delete()

◆ thr_run()

◆ thr_run_detached()

◆ unblockSignal()

◆ unregisterThread()

◆ unsetId()

Member Data Documentation

◆ _blockedSignals

◆ _cancel_deferred

◆ _cancel_enabled

◆ _detached

◆ _exception

◆ _fullname

◆ _id

◆ _interrupted

◆ _mutex

◆ _name

◆ _policy

◆ _priority

◆ _running

◆ _unblockedSignals

◆ unknownName