86 lines
5.1 KiB
HTML
86 lines
5.1 KiB
HTML
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
|
|
<title>cancellation_slot::emplace</title>
|
||
|
|
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||
|
|
<link rel="home" href="../../../index.html" title="Asio">
|
||
|
|
<link rel="up" href="../cancellation_slot.html" title="cancellation_slot">
|
||
|
|
<link rel="prev" href="clear.html" title="cancellation_slot::clear">
|
||
|
|
<link rel="next" href="has_handler.html" title="cancellation_slot::has_handler">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
</head>
|
||
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||
|
|
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||
|
|
<hr>
|
||
|
|
<div class="spirit-nav">
|
||
|
|
<a accesskey="p" href="clear.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../cancellation_slot.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="has_handler.html"><img src="../../../next.png" alt="Next"></a>
|
||
|
|
</div>
|
||
|
|
<div class="section">
|
||
|
|
<div class="titlepage"><div><div><h4 class="title">
|
||
|
|
<a name="asio.reference.cancellation_slot.emplace"></a><a class="link" href="emplace.html" title="cancellation_slot::emplace">cancellation_slot::emplace</a>
|
||
|
|
</h4></div></div></div>
|
||
|
|
<p>
|
||
|
|
<a class="indexterm" name="asio.indexterm.cancellation_slot.emplace"></a>
|
||
|
|
Installs
|
||
|
|
a handler into the slot, constructing the new object directly.
|
||
|
|
</p>
|
||
|
|
<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span>
|
||
|
|
<span class="keyword">typename</span> <a class="link" href="../CancellationHandler.html" title="Cancellation handler requirements">CancellationHandler</a><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span><span class="special">...</span> <span class="identifier">Args</span><span class="special">></span>
|
||
|
|
<span class="identifier">CancellationHandler</span> <span class="special">&</span> <span class="identifier">emplace</span><span class="special">(</span>
|
||
|
|
<span class="identifier">Args</span> <span class="special">&&...</span> <span class="identifier">args</span><span class="special">);</span>
|
||
|
|
</pre>
|
||
|
|
<p>
|
||
|
|
Destroys any existing handler in the slot, then installs the new handler,
|
||
|
|
constructing it with the supplied <code class="computeroutput"><span class="identifier">args</span></code>.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
The handler is a function object to be called when the signal is emitted.
|
||
|
|
The signature of the handler must be
|
||
|
|
</p>
|
||
|
|
<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">cancellation_type_t</span><span class="special">);</span>
|
||
|
|
</pre>
|
||
|
|
<h6>
|
||
|
|
<a name="asio.reference.cancellation_slot.emplace.h0"></a>
|
||
|
|
<span><a name="asio.reference.cancellation_slot.emplace.parameters"></a></span><a class="link" href="emplace.html#asio.reference.cancellation_slot.emplace.parameters">Parameters</a>
|
||
|
|
</h6>
|
||
|
|
<div class="variablelist">
|
||
|
|
<p class="title"><b></b></p>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="term">args</span></dt>
|
||
|
|
<dd><p>
|
||
|
|
Arguments to be passed to the <code class="computeroutput"><span class="identifier">CancellationHandler</span></code>
|
||
|
|
object's constructor.
|
||
|
|
</p></dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<h6>
|
||
|
|
<a name="asio.reference.cancellation_slot.emplace.h1"></a>
|
||
|
|
<span><a name="asio.reference.cancellation_slot.emplace.return_value"></a></span><a class="link" href="emplace.html#asio.reference.cancellation_slot.emplace.return_value">Return
|
||
|
|
Value</a>
|
||
|
|
</h6>
|
||
|
|
<p>
|
||
|
|
A reference to the newly installed handler.
|
||
|
|
</p>
|
||
|
|
<h6>
|
||
|
|
<a name="asio.reference.cancellation_slot.emplace.h2"></a>
|
||
|
|
<span><a name="asio.reference.cancellation_slot.emplace.remarks"></a></span><a class="link" href="emplace.html#asio.reference.cancellation_slot.emplace.remarks">Remarks</a>
|
||
|
|
</h6>
|
||
|
|
<p>
|
||
|
|
Handlers installed into the slot via <code class="computeroutput"><span class="identifier">emplace</span></code>
|
||
|
|
are not required to be copy constructible or move constructible.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<div class="copyright-footer">Copyright © 2003-2023 Christopher M. Kohlhoff<p>
|
||
|
|
Distributed under the Boost Software License, Version 1.0. (See accompanying
|
||
|
|
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>)
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<hr>
|
||
|
|
<div class="spirit-nav">
|
||
|
|
<a accesskey="p" href="clear.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../cancellation_slot.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="has_handler.html"><img src="../../../next.png" alt="Next"></a>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|