Application for running the NIDAS data acquistion process. More...

#include <DSMEngine.h>

Inheritance diagram for nidas::core::DSMEngine:

Public Types
enum	command { DSM_STOP, DSM_RUN, DSM_QUIT, DSM_RESTART, DSM_REBOOT, DSM_SHUTDOWN }

Public Member Functions
	DSMEngine ()

	~DSMEngine ()
	Nuke it. More...

void	initLogger ()
	Initialize the Logger. More...

int	initProcess ()
	Initialize various process parameters, uid, etc. More...

int	run () throw ()
	main loop More...

int	parseRunstring (int argc, char **argv)
	Parse the runstring parameters. More...

void	usage ()
	Print runstring usage to stderr. More...

void	start ()
	Starts the main loop (for the XMLRPC call). More...

void	stop ()
	Stops the main loop (for the XMLRPC call). More...

void	restart ()
	Restarts the main loop (for the XMLRPC call). More...

void	quit ()
	Quit the main loop. More...

void	shutdown ()
	Quits the main loop, and spawns a "halt" shell command. More...

void	reboot ()
	Quits the main loop, and spawns a "reboot" shell command. More...

const DSMConfig *	getDSMConfig () const

const SensorHandler *	getSensorHandler () const

void	registerSensorWithXmlRpc (const std::string &devname, DSMSensor *)
	Sensors register with the DSMEngineIntf XmlRpcThread if they have a executeXmlRpc() method which can be invoked with a "SensorAction" XmlRpc request. More...

bool	quitCommand (enum command command)

enum command	getCommand () const

Static Public Member Functions
static int	main (int argc, char **argv) throw ()
	Entry point to run a DSMEngine process from a command line. More...

static DSMEngine *	getInstance ()
	Get a pointer to the singleton instance of DSMEngine created by main(). More...

Private Types
enum	run_states { DSM_RUNNING, DSM_ERROR, DSM_STOPPED }

Private Member Functions
void	setupSignals ()
	Create a signal mask, and block those masked signals. More...

void	waitForSignal (int secs)
	Unblock and wait for signals of interest. More...

void	initialize (xercesc::DOMDocument *projectDoc) throw (nidas::util::InvalidParameterException)
	Initialize the DSMEngine based on the parameters in the DOMDocument. More...

void	startXmlRpcThread () throw (nidas::util::Exception)

void	killXmlRpcThread () throw ()

void	openSensors () throw (nidas::util::IOException)

void	connectOutputs () throw (nidas::util::IOException)

void	connectProcessors () throw (nidas::util::IOException, nidas::util::InvalidParameterException)

void	disconnectProcessors () throw ()

void	closeOutputs () throw ()

void	interrupt ()

void	deleteDataThreads () throw ()

void	joinDataThreads () throw ()

void	connect (SampleOutput *) throw ()
	Implementation of SampleConnectionRequester connect methods. More...

void	disconnect (SampleOutput *) throw ()
	How SampleOutputs notify their SampleConnectionRequester that they wish to be closed, likely do to an IOException. More...

void	connect (SampleInput *) throw ()
	DSMEngine does not receive SampleInputs, so this will die with an assert. More...

void	disconnect (SampleInput *) throw ()
	DSMEngine does not receive SampleInputs, so these will die with an assert. More...

	DSMEngine (const DSMEngine &)
	No copy. More...

DSMEngine &	operator= (const DSMEngine &)
	No assignment. More...

Private Attributes
bool	_externalControl

bool	_disableAutoconfig

enum nidas::core::DSMEngine::run_states	_runState

enum command	_command

bool	_syslogit
	Whether to log messages on syslog (true) or stderr (false). More...

std::string	_configFile
	Name of XML configuration file. More...

nidas::util::Inet4SocketAddress	_configSockAddr
	Address to use when fishing for the XML configuration. More...

Project *	_project

DSMConfig *	_dsmConfig

SensorHandler *	_selector

SamplePipeline *	_pipeline

DSMEngineStat *	_statusThread
	A thread that generates streaming XML time and status. More...

DSMEngineIntf *	_xmlrpcThread
	This thread provides XML-based Remote Procedure calls. More...

std::set< SampleOutput * >	_outputSet
	Connected SampleOutputs. More...

nidas::util::Mutex	_outputMutex

int	_logLevel

