1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_signal_set::cancel (1 of 2 overloads)</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="../../../../boost_asio.html" title="Boost.Asio"> 8<link rel="up" href="../cancel.html" title="basic_signal_set::cancel"> 9<link rel="prev" href="../cancel.html" title="basic_signal_set::cancel"> 10<link rel="next" href="overload2.html" title="basic_signal_set::cancel (2 of 2 overloads)"> 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="../cancel.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h5 class="title"> 27<a name="boost_asio.reference.basic_signal_set.cancel.overload1"></a><a class="link" href="overload1.html" title="basic_signal_set::cancel (1 of 2 overloads)">basic_signal_set::cancel 28 (1 of 2 overloads)</a> 29</h5></div></div></div> 30<p> 31 Cancel all operations associated with the signal set. 32 </p> 33<pre class="programlisting">void cancel(); 34</pre> 35<p> 36 This function forces the completion of any pending asynchronous wait 37 operations against the signal set. The handler for each cancelled operation 38 will be invoked with the <code class="computeroutput">boost::asio::error::operation_aborted</code> 39 error code. 40 </p> 41<p> 42 Cancellation does not alter the set of registered signals. 43 </p> 44<h6> 45<a name="boost_asio.reference.basic_signal_set.cancel.overload1.h0"></a> 46 <span class="phrase"><a name="boost_asio.reference.basic_signal_set.cancel.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_signal_set.cancel.overload1.exceptions">Exceptions</a> 47 </h6> 48<div class="variablelist"> 49<p class="title"><b></b></p> 50<dl class="variablelist"> 51<dt><span class="term">boost::system::system_error</span></dt> 52<dd><p> 53 Thrown on failure. 54 </p></dd> 55</dl> 56</div> 57<h6> 58<a name="boost_asio.reference.basic_signal_set.cancel.overload1.h1"></a> 59 <span class="phrase"><a name="boost_asio.reference.basic_signal_set.cancel.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_signal_set.cancel.overload1.remarks">Remarks</a> 60 </h6> 61<p> 62 If a registered signal occurred before <code class="computeroutput">cancel()</code> is called, 63 then the handlers for asynchronous wait operations will: 64 </p> 65<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 66<li class="listitem"> 67 have already been invoked; or 68 </li> 69<li class="listitem"> 70 have been queued for invocation in the near future. 71 </li> 72</ul></div> 73<p> 74 These handlers can no longer be cancelled, and therefore are passed an 75 error code that indicates the successful completion of the wait operation. 76 </p> 77</div> 78<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 79<td align="left"></td> 80<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 81 Kohlhoff<p> 82 Distributed under the Boost Software License, Version 1.0. (See accompanying 83 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>) 84 </p> 85</div></td> 86</tr></table> 87<hr> 88<div class="spirit-nav"> 89<a accesskey="p" href="../cancel.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 90</div> 91</body> 92</html> 93
