experimental__as_single_t.html 7.65 KB
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>experimental::as_single_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="experimental__as_single.html" title="experimental::as_single">
<link rel="next" href="experimental__as_single_t/as_default_on.html" title="experimental::as_single_t::as_default_on">
</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="experimental__as_single.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="experimental__as_single_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.experimental__as_single_t"></a><a class="link" href="experimental__as_single_t.html" title="experimental::as_single_t">experimental::as_single_t</a>
</h3></div></div></div>
<p>
        Completion token type used to specify that the completion handler arguments
        should be combined into a single argument.
      </p>
<pre class="programlisting">template&lt;
    typename CompletionToken&gt;
class as_single_t
</pre>
<h5>
<a name="asio.reference.experimental__as_single_t.h0"></a>
        <span><a name="asio.reference.experimental__as_single_t.types"></a></span><a class="link" href="experimental__as_single_t.html#asio.reference.experimental__as_single_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="experimental__as_single_t__default_constructor_tag.html" title="experimental::as_single_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="experimental__as_single_t__executor_with_default.html" title="experimental::as_single_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_single_t completion token as the
                  default.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.experimental__as_single_t.h1"></a>
        <span><a name="asio.reference.experimental__as_single_t.member_functions"></a></span><a class="link" href="experimental__as_single_t.html#asio.reference.experimental__as_single_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="experimental__as_single_t/as_default_on.html" title="experimental::as_single_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_single_t as its
                  default completion token type.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="experimental__as_single_t/as_single_t.html" title="experimental::as_single_t::as_single_t"><span class="bold"><strong>as_single_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.experimental__as_single_t.h2"></a>
        <span><a name="asio.reference.experimental__as_single_t.data_members"></a></span><a class="link" href="experimental__as_single_t.html#asio.reference.experimental__as_single_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="experimental__as_single_t/token_.html" title="experimental::as_single_t::token_"><span class="bold"><strong>token_</strong></span></a>
                </p>
              </td>
<td>
              </td>
</tr></tbody>
</table></div>
<p>
        The <a class="link" href="experimental__as_single_t.html" title="experimental::as_single_t"><code class="computeroutput">experimental::as_single_t</code></a>
        class is used to indicate that any arguments to the completion handler should
        be combined and passed as a single argument. If there is already one argument,
        that argument is passed as-is. If there is more than argument, the arguments
        are first moved into a <code class="computeroutput">std::tuple</code> and that tuple is then passed
        to the completion handler.
      </p>
<h5>
<a name="asio.reference.experimental__as_single_t.h3"></a>
        <span><a name="asio.reference.experimental__as_single_t.requirements"></a></span><a class="link" href="experimental__as_single_t.html#asio.reference.experimental__as_single_t.requirements">Requirements</a>
      </h5>
<p>
        <span class="emphasis"><em>Header: </em></span><code class="literal">asio/experimental/as_single.hpp</code>
      </p>
<p>
        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
      </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2020 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></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="experimental__as_single.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="experimental__as_single_t/as_default_on.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>