Thread which opens DSMSensors. More...

#include <SensorOpener.h>

Inheritance diagram for nidas::core::SensorOpener:

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
	SensorOpener (SensorHandler *)
	Constructor. More...

	~SensorOpener ()
	Note that SensorOpener does not own the sensors, and does not delete them. More...

void	openSensor (DSMSensor *sensor)
	A SensorHandler calls this method to schedule a sensor to be opened. More...

void	reopenSensor (DSMSensor *sensor)
	A SensorHandler calls this method to schedule a sensor to be reopened. More...

int	run () throw (nidas::util::Exception)
	Thread function, open sensors. More...

void	interrupt ()
	Interrupt this SensorOpener. More...

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

virtual int	join () throw (Exception)
	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. More...

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

virtual void	cancel () throw (Exception)
	Cancel this thread. More...

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

virtual bool	isRunning () const
	Is this thread running? More...

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

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

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

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

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

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

bool	setRealTimeRoundRobinPriority (int val) throw (Exception)

bool	setRealTimeFIFOPriority (int val) throw (Exception)

bool	setNonRealTimePriority () throw (Exception)

void	setThreadScheduler (enum SchedPolicy policy, int priority) throw (Exception)

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

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

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

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

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

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

Protected Member Functions
	SensorOpener (const SensorOpener &)

SensorOpener &	operator= (const SensorOpener &)

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

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

pthread_t	getId () const

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

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

Protected Attributes
SensorHandler *	_selector

std::list< DSMSensor * >	_sensors

std::list< DSMSensor * >	_problemSensors

nidas::util::Cond	_sensorCond

Detailed Description

Thread which opens DSMSensors.

Member Enumeration Documentation

enum nidas::util::Thread::runStatus

inherited

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

enum nidas::util::Thread::SchedPolicy

inherited

Enumerator
NU_THREAD_OTHER
NU_THREAD_FIFO
NU_THREAD_RR

Constructor & Destructor Documentation

SensorOpener::SensorOpener ( SensorHandler * s )

Constructor.

Parameters

SensorHandler to notify of an opened DSMSensor.

References nidas::util::Thread::blockSignal().

SensorOpener::~SensorOpener ( )

Note that SensorOpener does not own the sensors, and does not delete them.

The SensorHander is responsible for deleting them.

nidas::core::SensorOpener::SensorOpener ( const SensorOpener & )

protected

Member Function Documentation

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.

Referenced by nidas::core::SampleOutputRequestThread::run(), nidas::core::Looper::run(), nidas::dynld::isff::GOESOutput::run(), nidas::core::DSMServerStat::run(), and nidas::util::Thread::test().

void Thread::blockSignal ( int sig )

inherited

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 nidas::util::Thread::_blockedSignals, nidas::util::Thread::_unblockedSignals, nidas::util::Thread::currentThread(), nidas::util::Thread::isRunning(), and nidas::util::Thread::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(), SensorOpener(), nidas::util::Thread::test(), nidas::dynld::RawSampleService::Worker::Worker(), nidas::core::XmlRpcThread::XmlRpcThread(), and nidas::dynld::UDPSampleOutput::XMLSocketListener::XMLSocketListener().

void Thread::cancel	(		)
throw	(	Exception
	)

virtualinherited

Cancel this thread.

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

Referenced by nidas::core::DSMService::cancel(), nidas::dynld::isff::GOESOutput::cancelThread(), nidas::core::DerivedDataReader::deleteInstance(), and nidas::core::DSMEngine::joinDataThreads().

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

inlinestaticinherited

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

References nidas::util::Thread::currentThread(), nidas::util::Thread::getName(), and nidas::util::Thread::unknownName.

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

Thread * Thread::currentThread ( )

staticinherited

Return the thread object for the current thread.

Returns null if not found.

Referenced by nidas::util::Thread::blockSignal(), nidas::util::Thread::currentName(), and nidas::util::Thread::unblockSignal().

pthread_t Thread::currentThreadId ( )

staticinherited

Referenced by nidas::core::Looper::removeClient().

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

inherited

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

References nidas::util::Thread::_fullname.

Referenced by nidas::util::Thread::pRun(), nidas::util::Thread::test(), nidas::util::Thread::thr_cleanup(), and nidas::util::Thread::thr_cleanup_delete().

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

inlineprotectedinherited

References nidas::util::Thread::_id, and nidas::util::Thread::_mutex.

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

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

inherited

Return the name of this thread.

References nidas::util::Thread::_name.

string Thread::getPolicyString ( int policy )

staticinherited

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

References nidas::util::Thread::NU_THREAD_FIFO, nidas::util::Thread::NU_THREAD_OTHER, and nidas::util::Thread::NU_THREAD_RR.

