LogWriter Class Reference

Base class for a generalized set of "log data destinations," including to files (text or binary), over communications links, etc. More...

#include <LogWriter.h>

Inheritance diagram for LogWriter:

Collaboration diagram for LogWriter:

Public Types
enum	ServiceType {   NO_SERVICE = -1, SERVICE_COURIER, SERVICE_EXPRESS, SERVICE_PRIORITY,   SERVICE_NORMAL, SERVICE_BULK, SERVICE_COUNT, SERVICE_MULTI }

Public Member Functions
virtual	~LogWriter ()
	Destructor. More...
virtual unsigned int	writeHeader ()
	Write the log header, if any. More...
virtual void	setOutStream (OutStream &outStream)
	Sets the OutStream. More...
virtual bool	isValid ()
	Return true if logStream_ is available. More...
virtual unsigned int	write (const LogEntry *entry, const Unit *unit=NULL)=0
	Write the given LogEntry - should lock the writeMutex_. More...
virtual void	endCycle ()
	Do what needs to be done at the end of the cycle. More...
virtual unsigned int	writeFooter ()
	Write the log footer, if any. More...
virtual void	config (Logger &logger)
	Configure from a config file. More...
virtual void	resetInputs ()
	Reset cached input settings. More...
void	addParent ()
void	removeParent ()
int	getParentCount ()
virtual void	activate ()
virtual void	deactivate ()
virtual bool	isActive ()
virtual void	lockWrites ()
virtual void	unlockWrites ()

Static Public Member Functions
static ServiceType	Str2ServiceType (const char *const serviceTypeStr, int len=-1)
static const char *	ServiceType2Str (LogWriter::ServiceType serviceType)
static size_t	ServiceType2Strlen (LogWriter::ServiceType serviceType)

Static Public Attributes
static const char *const	SERVICE_TYPE_STRS [SERVICE_COUNT]
static size_t const	SERVICE_TYPE_STRLEN [SERVICE_COUNT]

Protected Member Functions
	LogWriter ()
	Protected constructor for pure virtual class. More...
	LogWriter (OutStream &outStream)
	Protected constructor for pure virtual class. More...

Protected Attributes
OutStream *	logStream_
	Stores an OutStream. More...
bool	wroteHeader_
bool	wroteFooter_
Mutex	writeMutex_
int	parentCount_
bool	active_

Private Member Functions
	LogWriter (const LogWriter &old)

Detailed Description

Base class for a generalized set of "log data destinations," including to files (text or binary), over communications links, etc.

Constructor & Destructor Documentation

LogWriter::~LogWriter ( )

virtual

Destructor.

References writeFooter(), and wroteFooter_.

LogWriter::LogWriter ( )

protected

Protected constructor for pure virtual class.

Constructor.

LogWriter::LogWriter ( OutStream &  outStream )

protected

Protected constructor for pure virtual class.

Constructor.

LogWriter::LogWriter ( const LogWriter &  old )

private

Member Function Documentation

virtual void LogWriter::activate ( )

inlinevirtual

References active_.

void LogWriter::addParent ( )

inline

References parentCount_.

Referenced by FileLogWriter::FileLogWriter(), FilterLogWriter::FilterLogWriter(), LogAssociation::LogAssociation(), and TableLogWriter::TableLogWriter().

virtual void LogWriter::config ( Logger &  logger )

inlinevirtual

Configure from a config file.

Reimplemented in LinearApproxLogWriter, FilterLogWriter, and LinearApproximationLogWriter.

Referenced by FilterLogWriter::config(), LinearApproximationLogWriter::config(), LinearApproxLogWriter::config(), and LogAssociation::configLogWriter().

virtual void LogWriter::deactivate ( )

inlinevirtual

References active_.

virtual void LogWriter::endCycle ( )

inlinevirtual

Do what needs to be done at the end of the cycle.

Reimplemented in FileLogWriter, LinearApproxLogWriter, LinearApproximationLogWriter, FilterLogWriter, AllLogWriter, and MostRecentLogWriter.

Referenced by LogAssociation::endCycle(), AllLogWriter::endCycle(), MostRecentLogWriter::endCycle(), FilterLogWriter::endCycle(), LinearApproximationLogWriter::endCycle(), and LinearApproxLogWriter::endCycle().

int LogWriter::getParentCount ( )

inline

References parentCount_.

Referenced by FileLogWriter::~FileLogWriter(), FilterLogWriter::~FilterLogWriter(), LogAssociation::~LogAssociation(), and TableLogWriter::~TableLogWriter().

virtual bool LogWriter::isActive ( void  )

inlinevirtual

References active_.

Referenced by MultiLogWriter::flush(), and LogAssociation::matchAndProcess().

bool LogWriter::isValid ( void  )