sigset_t	_signalMask

pthread_t	_myThreadId

NidasApp	_app

NidasAppArg	ExternalControl

NidasAppArg	DisableAutoConfig

Static Private Attributes
static DSMEngine *	_instance = 0

Detailed Description

Application for running the NIDAS data acquistion process.

Member Enumeration Documentation

enum nidas::core::DSMEngine::command

Enumerator
DSM_STOP
DSM_RUN
DSM_QUIT
DSM_RESTART
DSM_REBOOT
DSM_SHUTDOWN

enum nidas::core::DSMEngine::run_states

private

Enumerator
DSM_RUNNING
DSM_ERROR
DSM_STOPPED

Constructor & Destructor Documentation

DSMEngine::DSMEngine ( )

References _configSockAddr, nidas::util::Inet4Address::getByName(), NIDAS_MULTICAST_ADDR, NIDAS_SVC_REQUEST_PORT_UDP, setupSignals(), and nidas::util::Exception::what().

DSMEngine::~DSMEngine ( )

Nuke it.

References _project, _statusThread, _xmlrpcThread, nidas::core::SamplePools::deleteInstance(), and nidas::core::SampleOutputRequestThread::destroyInstance().

nidas::core::DSMEngine::DSMEngine ( const DSMEngine & )

private

No copy.

Member Function Documentation

void DSMEngine::closeOutputs	(	)
throw	(
	)

private

void DSMEngine::connect	(	SampleOutput *	output	)
throw	(
	)

privatevirtual

Implementation of SampleConnectionRequester connect methods.

This is how DSMEngine is notified of remote connections.

Implements nidas::core::SampleConnectionRequester.

References nidas::util::Logger::getInstance(), nidas::util::Logger::log(), and LOG_INFO.

void nidas::core::DSMEngine::connect	(	SampleInput *	)
throw	(
	)

inlineprivate

DSMEngine does not receive SampleInputs, so this will die with an assert.

void DSMEngine::connectOutputs	(		)
throw	(	nidas::util::IOException
	)

private

References _dsmConfig, _pipeline, nidas::core::SampleOutputRequestThread::addConnectRequest(), nidas::core::SampleOutput::addSourceSampleTags(), DLOG, nidas::core::SampleOutputRequestThread::getInstance(), nidas::core::SampleOutput::getName(), nidas::core::DSMConfig::getOutputs(), nidas::core::SamplePipeline::getProcessedSampleSource(), nidas::core::SamplePipeline::getRawSampleSource(), nidas::core::SampleSource::getSampleTags(), and nidas::core::SampleOutput::isRaw().

Referenced by run().

void DSMEngine::connectProcessors	(		)
throw	(	nidas::util::IOException,
		nidas::util::InvalidParameterException
	)

private

References _dsmConfig, _pipeline, nidas::core::SampleIOProcessor::connectSource(), nidas::core::DSMConfig::getProcessorIterator(), nidas::core::DSMConfig::getSensorIterator(), nidas::core::ProcessorIterator::hasNext(), nidas::core::SensorIterator::hasNext(), nidas::core::DSMSensor::init(), nidas::core::ProcessorIterator::next(), and nidas::core::SensorIterator::next().

Referenced by run().

void DSMEngine::deleteDataThreads	(	)
throw	(
	)

private

References _pipeline, _selector, _statusThread, nidas::core::DerivedDataReader::deleteInstance(), and nidas::core::DerivedDataReader::getInstance().

Referenced by run().

void DSMEngine::disconnect	(	SampleOutput *	output	)
throw	(
	)

privatevirtual

How SampleOutputs notify their SampleConnectionRequester that they wish to be closed, likely do to an IOException.

Implements nidas::core::SampleConnectionRequester.

References nidas::core::SampleOutputRequestThread::addConnectRequest(), nidas::core::SampleOutputRequestThread::addDeleteRequest(), nidas::core::SampleOutputRequestThread::getInstance(), nidas::util::Logger::getInstance(), nidas::core::SampleOutput::getOriginal(), nidas::core::SampleOutput::getReconnectDelaySecs(), nidas::util::Logger::log(), LOG_ERR, and nidas::util::Exception::what().

void nidas::core::DSMEngine::disconnect	(	SampleInput *	)
throw	(
	)

inlineprivate

DSMEngine does not receive SampleInputs, so these will die with an assert.

