libs/beast/doc/html/beast/ref/boost__beast__test__fail_handler.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>test::fail_handler</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__fail_count/fail_count/overload2.html" title="test::fail_count::fail_count (2 of 2 overloads)">
  10 <link rel="next" href="boost__beast__test__handler.html" title="test::handler">
  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__fail_count/fail_count/overload2.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__handler.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__fail_handler"></a><a class="link" href="boost__beast__test__fail_handler.html" title="test::fail_handler">test::fail_handler</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873477565296"></a>
  31 Return a test CompletionHandler which requires a specific
  32         error code.
  33       </p>
  34 <h5>
  35 <a name="beast.ref.boost__beast__test__fail_handler.h0"></a>
  36         <span class="phrase"><a name="beast.ref.boost__beast__test__fail_handler.synopsis"></a></span><a class="link" href="boost__beast__test__fail_handler.html#beast.ref.boost__beast__test__fail_handler.synopsis">Synopsis</a>
  37       </h5>
  38 <p>
  39         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>
  40       </p>
  41 <pre class="programlisting"><span class="identifier">handler</span>
  42 <span class="identifier">fail_handler</span><span class="special">(</span>
  43     <span class="identifier">error_code</span> <span class="identifier">ec</span><span class="special">);</span>
  44 </pre>
  45 <h5>
  46 <a name="beast.ref.boost__beast__test__fail_handler.h1"></a>
  47         <span class="phrase"><a name="beast.ref.boost__beast__test__fail_handler.description"></a></span><a class="link" href="boost__beast__test__fail_handler.html#beast.ref.boost__beast__test__fail_handler.description">Description</a>
  48       </h5>
  49 <p>
  50         This handler can be invoked with any signature whose first parameter is an
  51         <code class="computeroutput"><span class="identifier">error_code</span></code>. The handler fails
  52         the test if:
  53       </p>
  54 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  55 <li class="listitem">
  56             The handler is destroyed without being invoked.
  57           </li>
  58 <li class="listitem">
  59             The handler is invoked with an error code different from what is specified.
  60           </li>
  61 </ul></div>
  62 <h5>
  63 <a name="beast.ref.boost__beast__test__fail_handler.h2"></a>
  64         <span class="phrase"><a name="beast.ref.boost__beast__test__fail_handler.parameters"></a></span><a class="link" href="boost__beast__test__fail_handler.html#beast.ref.boost__beast__test__fail_handler.parameters">Parameters</a>
  65       </h5>
  66 <div class="informaltable"><table class="table">
  67 <colgroup>
  68 <col>
  69 <col>
  70 </colgroup>
  71 <thead><tr>
  72 <th>
  73                 <p>
  74                   Name
  75                 </p>
  76               </th>
  77 <th>
  78                 <p>
  79                   Description
  80                 </p>
  81               </th>
  82 </tr></thead>
  83 <tbody><tr>
  84 <td>
  85                 <p>
  86                   <code class="computeroutput"><span class="identifier">ec</span></code>
  87                 </p>
  88               </td>
  89 <td>
  90                 <p>
  91                   The error code to specify.
  92                 </p>
  93               </td>
  94 </tr></tbody>
  95 </table></div>
  96 </div>
  97 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  98 <td align="left"></td>
  99 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 100       Falco<p>
 101         Distributed under the Boost Software License, Version 1.0. (See accompanying
 102         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>)
 103       </p>
 104 </div></td>
 105 </tr></table>
 106 <hr>
 107 <div class="spirit-nav">
 108 <a accesskey="p" href="boost__beast__test__fail_count/fail_count/overload2.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__handler.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 109 </div>
 110 </body>
 111 </html>