ball::Log_Stream Class Reference

#include <ball_log.h>

List of all members.

Public Member Functions
	Log_Stream (const Category *category, const char *fileName, int lineNumber, int severity)
	~Log_Stream () BSLS_KEYWORD_NOEXCEPT_SPECIFICATION(false)
Record *	record ()
bsl::ostream &	stream ()
const Category *	category () const
const Record *	record () const
int	severity () const

---

Detailed Description

This class provides an aggregate of several objects relevant to the logging of a message via the C++ stream-based macros:

      - record to be logged
      - category to which to log the record
      - severity at which to log the record
      - stream to which the user log message is put

As a side-effect of creating an object of this class, the record and stream are also constructed. As a side-effect of destroying the object, the record is logged.

This class should not be used directly by client code. It is an implementation detail of the macros provided by this component.

See Component ball_log

---

Constructor & Destructor Documentation

ball::Log_Stream::Log_Stream	(	const Category *	category,
		const char *	fileName,
		int	lineNumber,
		int	severity
	)

Create a logging stream that holds (1) the specified category and severity, (2) a record that is created from the specified fileName and lineNumber, and (3) an bsl::ostream to which the log message is put.

ball::Log_Stream::~Log_Stream

(

)

Log the record held by this logging stream to the held category (as returned by category) at the held severity (as returned by severity) and destroy this logging stream.

---

Member Function Documentation

Record* ball::Log_Stream::record

(

)

Return the address of the modifiable log record held by this logging stream. The address remains valid until this logging stream is destroyed.

bsl::ostream& ball::Log_Stream::stream

(

)

Return a reference to the modifiable stream held by this logging stream. The reference remains valid until this logging stream is destroyed.

const Category* ball::Log_Stream::category

(

)

const

Return the address of the non-modifiable category held by this logging stream.

const Record* ball::Log_Stream::record

(

)

const

Return the address of the non-modifiable log record held by this logging stream. The address remains valid until this logging stream is destroyed.

int ball::Log_Stream::severity

(

)

const

Return the severity held by this logging stream.

---

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

• ball_log.h