| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>Signal set service requirements</title> |
| <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> |
| <link rel="home" href="../../boost_asio.html" title="Boost.Asio"> |
| <link rel="up" href="../reference.html" title="Reference"> |
| <link rel="prev" href="SignalHandler.html" title="Signal handler requirements"> |
| <link rel="next" href="SocketAcceptorService.html" title="Socket acceptor 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="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> |
| <td align="center"><a href="../../../../index.html">Home</a></td> |
| <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> |
| <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> |
| <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> |
| <td align="center"><a href="../../../../more/index.htm">More</a></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="SignalHandler.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="SocketAcceptorService.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="section"> |
| <div class="titlepage"><div><div><h3 class="title"> |
| <a name="boost_asio.reference.SignalSetService"></a><a class="link" href="SignalSetService.html" title="Signal set service requirements">Signal set service |
| requirements</a> |
| </h3></div></div></div> |
| <p> |
| A signal set 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 signal set service class, <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">ec</span></code> |
| denotes a value of type <code class="computeroutput"><span class="identifier">error_code</span></code>, |
| <code class="computeroutput"><span class="identifier">n</span></code> denotes a value of type |
| <code class="computeroutput"><span class="keyword">int</span></code>, and <code class="computeroutput"><span class="identifier">sh</span></code> |
| denotes a value meeting <a class="link" href="SignalHandler.html" title="Signal handler requirements"><code class="computeroutput"><span class="identifier">SignalHandler</span></code></a> requirements. |
| </p> |
| <div class="table"> |
| <a name="id870278"></a><p class="title"><b>Table 27. SignalSetService requirements</b></p> |
| <div class="table-contents"><table class="table" summary="SignalSetService 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-condition |
| </p> |
| </th> |
| </tr></thead> |
| <tbody> |
| <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.<br> |
| </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 clears the registered signals as if by |
| calling <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">clear</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> |
| <span class="identifier">ec</span><span class="special">)</span></code>, |
| then implicitly cancels outstanding asynchronous operations as |
| if by calling <code class="computeroutput"><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></code>. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| |
| </p> |
| <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">add</span><span class="special">(</span><span class="identifier">b</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> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| |
| </p> |
| <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">remove</span><span class="special">(</span><span class="identifier">b</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> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| |
| </p> |
| <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">clear</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> |
| </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> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">async_wait</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> |
| <span class="identifier">sh</span><span class="special">);</span></code> |
| </p> |
| </td> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="keyword">void</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>.<br> |
| <br> Initiates an asynchronous operation to wait for the delivery |
| of one of the signals registered for the signal set <code class="computeroutput"><span class="identifier">b</span></code>. The operation 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">get_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.<br> <br> If the operation completes |
| successfully, the <code class="computeroutput"><span class="identifier">SignalHandler</span></code> |
| object <code class="computeroutput"><span class="identifier">sh</span></code> is invoked |
| with the number identifying the delivered signal. Otherwise it |
| is invoked with <code class="computeroutput"><span class="number">0</span></code>. |
| </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-2011 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="SignalHandler.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="SocketAcceptorService.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |
