libs/beast/doc/html/beast/ref/boost__beast__test__run.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>test::run</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.Beast">
   8 <link rel="up" href="../ref.html" title="This Page Intentionally Left Blank 2/2">
   9 <link rel="prev" href="boost__beast__test__handler/handler_dtor_.html" title="test::handler::~handler">
  10 <link rel="next" href="boost__beast__test__run_for.html" title="test::run_for">
  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="boost__beast__test__handler/handler_dtor_.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../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="boost__beast__test__run_for.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="beast.ref.boost__beast__test__run"></a><a class="link" href="boost__beast__test__run.html" title="test::run">test::run</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873477288480"></a>
  31 Run an I/O context.
  32       </p>
  33 <h5>
  34 <a name="beast.ref.boost__beast__test__run.h0"></a>
  35         <span class="phrase"><a name="beast.ref.boost__beast__test__run.synopsis"></a></span><a class="link" href="boost__beast__test__run.html#beast.ref.boost__beast__test__run.synopsis">Synopsis</a>
  36       </h5>
  37 <p>
  38         Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/_experimental/test/handler.hpp" target="_top">boost/beast/_experimental/test/handler.hpp</a>&gt;</code>
  39       </p>
  40 <pre class="programlisting"><span class="keyword">void</span>
  41 <span class="identifier">run</span><span class="special">(</span>
  42     <span class="identifier">net</span><span class="special">::</span><span class="identifier">io_context</span><span class="special">&amp;</span> <span class="identifier">ioc</span><span class="special">);</span>
  43 </pre>
  44 <h5>
  45 <a name="beast.ref.boost__beast__test__run.h1"></a>
  46         <span class="phrase"><a name="beast.ref.boost__beast__test__run.description"></a></span><a class="link" href="boost__beast__test__run.html#beast.ref.boost__beast__test__run.description">Description</a>
  47       </h5>
  48 <p>
  49         This function runs and dispatches handlers on the specified I/O context,
  50         until one of the following conditions is true:
  51       </p>
  52 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  53             The I/O context runs out of work.
  54           </li></ul></div>
  55 <h5>
  56 <a name="beast.ref.boost__beast__test__run.h2"></a>
  57         <span class="phrase"><a name="beast.ref.boost__beast__test__run.parameters"></a></span><a class="link" href="boost__beast__test__run.html#beast.ref.boost__beast__test__run.parameters">Parameters</a>
  58       </h5>
  59 <div class="informaltable"><table class="table">
  60 <colgroup>
  61 <col>
  62 <col>
  63 </colgroup>
  64 <thead><tr>
  65 <th>
  66                 <p>
  67                   Name
  68                 </p>
  69               </th>
  70 <th>
  71                 <p>
  72                   Description
  73                 </p>
  74               </th>
  75 </tr></thead>
  76 <tbody><tr>
  77 <td>
  78                 <p>
  79                   <code class="computeroutput"><span class="identifier">ioc</span></code>
  80                 </p>
  81               </td>
  82 <td>
  83                 <p>
  84                   The I/O context to run
  85                 </p>
  86               </td>
  87 </tr></tbody>
  88 </table></div>
  89 </div>
  90 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  91 <td align="left"></td>
  92 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
  93       Falco<p>
  94         Distributed under the Boost Software License, Version 1.0. (See accompanying
  95         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>)
  96       </p>
  97 </div></td>
  98 </tr></table>
  99 <hr>
 100 <div class="spirit-nav">
 101 <a accesskey="p" href="boost__beast__test__handler/handler_dtor_.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../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="boost__beast__test__run_for.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 102 </div>
 103 </body>
 104 </html>