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