Transports::LoggingDigest::Task Struct Reference

Public Member Functions
	Task (const std::string &name, Tasks::Context &ctx)
	~Task (void)
void	onResourceInitialization (void)
void	onUpdateParameters (void)
uint32_t	getKey (const IMC::Message *msg)
void	startLog (const std::string &name)
void	stopLog (void)
void	consume (const IMC::LoggingControl *msg)
void	consume (const IMC::Message *msg)
void	writeSample (void)
void	flush (void)
void	logMessage (const IMC::Message *msg)
void	onMain (void)
Public Member Functions inherited from DUNE::Tasks::Task
	Task (const std::string &name, Context &context)
const char *	getName (void) const
const char *	getSystemName (void) const
unsigned int	getSystemId (void) const
unsigned int	getEntityId (void) const
uint16_t	getActivationTime (void) const
uint16_t	getDeactivationTime (void) const
unsigned int	resolveSystemName (const std::string &name) const
const char *	resolveSystemId (unsigned int id) const
void	loadConfig (void)
void	setPriority (unsigned int value)
unsigned int	getPriority (void) const
void	inf (const char *format,...) DUNE_PRINTF_FORMAT(2
void void	war (const char *format,...) DUNE_PRINTF_FORMAT(2
void void void	err (const char *format,...) DUNE_PRINTF_FORMAT(2
void void void void	cri (const char *format,...) DUNE_PRINTF_FORMAT(2
void void void void void	debug (const char *format,...) DUNE_PRINTF_FORMAT(2
void void void void void void	trace (const char *format,...) DUNE_PRINTF_FORMAT(2
void void void void void void void	spew (const char *format,...) DUNE_PRINTF_FORMAT(2
void void void void void void void void	dispatch (IMC::Message *msg, unsigned int flags=0)
void	dispatch (IMC::Message &msg, unsigned int flags=0)
void	dispatchReply (const IMC::Message &original, IMC::Message &msg, unsigned int flags=0)
void	receive (const IMC::Message *msg)
void	reserveEntities (void)
void	resolveEntities (void)
void	acquireResources (void)
void	releaseResources (void)
void	initializeResources (void)
void	updateParameters (bool act_deact=true)
void	writeParamsXML (std::ostream &os) const
Public Member Functions inherited from DUNE::Tasks::AbstractTask
	AbstractTask (void)
virtual	~AbstractTask (void)
Public Member Functions inherited from DUNE::Concurrency::Thread
	Thread (void)
virtual	~Thread (void)
int	getProcessorUsage (void)
Public Member Functions inherited from DUNE::Concurrency::Runnable
	Runnable (void)
virtual	~Runnable (void)
void	start (void)
void	stop (void)
void	join (void)
void	stopAndJoin (void)
void	setPriority (Scheduler::Policy policy, unsigned priority)
State	getState (void)
bool	isCreated (void)
bool	isStopping (void)
bool	isRunning (void)
bool	isStarting (void)
bool	isDead (void)

Public Attributes
Compression::FileOutput *	m_log
std::map< uint32_t, IMC::Message * >	m_messages
Counter< double >	m_sample_timer
Counter< double >	m_flush_timer
ByteBuffer	m_buffer
Arguments	m_args

Additional Inherited Members
Public Types inherited from DUNE::Concurrency::Runnable
enum	State {   StateStarting, StateRunning, StateStopping, StateDead,   StateUnknown }
Protected Member Functions inherited from DUNE::Tasks::Task
const char *	getEntityLabel (void) const
void	setEntityLabel (const std::string &label)
void	setEntityState (IMC::EntityState::StateEnum state, Status::Code code)
void	setEntityState (IMC::EntityState::StateEnum state, const std::string &description)
IMC::EntityState::StateEnum	getEntityState (void) const
unsigned int	reserveEntity (const std::string &label)
unsigned int	resolveEntity (const std::string &label) const
std::string	resolveEntity (unsigned int id) const
bool	stopping (void)
bool	isActive (void) const
void	waitForMessages (double timeout)
void	consumeMessages (void)
template<typename T >
Parameter &	param (const std::string &name, T &var)
template<typename Y , typename T >
Parameter &	param (const std::string &name, T &var)
template<typename T >
bool	paramChanged (T &var)
void	paramActive (Parameter::Scope def_scope, Parameter::Visibility def_visibility, bool def_value=false)
void	setParamSectionEditor (const std::string &name)
template<typename M , typename T >
void	bind (T *task_obj, void(T::*consumer)(const M *)=&T::consume)
template<typename T >
void	bind (T *task_obj, const std::vector< uint32_t > &list)
template<typename T >
void	bind (T *task_obj, const std::vector< std::string > &list)
void	requestActivation (void)
void	requestDeactivation (void)
void	activate (void)
void	activationFailed (const std::string &reason)
void	deactivate (void)
void	deactivationFailed (const std::string &reason)
virtual void	onEntityReservation (void)
virtual void	onEntityResolution (void)
virtual void	onReportEntityState (void)
virtual void	onResourceAcquisition (void)
virtual void	onResourceRelease (void)
virtual void	onRequestActivation (void)
virtual void	onRequestDeactivation (void)
virtual void	onActivation (void)
virtual void	onDeactivation (void)
Protected Member Functions inherited from DUNE::Concurrency::Thread
void	startImpl (void)
void	stopImpl (void)
void	joinImpl (void)
void	setPriorityImpl (Scheduler::Policy policy, unsigned priority)
Protected Attributes inherited from DUNE::Tasks::Task
Context &	m_ctx

Constructor & Destructor Documentation

Transports::LoggingDigest::Task::Task ( const std::string &  name, Tasks::Context &  ctx  )

inline

Constructor.

Parameters

[in]	name	task name.
[in]	ctx	context.

References DUNE::Tasks::Parameter::defaultValue(), Transports::LoggingDigest::Arguments::flush_interval, Transports::LoggingDigest::Arguments::log_folder, Transports::LoggingDigest::Arguments::lsf_name, m_args, Transports::LoggingDigest::Arguments::messages, DUNE::Tasks::Task::param(), and Transports::LoggingDigest::Arguments::sample_interval.

Transports::LoggingDigest::Task::~Task ( void  )

inlinevirtual

Destructor.

Reimplemented from DUNE::Tasks::Task.

References m_messages, and stopLog().

Member Function Documentation

void Transports::LoggingDigest::Task::consume ( const IMC::LoggingControl *  msg )

inline

References DUNE::Tasks::Task::err(), logMessage(), m_log, DUNE::Tasks::Task::setEntityState(), startLog(), and stopLog().

void Transports::LoggingDigest::Task::consume ( const IMC::Message *  msg )

inline

References getKey(), and m_messages.

void Transports::LoggingDigest::Task::flush ( void  )

inline

References m_flush_timer, m_log, DUNE::Time::Counter< T >::overflow(), and DUNE::Time::Counter< T >::reset().

Referenced by onMain().

uint32_t Transports::LoggingDigest::Task::getKey ( const IMC::Message *  msg )

inline

Referenced by consume().

void Transports::LoggingDigest::Task::logMessage ( const IMC::Message *  msg )

inline

References m_buffer, and m_log.

Referenced by consume(), startLog(), and writeSample().

void Transports::LoggingDigest::Task::onMain ( void  )

inlinevirtual

Main loop.

Implements DUNE::Tasks::Task.

References flush(), DUNE::Tasks::Task::stopping(), DUNE::Tasks::Task::waitForMessages(), and writeSample().

void Transports::LoggingDigest::Task::onResourceInitialization ( void  )

inlinevirtual

Called when the task is instructed to initialize resources acquired previously or whose initialization depends on run-time parameters.

Reimplemented from DUNE::Tasks::Task.

References DUNE::Tasks::Task::setEntityState().

void Transports::LoggingDigest::Task::onUpdateParameters ( void  )

inlinevirtual

Update internal state with new parameter values.

Reimplemented from DUNE::Tasks::Task.

References DUNE::Tasks::Task::bind(), Transports::LoggingDigest::Arguments::flush_interval, m_args, m_flush_timer, m_sample_timer, Transports::LoggingDigest::Arguments::messages, Transports::LoggingDigest::Arguments::sample_interval, and DUNE::Time::Counter< T >::setTop().

void Transports::LoggingDigest::Task::startLog ( const std::string &  name )

inline

References DUNE::Tasks::EntityDataBase::contents(), DUNE::Tasks::Context::dir_log, DUNE::Tasks::Context::entities, DUNE::Tasks::Task::getSystemId(), Transports::LoggingDigest::Arguments::log_folder, logMessage(), Transports::LoggingDigest::Arguments::lsf_name, m_args, DUNE::Tasks::Task::m_ctx, m_log, and stopLog().

Referenced by consume().

void Transports::LoggingDigest::Task::stopLog ( void  )

inline

References m_log.

Referenced by consume(), startLog(), and ~Task().

void Transports::LoggingDigest::Task::writeSample ( void  )

inline

References logMessage(), m_log, m_messages, m_sample_timer, DUNE::Time::Counter< T >::overflow(), and DUNE::Time::Counter< T >::reset().

Referenced by onMain().

Member Data Documentation

Arguments Transports::LoggingDigest::Task::m_args

Task arguments.

Referenced by onUpdateParameters(), startLog(), and Task().

ByteBuffer Transports::LoggingDigest::Task::m_buffer

Serialization buffer.

Referenced by logMessage().

Counter<double> Transports::LoggingDigest::Task::m_flush_timer

Flush timer.

Referenced by flush(), and onUpdateParameters().

Compression::FileOutput* Transports::LoggingDigest::Task::m_log

Log file.

Referenced by consume(), flush(), logMessage(), startLog(), stopLog(), and writeSample().

std::map<uint32_t, IMC::Message*> Transports::LoggingDigest::Task::m_messages

Map of messages.

Referenced by consume(), writeSample(), and ~Task().

Counter<double> Transports::LoggingDigest::Task::m_sample_timer

Sampling timer.

Referenced by onUpdateParameters(), and writeSample().

Collaboration diagram for Transports::LoggingDigest::Task: