Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::sources::basic_channel_logger< BaseT, ChannelT > Class Template Reference

Channel feature implementation. More...

#include <channel_feature.hpp>

Inheritance diagram for boost::sources::basic_channel_logger< BaseT, ChannelT >:
Collaboration diagram for boost::sources::basic_channel_logger< BaseT, ChannelT >:

Public Types

typedef base_type::char_type char_type
 Character type. More...
 
typedef base_type::final_type final_type
 Final type. More...
 
typedef base_type::threading_model threading_model
 Threading model being used. More...
 
typedef ChannelT channel_type
 Channel type. More...
 
typedef
attributes::mutable_constant
< channel_type
channel_attribute
 Channel attribute type. More...
 
typedef strictest_lock
< typename
base_type::open_record_lock,
boost::log::aux::exclusive_lock_guard
< threading_model > >::type 
open_record_lock
 Lock requirement for the open_record_unlocked method. More...
 
typedef strictest_lock
< typename
base_type::swap_lock,
boost::log::aux::exclusive_lock_guard
< threading_model > >::type 
swap_lock
 Lock requirement for the swap_unlocked method. More...
 

Public Member Functions

 basic_channel_logger ()
 Default constructor. More...
 
 basic_channel_logger (basic_channel_logger const &that)
 Copy constructor. More...
 
 basic_channel_logger (BOOST_RV_REF(basic_channel_logger) that)
 Move constructor. More...
 
template<typename ArgsT >
 basic_channel_logger (ArgsT const &args)
 Constructor with arguments. More...
 
channel_type channel () const
 The observer of the channel name. More...
 
void channel (channel_type const &ch)
 The setter of the channel name. More...
 

Protected Member Functions

channel_attribute const & get_channel_attribute () const
 Channel attribute accessor. More...
 
template<typename ArgsT >
record open_record_unlocked (ArgsT const &args)
 Unlocked open_record. More...
 
void swap_unlocked (basic_channel_logger &that)
 Unlocked swap. More...
 

Detailed Description

template<typename BaseT, typename ChannelT>
class boost::sources::basic_channel_logger< BaseT, ChannelT >

Channel feature implementation.

Member Typedef Documentation

template<typename BaseT , typename ChannelT >
typedef attributes::mutable_constant< channel_type > boost::sources::basic_channel_logger< BaseT, ChannelT >::channel_attribute

Channel attribute type.

template<typename BaseT , typename ChannelT >
typedef ChannelT boost::sources::basic_channel_logger< BaseT, ChannelT >::channel_type

Channel type.

template<typename BaseT , typename ChannelT >
typedef base_type::char_type boost::sources::basic_channel_logger< BaseT, ChannelT >::char_type

Character type.

template<typename BaseT , typename ChannelT >
typedef base_type::final_type boost::sources::basic_channel_logger< BaseT, ChannelT >::final_type

Final type.

template<typename BaseT , typename ChannelT >
typedef strictest_lock< typename base_type::open_record_lock, boost::log::aux::exclusive_lock_guard< threading_model > >::type boost::sources::basic_channel_logger< BaseT, ChannelT >::open_record_lock

Lock requirement for the open_record_unlocked method.

template<typename BaseT , typename ChannelT >
typedef strictest_lock< typename base_type::swap_lock, boost::log::aux::exclusive_lock_guard< threading_model > >::type boost::sources::basic_channel_logger< BaseT, ChannelT >::swap_lock

Lock requirement for the swap_unlocked method.

template<typename BaseT , typename ChannelT >
typedef base_type::threading_model boost::sources::basic_channel_logger< BaseT, ChannelT >::threading_model

Threading model being used.

Constructor & Destructor Documentation

template<typename BaseT , typename ChannelT >
boost::sources::basic_channel_logger< BaseT, ChannelT >::basic_channel_logger ( )
inline

Default constructor.

The constructed logger has the default-constructed channel name.

template<typename BaseT , typename ChannelT >
boost::sources::basic_channel_logger< BaseT, ChannelT >::basic_channel_logger ( basic_channel_logger< BaseT, ChannelT > const &  that)
inline

Copy constructor.

template<typename BaseT , typename ChannelT >
boost::sources::basic_channel_logger< BaseT, ChannelT >::basic_channel_logger ( BOOST_RV_REF(basic_channel_logger< BaseT, ChannelT >)  that)
inline

Move constructor.

template<typename BaseT , typename ChannelT >
template<typename ArgsT >
boost::sources::basic_channel_logger< BaseT, ChannelT >::basic_channel_logger ( ArgsT const &  args)
inlineexplicit

Constructor with arguments.

Allows to register a channel name attribute on construction.

Parameters
argsA set of named arguments. The following arguments are supported:
  • channel - a string that represents the channel name

Member Function Documentation

template<typename BaseT , typename ChannelT >
channel_type boost::sources::basic_channel_logger< BaseT, ChannelT >::channel ( ) const
inline

The observer of the channel name.

Returns
The channel name that was set by the logger

References boost::lock().

template<typename BaseT , typename ChannelT >
void boost::sources::basic_channel_logger< BaseT, ChannelT >::channel ( channel_type const &  ch)
inline

The setter of the channel name.

Parameters
chThe channel name to be set for the logger

References boost::lock().

template<typename BaseT , typename ChannelT >
channel_attribute const& boost::sources::basic_channel_logger< BaseT, ChannelT >::get_channel_attribute ( ) const
inlineprotected

Channel attribute accessor.

template<typename BaseT , typename ChannelT >
template<typename ArgsT >
record boost::sources::basic_channel_logger< BaseT, ChannelT >::open_record_unlocked ( ArgsT const &  args)
inlineprotected

Unlocked open_record.

template<typename BaseT , typename ChannelT >
void boost::sources::basic_channel_logger< BaseT, ChannelT >::swap_unlocked ( basic_channel_logger< BaseT, ChannelT > &  that)
inlineprotected

Unlocked swap.


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