Google Git
Sign in
nest-open-source / nest-cam / 4320010 / boost / 62d1066a6d52d5ac4e10c106f0eab14c820be0ce / . / boost / libs / log / doc / html / boost / log / sinks / file / rotation_at_time_point.html
blob: e86ad1a5a91437c95005aaf337bab87a77671d78 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class rotation_at_time_point</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Boost.Log v2">
<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;">
<link rel="prev" href="rotation_at_time_interval.html" title="Class rotation_at_time_interval">
<link rel="next" href="make_collector.html" title="Function template make_collector">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="rotation_at_time_interval.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="make_collector.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.log.sinks.file.rotation_at_time_point"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class rotation_at_time_point</span></h2>
<p>boost::log::sinks::file::rotation_at_time_point</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<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;
</span>
<span class="keyword">class</span> <a class="link" href="rotation_at_time_point.html" title="Class rotation_at_time_point">rotation_at_time_point</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// types</span>
<span class="keyword">typedef</span> <span class="keyword">bool</span> <a name="boost.log.sinks.file.rotation_at_time_point.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
<span class="comment">// <a class="link" href="rotation_at_time_point.html#boost.log.sinks.file.rotation_at_time_pointconstruct-copy-destruct">construct/copy/destruct</a></span>
<span class="keyword">explicit</span> <a class="link" href="rotation_at_time_point.html#idp44883376-bb"><span class="identifier">rotation_at_time_point</span></a><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">char</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">char</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">char</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">explicit</span> <a class="link" href="rotation_at_time_point.html#idp44888096-bb"><span class="identifier">rotation_at_time_point</span></a><span class="special">(</span><span class="identifier">date_time</span><span class="special">::</span><span class="identifier">weekdays</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span>
<span class="keyword">unsigned</span> <span class="keyword">char</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">explicit</span> <a class="link" href="rotation_at_time_point.html#idp44894816-bb"><span class="identifier">rotation_at_time_point</span></a><span class="special">(</span><span class="identifier">gregorian</span><span class="special">::</span><span class="identifier">greg_day</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span>
<span class="keyword">unsigned</span> <span class="keyword">char</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="rotation_at_time_point.html#idp44881104-bb">public member functions</a></span>
<span class="keyword">bool</span> <a class="link" href="rotation_at_time_point.html#idp44881664-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>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idp126185680"></a><h2>Description</h2>
<p>The class represents the time point of log file rotation. One can specify one of three types of time point based rotation:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>rotation takes place every day, at the specified time </p></li>
<li class="listitem"><p>rotation takes place on the specified day of every week, at the specified time </p></li>
<li class="listitem"><p>rotation takes place on the specified day of every month, at the specified time</p></li>
</ul></div>
<p>
The time points are considered to be local time. </p>
<div class="refsect2">
<a name="idp126188768"></a><h3>
<a name="boost.log.sinks.file.rotation_at_time_pointconstruct-copy-destruct"></a><code class="computeroutput">rotation_at_time_point</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp44883376-bb"></a><span class="identifier">rotation_at_time_point</span><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">char</span> hour<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> minute<span class="special">,</span>
<span class="keyword">unsigned</span> <span class="keyword">char</span> second<span class="special">)</span><span class="special">;</span></pre>
<p>Creates a rotation time point of every day at the specified time</p>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">hour</code></span></p></td>
<td><p>The rotation hour, should be within 0 and 23 </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">minute</code></span></p></td>
<td><p>The rotation minute, should be within 0 and 59 </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">second</code></span></p></td>
<td><p>The rotation second, should be within 0 and 59 </p></td>
</tr>
</tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp44888096-bb"></a><span class="identifier">rotation_at_time_point</span><span class="special">(</span><span class="identifier">date_time</span><span class="special">::</span><span class="identifier">weekdays</span> wday<span class="special">,</span>
<span class="keyword">unsigned</span> <span class="keyword">char</span> hour <span class="special">=</span> <span class="number">0</span><span class="special">,</span>
<span class="keyword">unsigned</span> <span class="keyword">char</span> minute <span class="special">=</span> <span class="number">0</span><span class="special">,</span>
<span class="keyword">unsigned</span> <span class="keyword">char</span> second <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre>
<p>Creates a rotation time point of each specified weekday at the specified time</p>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">hour</code></span></p></td>
<td><p>The rotation hour, should be within 0 and 23 </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">minute</code></span></p></td>
<td><p>The rotation minute, should be within 0 and 59 </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">second</code></span></p></td>
<td><p>The rotation second, should be within 0 and 59 </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">wday</code></span></p></td>
<td><p>The weekday of the rotation </p></td>
</tr>
</tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp44894816-bb"></a><span class="identifier">rotation_at_time_point</span><span class="special">(</span><span class="identifier">gregorian</span><span class="special">::</span><span class="identifier">greg_day</span> mday<span class="special">,</span>
<span class="keyword">unsigned</span> <span class="keyword">char</span> hour <span class="special">=</span> <span class="number">0</span><span class="special">,</span>
<span class="keyword">unsigned</span> <span class="keyword">char</span> minute <span class="special">=</span> <span class="number">0</span><span class="special">,</span>
<span class="keyword">unsigned</span> <span class="keyword">char</span> second <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre>
<p>Creates a rotation time point of each specified day of month at the specified time</p>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">hour</code></span></p></td>
<td><p>The rotation hour, should be within 0 and 23 </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">mday</code></span></p></td>
<td><p>The monthday of the rotation, should be within 1 and 31 </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">minute</code></span></p></td>
<td><p>The rotation minute, should be within 0 and 59 </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">second</code></span></p></td>
<td><p>The rotation second, should be within 0 and 59 </p></td>
</tr>
</tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="idp126253344"></a><h3>
<a name="idp44881104-bb"></a><code class="computeroutput">rotation_at_time_point</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="idp44881664-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>
<p>Checks if it's time to rotate the file </p>
</li></ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2007-2015 Andrey
Semashev<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>).
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="rotation_at_time_interval.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="make_collector.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>