nidas v1.2.3
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | List of all members
nidas::core::SensorOpener Class Reference

Thread which opens DSMSensors. More...

#include <SensorOpener.h>

Inheritance diagram for nidas::core::SensorOpener:
Inheritance graph
[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

 SensorOpener (SensorHandler *)
 Constructor.
 
 ~SensorOpener ()
 Note that SensorOpener does not own the sensors, and does not delete them.
 
void openSensor (DSMSensor *sensor)
 A SensorHandler calls this method to schedule a sensor to be opened.
 
void reopenSensor (DSMSensor *sensor)
 A SensorHandler calls this method to schedule a sensor to be reopened.
 
int run ()
 Thread function, open sensors.
 
void interrupt ()
 Interrupt this SensorOpener.
 
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 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.
 

Static Public Member Functions

static ThreadcurrentThread ()
 Return the thread object for the current thread.
 
static pthread_t currentThreadId ()
 
static ThreadlookupThread (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

 SensorOpener (const SensorOpener &)
 
SensorOpeneroperator= (const SensorOpener &)
 
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.
 

Protected Attributes

SensorHandler_selector
 
std::list< DSMSensor * > _sensors
 
std::list< DSMSensor * > _problemSensors
 
nidas::util::Cond _sensorCond
 

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

Static Private Member Functions

static voidthr_run (void *me)
 
static voidthr_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")
 

Detailed Description

Thread which opens DSMSensors.

Member Enumeration Documentation

◆ 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

Enumerator
NU_THREAD_OTHER 
NU_THREAD_FIFO 
NU_THREAD_RR 

Constructor & Destructor Documentation

◆ SensorOpener() [1/2]

SensorOpener::SensorOpener ( SensorHandler * s)

Constructor.

Parameters
SensorHandlerto notify of an opened DSMSensor.

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

◆ ~SensorOpener()

SensorOpener::~SensorOpener ( )

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

The SensorHander is responsible for deleting them.

◆ SensorOpener() [2/2]

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

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)
inherited

◆ cancel()

void Thread::cancel ( )
virtualinherited

◆ currentName()

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(), and nidas::util::Thread::unknownName.

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

◆ currentThread()

Thread * Thread::currentThread ( )
staticinherited

◆ currentThreadId()

pthread_t Thread::currentThreadId ( )
staticinherited

◆ getFullName()

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

◆ getId()

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

◆ getName()

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

◆ getPolicyString()

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::util::Thread::makeFullName().

◆ interrupt()

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::kill(), nidas::util::Cond::lock(), nidas::util::Cond::signal(), nidas::util::Cond::unlock(), and WLOG.

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

◆ isCancelDeferred()

bool Thread::isCancelDeferred ( ) const
inherited

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

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

◆ isCancelEnabled()

bool Thread::isCancelEnabled ( ) const
inherited

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

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

◆ isDetached()

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

Is this a detached thread.

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

◆ isInterrupted()

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

◆ isJoined()

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

◆ isRunning()

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

◆ join()

int Thread::join ( )
virtualinherited

◆ kill()

void Thread::kill ( int sig)
virtualinherited

◆ lookupThread()

Thread * Thread::lookupThread ( pthread_t id)
staticinherited

◆ makeFullName()

void Thread::makeFullName ( )
privateinherited

◆ openSensor()

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

◆ operator=()

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

◆ pRun()

int Thread::pRun ( )
privatevirtualinherited

◆ registerThread()

void Thread::registerThread ( )
privateinherited

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

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

References nidas::util::Thread::_id.

Referenced by nidas::util::Thread::start().

◆ reopenSensor()

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

◆ run()

int SensorOpener::run ( )
virtual

◆ setCancelDeferred()

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.

◆ setCancelEnabled()

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.

◆ setNonRealTimePriority()

bool Thread::setNonRealTimePriority ( )
inherited

◆ setRealTimeFIFOPriority()

bool Thread::setRealTimeFIFOPriority ( int val)
inherited

◆ setRealTimeRoundRobinPriority()

bool Thread::setRealTimeRoundRobinPriority ( int val)
inherited

◆ setThreadScheduler()

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

◆ setThreadSchedulerNolock() [1/2]

void Thread::setThreadSchedulerNolock ( )
privateinherited

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 nidas::util::Thread::_id, nidas::util::Thread::_policy, nidas::util::Thread::_priority, ELOG, nidas::util::Exception::errnoToString(), nidas::util::Thread::getName(), nidas::util::Thread::NU_THREAD_FIFO, nidas::util::Thread::NU_THREAD_RR, and WLOG.

Referenced by nidas::util::Thread::pRun(), nidas::util::Thread::setThreadScheduler(), and nidas::util::Thread::setThreadSchedulerNolock().

◆ setThreadSchedulerNolock() [2/2]

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

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

Exceptions
Exception

References nidas::util::Thread::_policy, nidas::util::Thread::_priority, and nidas::util::Thread::setThreadSchedulerNolock().

◆ sigAction()

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

◆ signalHandler()

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

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

◆ start()

void Thread::start ( )
virtualinherited

◆ test()

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

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)
staticprivateinherited

◆ thr_cleanup()

void Thread::thr_cleanup ( void * me)
staticprivateinherited

References ILOG.

Referenced by nidas::util::Thread::thr_run().

◆ thr_cleanup_delete()

void Thread::thr_cleanup_delete ( void * me)
staticprivateinherited

◆ thr_run()

void * Thread::thr_run ( void * me)
staticprivateinherited

◆ thr_run_detached()

void * Thread::thr_run_detached ( void * me)
staticprivateinherited

◆ unblockSignal()

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()
}
}
Sample * getSample(sampleType type, unsigned int len)
A convienence method for getting a sample of an enumerated type from a pool.
Definition Sample.cc:70

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::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 ( )
privateinherited

◆ unsetId()

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

Member Data Documentation

◆ _blockedSignals

sigset_t nidas::util::Thread::_blockedSignals
privateinherited

◆ _cancel_deferred

bool nidas::util::Thread::_cancel_deferred
privateinherited

◆ _cancel_enabled

bool nidas::util::Thread::_cancel_enabled
privateinherited

◆ _detached

bool nidas::util::Thread::_detached
privateinherited

◆ _exception

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

Exception thrown by run method.

Referenced by nidas::util::Thread::join(), nidas::util::Thread::pRun(), and nidas::util::Thread::~Thread().

◆ _fullname

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

◆ _id

pthread_t nidas::util::Thread::_id
privateinherited

◆ _interrupted

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

◆ _mutex

Mutex nidas::util::Thread::_mutex
mutableprivateinherited

◆ _name

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

◆ _policy

SchedPolicy nidas::util::Thread::_policy
privateinherited

◆ _priority

int nidas::util::Thread::_priority
privateinherited

◆ _problemSensors

std::list<DSMSensor*> nidas::core::SensorOpener::_problemSensors
protected

Referenced by reopenSensor(), and run().

◆ _running

bool nidas::util::Thread::_running
privateinherited

◆ _selector

SensorHandler* nidas::core::SensorOpener::_selector
protected

Referenced by run().

◆ _sensorCond

nidas::util::Cond nidas::core::SensorOpener::_sensorCond
protected

◆ _sensors

std::list<DSMSensor*> nidas::core::SensorOpener::_sensors
protected

Referenced by openSensor(), and run().

◆ _unblockedSignals

sigset_t nidas::util::Thread::_unblockedSignals
privateinherited

◆ unknownName

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

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