Logging record adapter with a streaming capability. More...

#include <record_ostream.hpp>

Inheritance diagram for boost::basic_record_ostream< CharT >:

Collaboration diagram for boost::basic_record_ostream< CharT >:

Public Types
typedef CharT	char_type
	Character type. More...

typedef std::basic_string < char_type >	string_type
	String type to be used as a message text holder. More...

typedef std::basic_ostream < char_type >	stream_type
	Stream type. More...

typedef TraitsT	traits_type
	Character traits. More...

typedef AllocatorT	allocator_type
	Memory allocator. More...

typedef boost::log::aux::basic_ostringstreambuf < char_type, traits_type, allocator_type >	streambuf_type
	Stream buffer type. More...

typedef std::basic_ostream < char_type, traits_type >	ostream_type
	Stream type. More...

typedef ostream_type::pos_type	pos_type
	Stream position type. More...

typedef ostream_type::off_type	off_type
	Stream offset type. More...

typedef ostream_type::int_type	int_type
	Integer type for characters. More...

typedef ostream_type::failure	failure

typedef ostream_type::fmtflags	fmtflags

typedef ostream_type::iostate	iostate

typedef ostream_type::openmode	openmode

typedef ostream_type::seekdir	seekdir

typedef ostream_type::Init	Init

typedef ostream_type::event	event

typedef ostream_type::event_callback	event_callback

Public Member Functions
	basic_record_ostream () BOOST_NOEXCEPT
	Default constructor. More...

	basic_record_ostream (record &rec)
	Constructor from a record object. More...

	~basic_record_ostream () BOOST_NOEXCEPT
	Destructor. More...

bool	operator! () const BOOST_NOEXCEPT
	Conversion to an unspecified boolean type. More...

record &	get_record ()
	Flushes internal buffers to complete all pending formatting operations and returns the aggregated log record. More...

record const &	get_record () const
	Flushes internal buffers to complete all pending formatting operations and returns the aggregated log record. More...

void	attach_record (record &rec)
	If the stream is attached to a log record, flushes internal buffers to complete all pending formatting operations. More...

BOOST_LOG_API void	detach_from_record () BOOST_NOEXCEPT
	The function resets the stream into a detached (default initialized) state. More...

void	attach (string_type &str)
	Attaches the stream to the string. More...

void	detach ()
	Detaches the stream from the string. More...

string_type const &	str () const

ostream_type &	stream ()

ostream_type const &	stream () const

fmtflags	flags () const

fmtflags	flags (fmtflags f)

fmtflags	setf (fmtflags f)

fmtflags	setf (fmtflags f, fmtflags mask)

void	unsetf (fmtflags f)

std::streamsize	precision () const

std::streamsize	precision (std::streamsize p)

std::streamsize	width () const

std::streamsize	width (std::streamsize w)

std::locale	getloc () const

std::locale	imbue (std::locale const &loc)

long &	iword (int index)

void *&	pword (int index)

void	register_callback (event_callback fn, int index)

iostate	rdstate () const

void	clear (iostate state=goodbit)

void	setstate (iostate state)

bool	good () const

bool	eof () const

bool	fail () const

bool	bad () const

iostate	exceptions () const

void	exceptions (iostate s)

ostream_type *	tie () const

ostream_type *	tie (ostream_type *strm)

streambuf_type *	rdbuf () const

basic_formatting_ostream &	copyfmt (std::basic_ios< char_type, traits_type > &rhs)

basic_formatting_ostream &	copyfmt (basic_formatting_ostream &rhs)

char_type	fill () const

char_type	fill (char_type ch)

char	narrow (char_type ch, char def) const

char_type	widen (char ch) const

basic_formatting_ostream &	flush ()

pos_type	tellp ()

basic_formatting_ostream &	seekp (pos_type pos)

basic_formatting_ostream &	seekp (off_type off, std::ios_base::seekdir dir)

basic_formatting_ostream &	put (char_type c)

aux::enable_if_char_type < OtherCharT, basic_formatting_ostream & > ::type	put (OtherCharT c)

basic_formatting_ostream &	write (const char_type *p, std::streamsize size)

aux::enable_if_char_type < OtherCharT, basic_formatting_ostream & > ::type	write (const OtherCharT *p, std::streamsize size)

