dueca::DUECALogConfig Struct Reference

Configuration message for DUECA logging. More...

#include <DUECALogConfig.hxx>

Public Types
typedef DUECALogConfig	__ThisDCOType__
	typedef for internal reference

Public Member Functions
	DUECALogConfig ()
	default constructor.
	DUECALogConfig (const vstring &filename, const vstring &prefix, const vstring &attribute)
	Constructor with arguments.
	DUECALogConfig (const DUECALogConfig &o)
	copy constructor.
	DUECALogConfig (::dueca::AmorphReStore &r)
	constructor to restore an DUECALogConfig from amorphous storage.
	~DUECALogConfig ()
	destructor.
void	packData (::dueca::AmorphStore &s) const
	packs the DUECALogConfig into amorphous storage.
void	packDataDiff (::dueca::AmorphStore &s, const DUECALogConfig &ref) const
	packs the DUECALogConfig into amorphous storage.
void	unPackData (::dueca::AmorphReStore &s)
	unpacks the DUECALogConfig from an amorphous storage.
void	unPackDataDiff (::dueca::AmorphReStore &s)
	unpacks the differences for DUECALogConfig from an amorphous storage.
bool	operator== (const DUECALogConfig &o) const
	Test for equality.
bool	operator!= (const DUECALogConfig &o) const
	Test for inequality.
DUECALogConfig &	operator= (const DUECALogConfig &o)
	Assignment operator.
std::ostream &	print (std::ostream &s) const
	prints the DUECALogConfig to a stream.

Static Public Member Functions
static void *	operator new (size_t size)
	new operator "new", which places objects not on a heap, but in one of the memory arenas.
static void *	operator new (size_t size, void *mem)
	accompanying placement operator "new"
static void	operator delete (void *p)
	new operator "delete", to go with the new version of operator new.
static void *	operator new (size_t size, DUECALogConfig *&o)
	placement "new", needed for stl.

Public Attributes
vstring	filename
	File name pattern for creating a log, if empty, use previous or default file name.
vstring	prefix
	path prefix for the logging.
vstring	attribute
	attribute string that will be added to the log base point, for additional logging/condition information, if possible with the logger.

Static Public Attributes
static const char *const	classname
	The name of this class.
static const uint32_t	magic_check_number
	a "magic" number, hashed out of the class definition, that will be used to check consistency of the sent objects across the dueca nodes.

Detailed Description

Configuration message for DUECA logging.

When configured to listen to config messages, the Logger will only start logging after such a message has been received.

Possible modes of operation:

• Simply configuring the attribute for the default logging; send one message, with filename and prefix empty, and optionally the attribute string filled. This uses the default filename supplied to the logger, and no prefix.
• Multiple log files; send a message whenever a new log should be started, typically in HoldCurrent mode. When the filename is not empty, a new file is opened using the filename. When the filename is empty, and also the prefix is empty, a new filename is used with the default naming pattern.
• Multiple logs in a single file (if possible with the logger); if the filename is empty, and the prefix is non-empty, the current file is used, and an additional set of logging data is added under the new prefix. The first message sent in this way may also specify the filename.

Member Function Documentation

operator new()

static void * dueca::DUECALogConfig::operator new ( size_t size )

static

new operator "new", which places objects not on a heap, but in one of the memory arenas.

This to speed up memory management.

packDataDiff()

void dueca::DUECALogConfig::packDataDiff	(	::dueca::AmorphStore &	s,
		const DUECALogConfig &	ref ) const

packs the DUECALogConfig into amorphous storage.

only differences with a previous object are packed.

Member Data Documentation

filename

vstring dueca::DUECALogConfig::filename

File name pattern for creating a log, if empty, use previous or default file name.

;; This uses boost::posix_time to fill any patterns with time and/or date information. Possible patterns include Y m d H M S for year, month, day, hour, minute and second, respectively.

prefix

vstring dueca::DUECALogConfig::prefix

path prefix for the logging.

Can be used to log multiple sets in a single file. If empty, no prefix is used

attribute

vstring dueca::DUECALogConfig::attribute

attribute string that will be added to the log base point, for additional logging/condition information, if possible with the logger.

If the prefix is empty, this is attribute is attached to the file root group, otherwise to the chosen prefix.

---

The documentation for this struct was generated from the following file:

• /home/abuild/rpmbuild/BUILD/dueca-4.2.5-build/dueca-4.2.5/redhat-linux-build/dueca/DUECALogConfig.hxx