Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::sinks::file::rotation_at_time_interval Class Reference

The class represents the time interval of log file rotation. More...

#include <text_file_backend.hpp>

Public Types

typedef bool result_type
 

Public Member Functions

 rotation_at_time_interval (posix_time::time_duration const &interval)
 Creates a rotation time interval of the specified duration. More...
 
BOOST_LOG_API bool operator() () const
 Checks if it's time to rotate the file. More...
 

Detailed Description

The class represents the time interval of log file rotation.

The log file will be rotated after the specified time interval has passed.

Member Typedef Documentation

Constructor & Destructor Documentation

boost::sinks::file::rotation_at_time_interval::rotation_at_time_interval ( posix_time::time_duration const &  interval)
inlineexplicit

Creates a rotation time interval of the specified duration.

Parameters
intervalThe interval of the rotation, should be no less than 1 second

References BOOST_ASSERT, boost::date_time::time_duration< T, rep_type >::is_special(), and boost::date_time::time_duration< T, rep_type >::total_seconds().

Member Function Documentation

BOOST_LOG_API bool boost::sinks::file::rotation_at_time_interval::operator() ( ) const

Checks if it's time to rotate the file.


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