libs/test/doc/html/boost_test/utf_reference/testing_tool_ref/decorator_timeout.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>timeout (decorator)</title>
   5 <link rel="stylesheet" href="../../../boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../index.html" title="Boost.Test">
   8 <link rel="up" href="../testing_tool_ref.html" title="Reference API for writing tests">
   9 <link rel="prev" href="decorator_expected_failures.html" title="expected_failures (decorator)">
  10 <link rel="next" href="decorator_tolerance.html" title="tolerance (decorator)">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="decorator_expected_failures.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../testing_tool_ref.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="decorator_tolerance.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="boost_test.utf_reference.testing_tool_ref.decorator_timeout"></a><a class="link" href="decorator_timeout.html" title="timeout (decorator)">timeout
  28         (decorator)</a>
  29 </h4></div></div></div>
  30 <pre class="programlisting"><span class="identifier">timeout</span><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="identifier">seconds</span><span class="special">);</span>
  31 </pre>
  32 <p>
  33           Specifies a time-out for a <span class="bold"><strong>test-case</strong></span> or
  34           a <span class="bold"><strong>test-suite</strong></span>, in wall-clock time.
  35         </p>
  36 <p>
  37           If a test-case lasts longer than the timeout, the test is flagged as failed.
  38           On some systems (see below), the test-case is forced to stop.
  39         </p>
  40 <p>
  41           For test-suites, the mechanism is similar: every test-unit under the test-suite
  42           is allocated a maximum duration time that is the remainder of the timeout
  43           after the previous tests have been executed. If a timeout occurs during
  44           the execution of the suite, the suite is flagged as timed-out and the remaining
  45           test-units are skipped.
  46         </p>
  47 <p>
  48           See <a class="link" href="../../testing_tools/timeout.html" title="Time-out for test cases">here</a> for more
  49           details.
  50         </p>
  51 <div class="note"><table border="0" summary="Note">
  52 <tr>
  53 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td>
  54 <th align="left">Note</th>
  55 </tr>
  56 <tr><td align="left" valign="top"><p>
  57             The macro <code class="computeroutput"><span class="identifier">BOOST_SIGACTION_BASED_SIGNAL_HANDLING</span></code>
  58             is defined if Boost.Test is able to force the test-case to stop.
  59           </p></td></tr>
  60 </table></div>
  61 <div class="note"><table border="0" summary="Note">
  62 <tr>
  63 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td>
  64 <th align="left">Note</th>
  65 </tr>
  66 <tr><td align="left" valign="top"><p>
  67             The support for test suites has been added in <a class="link" href="../../change_log.html#ref_CHANGE_LOG_3_10">Boost
  68             1.70 / <span class="emphasis"><em>Unit Test Framework</em></span> v3.10</a>
  69           </p></td></tr>
  70 </table></div>
  71 </div>
  72 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  73 <td align="left"></td>
  74 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  75       contributors<p>
  76         Distributed under the Boost Software License, Version 1.0. (See accompanying
  77         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>)
  78       </p>
  79 </div></td>
  80 </tr></table>
  81 <hr>
  82 <div class="spirit-nav">
  83 <a accesskey="p" href="decorator_expected_failures.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../testing_tool_ref.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="decorator_tolerance.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  84 </div>
  85 </body>
  86 </html>