virtual

Return true if logStream_ is available.

References OutStream::isWritable(), and logStream_.

Referenced by KmlLogWriter::write(), TextLogWriter::write(), KmlLogWriter::writeFooter(), TextTableLogWriter::writeHeader(), KmlLogWriter::writeHeader(), and TextTableLogWriter::writeRow().

virtual void LogWriter::lockWrites ( )

inlinevirtual

References Mutex::lock(), and writeMutex_.

Referenced by DecimationLogManager::lockWrites(), SplitFileLogWriter::resetFileBase(), and Supervisor::RestartLogs().

void LogWriter::removeParent ( )

inline

References parentCount_.

Referenced by FileLogWriter::~FileLogWriter(), FilterLogWriter::~FilterLogWriter(), LogAssociation::~LogAssociation(), and TableLogWriter::~TableLogWriter().

virtual void LogWriter::resetInputs ( )

inlinevirtual

Reset cached input settings.

Reimplemented in FilterLogWriter, FileLogWriter, and TableLogWriter.

Referenced by LogAssociation::resetInputs(), TableLogWriter::resetInputs(), FileLogWriter::resetInputs(), and FilterLogWriter::resetInputs().

const char * LogWriter::ServiceType2Str ( LogWriter::ServiceType  serviceType )

static

References SERVICE_COUNT, and SERVICE_TYPE_STRS.

Referenced by CommandLine::commandConfigSet(), CommandLine::commandRetransmit(), DecimationLogManager::configLog(), Supervisor::FilterCourier(), Supervisor::FilterCourierLzma(), Supervisor::FilterExpress(), Supervisor::FilterExpressLzma(), Supervisor::FilterNormal(), Supervisor::FilterNormalLzma(), Supervisor::FilterPriority(), Supervisor::FilterPriorityLzma(), DecimationLogManager::getFileWriter(), DecimationLogManager::resetDirectoryEntries(), DecimationLogManager::resetFileBases(), and ParsedCommand::toString().

size_t LogWriter::ServiceType2Strlen ( LogWriter::ServiceType  serviceType )

static

References SERVICE_COUNT, and SERVICE_TYPE_STRLEN.

Referenced by Supervisor::FilterCourier(), Supervisor::FilterCourierLzma(), Supervisor::FilterExpress(), Supervisor::FilterExpressLzma(), Supervisor::FilterNormal(), Supervisor::FilterNormalLzma(), Supervisor::FilterPriority(), and Supervisor::FilterPriorityLzma().

void LogWriter::setOutStream ( OutStream &  outStream )

virtual

Sets the OutStream.

References logStream_.

Referenced by FileLogWriter::FileLogWriter().

LogWriter::ServiceType LogWriter::Str2ServiceType ( const char *const  serviceTypeStr, int  len = -1  )

static

References AuvMath::Min(), NO_SERVICE, SERVICE_COUNT, SERVICE_MULTI, SERVICE_TYPE_STRLEN, and SERVICE_TYPE_STRS.

Referenced by SendDataComponent::Instance(), ParsedCommand::matchServiceType(), and Config::ParseLine().

virtual void LogWriter::unlockWrites ( )

inlinevirtual

References Mutex::unlock(), and writeMutex_.

Referenced by SplitFileLogWriter::resetFileBase(), Supervisor::RestartLogs(), and DecimationLogManager::unlockWrites().

virtual unsigned int LogWriter::write ( const LogEntry *  entry, const Unit *  unit = NULL  )

pure virtual

Write the given LogEntry - should lock the writeMutex_.

Implemented in FileLogWriter, SplitFileLogWriter, BinaryLogWriter, LinearApproxLogWriter, TextLogWriter, HDF5LogWriter, NetCdfLogWriter, NetCdfTableLogWriter, FilterLogWriter, TableLogWriter, JsonLogWriter, MultiLogWriter, DirectoryManagingLogWriter, KmlLogWriter, AllLogWriter, and MostRecentLogWriter.

Referenced by MultiLogWriter::forceWrite(), LinearApproximationLogWriter::forceWrite(), LogAssociation::matchAndProcess(), LinearApproximationLogWriter::sendOutput(), LinearApproxLogWriter::sendOutput(), AllLogWriter::write(), MultiLogWriter::write(), FileLogWriter::write(), FilterLogWriter::writeCycleStart(), DirectoryManagingLogWriter::writeData(), FilterLogWriter::writeData(), Slate::WriteDataAccessEntry(), Slate::WriteElementURIEntry(), MostRecentLogWriter::writeFooter(), Slate::WriteNameEntry(), TableLogWriter::writeRow(), LinearApproximationLogWriter::writeRow(), DirectoryManagingLogWriter::writeSyslog(), MultiLogWriter::writeSyslog(), TableLogWriter::writeSyslog(), LinearApproximationLogWriter::writeSyslog(), and TableLogWriter::writeToColumn().

