Rogue Wave web site:  Home Page  |  Main Documentation Page

rwsf::LogMessage Class Reference
[Core Logging]

Constructs log messages, provides insertion operators for basic types, and can be extended to support user-defined types as well. More...

#include <rwsf/core/LogMessage.h>

List of all members.

Public Member Functions
	LogMessage ()
virtual std::string	str () const
void	append (const std::string &str)
Related Functions
(Note that these are not member functions.)
rwsf::LogMessage &	operator<< (rwsf::LogMessage &, bool)
rwsf::LogMessage &	operator<< (rwsf::LogMessage &, char)
rwsf::LogMessage &	operator<< (rwsf::LogMessage &, unsigned char)
rwsf::LogMessage &	operator<< (rwsf::LogMessage &, short)
rwsf::LogMessage &	operator<< (rwsf::LogMessage &, int)
rwsf::LogMessage &	operator<< (rwsf::LogMessage &, long)
rwsf::LogMessage &	operator<< (rwsf::LogMessage &, float)
rwsf::LogMessage &	operator<< (rwsf::LogMessage &, double)
rwsf::LogMessage &	operator<< (rwsf::LogMessage &, const char *)
rwsf::LogMessage &	operator<< (rwsf::LogMessage &, const std::string &)

---

Detailed Description

rwsf::LogMessage is a utility class for constructing log messages. LogMessage provides insertion operators for basic types, and can be extended to support user-defined types as well.

Note:

For more information on the Agent logger, see the logging chapter in the User Guide.

The following example demonstrates how to create a simple message and insert a basic data type:

   int logType = 0;
   rwsf::Logger logger = rwsf::LogManager()::getLogger();
   rwsf::LogMessage msg;
   msg << "This is a " << logType << "-type logger.";
   msg.append("\n");
   logger.info(msg);

---

Constructor & Destructor Documentation

rwsf::LogMessage::LogMessage

(

)

Default constructor. Creates a blank message.

---

Member Function Documentation

void rwsf::LogMessage::append

(

const std::string &

str

)

Appends text to the log message.

virtual std::string rwsf::LogMessage::str

(

)

const [virtual]

Returns the prepared message as a string.

---

Friends And Related Function Documentation

rwsf::LogMessage & operator<<	(	rwsf::LogMessage &	,
		const std::string &
	)			[related]

Insertion operator for appending to a LogMessage instance.

rwsf::LogMessage & operator<<	(	rwsf::LogMessage &	,
		const char *
	)			[related]

Insertion operator for appending to a LogMessage instance.

rwsf::LogMessage & operator<<	(	rwsf::LogMessage &	,
		double
	)			[related]

Insertion operator for appending to a LogMessage instance.

rwsf::LogMessage & operator<<	(	rwsf::LogMessage &	,
		float
	)			[related]

Insertion operator for appending to a LogMessage instance.

rwsf::LogMessage & operator<<	(	rwsf::LogMessage &	,
		long
	)			[related]

Insertion operator for appending to a LogMessage instance.

rwsf::LogMessage & operator<<	(	rwsf::LogMessage &	,
		int
	)			[related]

Insertion operator for appending to a LogMessage instance.

rwsf::LogMessage & operator<<	(	rwsf::LogMessage &	,
		short
	)			[related]

Insertion operator for appending to a LogMessage instance.

rwsf::LogMessage & operator<<	(	rwsf::LogMessage &	,
		unsigned	char
	)			[related]

Insertion operator for appending to a LogMessage instance.

rwsf::LogMessage & operator<<	(	rwsf::LogMessage &	,
		char
	)			[related]

Insertion operator for appending to a LogMessage instance.

rwsf::LogMessage & operator<<	(	rwsf::LogMessage &	,
		bool
	)			[related]

Insertion operator for appending to a LogMessage instance.