basic_formatting_ostream &	operator<< (ios_base_manip manip)

basic_formatting_ostream &	operator<< (basic_ios_manip manip)

basic_formatting_ostream &	operator<< (stream_manip manip)

basic_formatting_ostream &	operator<< (char c)

basic_formatting_ostream &	operator<< (const char *p)

basic_formatting_ostream &	operator<< (wchar_t c)

basic_formatting_ostream &	operator<< (const wchar_t *p)

basic_formatting_ostream &	operator<< (char16_t c)

basic_formatting_ostream &	operator<< (const char16_t *p)

basic_formatting_ostream &	operator<< (char32_t c)

basic_formatting_ostream &	operator<< (const char32_t *p)

basic_formatting_ostream &	operator<< (bool value)

basic_formatting_ostream &	operator<< (signed char value)

basic_formatting_ostream &	operator<< (unsigned char value)

basic_formatting_ostream &	operator<< (short value)

basic_formatting_ostream &	operator<< (unsigned short value)

basic_formatting_ostream &	operator<< (int value)

basic_formatting_ostream &	operator<< (unsigned int value)

basic_formatting_ostream &	operator<< (long value)

basic_formatting_ostream &	operator<< (unsigned long value)

basic_formatting_ostream &	operator<< (long long value)

basic_formatting_ostream &	operator<< (unsigned long long value)

basic_formatting_ostream &	operator<< (float value)

basic_formatting_ostream &	operator<< (double value)

basic_formatting_ostream &	operator<< (long double value)

basic_formatting_ostream &	operator<< (const void *value)

basic_formatting_ostream &	operator<< (std::basic_streambuf< char_type, traits_type > *buf)

Static Public Member Functions
static int	xalloc ()

static bool	sync_with_stdio (bool sync=true)

Static Public Attributes
static BOOST_CONSTEXPR_OR_CONST fmtflags	boolalpha

static BOOST_CONSTEXPR_OR_CONST fmtflags	dec

static BOOST_CONSTEXPR_OR_CONST fmtflags	fixed

static BOOST_CONSTEXPR_OR_CONST fmtflags	hex

static BOOST_CONSTEXPR_OR_CONST fmtflags	internal

static BOOST_CONSTEXPR_OR_CONST fmtflags	left

static BOOST_CONSTEXPR_OR_CONST fmtflags	oct

static BOOST_CONSTEXPR_OR_CONST fmtflags	right

static BOOST_CONSTEXPR_OR_CONST fmtflags	scientific

static BOOST_CONSTEXPR_OR_CONST fmtflags	showbase

static BOOST_CONSTEXPR_OR_CONST fmtflags	showpoint

static BOOST_CONSTEXPR_OR_CONST fmtflags	skipws

static BOOST_CONSTEXPR_OR_CONST fmtflags	unitbuf

static BOOST_CONSTEXPR_OR_CONST fmtflags	uppercase

static BOOST_CONSTEXPR_OR_CONST fmtflags	adjustfield

static BOOST_CONSTEXPR_OR_CONST fmtflags	basefield

static BOOST_CONSTEXPR_OR_CONST fmtflags	floatfield

static BOOST_CONSTEXPR_OR_CONST iostate	badbit

static BOOST_CONSTEXPR_OR_CONST iostate	eofbit

static BOOST_CONSTEXPR_OR_CONST iostate	failbit

static BOOST_CONSTEXPR_OR_CONST iostate	goodbit

static BOOST_CONSTEXPR_OR_CONST openmode	app

static BOOST_CONSTEXPR_OR_CONST openmode	ate

static BOOST_CONSTEXPR_OR_CONST openmode	binary

static BOOST_CONSTEXPR_OR_CONST openmode	in

static BOOST_CONSTEXPR_OR_CONST openmode	out

static BOOST_CONSTEXPR_OR_CONST openmode	trunc

static BOOST_CONSTEXPR_OR_CONST seekdir	beg

static BOOST_CONSTEXPR_OR_CONST seekdir	cur

static BOOST_CONSTEXPR_OR_CONST seekdir	end

static BOOST_CONSTEXPR_OR_CONST event	erase_event

static BOOST_CONSTEXPR_OR_CONST event	imbue_event

