Boost C++ Libraries

PrevUpHomeNext

Class template basic_exception_handler_logger

boost::log::sources::basic_exception_handler_logger — Exception handler feature implementation.

Synopsis

// In header: <boost/log/sources/exception_handler_feature.hpp>

template<typename BaseT> 
class basic_exception_handler_logger {
public:
  // types
  typedef base_type::record_type                                                               record_type;             // Log record type. 
  typedef base_type::threading_model                                                           threading_model;         // Threading model being used. 
  typedef base_type::final_type                                                                final_type;              // Final logger type. 
  typedef function0< void >                                                                    exception_handler_type;  // Exception handler function type. 
  typedef strictest_lock< typename base_type::open_record_lock, no_lock >::type                open_record_lock;        // Lock requirement for the open_record_unlocked method. 
  typedef strictest_lock< typename base_type::push_record_lock, no_lock >::type                push_record_lock;        // Lock requirement for the push_record_unlocked method. 
  typedef strictest_lock< typename base_type::swap_lock, lock_guard< threading_model > >::type swap_lock;               // Lock requirement for the swap_unlocked method. 

  // construct/copy/destruct
  basic_exception_handler_logger();
  basic_exception_handler_logger(basic_exception_handler_logger const &);
  template<typename ArgsT> 
    explicit basic_exception_handler_logger(ArgsT const &);

  // public member functions
  template<typename HandlerT> void set_exception_handler(HandlerT const &);

  // protected member functions
  template<typename ArgsT> record_type open_record_unlocked(ArgsT const &);
  void push_record_unlocked(record_type const &);
  void swap_unlocked(basic_exception_handler_logger &);
};

Description

basic_exception_handler_logger public construct/copy/destruct

  1. basic_exception_handler_logger();

    Default constructor. The constructed logger does not have an exception handler.

  2. basic_exception_handler_logger(basic_exception_handler_logger const & that);

    Copy constructor

  3. template<typename ArgsT> 
      explicit basic_exception_handler_logger(ArgsT const & args);

    Constructor with arguments. Passes arguments to other features.

basic_exception_handler_logger public member functions

  1. template<typename HandlerT> 
      void set_exception_handler(HandlerT const & handler);

    The method sets exception handler function. The function will be called with no arguments in case if an exception occurs during either open_record or push_record method execution. Since exception handler is called from a catch statement, the exception can be rethrown in order to determine its type.

    By default no handler is installed, thus any exception is propagated as usual.

    See Also:

    utility/exception_handler.hpp

    [Note] Note

    The exception handler can be invoked in several threads concurrently.

    Thread interruptions are not affected by exception handlers.

    Parameters:
    handler

    Exception handling function

basic_exception_handler_logger protected member functions

  1. template<typename ArgsT> record_type open_record_unlocked(ArgsT const & args);

    Unlocked open_record

  2. void push_record_unlocked(record_type const & record);

    Unlocked push_record

  3. void swap_unlocked(basic_exception_handler_logger & that);

    Unlocked swap


PrevUpHomeNext