<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Socket acceptor service requirements</title> <link rel="stylesheet" href="../../boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.73.2"> <link rel="start" href="../../index.html" title="Asio"> <link rel="up" href="../reference.html" title="Reference"> <link rel="prev" href="SettableSocketOption.html" title="Settable socket option requirements"> <link rel="next" href="SocketService.html" title="Socket 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="SettableSocketOption.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="SocketService.html"><img src="../../next.png" alt="Next"></a> </div> <div class="section" lang="en"> <div class="titlepage"><div><div><h3 class="title"> <a name="asio.reference.SocketAcceptorService"></a><a class="link" href="SocketAcceptorService.html" title="Socket acceptor service requirements">Socket acceptor service requirements</a> </h3></div></div></div> <p> A socket acceptor service must meet the requirements for an <a class="link" href="IoObjectService.html" title="I/O object service requirements">I/O object service</a>, as well as the additional requirements listed below. </p> <p> In the table below, <code class="computeroutput"><span class="identifier">X</span></code> denotes a socket acceptor service class for protocol <a class="link" href="Protocol.html" title="Protocol requirements"><code class="computeroutput"><span class="identifier">Protocol</span></code></a>, <code class="computeroutput"><span class="identifier">a</span></code> denotes a value of type <code class="computeroutput"><span class="identifier">X</span></code>, <code class="computeroutput"><span class="identifier">b</span></code> denotes a value of type <code class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">implementation_type</span></code>, <code class="computeroutput"><span class="identifier">p</span></code> denotes a value of type <code class="computeroutput"><span class="identifier">Protocol</span></code>, <code class="computeroutput"><span class="identifier">n</span></code> denotes a value of type <code class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">native_type</span></code>, <code class="computeroutput"><span class="identifier">e</span></code> denotes a value of type <code class="computeroutput"><span class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span></code>, <code class="computeroutput"><span class="identifier">ec</span></code> denotes a value of type <code class="computeroutput"><span class="identifier">error_code</span></code>, <code class="computeroutput"><span class="identifier">s</span></code> denotes a value meeting <a class="link" href="SettableSocketOption.html" title="Settable socket option requirements"><code class="computeroutput"><span class="identifier">SettableSocketOption</span></code></a> requirements, <code class="computeroutput"><span class="identifier">g</span></code> denotes a value meeting <a class="link" href="GettableSocketOption.html" title="Gettable socket option requirements"><code class="computeroutput"><span class="identifier">GettableSocketOption</span></code></a> requirements, <code class="computeroutput"><span class="identifier">i</span></code> denotes a value meeting <a class="link" href="IoControlCommand.html" title="I/O control command requirements"><code class="computeroutput"><span class="identifier">IoControlCommand</span></code></a> requirements, <code class="computeroutput"><span class="identifier">k</span></code> denotes a value of type <code class="computeroutput"><span class="identifier">basic_socket</span><span class="special"><</span><span class="identifier">Protocol</span><span class="special">,</span> <span class="identifier">SocketService</span><span class="special">></span></code> where <code class="computeroutput"><span class="identifier">SocketService</span></code> is a type meeting <a class="link" href="SocketService.html" title="Socket service requirements">socket service</a> requirements, <code class="computeroutput"><span class="identifier">ah</span></code> denotes a value meeting <a class="link" href="AcceptHandler.html" title="Accept handler requirements"><code class="computeroutput"><span class="identifier">AcceptHandler</span></code></a> requirements, and <code class="computeroutput"><span class="identifier">u</span></code> and <code class="computeroutput"><span class="identifier">v</span></code> denote identifiers. </p> <div class="table"> <a name="id705641"></a><p class="title"><b>Table 26. SocketAcceptorService requirements</b></p> <div class="table-contents"><table class="table" summary="SocketAcceptorService requirements"> <colgroup> <col> <col> <col> </colgroup> <thead><tr> <th> <p> expression </p> </th> <th> <p> return type </p> </th> <th> <p> assertion/note\npre/post-condition </p> </th> </tr></thead> <tbody> <tr> <td> <p> <code class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">native_type</span></code> </p> </td> <td> </td> <td> <p> The implementation-defined native representation of a socket acceptor. Must satisfy the requirements of <code class="computeroutput"><span class="identifier">CopyConstructible</span></code> types (C++ Std, 20.1.3), and the requirements of <code class="computeroutput"><span class="identifier">Assignable</span></code> types (C++ Std, 23.1). </p> </td> </tr> <tr> <td> <p> <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">construct</span><span class="special">(</span><span class="identifier">b</span><span class="special">);</span></code> </p> </td> <td> </td> <td> <p> From <a class="link" href="IoObjectService.html" title="I/O object service requirements">IoObjectService</a> requirements.\n post: <code class="computeroutput"><span class="special">!</span><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>. </p> </td> </tr> <tr> <td> <p> <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">destroy</span><span class="special">(</span><span class="identifier">b</span><span class="special">);</span></code> </p> </td> <td> </td> <td> <p> From <a class="link" href="IoObjectService.html" title="I/O object service requirements">IoObjectService</a> requirements. Implicitly cancels asynchronous operations, as if by calling <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">close</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">)</span></code>. </p> </td> </tr> <tr> <td> <p> </p> <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">open</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">p</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span> </pre> <p> </p> </td> <td> <p> <code class="computeroutput"><span class="identifier">error_code</span></code> </p> </td> <td> <p> pre: <code class="computeroutput"><span class="special">!</span><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.\n post: <code class="computeroutput"><span class="special">!!</span><span class="identifier">ec</span> <span class="special">||</span> <span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>. </p> </td> </tr> <tr> <td> <p> </p> <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">assign</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">p</span><span class="special">,</span> <span class="identifier">n</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span> </pre> <p> </p> </td> <td> <p> <code class="computeroutput"><span class="identifier">error_code</span></code> </p> </td> <td> <p> pre: <code class="computeroutput"><span class="special">!</span><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.\n post: <code class="computeroutput"><span class="special">!!</span><span class="identifier">ec</span> <span class="special">||</span> <span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>. </p> </td> </tr> <tr> <td> <p> </p> <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">);</span> </pre> <p> </p> </td> <td> <p> <code class="computeroutput"><span class="keyword">bool</span></code> </p> </td> <td> </td> </tr> <tr> <td> <p> </p> <pre class="programlisting"><span class="keyword">const</span> <span class="identifier">X</span><span class="special">&</span> <span class="identifier">u</span> <span class="special">=</span> <span class="identifier">a</span><span class="special">;</span> <span class="keyword">const</span> <span class="identifier">X</span><span class="special">::</span><span class="identifier">implementation_type</span><span class="special">&</span> <span class="identifier">v</span> <span class="special">=</span> <span class="identifier">b</span><span class="special">;</span> <span class="identifier">u</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">v</span><span class="special">);</span> </pre> <p> </p> </td> <td> <p> <code class="computeroutput"><span class="keyword">bool</span></code> </p> </td> <td> </td> </tr> <tr> <td> <p> </p> <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">close</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span> </pre> <p> </p> </td> <td> <p> <code class="computeroutput"><span class="identifier">error_code</span></code> </p> </td> <td> <p> If <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">()</span></code> is true, causes any outstanding asynchronous operations to complete as soon as possible. Handlers for cancelled operations shall be passed the error code <code class="computeroutput"><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code>.\n post: <code class="computeroutput"><span class="special">!</span><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>. </p> </td> </tr> <tr> <td> <p> </p> <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">native</span><span class="special">(</span><span class="identifier">b</span><span class="special">);</span> </pre> <p> </p> </td> <td> <p> <code class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">native_type</span></code> </p> </td> <td> </td> </tr> <tr> <td> <p> </p> <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">cancel</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span> </pre> <p> </p> </td> <td> <p> <code class="computeroutput"><span class="identifier">error_code</span></code> </p> </td> <td> <p> pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.\n Causes any outstanding asynchronous operations to complete as soon as possible. Handlers for cancelled operations shall be passed the error code <code class="computeroutput"><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code>. </p> </td> </tr> <tr> <td> <p> </p> <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">s</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span> </pre> <p> </p> </td> <td> <p> <code class="computeroutput"><span class="identifier">error_code</span></code> </p> </td> <td> <p> pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>. </p> </td> </tr> <tr> <td> <p> </p> <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">g</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span> </pre> <p> </p> </td> <td> <p> <code class="computeroutput"><span class="identifier">error_code</span></code> </p> </td> <td> <p> pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>. </p> </td> </tr> <tr> <td> <p> </p> <pre class="programlisting"><span class="keyword">const</span> <span class="identifier">X</span><span class="special">&</span> <span class="identifier">u</span> <span class="special">=</span> <span class="identifier">a</span><span class="special">;</span> <span class="keyword">const</span> <span class="identifier">X</span><span class="special">::</span><span class="identifier">implementation_type</span><span class="special">&</span> <span class="identifier">v</span> <span class="special">=</span> <span class="identifier">b</span><span class="special">;</span> <span class="identifier">u</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">v</span><span class="special">,</span> <span class="identifier">g</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span> </pre> <p> </p> </td> <td> <p> <code class="computeroutput"><span class="identifier">error_code</span></code> </p> </td> <td> <p> pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>. </p> </td> </tr> <tr> <td> <p> </p> <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">io_control</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">i</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span> </pre> <p> </p> </td> <td> <p> <code class="computeroutput"><span class="identifier">error_code</span></code> </p> </td> <td> <p> pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>. </p> </td> </tr> <tr> <td> <p> </p> <pre class="programlisting"><span class="keyword">const</span> <span class="keyword">typename</span> <span class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span><span class="special">&</span> <span class="identifier">u</span> <span class="special">=</span> <span class="identifier">e</span><span class="special">;</span> <span class="identifier">a</span><span class="special">.</span><span class="identifier">bind</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">u</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span> </pre> <p> </p> </td> <td> <p> <code class="computeroutput"><span class="identifier">error_code</span></code> </p> </td> <td> <p> pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>. </p> </td> </tr> <tr> <td> <p> </p> <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">local_endpoint</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span> </pre> <p> </p> </td> <td> <p> <code class="computeroutput"><span class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span></code> </p> </td> <td> <p> pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>. </p> </td> </tr> <tr> <td> <p> </p> <pre class="programlisting"><span class="keyword">const</span> <span class="identifier">X</span><span class="special">&</span> <span class="identifier">u</span> <span class="special">=</span> <span class="identifier">a</span><span class="special">;</span> <span class="keyword">const</span> <span class="identifier">X</span><span class="special">::</span><span class="identifier">implementation_type</span><span class="special">&</span> <span class="identifier">v</span> <span class="special">=</span> <span class="identifier">b</span><span class="special">;</span> <span class="identifier">u</span><span class="special">.</span><span class="identifier">local_endpoint</span><span class="special">(</span><span class="identifier">v</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span> </pre> <p> </p> </td> <td> <p> <code class="computeroutput"><span class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span></code> </p> </td> <td> <p> pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>. </p> </td> </tr> <tr> <td> <p> </p> <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">accept</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">k</span><span class="special">,</span> <span class="special">&</span><span class="identifier">e</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span> </pre> <p> </p> </td> <td> <p> <code class="computeroutput"><span class="identifier">error_code</span></code> </p> </td> <td> <p> pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span> <span class="special">&&</span> <span class="special">!</span><span class="identifier">k</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">()</span></code>.\n post: <code class="computeroutput"><span class="identifier">k</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">()</span></code> </p> </td> </tr> <tr> <td> <p> </p> <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">accept</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">k</span><span class="special">,</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span> </pre> <p> </p> </td> <td> <p> <code class="computeroutput"><span class="identifier">error_code</span></code> </p> </td> <td> <p> pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span> <span class="special">&&</span> <span class="special">!</span><span class="identifier">k</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">()</span></code>.\n post: <code class="computeroutput"><span class="identifier">k</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">()</span></code> </p> </td> </tr> <tr> <td> <p> </p> <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">async_accept</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">k</span><span class="special">,</span> <span class="special">&</span><span class="identifier">e</span><span class="special">,</span> <span class="identifier">ah</span><span class="special">);</span> </pre> <p> </p> </td> <td> </td> <td> <p> pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span> <span class="special">&&</span> <span class="special">!</span><span class="identifier">k</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">()</span></code>.\n Initiates an asynchronous accept operation that is performed via the <code class="computeroutput"><span class="identifier">io_service</span></code> object <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">io_service</span><span class="special">()</span></code> and behaves according to <a class="link" href="asynchronous_operations.html" title="Requirements on asynchronous operations">asynchronous operation</a> requirements.\n\n The program must ensure the objects <code class="computeroutput"><span class="identifier">k</span></code> and <code class="computeroutput"><span class="identifier">e</span></code> are valid until the handler for the asynchronous operation is invoked. </p> </td> </tr> <tr> <td> <p> </p> <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">async_accept</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">k</span><span class="special">,</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">ah</span><span class="special">);</span> </pre> <p> </p> </td> <td> </td> <td> <p> pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span> <span class="special">&&</span> <span class="special">!</span><span class="identifier">k</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">()</span></code>.\n Initiates an asynchronous accept operation that is performed via the <code class="computeroutput"><span class="identifier">io_service</span></code> object <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">io_service</span><span class="special">()</span></code> and behaves according to <a class="link" href="asynchronous_operations.html" title="Requirements on asynchronous operations">asynchronous operation</a> requirements.\n\n The program must ensure the object <code class="computeroutput"><span class="identifier">k</span></code> is valid until the handler for the asynchronous operation is invoked. </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 - 2010 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="SettableSocketOption.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="SocketService.html"><img src="../../next.png" alt="Next"></a> </div> </body> </html>