123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151 |
- <html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
- <title>Handlers</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="GettableSocketOption.html" title="Gettable socket option requirements">
- <link rel="next" href="HandleService.html" title="Handle service requirements">
- </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="GettableSocketOption.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="HandleService.html"><img src="../../next.png" alt="Next"></a>
- </div>
- <div class="section">
- <div class="titlepage"><div><div><h3 class="title">
- <a name="asio.reference.Handler"></a><a class="link" href="Handler.html" title="Handlers">Handlers</a>
- </h3></div></div></div>
- <p>
- A handler must meet the requirements of <code class="computeroutput"><span class="identifier">CopyConstructible</span></code>
- types (C++ Std, 20.1.3).
- </p>
- <p>
- In the table below, <code class="computeroutput"><span class="identifier">X</span></code> denotes
- a handler class, <code class="computeroutput"><span class="identifier">h</span></code> denotes
- a value of <code class="computeroutput"><span class="identifier">X</span></code>, <code class="computeroutput"><span class="identifier">p</span></code> denotes a pointer to a block of allocated
- memory of type <code class="computeroutput"><span class="keyword">void</span><span class="special">*</span></code>,
- <code class="computeroutput"><span class="identifier">s</span></code> denotes the size for a
- block of allocated memory, and <code class="computeroutput"><span class="identifier">f</span></code>
- denotes a function object taking no arguments.
- </p>
- <div class="table">
- <a name="asio.reference.Handler.t0"></a><p class="title"><b>Table 13. Handler requirements</b></p>
- <div class="table-contents"><table class="table" summary="Handler requirements">
- <colgroup>
- <col>
- <col>
- <col>
- </colgroup>
- <thead><tr>
- <th>
- <p>
- expression
- </p>
- </th>
- <th>
- <p>
- return type
- </p>
- </th>
- <th>
- <p>
- assertion/note<br> pre/post-conditions
- </p>
- </th>
- </tr></thead>
- <tbody>
- <tr>
- <td>
- <p>
- </p>
- <pre class="programlisting"><span class="keyword">using</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">asio_handler_allocate</span><span class="special">;</span>
- <span class="identifier">asio_handler_allocate</span><span class="special">(</span><span class="identifier">s</span><span class="special">,</span> <span class="special">&</span><span class="identifier">h</span><span class="special">);</span>
- </pre>
- <p>
- </p>
- </td>
- <td>
- <p>
- <code class="computeroutput"><span class="keyword">void</span><span class="special">*</span></code>
- </p>
- </td>
- <td>
- <p>
- Returns a pointer to a block of memory of size <code class="computeroutput"><span class="identifier">s</span></code>.
- The pointer must satisfy the same alignment requirements as a pointer
- returned by <code class="computeroutput"><span class="special">::</span><span class="keyword">operator</span>
- <span class="keyword">new</span><span class="special">()</span></code>.
- Throws <code class="computeroutput"><span class="identifier">bad_alloc</span></code>
- on failure.<br> <br> The <code class="computeroutput"><span class="identifier">asio_handler_allocate</span><span class="special">()</span></code> function is located using argument-dependent
- lookup. The function <code class="computeroutput"><span class="identifier">asio</span><span class="special">::</span><span class="identifier">asio_handler_allocate</span><span class="special">()</span></code> serves as a default if no user-supplied
- function is available.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- </p>
- <pre class="programlisting"><span class="keyword">using</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">asio_handler_deallocate</span><span class="special">;</span>
- <span class="identifier">asio_handler_deallocate</span><span class="special">(</span><span class="identifier">p</span><span class="special">,</span> <span class="identifier">s</span><span class="special">,</span> <span class="special">&</span><span class="identifier">h</span><span class="special">);</span>
- </pre>
- <p>
- </p>
- </td>
- <td>
- </td>
- <td>
- <p>
- Frees a block of memory associated with a pointer <code class="computeroutput"><span class="identifier">p</span></code>, of at least size <code class="computeroutput"><span class="identifier">s</span></code>, that was previously allocated
- using <code class="computeroutput"><span class="identifier">asio_handler_allocate</span><span class="special">()</span></code>.<br> <br> The <code class="computeroutput"><span class="identifier">asio_handler_deallocate</span><span class="special">()</span></code>
- function is located using argument-dependent lookup. The function
- <code class="computeroutput"><span class="identifier">asio</span><span class="special">::</span><span class="identifier">asio_handler_deallocate</span><span class="special">()</span></code>
- serves as a default if no user-supplied function is available.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- </p>
- <pre class="programlisting"><span class="keyword">using</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">asio_handler_invoke</span><span class="special">;</span>
- <span class="identifier">asio_handler_invoke</span><span class="special">(</span><span class="identifier">f</span><span class="special">,</span> <span class="special">&</span><span class="identifier">h</span><span class="special">);</span>
- </pre>
- <p>
- </p>
- </td>
- <td>
- </td>
- <td>
- <p>
- Causes the function object <code class="computeroutput"><span class="identifier">f</span></code>
- to be executed as if by calling <code class="computeroutput"><span class="identifier">f</span><span class="special">()</span></code>.<br> <br> The <code class="computeroutput"><span class="identifier">asio_handler_invoke</span><span class="special">()</span></code>
- function is located using argument-dependent lookup. The function
- <code class="computeroutput"><span class="identifier">asio</span><span class="special">::</span><span class="identifier">asio_handler_invoke</span><span class="special">()</span></code>
- serves as a default if no user-supplied function is available.
- </p>
- </td>
- </tr>
- </tbody>
- </table></div>
- </div>
- <br class="table-break">
- </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-2014 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="GettableSocketOption.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="HandleService.html"><img src="../../next.png" alt="Next"></a>
- </div>
- </body>
- </html>
|