Class template synchronous_sink

Boost C++ Libraries

Class template synchronous_sink

boost::log::sinks::synchronous_sink — Synchronous logging sink frontend.

Synopsis

// In header: <boost/log/sinks/sync_frontend.hpp>

template<typename SinkBackendT> 
class synchronous_sink :
  public synchronous_frontend< SinkBackendT::char_type >
{
public:
  // types
  typedef SinkBackendT           sink_backend_type;   // Sink implementation type. 
  typedef base_type::record_type record_type;         // Log record type. 
  typedef base_type::string_type string_type;         // String type to be used as a message text holder. 
  typedef implementation_defined locked_backend_ptr;  // A pointer type that locks the backend until it's destroyed. 

  // construct/copy/destruct
  synchronous_sink();
  explicit synchronous_sink(shared_ptr< sink_backend_type > const &);

  // public member functions
  locked_backend_ptr locked_backend() const;
};

Description

The sink frontend serializes threads before passing logging records to the backend

`synchronous_sink` public construct/copy/destruct

```
synchronous_sink();
```
Default constructor. Constructs the sink backend instance. Requires the backend to be default-constructible.
```
explicit synchronous_sink(shared_ptr< sink_backend_type > const & backend);
```
Constructor attaches user-constructed backend instance

Parameters:

backend
Pointer to the backend instance

Requires:
backend is not NULL.

`synchronous_sink` public member functions

locked_backend_ptr locked_backend() const;

Locking accessor to the attached backend