libs/log/doc/html/boost/log/sinks/file/rotation_at_time_interval.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class rotation_at_time_interval</title>
   5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Boost.Log v2">
   8 <link rel="up" href="../../../../sinks.html#header.boost.log.sinks.text_file_backend_hpp" title="Header &lt;boost/log/sinks/text_file_backend.hpp&gt;">
   9 <link rel="prev" href="collector.html" title="Struct collector">
  10 <link rel="next" href="rotation_at_time_point.html" title="Class rotation_at_time_point">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td></tr></table>
  14 <hr>
  15 <div class="spirit-nav">
  16 <a accesskey="p" href="collector.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../../sinks.html#header.boost.log.sinks.text_file_backend_hpp"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="rotation_at_time_point.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.sinks.file.rotation_at_time_interval"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class rotation_at_time_interval</span></h2>
  22 <p>boost::log::sinks::file::rotation_at_time_interval</p>
  23 </div>
  24 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  25 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../../sinks.html#header.boost.log.sinks.text_file_backend_hpp" title="Header &lt;boost/log/sinks/text_file_backend.hpp&gt;">boost/log/sinks/text_file_backend.hpp</a>&gt;
  26
  27 </span>
  28 <span class="keyword">class</span> <a class="link" href="rotation_at_time_interval.html" title="Class rotation_at_time_interval">rotation_at_time_interval</a> <span class="special">{</span>
  29 <span class="keyword">public</span><span class="special">:</span>
  30   <span class="comment">// types</span>
  31   <span class="keyword">typedef</span> <span class="keyword">bool</span> <a name="boost.log.sinks.file.rotation_at_time_interval.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
  32
  33   <span class="comment">// <a class="link" href="rotation_at_time_interval.html#boost.log.sinks.file.rotation_at_time_intervalconstruct-copy-destruct">construct/copy/destruct</a></span>
  34   <span class="keyword">explicit</span> <a class="link" href="rotation_at_time_interval.html#idm45711345623664-bb"><span class="identifier">rotation_at_time_interval</span></a><span class="special">(</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">time_duration</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  35
  36   <span class="comment">// <a class="link" href="rotation_at_time_interval.html#idm45711345625936-bb">public member functions</a></span>
  37   <span class="keyword">bool</span> <a class="link" href="rotation_at_time_interval.html#idm45711345625376-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  38 <span class="special">}</span><span class="special">;</span></pre></div>
  39 <div class="refsect1">
  40 <a name="idm45554731893248"></a><h2>Description</h2>
  41 <p>The class represents the time interval of log file rotation. The log file will be rotated after the specified time interval has passed. </p>
  42 <div class="refsect2">
  43 <a name="idm45554731892416"></a><h3>
  44 <a name="boost.log.sinks.file.rotation_at_time_intervalconstruct-copy-destruct"></a><code class="computeroutput">rotation_at_time_interval</code>
  45         public
  46        construct/copy/destruct</h3>
  47 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  48 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45711345623664-bb"></a><span class="identifier">rotation_at_time_interval</span><span class="special">(</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">time_duration</span> <span class="keyword">const</span> <span class="special">&amp;</span> interval<span class="special">)</span><span class="special">;</span></pre>
  49 <p>Creates a rotation time interval of the specified duration</p>
  50 <p>
  51 </p>
  52 <div class="variablelist"><table border="0" class="variablelist compact">
  53 <colgroup>
  54 <col align="left" valign="top">
  55 <col>
  56 </colgroup>
  57 <tbody><tr>
  58 <td><p><span class="term">Parameters:</span></p></td>
  59 <td><div class="variablelist"><table border="0" class="variablelist compact">
  60 <colgroup>
  61 <col align="left" valign="top">
  62 <col>
  63 </colgroup>
  64 <tbody><tr>
  65 <td><p><span class="term"><code class="computeroutput">interval</code></span></p></td>
  66 <td><p>The interval of the rotation, should be no less than 1 second </p></td>
  67 </tr></tbody>
  68 </table></div></td>
  69 </tr></tbody>
  70 </table></div>
  71 </li></ol></div>
  72 </div>
  73 <div class="refsect2">
  74 <a name="idm45554731879104"></a><h3>
  75 <a name="idm45711345625936-bb"></a><code class="computeroutput">rotation_at_time_interval</code> public member functions</h3>
  76 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  77 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm45711345625376-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  78 <p>Checks if it's time to rotate the file </p>
  79 </li></ol></div>
  80 </div>
  81 </div>
  82 </div>
  83 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  84 <td align="left"></td>
  85 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
  86         Distributed under the Boost Software License, Version 1.0. (See accompanying
  87         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>).
  88       </p>
  89 </div></td>
  90 </tr></table>
  91 <hr>
  92 <div class="spirit-nav">
  93 <a accesskey="p" href="collector.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../../sinks.html#header.boost.log.sinks.text_file_backend_hpp"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="rotation_at_time_point.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  94 </div>
  95 </body>
  96 </html>