virtual unsigned int LogWriter::writeFooter ( )

inlinevirtual

Write the log footer, if any.

Reimplemented in FilterLogWriter, LinearApproxLogWriter, LinearApproximationLogWriter, HDF5LogWriter, NetCdfLogWriter, NetCdfTableLogWriter, TableLogWriter, JsonLogWriter, MultiLogWriter, KmlLogWriter, TextTableLogWriter, AllLogWriter, MostRecentLogWriter, and DirectoryManagingLogWriter.

Referenced by FileLogWriter::close(), SplitFileLogWriter::resetFileBase(), DirectoryManagingLogWriter::writeFooter(), AllLogWriter::writeFooter(), LogAssociation::writeFooter(), MultiLogWriter::writeFooter(), TableLogWriter::writeFooter(), ~LogWriter(), and TableLogWriter::~TableLogWriter().

virtual unsigned int LogWriter::writeHeader ( )

inlinevirtual

Write the log header, if any.

Reimplemented in LinearApproxLogWriter, LinearApproximationLogWriter, TableLogWriter, TextLogWriter, BinaryLogWriter, FilterLogWriter, HDF5LogWriter, NetCdfLogWriter, NetCdfTableLogWriter, JsonLogWriter, KmlLogWriter, MultiLogWriter, TextTableLogWriter, DirectoryManagingLogWriter, DirectoryLogWriter, AllLogWriter, and MostRecentLogWriter.

Referenced by FileLogWriter::FileLogWriter(), FileLogWriter::open(), AllLogWriter::writeHeader(), MostRecentLogWriter::writeHeader(), DirectoryManagingLogWriter::writeHeader(), MultiLogWriter::writeHeader(), TableLogWriter::writeHeader(), LinearApproximationLogWriter::writeHeader(), and LinearApproxLogWriter::writeHeader().

Member Data Documentation

bool LogWriter::active_

protected

Referenced by activate(), deactivate(), and isActive().

OutStream* LogWriter::logStream_

protected

Stores an OutStream.

Referenced by isValid(), setOutStream(), KmlLogWriter::write(), TextLogWriter::write(), BinaryLogWriter::write(), KmlLogWriter::writeFooter(), JsonLogWriter::writeFooter(), TextTableLogWriter::writeHeader(), KmlLogWriter::writeHeader(), BinaryLogWriter::writeHeader(), TextLogWriter::writeHeader(), TextTableLogWriter::writeRow(), and KmlLogWriter::writeSyslogItems().

int LogWriter::parentCount_

protected

Referenced by addParent(), getParentCount(), and removeParent().

const size_t LogWriter::SERVICE_TYPE_STRLEN

static

Initial value:

=
{
    7,
    7,
    8,
    6,
    4,
}

Referenced by ServiceType2Strlen(), and Str2ServiceType().

const char *const LogWriter::SERVICE_TYPE_STRS

static

Initial value:

=
{
    "Courier",
    "Express",
    "Priority",
    "Normal",
    "Bulk",
}

Referenced by ServiceType2Str(), and Str2ServiceType().

Mutex LogWriter::writeMutex_

protected

Referenced by MultiLogWriter::flush(), MultiLogWriter::forceWrite(), lockWrites(), MultiLogWriter::setCurrent(), unlockWrites(), KmlLogWriter::write(), MultiLogWriter::write(), TableLogWriter::write(), FilterLogWriter::write(), TextLogWriter::write(), BinaryLogWriter::write(), FileLogWriter::write(), and MultiLogWriter::writeSyslog().

bool LogWriter::wroteFooter_

protected

Referenced by FileLogWriter::open(), TextTableLogWriter::writeFooter(), KmlLogWriter::writeFooter(), JsonLogWriter::writeFooter(), NetCdfLogWriter::writeFooter(), NetCdfTableLogWriter::writeFooter(), HDF5LogWriter::writeFooter(), FilterLogWriter::writeFooter(), KmlLogWriter::writeHeader(), LinearApproximationLogWriter::~LinearApproximationLogWriter(), LinearApproxLogWriter::~LinearApproxLogWriter(), and ~LogWriter().

bool LogWriter::wroteHeader_

protected

Referenced by KmlLogWriter::writeFooter(), MostRecentLogWriter::writeHeader(), AllLogWriter::writeHeader(), MultiLogWriter::writeHeader(), and KmlLogWriter::writeHeader().

---

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

• /Volumes/ubuntu_share/lrauv-application/Source/logger/LogWriter.h
• /Volumes/ubuntu_share/lrauv-application/Source/logger/LogWriter.cpp