boost::logging::destination Namespace Reference

Destination is a manipulator. It contains a place where the message, after being formatted, is to be written to. More...


Classes

struct  msg_type
 what is the default type of your string, in destination_base ? See BOOST_LOG_DESTINATION_MSG More...
struct  base
 What to use as base class, for your destination classes. More...
struct  class_
 Use this when implementing your own destination class. More...
struct  cout_t
 Writes the string to console. More...
struct  cerr_t
 Writes the string to cerr. More...
struct  stream_t
 writes to stream. More...
struct  dbg_window_t
 Writes the string to output debug window. More...
struct  file_settings
 settings for when constructing a file class. To see how it's used, see Dealing with flags.. More...
struct  file_t
 Writes the string to a file. More...
struct  named_t
 Allows you to contain multiple destinations, give each such destination a name. Then, at run-time, you can specify a format string which will specify which destinations to be called, and on what order. More...
struct  rolling_file_settings
 Settings you can pass to the rolling file. To see how it's used, see Dealing with flags.. More...
struct  rolling_file_t
 Writes to multiple files: name_prefix.1, name_prefix.2, ... name_prefix.N, and then restarts from 1. More...

Namespaces

namespace  convert
 Allows writing messages to destinations.

Typedefs

typedef
boost::logging::manipulator::implement_op_equal 
implement_op_equal
typedef
boost::logging::manipulator::is_generic 
is_generic
typedef cout_t cout
 cout_t with default values. See cout_t
typedef cerr_t cerr
 cerr_t with default values. See cerr_t
typedef stream_t stream
 stream_t with default values. See stream_t
typedef dbg_window_t dbg_window
 dbg_window_t with default values. See dbg_window_t
typedef file_t file
 file_t with default values. See file_t
typedef named_t named
 named_t with default values. See named_t
typedef rolling_file_t rolling_file
 rolling_file_t with default values. See rolling_file_t


Detailed Description

Destination is a manipulator. It contains a place where the message, after being formatted, is to be written to.

Some viable destinations are : the console, a file, a socket, etc.

See:


Typedef Documentation

typedef cerr_t boost::logging::destination::cerr

cerr_t with default values. See cerr_t

Writes the string to cerr.

typedef cout_t boost::logging::destination::cout

cout_t with default values. See cout_t

Writes the string to console.

typedef dbg_window_t boost::logging::destination::dbg_window

dbg_window_t with default values. See dbg_window_t

Writes the string to output debug window.

For non-Windows systems, this is the console.

typedef file_t boost::logging::destination::file

file_t with default values. See file_t

Writes the string to a file.

typedef boost::logging::manipulator::implement_op_equal boost::logging::destination::implement_op_equal

See also:
boost::logging::manipulator::implement_op_equal

typedef boost::logging::manipulator::is_generic boost::logging::destination::is_generic

See also:
boost::logging::manipulator::is_generic

typedef named_t boost::logging::destination::named

named_t with default values. See named_t

Allows you to contain multiple destinations, give each such destination a name. Then, at run-time, you can specify a format string which will specify which destinations to be called, and on what order.

This allows you:

The format string contains destination names, separated by space.

When a message is written to this destination, I parse the format string. When a name is encountered, if there's a destination corresponding to this name, I will call it.

Example:

g_l()->writer().add_destination( 
    destination::named("cout out debug")
        .add( "cout", destination::cout())
        .add( "debug", destination::dbg_window() )
        .add( "out", destination::file("out.txt"))
     );

In the above code, we'll write to 3 destinations, in the following order:

typedef rolling_file_t boost::logging::destination::rolling_file

rolling_file_t with default values. See rolling_file_t

Writes to multiple files: name_prefix.1, name_prefix.2, ... name_prefix.N, and then restarts from 1.

We first write to name_prefix.1.

The log has a max_size. When max_size is reached, we start writing to name_prefix.2. When max_size is reached, we start writing to name_prefix.3. And so on, until we reach name_prefix.N (N = file_count). When that gets fool, we start over, with name_prefix.1.

typedef stream_t boost::logging::destination::stream

stream_t with default values. See stream_t

writes to stream.

Note:
: The stream must outlive this object! Or, clear() the stream, before the stream is deleted.



Copyright John Torjo © 2007
Have a question/ suggestion/ comment? Send me feedback