libs/beast/doc/html/beast/ref/boost__beast__allocate_stable.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>allocate_stable</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="../../index.html" title="Chapter&#160;1.&#160;Boost.Beast">
   8 <link rel="up" href="../ref.html" title="This Page Intentionally Left Blank 2/2">
   9 <link rel="prev" href="../ref.html" title="This Page Intentionally Left Blank 2/2">
  10 <link rel="next" href="boost__beast__async_base.html" title="async_base">
  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="../ref.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__async_base.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="beast.ref.boost__beast__allocate_stable"></a><a class="link" href="boost__beast__allocate_stable.html" title="allocate_stable">allocate_stable</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873520603952"></a>
  31 Allocate a temporary object to hold stable asynchronous operation
  32         state.
  33       </p>
  34 <h5>
  35 <a name="beast.ref.boost__beast__allocate_stable.h0"></a>
  36         <span class="phrase"><a name="beast.ref.boost__beast__allocate_stable.synopsis"></a></span><a class="link" href="boost__beast__allocate_stable.html#beast.ref.boost__beast__allocate_stable.synopsis">Synopsis</a>
  37       </h5>
  38 <p>
  39         Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/core/async_base.hpp" target="_top">boost/beast/core/async_base.hpp</a>&gt;</code>
  40       </p>
  41 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  42     <span class="keyword">class</span> <span class="identifier">State</span><span class="special">,</span>
  43     <span class="keyword">class</span> <a href="../../../../../../doc/html/boost_asio/reference/Handler.html" target="_top"><span class="emphasis"><em>Handler</em></span></a><span class="special">,</span>
  44     <span class="keyword">class</span> <a href="../../../../../../doc/html/boost_asio/reference/Executor1.html" target="_top"><span class="emphasis"><em>Executor1</em></span></a><span class="special">,</span>
  45     <span class="keyword">class</span> <a href="https://en.cppreference.com/w/cpp/named_req/Allocator" target="_top"><span class="emphasis"><em>Allocator</em></span></a><span class="special">,</span>
  46     <span class="keyword">class</span><span class="special">...</span> <span class="identifier">Args</span><span class="special">&gt;</span>
  47 <span class="identifier">State</span><span class="special">&amp;</span>
  48 <span class="identifier">allocate_stable</span><span class="special">(</span>
  49     <span class="identifier">stable_async_base</span><span class="special">&lt;</span> <span class="identifier">Handler</span><span class="special">,</span> <span class="identifier">Executor1</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">&gt;&amp;</span> <span class="identifier">base</span><span class="special">,</span>
  50     <span class="identifier">Args</span><span class="special">&amp;&amp;...</span> <span class="identifier">args</span><span class="special">);</span>
  51 </pre>
  52 <h5>
  53 <a name="beast.ref.boost__beast__allocate_stable.h1"></a>
  54         <span class="phrase"><a name="beast.ref.boost__beast__allocate_stable.description"></a></span><a class="link" href="boost__beast__allocate_stable.html#beast.ref.boost__beast__allocate_stable.description">Description</a>
  55       </h5>
  56 <p>
  57         The object will be destroyed just before the completion handler is invoked,
  58         or when the base is destroyed.
  59       </p>
  60 <h5>
  61 <a name="beast.ref.boost__beast__allocate_stable.h2"></a>
  62         <span class="phrase"><a name="beast.ref.boost__beast__allocate_stable.template_parameters"></a></span><a class="link" href="boost__beast__allocate_stable.html#beast.ref.boost__beast__allocate_stable.template_parameters">Template
  63         Parameters</a>
  64       </h5>
  65 <div class="informaltable"><table class="table">
  66 <colgroup>
  67 <col>
  68 <col>
  69 </colgroup>
  70 <thead><tr>
  71 <th>
  72                 <p>
  73                   Type
  74                 </p>
  75               </th>
  76 <th>
  77                 <p>
  78                   Description
  79                 </p>
  80               </th>
  81 </tr></thead>
  82 <tbody><tr>
  83 <td>
  84                 <p>
  85                   <code class="computeroutput"><span class="identifier">State</span></code>
  86                 </p>
  87               </td>
  88 <td>
  89                 <p>
  90                   The type of object to allocate.
  91                 </p>
  92               </td>
  93 </tr></tbody>
  94 </table></div>
  95 <h5>
  96 <a name="beast.ref.boost__beast__allocate_stable.h3"></a>
  97         <span class="phrase"><a name="beast.ref.boost__beast__allocate_stable.parameters"></a></span><a class="link" href="boost__beast__allocate_stable.html#beast.ref.boost__beast__allocate_stable.parameters">Parameters</a>
  98       </h5>
  99 <div class="informaltable"><table class="table">
 100 <colgroup>
 101 <col>
 102 <col>
 103 </colgroup>
 104 <thead><tr>
 105 <th>
 106                 <p>
 107                   Name
 108                 </p>
 109               </th>
 110 <th>
 111                 <p>
 112                   Description
 113                 </p>
 114               </th>
 115 </tr></thead>
 116 <tbody>
 117 <tr>
 118 <td>
 119                 <p>
 120                   <code class="computeroutput"><span class="identifier">base</span></code>
 121                 </p>
 122               </td>
 123 <td>
 124                 <p>
 125                   The helper to allocate from.
 126                 </p>
 127               </td>
 128 </tr>
 129 <tr>
 130 <td>
 131                 <p>
 132                   <code class="computeroutput"><span class="identifier">args</span></code>
 133                 </p>
 134               </td>
 135 <td>
 136                 <p>
 137                   An optional list of parameters to forward to the constructor of
 138                   the object being allocated.
 139                 </p>
 140               </td>
 141 </tr>
 142 </tbody>
 143 </table></div>
 144 <h5>
 145 <a name="beast.ref.boost__beast__allocate_stable.h4"></a>
 146         <span class="phrase"><a name="beast.ref.boost__beast__allocate_stable.see_also"></a></span><a class="link" href="boost__beast__allocate_stable.html#beast.ref.boost__beast__allocate_stable.see_also">See
 147         Also</a>
 148       </h5>
 149 <p>
 150         <a class="link" href="boost__beast__stable_async_base.html" title="stable_async_base"><code class="computeroutput"><span class="identifier">stable_async_base</span></code></a>
 151       </p>
 152 <p>
 153         Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/core.hpp" target="_top">boost/beast/core.hpp</a>&gt;</code>
 154       </p>
 155 </div>
 156 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 157 <td align="left"></td>
 158 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 159       Falco<p>
 160         Distributed under the Boost Software License, Version 1.0. (See accompanying
 161         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>)
 162       </p>
 163 </div></td>
 164 </tr></table>
 165 <hr>
 166 <div class="spirit-nav">
 167 <a accesskey="p" href="../ref.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__async_base.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 168 </div>
 169 </body>
 170 </html>