Referenced by nidas::core::DSMSensor::getLooper(), and nidas::util::Thread::makeFullName().

void SensorOpener::interrupt ( )

virtual

Interrupt this SensorOpener.

Send a _sensorCond.signal() so it will see the interrupt.

Reimplemented from nidas::util::Thread.

References _sensorCond, nidas::util::Thread::interrupt(), nidas::util::Thread::kill(), nidas::util::Cond::lock(), nidas::util::Cond::signal(), nidas::util::Cond::unlock(), nidas::util::Exception::what(), and WLOG.

Referenced by nidas::core::SensorHandler::run().

bool Thread::isCancelDeferred ( ) const

inherited

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

References nidas::util::Thread::_cancel_deferred.

bool Thread::isCancelEnabled ( ) const

inherited

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

References nidas::util::Thread::_cancel_enabled.

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

inlinevirtualinherited

Is this a detached thread.

References nidas::util::Thread::_detached.

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

inlinevirtualinherited

Return true when this thread has been interrupted.

Implements nidas::util::Runnable.

References nidas::util::Thread::_interrupted, and nidas::util::Thread::_mutex.

Referenced by nidas::core::SampleSorter::flush(), nidas::core::SampleOutputRequestThread::run(), nidas::core::StatusListener::run(), nidas::core::DerivedDataReader::run(), run(), Sender::run(), nidas::core::DSMEngineStat::run(), nidas::core::SensorHandler::run(), nidas::core::FsMountWorkerThread::run(), ModemLineSetter::run(), ModemLineMonitor::run(), nidas::core::SampleBuffer::run(), nidas::core::SampleSorter::run(), ServerThread::run(), nidas::util::McSocketListener::run(), and nidas::dynld::raf::SyncServer::stop().

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

inlinevirtualinherited

Has this thread been joined?

References nidas::util::Thread::getId().

Referenced by nidas::core::FsMount::cancel(), nidas::core::DerivedDataReader::deleteInstance(), nidas::core::SensorHandler::join(), nidas::dynld::isff::GOESOutput::joinThread(), nidas::util::Thread::test(), nidas::core::SampleBuffer::~SampleBuffer(), nidas::core::SampleSorter::~SampleSorter(), and nidas::util::Thread::~Thread().

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

inlinevirtualinherited

Is this thread running?

References nidas::util::Thread::_mutex, and nidas::util::Thread::_running.

Referenced by nidas::util::Thread::blockSignal(), nidas::core::DSMService::cancel(), nidas::core::FsMount::cancel(), nidas::dynld::isff::GOESOutput::cancelThread(), nidas::core::DSMService::checkSubThreads(), nidas::dynld::UDPSampleOutput::XMLSocketListener::checkWorkers(), nidas::dynld::UDPSampleOutput::close(), nidas::util::McSocket< SocketT >::close(), nidas::core::DerivedDataReader::deleteInstance(), nidas::core::DSMService::interrupt(), nidas::core::SamplePipeline::join(), nidas::dynld::isff::GOESOutput::joinThread(), nidas::core::DSMServerApp::killStatusThread(), nidas::dynld::isff::GOESOutput::killThread(), nidas::core::Looper::removeClient(), nidas::core::SensorHandler::run(), nidas::core::Looper::setupClientMaps(), nidas::util::Thread::test(), nidas::util::Thread::unblockSignal(), nidas::core::SampleBuffer::~SampleBuffer(), nidas::core::SampleSorter::~SampleSorter(), nidas::util::Thread::~Thread(), and nidas::dynld::UDPSampleOutput::~UDPSampleOutput().

int Thread::join	(		)
throw	(	Exception
	)

virtualinherited

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.

Reimplemented in nidas::core::SensorHandler.

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

Referenced by nidas::core::DSMService::checkSubThreads(), nidas::dynld::UDPSampleOutput::XMLSocketListener::checkWorkers(), nidas::dynld::UDPSampleOutput::close(), nidas::util::McSocketListener::close(), nidas::core::DerivedDataReader::deleteInstance(), nidas::dynld::UDPSampleOutput::XMLSocketListener::fireWorkers(), nidas::core::DSMService::join(), nidas::core::SensorHandler::join(), nidas::core::SamplePipeline::join(), nidas::core::DSMEngine::joinDataThreads(), nidas::dynld::isff::GOESOutput::joinThread(), nidas::core::DSMServerApp::killStatusThread(), nidas::core::DSMServerApp::killXmlRpcThread(), nidas::core::DSMEngine::killXmlRpcThread(), main(), 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().