static BOOST_CONSTEXPR_OR_CONST event	copyfmt_event

Detailed Description

template<typename CharT>
class boost::basic_record_ostream< CharT >

Logging record adapter with a streaming capability.

This class allows to compose the logging record message by streaming operations. It aggregates the log record and provides the standard output stream interface.

Member Typedef Documentation

typedef AllocatorT boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::allocator_type

inherited

Memory allocator.

template<typename CharT>

typedef CharT boost::basic_record_ostream< CharT >::char_type

Character type.

typedef ostream_type::event boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::event

inherited

typedef ostream_type::event_callback boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::event_callback

inherited

typedef ostream_type::failure boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::failure

inherited

typedef ostream_type::fmtflags boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::fmtflags

inherited

typedef ostream_type::Init boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::Init

inherited

typedef ostream_type::int_type boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::int_type

inherited

Integer type for characters.

typedef ostream_type::iostate boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::iostate

inherited

typedef ostream_type::off_type boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::off_type

inherited

Stream offset type.

typedef ostream_type::openmode boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::openmode

inherited

typedef std::basic_ostream< char_type, traits_type > boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::ostream_type

inherited

Stream type.

typedef ostream_type::pos_type boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::pos_type

inherited

Stream position type.

typedef ostream_type::seekdir boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::seekdir

inherited

template<typename CharT>

typedef std::basic_ostream< char_type > boost::basic_record_ostream< CharT >::stream_type

Stream type.

typedef boost::log::aux::basic_ostringstreambuf< char_type, traits_type, allocator_type > boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::streambuf_type

inherited

Stream buffer type.

template<typename CharT>

typedef std::basic_string< char_type > boost::basic_record_ostream< CharT >::string_type

String type to be used as a message text holder.

typedef TraitsT boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::traits_type

inherited

Character traits.

Constructor & Destructor Documentation

template<typename CharT>

boost::basic_record_ostream< CharT >::basic_record_ostream ( )

inline

Default constructor.

Creates an empty record that is equivalent to the invalid record handle. The stream capability is not available after construction.

Postcondition: !*this == true

template<typename CharT>

boost::basic_record_ostream< CharT >::basic_record_ostream ( record & rec )

inlineexplicit

Constructor from a record object.

Attaches to the provided record.

Precondition: !!rec == true

Postcondition: &this->get_record() == &rec

Parameters

rec	The record handle being attached to

template<typename CharT>

boost::basic_record_ostream< CharT >::~basic_record_ostream ( )

inline

Destructor.

Destroys the record, releases any sinks and attribute values that were involved in processing this record.

Member Function Documentation

void boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::attach ( string_type & str )

inlineinherited

Attaches the stream to the string.

The string will be used to store the formatted characters.

Parameters

str	The string buffer to attach.

template<typename CharT>

void boost::basic_record_ostream< CharT >::attach_record ( record & rec )

inline

If the stream is attached to a log record, flushes internal buffers to complete all pending formatting operations.

Then reattaches the stream to another log record.

Parameters

rec	New log record to attach to

bool boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::bad ( ) const

inlineinherited

void boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::clear ( iostate state = goodbit )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::copyfmt ( std::basic_ios< char_type, traits_type > & rhs )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::copyfmt ( basic_formatting_ostream< CharT > & rhs )

inlineinherited

void boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::detach ( )

inlineinherited

Detaches the stream from the string.

Any buffered data is flushed to the string.

template<typename CharT>

BOOST_LOG_API void boost::basic_record_ostream< CharT >::detach_from_record ( )

The function resets the stream into a detached (default initialized) state.

Referenced by boost::basic_record_ostream< char_type >::attach_record(), and boost::basic_record_ostream< char_type >::~basic_record_ostream().

bool boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::eof ( ) const

inlineinherited

iostate boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::exceptions ( ) const

inlineinherited

void boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::exceptions ( iostate s )

inlineinherited

bool boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::fail ( ) const

inlineinherited

Referenced by boost::basic_record_ostream< char_type >::operator!().

char_type boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::fill ( ) const

inlineinherited

char_type boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::fill ( char_type ch )

inlineinherited

fmtflags boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::flags ( ) const

inlineinherited

