98 lines
5.9 KiB
HTML
98 lines
5.9 KiB
HTML
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
|
|
<title>io_context::dispatch</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="../io_context.html" title="io_context">
|
||
|
|
<link rel="prev" href="destroy.html" title="io_context::destroy">
|
||
|
|
<link rel="next" href="executor_type.html" title="io_context::executor_type">
|
||
|
|
<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="destroy.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../io_context.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="executor_type.html"><img src="../../../next.png" alt="Next"></a>
|
||
|
|
</div>
|
||
|
|
<div class="section">
|
||
|
|
<div class="titlepage"><div><div><h4 class="title">
|
||
|
|
<a name="asio.reference.io_context.dispatch"></a><a class="link" href="dispatch.html" title="io_context::dispatch">io_context::dispatch</a>
|
||
|
|
</h4></div></div></div>
|
||
|
|
<p>
|
||
|
|
<a class="indexterm" name="asio.indexterm.io_context.dispatch"></a>
|
||
|
|
(Deprecated: Use <a class="link" href="../dispatch.html" title="dispatch"><code class="computeroutput"><span class="identifier">dispatch</span></code></a>.)
|
||
|
|
Request the <a class="link" href="../io_context.html" title="io_context"><code class="computeroutput"><span class="identifier">io_context</span></code></a>
|
||
|
|
to invoke the given handler.
|
||
|
|
</p>
|
||
|
|
<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span>
|
||
|
|
<span class="keyword">typename</span> <a class="link" href="../LegacyCompletionHandler.html" title="Legacy completion handler requirements">LegacyCompletionHandler</a><span class="special">></span>
|
||
|
|
<a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> <span class="identifier">dispatch</span><span class="special">(</span>
|
||
|
|
<span class="identifier">LegacyCompletionHandler</span> <span class="special">&&</span> <span class="identifier">handler</span><span class="special">);</span>
|
||
|
|
</pre>
|
||
|
|
<p>
|
||
|
|
This function is used to ask the <a class="link" href="../io_context.html" title="io_context"><code class="computeroutput"><span class="identifier">io_context</span></code></a> to execute the given
|
||
|
|
handler.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
The <a class="link" href="../io_context.html" title="io_context"><code class="computeroutput"><span class="identifier">io_context</span></code></a>
|
||
|
|
guarantees that the handler will only be called in a thread in which the
|
||
|
|
<code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code>,
|
||
|
|
<code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code>,
|
||
|
|
<code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code>
|
||
|
|
or <code class="computeroutput"><span class="identifier">poll_one</span><span class="special">()</span></code>
|
||
|
|
member functions is currently being invoked. The handler may be executed
|
||
|
|
inside this function if the guarantee can be met.
|
||
|
|
</p>
|
||
|
|
<h6>
|
||
|
|
<a name="asio.reference.io_context.dispatch.h0"></a>
|
||
|
|
<span><a name="asio.reference.io_context.dispatch.parameters"></a></span><a class="link" href="dispatch.html#asio.reference.io_context.dispatch.parameters">Parameters</a>
|
||
|
|
</h6>
|
||
|
|
<div class="variablelist">
|
||
|
|
<p class="title"><b></b></p>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="term">handler</span></dt>
|
||
|
|
<dd>
|
||
|
|
<p>
|
||
|
|
The handler to be called. The <a class="link" href="../io_context.html" title="io_context"><code class="computeroutput"><span class="identifier">io_context</span></code></a> will make a copy
|
||
|
|
of the handler object as required. The function signature of the
|
||
|
|
handler must be:
|
||
|
|
</p>
|
||
|
|
<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">();</span>
|
||
|
|
</pre>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<h6>
|
||
|
|
<a name="asio.reference.io_context.dispatch.h1"></a>
|
||
|
|
<span><a name="asio.reference.io_context.dispatch.remarks"></a></span><a class="link" href="dispatch.html#asio.reference.io_context.dispatch.remarks">Remarks</a>
|
||
|
|
</h6>
|
||
|
|
<p>
|
||
|
|
This function throws an exception only if:
|
||
|
|
</p>
|
||
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||
|
|
<li class="listitem">
|
||
|
|
the handler's <code class="computeroutput"><span class="identifier">asio_handler_allocate</span></code>
|
||
|
|
function; or
|
||
|
|
</li>
|
||
|
|
<li class="listitem">
|
||
|
|
the handler's copy constructor
|
||
|
|
</li>
|
||
|
|
</ul></div>
|
||
|
|
<p>
|
||
|
|
throws an exception.
|
||
|
|
</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="destroy.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../io_context.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="executor_type.html"><img src="../../../next.png" alt="Next"></a>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|