void Thread::kill	(	int	sig	)
throw	(	Exception
	)

virtualinherited

Send a signal to this thread.

References nidas::util::Exception::errnoToString().

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

Thread * Thread::lookupThread ( pthread_t id )

staticinherited

Referenced by nidas::util::LogContext::threadName().

void SensorOpener::openSensor ( DSMSensor * sensor )

A SensorHandler calls this method to schedule a sensor to be opened.

Called from the main thread.

SensorOpener will call the SensorHandler::sensorOpen() method after the sensor has been successfully opened, to notify the PortSelect that the sensor is ready for IO. The SensorHandler owns the DSMSensor pointer. SensorHandler will cancel the SensorOpener thread before deleting any DSMSensors.

References _sensorCond, _sensors, nidas::util::Cond::lock(), nidas::util::Cond::signal(), and nidas::util::Cond::unlock().

Referenced by nidas::core::SensorHandler::addSensor().

SensorOpener& nidas::core::SensorOpener::operator= ( const SensorOpener & )

protected

void SensorOpener::reopenSensor ( DSMSensor * sensor )

A SensorHandler calls this method to schedule a sensor to be reopened.

Called from the main thread.

This is typically done on a sensor that has returned an IOException on a read, in which case the SensorHandler closes the sensor and requests a reopen.

References _problemSensors, _sensorCond, nidas::util::Cond::lock(), nidas::util::Cond::signal(), and nidas::util::Cond::unlock().

Referenced by nidas::core::SensorHandler::handlePollingChange().

int SensorOpener::run	(		)
throw	(	nidas::util::Exception
	)

virtual

Thread function, open sensors.

Implements nidas::util::Runnable.

References _problemSensors, _selector, _sensorCond, _sensors, nidas::core::DSMSensor::close(), nidas::core::DSMSensor::getDefaultMode(), nidas::core::DSMSensor::getName(), nidas::core::DSMSensor::incrementTimeoutCount(), nidas::util::Thread::isInterrupted(), nidas::util::Cond::lock(), nidas::core::DSMSensor::open(), PLOG, nidas::util::Thread::RUN_OK, nidas::core::SensorHandler::sensorIsOpen(), nidas::util::Cond::unlock(), nidas::util::Cond::wait(), nidas::util::Exception::what(), and WLOG.

void Thread::setCancelDeferred ( bool val )

protectedinherited

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 nidas::util::Thread::_cancel_deferred.

void Thread::setCancelEnabled ( bool val )

protectedinherited

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 nidas::util::Thread::_cancel_enabled.

bool Thread::setNonRealTimePriority	(		)
throw	(	Exception
	)

inherited

References nidas::util::Thread::NU_THREAD_OTHER, and nidas::util::Thread::setThreadScheduler().

bool Thread::setRealTimeFIFOPriority	(	int	val	)
throw	(	Exception
	)

inherited

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

bool Thread::setRealTimeRoundRobinPriority	(	int	val	)
throw	(	Exception
	)

inherited

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

inherited

Referenced by nidas::dynld::RawSampleService::connect(), nidas::core::DSMSensor::getLooper(), and nidas::util::Thread::setNonRealTimePriority().

void Thread::start	(		)
throw	(	Exception
	)

virtualinherited

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

Referenced by nidas::util::McSocketListener::accept(), nidas::dynld::RawSampleService::connect(), nidas::core::DerivedDataReader::createInstance(), nidas::util::McSocket< SocketT >::joinMulticaster(), main(), nidas::core::DSMEngine::openSensors(), nidas::core::SamplePipeline::procinit(), nidas::core::SamplePipeline::rawinit(), nidas::util::McSocket< SocketT >::request(), nidas::core::DSMServerApp::run(), nidas::core::DSMEngine::run(), PSI::run(), nidas::core::SensorHandler::run(), nidas::core::FsMountWorkerThread::run(), nidas::dynld::UDPSampleOutput::XMLSocketListener::run(), nidas::core::Socket::ConnectionThread::run(), ServerThread::run(), nidas::core::Looper::setupClientMaps(), nidas::core::DSMServerApp::startXmlRpcThread(), and nidas::core::DSMEngine::startXmlRpcThread().

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

staticinherited

a test method.

References nidas::util::Runnable::amInterrupted(), nidas::util::Thread::blockSignal(), nidas::util::Thread::getFullName(), nidas::util::Thread::getName(), nidas::util::Thread::isJoined(), nidas::util::Thread::isRunning(), nidas::util::Runnable::run(), nidas::util::Thread::Thread(), and nidas::util::Exception::what().

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.

void Thread::unblockSignal ( int sig )

inherited

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()
    }
}