fmtflags boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::flags ( fmtflags f )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::flush ( )

inlineinherited

Referenced by boost::basic_record_ostream< char_type >::get_record().

template<typename CharT>

record& boost::basic_record_ostream< CharT >::get_record ( )

inline

Flushes internal buffers to complete all pending formatting operations and returns the aggregated log record.

Returns: The aggregated record object

Referenced by boost::operator<<(), and boost::aux::record_pump< LoggerT >::~record_pump().

template<typename CharT>

record const& boost::basic_record_ostream< CharT >::get_record ( ) const

inline

Flushes internal buffers to complete all pending formatting operations and returns the aggregated log record.

Returns: The aggregated record object

std::locale boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::getloc ( ) const

inlineinherited

bool boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::good ( ) const

inlineinherited

std::locale boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::imbue ( std::locale const & loc )

inlineinherited

long& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::iword ( int index )

inlineinherited

char boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::narrow	(	char_type	ch,
		char	def
	)		const

inlineinherited

template<typename CharT>

bool boost::basic_record_ostream< CharT >::operator! ( ) const

inline

Conversion to an unspecified boolean type.

Returns: true, if stream is valid and ready for formatting, false, if the stream is not valid. The latter also applies to the case when the stream is not attached to a log record.

Inverted conversion to an unspecified boolean type

Returns: false, if stream is valid and ready for formatting, true, if the stream is not valid. The latter also applies to the case when the stream is not attached to a log record.

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( ios_base_manip manip )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( basic_ios_manip manip )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( stream_manip manip )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( char c )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( const char * p )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( wchar_t c )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( const wchar_t * p )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( char16_t c )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( const char16_t * p )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( char32_t c )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( const char32_t * p )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( bool value )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( signed char value )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( unsigned char value )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( short value )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( unsigned short value )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( int value )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( unsigned int value )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( long value )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( unsigned long value )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( long long value )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( unsigned long long value )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( float value )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( double value )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( long double value )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( const void * value )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::operator<< ( std::basic_streambuf< char_type, traits_type > * buf )

inlineinherited

std::streamsize boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::precision ( ) const

inlineinherited

std::streamsize boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::precision ( std::streamsize p )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::put ( char_type c )

inlineinherited

aux::enable_if_char_type< OtherCharT, basic_formatting_ostream& >::type boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::put ( OtherCharT c )

inlineinherited

void*& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::pword ( int index )

inlineinherited

streambuf_type* boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::rdbuf ( ) const

inlineinherited

iostate boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::rdstate ( ) const

inlineinherited

void boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::register_callback	(	event_callback	fn,
		int	index
	)

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::seekp ( pos_type pos )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::seekp	(	off_type	off,
		std::ios_base::seekdir	dir
	)

inlineinherited

fmtflags boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::setf ( fmtflags f )

inlineinherited

fmtflags boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::setf	(	fmtflags	f,
		fmtflags	mask
	)

inlineinherited

void boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::setstate ( iostate state )

inlineinherited

string_type const& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::str ( ) const

inlineinherited

Returns: Reference to the attached string. The string must be attached before calling this method.

ostream_type& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::stream ( )

inlineinherited

Returns: Reference to the wrapped stream

ostream_type const& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::stream ( ) const

inlineinherited

Returns: Reference to the wrapped stream

static bool boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::sync_with_stdio ( bool sync = true )

inlinestaticinherited

pos_type boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::tellp ( )

inlineinherited

ostream_type* boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::tie ( ) const

inlineinherited

ostream_type* boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::tie ( ostream_type * strm )

inlineinherited

void boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::unsetf ( fmtflags f )

inlineinherited

char_type boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::widen ( char ch ) const

inlineinherited

std::streamsize boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::width ( ) const

inlineinherited

std::streamsize boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::width ( std::streamsize w )

inlineinherited

basic_formatting_ostream& boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::write	(	const char_type *	p,
		std::streamsize	size
	)

inlineinherited

aux::enable_if_char_type< OtherCharT, basic_formatting_ostream& >::type boost::basic_formatting_ostream< CharT, TraitsT, AllocatorT >::write	(	const OtherCharT *	p,
		std::streamsize	size
	)