diff options
Diffstat (limited to 'doc/html/thread/time.html')
| -rw-r--r--[-rwxr-xr-x] | doc/html/thread/time.html | 117 |
1 files changed, 78 insertions, 39 deletions
diff --git a/doc/html/thread/time.html b/doc/html/thread/time.html index d0dedb3901..6f6bf48fe0 100755..100644 --- a/doc/html/thread/time.html +++ b/doc/html/thread/time.html @@ -1,13 +1,13 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Date and Time Requirements</title> +<title>Time Requirements</title> <link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> <link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> -<link rel="up" href="../thread.html" title="Chapter 28. Thread"> +<link rel="up" href="../thread.html" title="Chapter 28. Thread 3.0.1"> <link rel="prev" href="thread_local_storage.html" title="Thread Local Storage"> -<link rel="next" href="acknowledgements.html" title="Acknowledgments"> +<link rel="next" href="emulations.html" title="Emulations"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -20,41 +20,78 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="thread_local_storage.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../thread.html"><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="acknowledgements.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="thread_local_storage.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../thread.html"><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="emulations.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="section"> <div class="titlepage"><div><div><h2 class="title" style="clear: both"> -<a name="thread.time"></a><a class="link" href="time.html" title="Date and Time Requirements">Date and Time Requirements</a> +<a name="thread.time"></a><a class="link" href="time.html" title="Time Requirements">Time Requirements</a> </h2></div></div></div> -<div class="toc"><dl> -<dt><span class="section"><a href="time.html#thread.time.system_time">Typedef <code class="computeroutput"><span class="identifier">system_time</span></code></a></span></dt> -<dt><span class="section"><a href="time.html#thread.time.get_system_time">Non-member function <code class="computeroutput"><span class="identifier">get_system_time</span><span class="special">()</span></code></a></span></dt> -</dl></div> +<div class="toc"><dl><dt><span class="section"><a href="time.html#thread.time.deprecated">Deprecated</a></span></dt></dl></div> <p> - As of Boost 1.35.0, the <span class="bold"><strong>Boost.Thread</strong></span> library - uses the <a class="link" href="../date_time.html" title="Chapter 7. Boost.Date_Time">Boost.Date_Time</a> library for all operations - that require a time out. These include (but are not limited to): + As of Boost 1.50.0, the <span class="bold"><strong>Boost.Thread</strong></span> library + uses Boost.Chrono library for all operations that require a time out as defined + in the standard c++11. These include (but are not limited to): </p> <div class="itemizedlist"><ul class="itemizedlist" type="disc"> <li class="listitem"> - <a class="link" href="thread_management.html#thread.thread_management.this_thread.sleep" title="Non-member function sleep()"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">this_thread</span><span class="special">::</span><span class="identifier">sleep</span><span class="special">()</span></code></a> + <a class="link" href="thread_management.html#thread.thread_management.this_thread.sleep_for" title="Non-member function sleep_for()"><code class="computeroutput"><span class="identifier">sleep_for</span></code></a> </li> <li class="listitem"> - <a class="link" href="thread_management.html#thread.thread_management.thread.timed_join" title="Member function timed_join()"><code class="computeroutput"><span class="identifier">timed_join</span><span class="special">()</span></code></a> + <a class="link" href="thread_management.html#thread.thread_management.this_thread.sleep_until" title="Non-member function sleep_until()"><code class="computeroutput"><span class="identifier">sleep_until</span></code></a> </li> <li class="listitem"> - <a class="link" href="synchronization.html#thread.synchronization.condvar_ref.condition_variable.timed_wait" title="bool timed_wait(boost::unique_lock<boost::mutex>& lock,boost::system_time const& abs_time)"><code class="computeroutput"><span class="identifier">timed_wait</span><span class="special">()</span></code></a> + <a class="link" href="thread_management.html#thread.thread_management.thread.try_join_for" title="Member function try_join_for() EXTENSION"><code class="computeroutput"><span class="identifier">try_join_for</span></code></a> </li> <li class="listitem"> - <a class="link" href="synchronization.html#thread.synchronization.mutex_concepts.timed_lockable.timed_lock" title="bool timed_lock(boost::system_time const& abs_time)"><code class="computeroutput"><span class="identifier">timed_lock</span><span class="special">()</span></code></a> + <a class="link" href="thread_management.html#thread.thread_management.thread.try_join_until" title="Member function try_join_until() EXTENSION"><code class="computeroutput"><span class="identifier">try_join_until</span></code></a> + </li> +<li class="listitem"> + <a class="link" href="synchronization.html#thread.synchronization.condvar_ref.condition_variable.wait_for" title="template <class Rep, class Period> cv_status wait_for(boost::unique_lock<boost::mutex>& lock, const chrono::duration<Rep, Period>& rel_time)"><code class="computeroutput"><span class="identifier">wait_for</span></code></a> + </li> +<li class="listitem"> + <a class="link" href="synchronization.html#thread.synchronization.condvar_ref.condition_variable.wait_until" title="template <class Clock, class Duration> cv_status wait_until(boost::unique_lock<boost::mutex>& lock, const chrono::time_point<Clock, Duration>& abs_time)"><code class="computeroutput"><span class="identifier">wait_until</span></code></a> + </li> +<li class="listitem"> + <a class="link" href="synchronization.html#thread.synchronization.mutex_concepts.timed_lockable.try_lock_for" title="m.try_lock_for(rel_time)"><code class="computeroutput"><span class="identifier">try_lock_for</span></code></a> + </li> +<li class="listitem"> + <a class="link" href="synchronization.html#thread.synchronization.mutex_concepts.timed_lockable.try_lock_until" title="m.try_lock_until(abs_time)"><code class="computeroutput"><span class="identifier">try_lock_until</span></code></a> </li> </ul></div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="thread.time.deprecated"></a><a class="link" href="time.html#thread.time.deprecated" title="Deprecated">Deprecated</a> +</h3></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="time.html#thread.time.deprecated.system_time">Typedef <code class="computeroutput"><span class="identifier">system_time</span></code></a></span></dt> +<dt><span class="section"><a href="time.html#thread.time.deprecated.get_system_time">Non-member + function <code class="computeroutput"><span class="identifier">get_system_time</span><span class="special">()</span></code></a></span></dt> +</dl></div> <p> - For the overloads that accept an absolute time parameter, an object of type - <a class="link" href="time.html#thread.time.system_time" title="Typedef system_time"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">system_time</span></code></a> - is required. Typically, this will be obtained by adding a duration to the current - time, obtained with a call to <a class="link" href="time.html#thread.time.get_system_time" title="Non-member function get_system_time()"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">get_system_time</span><span class="special">()</span></code></a>. e.g. - </p> + The time related functions introduced in Boost 1.35.0, using the <a class="link" href="../date_time.html" title="Chapter 7. Boost.Date_Time">Boost.Date_Time</a> + library are deprecated. These include (but are not limited to): + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <a class="link" href="thread_management.html#thread.thread_management.this_thread.sleep" title="Non-member function sleep()"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">this_thread</span><span class="special">::</span><span class="identifier">sleep</span><span class="special">()</span></code></a> + </li> +<li class="listitem"> + <a class="link" href="thread_management.html#thread.thread_management.thread.timed_join" title="Member function timed_join()"><code class="computeroutput"><span class="identifier">timed_join</span><span class="special">()</span></code></a> + </li> +<li class="listitem"> + <a class="link" href="synchronization.html#thread.synchronization.condvar_ref.condition_variable.timed_wait" title="bool timed_wait(boost::unique_lock<boost::mutex>& lock,boost::system_time const& abs_time)"><code class="computeroutput"><span class="identifier">timed_wait</span><span class="special">()</span></code></a> + </li> +<li class="listitem"> + <a class="link" href="synchronization.html#thread.synchronization.mutex_concepts.timed_lockable.timed_lock" title="m.timed_lock(abs_time)"><code class="computeroutput"><span class="identifier">timed_lock</span><span class="special">()</span></code></a> + </li> +</ul></div> +<p> + For the overloads that accept an absolute time parameter, an object of type + <a class="link" href="time.html#thread.time.deprecated.system_time" title="Typedef system_time"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">system_time</span></code></a> + is required. Typically, this will be obtained by adding a duration to the + current time, obtained with a call to <a class="link" href="time.html#thread.time.deprecated.get_system_time" title="Non-member function get_system_time()"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">get_system_time</span><span class="special">()</span></code></a>. + e.g. + </p> <pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">system_time</span> <span class="keyword">const</span> <span class="identifier">timeout</span><span class="special">=</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">get_system_time</span><span class="special">()</span> <span class="special">+</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">milliseconds</span><span class="special">(</span><span class="number">500</span><span class="special">);</span> <span class="keyword">extern</span> <span class="keyword">bool</span> <span class="identifier">done</span><span class="special">;</span> @@ -71,10 +108,10 @@ <span class="special">}</span> </pre> <p> - For the overloads that accept a <span class="emphasis"><em>TimeDuration</em></span> parameter, - an object of any type that meets the <a class="link" href="../date_time/posix_time.html#date_time.posix_time.time_duration" title="Time Duration">Boost.Date_Time - Time Duration requirements</a> can be used, e.g. - </p> + For the overloads that accept a <span class="emphasis"><em>TimeDuration</em></span> parameter, + an object of any type that meets the <a class="link" href="../date_time/posix_time.html#date_time.posix_time.time_duration" title="Time Duration">Boost.Date_Time + Time Duration requirements</a> can be used, e.g. + </p> <pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">this_thread</span><span class="special">::</span><span class="identifier">sleep</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">milliseconds</span><span class="special">(</span><span class="number">25</span><span class="special">));</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">mutex</span> <span class="identifier">m</span><span class="special">;</span> @@ -84,21 +121,22 @@ <span class="special">}</span> </pre> <div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="thread.time.system_time"></a><a class="link" href="time.html#thread.time.system_time" title="Typedef system_time">Typedef <code class="computeroutput"><span class="identifier">system_time</span></code></a> -</h3></div></div></div> +<div class="titlepage"><div><div><h4 class="title"> +<a name="thread.time.deprecated.system_time"></a><a class="link" href="time.html#thread.time.deprecated.system_time" title="Typedef system_time">Typedef <code class="computeroutput"><span class="identifier">system_time</span></code></a> +</h4></div></div></div> <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">thread</span><span class="special">/</span><span class="identifier">thread_time</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="identifier">system_time</span><span class="special">;</span> </pre> <p> - See the documentation for <a class="link" href="../date_time/posix_time.html#date_time.posix_time.ptime_class" title="Ptime"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span></code></a> in the Boost.Date_Time library. - </p> + See the documentation for <a class="link" href="../date_time/posix_time.html#date_time.posix_time.ptime_class" title="Ptime"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span></code></a> in the Boost.Date_Time library. + </p> </div> <div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="thread.time.get_system_time"></a><a class="link" href="time.html#thread.time.get_system_time" title="Non-member function get_system_time()">Non-member function <code class="computeroutput"><span class="identifier">get_system_time</span><span class="special">()</span></code></a> -</h3></div></div></div> +<div class="titlepage"><div><div><h4 class="title"> +<a name="thread.time.deprecated.get_system_time"></a><a class="link" href="time.html#thread.time.deprecated.get_system_time" title="Non-member function get_system_time()">Non-member + function <code class="computeroutput"><span class="identifier">get_system_time</span><span class="special">()</span></code></a> +</h4></div></div></div> <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">thread</span><span class="special">/</span><span class="identifier">thread_time</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> <span class="identifier">system_time</span> <span class="identifier">get_system_time</span><span class="special">();</span> @@ -108,19 +146,20 @@ <dl> <dt><span class="term">Returns:</span></dt> <dd><p> - The current time. - </p></dd> + The current time. + </p></dd> <dt><span class="term">Throws:</span></dt> <dd><p> - Nothing. - </p></dd> + Nothing. + </p></dd> </dl> </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 © 2007 -8 Anthony Williams<p> +<td align="right"><div class="copyright-footer">Copyright © 2007 -11 Anthony Williams<br>Copyright © 2011 -12 Vicente J. Botet Escriba<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> @@ -128,7 +167,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="thread_local_storage.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../thread.html"><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="acknowledgements.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="thread_local_storage.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../thread.html"><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="emulations.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |