Insane_DNS/libraries/asio-1.28.1/doc/asio/reference/as_tuple_t.html

196 lines
7.4 KiB
HTML
Raw Normal View History

2023-10-24 21:59:30 -04:00
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>as_tuple_t</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="../reference.html" title="Reference">
<link rel="prev" href="as_tuple.html" title="as_tuple">
<link rel="next" href="as_tuple_t/as_default_on.html" title="as_tuple_t::as_default_on">
<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="as_tuple.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="as_tuple_t/as_default_on.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.as_tuple_t"></a><a class="link" href="as_tuple_t.html" title="as_tuple_t">as_tuple_t</a>
</h3></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.as_tuple_t"></a>
</p>
<p>
A <a class="link" href="../overview/model/completion_tokens.html" title="Completion Tokens">completion token</a>
adapter used to specify that the completion handler arguments should be combined
into a single tuple argument.
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <span class="identifier">CompletionToken</span><span class="special">&gt;</span>
<span class="keyword">class</span> <span class="identifier">as_tuple_t</span>
</pre>
<h5>
<a name="asio.reference.as_tuple_t.h0"></a>
<span><a name="asio.reference.as_tuple_t.types"></a></span><a class="link" href="as_tuple_t.html#asio.reference.as_tuple_t.types">Types</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<a class="link" href="as_tuple_t__default_constructor_tag.html" title="as_tuple_t::default_constructor_tag"><span class="bold"><strong>default_constructor_tag</strong></span></a>
</p>
</td>
<td>
<p>
Tag type used to prevent the "default" constructor from
being used for conversions.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="as_tuple_t__executor_with_default.html" title="as_tuple_t::executor_with_default"><span class="bold"><strong>executor_with_default</strong></span></a>
</p>
</td>
<td>
<p>
Adapts an executor to add the as_tuple_t completion token as the
default.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.as_tuple_t.h1"></a>
<span><a name="asio.reference.as_tuple_t.member_functions"></a></span><a class="link" href="as_tuple_t.html#asio.reference.as_tuple_t.member_functions">Member
Functions</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<a class="link" href="as_tuple_t/as_default_on.html" title="as_tuple_t::as_default_on"><span class="bold"><strong>as_default_on</strong></span></a> <span class="silver">[static]</span>
</p>
</td>
<td>
<p>
Function helper to adapt an I/O object to use as_tuple_t as its
default completion token type.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="as_tuple_t/as_tuple_t.html" title="as_tuple_t::as_tuple_t"><span class="bold"><strong>as_tuple_t</strong></span></a> <span class="silver">[constructor]</span>
</p>
</td>
<td>
<p>
Default constructor. <br> <span class="silver"></span><br> Constructor.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.as_tuple_t.h2"></a>
<span><a name="asio.reference.as_tuple_t.data_members"></a></span><a class="link" href="as_tuple_t.html#asio.reference.as_tuple_t.data_members">Data
Members</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<a class="link" href="as_tuple_t/token_.html" title="as_tuple_t::token_"><span class="bold"><strong>token_</strong></span></a>
</p>
</td>
<td>
</td>
</tr></tbody>
</table></div>
<p>
The <a class="link" href="as_tuple_t.html" title="as_tuple_t"><code class="computeroutput"><span class="identifier">as_tuple_t</span></code></a>
class is used to indicate that any arguments to the completion handler should
be combined and passed as a single tuple argument. The arguments are first
moved into a <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">tuple</span></code> and that tuple is then passed to
the completion handler.
</p>
<h5>
<a name="asio.reference.as_tuple_t.h3"></a>
<span><a name="asio.reference.as_tuple_t.requirements"></a></span><a class="link" href="as_tuple_t.html#asio.reference.as_tuple_t.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/as_tuple.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
</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="as_tuple.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="as_tuple_t/as_default_on.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>