void DSMEngine::disconnectProcessors	(	)
throw	(
	)

private

References _dsmConfig, _pipeline, nidas::core::SampleIOProcessor::disconnectSource(), nidas::core::SampleSource::flush(), nidas::core::DSMConfig::getProcessorIterator(), nidas::core::ProcessorIterator::hasNext(), and nidas::core::ProcessorIterator::next().

Referenced by run().

enum command nidas::core::DSMEngine::getCommand ( ) const

inline

References _command.

Referenced by main().

const DSMConfig* nidas::core::DSMEngine::getDSMConfig ( ) const

inline

References _dsmConfig.

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

static DSMEngine* nidas::core::DSMEngine::getInstance ( )

inlinestatic

Get a pointer to the singleton instance of DSMEngine created by main().

References _instance.

Referenced by nidas::core::DSMEngineIntf::DSMAction::execute(), nidas::dynld::raf::PSI9116_Sensor::open(), nidas::dynld::raf::DSMAnalogSensor::open(), and nidas::core::DSMEngineStat::run().

const SensorHandler* nidas::core::DSMEngine::getSensorHandler ( ) const

inline

References _selector.

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

void DSMEngine::initialize	(	xercesc::DOMDocument *	projectDoc	)
throw	(	nidas::util::InvalidParameterException
	)

private

Initialize the DSMEngine based on the parameters in the DOMDocument.

This method initializes the Project object, _project from the DOM, and sets the value of _dsmConfig.

Referenced by run().

void DSMEngine::initLogger ( )

Initialize the Logger.

References _app, and nidas::core::NidasApp::setupDaemon().

Referenced by main().

int DSMEngine::initProcess ( )

Initialize various process parameters, uid, etc.

References _app, nidas::core::NidasApp::checkPidFile(), nidas::core::NidasApp::lockMemory(), and nidas::core::NidasApp::setupProcess().

Referenced by main().

void DSMEngine::interrupt ( )

private

References _pipeline, _selector, _statusThread, nidas::core::SamplePipeline::flush(), nidas::core::DerivedDataReader::getInstance(), nidas::core::DerivedDataReader::interrupt(), nidas::core::SensorHandler::interrupt(), nidas::core::SamplePipeline::interrupt(), and nidas::util::Thread::interrupt().

Referenced by run().

void DSMEngine::joinDataThreads	(	)
throw	(
	)

private

References _pipeline, _selector, _statusThread, nidas::util::Thread::cancel(), DLOG, nidas::core::DerivedDataReader::getInstance(), nidas::util::Thread::join(), nidas::core::SensorHandler::join(), nidas::core::SamplePipeline::join(), PLOG, USECS_PER_SEC, nidas::util::Exception::what(), and WLOG.

Referenced by run().

void DSMEngine::killXmlRpcThread	(	)
throw	(
	)

private

References _xmlrpcThread, DLOG, nidas::core::XmlRpcThread::interrupt(), nidas::util::Thread::join(), nidas::util::Exception::what(), and WLOG.

Referenced by main().

int DSMEngine::main	(	int	argc,
		char **	argv
	)
throw	(
	)

static

Entry point to run a DSMEngine process from a command line.

main creates an instance of DSMEngine, passes it the command line arguments and calls the run method.

References nidas::core::DSMSensor::deleteLooper(), getCommand(), nidas::core::SamplePoolInterface::getNLargeSamplesIn(), nidas::core::SamplePoolInterface::getNMediumSamplesIn(), nidas::core::SamplePoolInterface::getNSamplesOut(), nidas::core::SamplePoolInterface::getNSmallSamplesIn(), ILOG, initLogger(), initProcess(), killXmlRpcThread(), NSECS_PER_SEC, parseRunstring(), PLOG, run(), nidas::util::Process::spawn(), startXmlRpcThread(), nidas::core::XMLImplementation::terminate(), and nidas::util::Exception::what().

Referenced by main().

void DSMEngine::openSensors	(		)
throw	(	nidas::util::IOException
	)

private

Referenced by run().

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

private

No assignment.

int DSMEngine::parseRunstring	(	int	argc,
		char **	argv
	)

Parse the runstring parameters.

If the runstring parameters are not OK, then DSMEngine::usage() is called to print a message to stderr, and this method then returns a error value of 1.