doc/html/boost_asio/reference/signal_set.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>signal_set</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="../../boost_asio.html" title="Boost.Asio">
   8 <link rel="up" href="../reference.html" title="Reference">
   9 <link rel="prev" href="service_already_exists/service_already_exists.html" title="service_already_exists::service_already_exists">
  10 <link rel="next" href="signal_set_service.html" title="signal_set_service">
  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="service_already_exists/service_already_exists.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="signal_set_service.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="boost_asio.reference.signal_set"></a><a class="link" href="signal_set.html" title="signal_set">signal_set</a>
  28 </h3></div></div></div>
  29 <p>
  30         <a class="indexterm" name="id1532702"></a>
  31 Typedef for the typical usage of a signal set.
  32       </p>
  33 <pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">basic_signal_set</span> <span class="identifier">signal_set</span><span class="special">;</span>
  34 </pre>
  35 <h5>
  36 <a name="boost_asio.reference.signal_set.h0"></a>
  37         <span><a name="boost_asio.reference.signal_set.types"></a></span><a class="link" href="signal_set.html#boost_asio.reference.signal_set.types">Types</a>
  38       </h5>
  39 <div class="informaltable"><table class="table">
  40 <colgroup>
  41 <col>
  42 <col>
  43 </colgroup>
  44 <thead><tr>
  45 <th>
  46                 <p>
  47                   Name
  48                 </p>
  49               </th>
  50 <th>
  51                 <p>
  52                   Description
  53                 </p>
  54               </th>
  55 </tr></thead>
  56 <tbody>
  57 <tr>
  58 <td>
  59                 <p>
  60                   <a class="link" href="basic_signal_set/implementation_type.html" title="basic_signal_set::implementation_type"><span class="bold"><strong>implementation_type</strong></span></a>
  61                 </p>
  62               </td>
  63 <td>
  64                 <p>
  65                   The underlying implementation type of I/O object.
  66                 </p>
  67               </td>
  68 </tr>
  69 <tr>
  70 <td>
  71                 <p>
  72                   <a class="link" href="basic_signal_set/service_type.html" title="basic_signal_set::service_type"><span class="bold"><strong>service_type</strong></span></a>
  73                 </p>
  74               </td>
  75 <td>
  76                 <p>
  77                   The type of the service that will be used to provide I/O operations.
  78                 </p>
  79               </td>
  80 </tr>
  81 </tbody>
  82 </table></div>
  83 <h5>
  84 <a name="boost_asio.reference.signal_set.h1"></a>
  85         <span><a name="boost_asio.reference.signal_set.member_functions"></a></span><a class="link" href="signal_set.html#boost_asio.reference.signal_set.member_functions">Member
  86         Functions</a>
  87       </h5>
  88 <div class="informaltable"><table class="table">
  89 <colgroup>
  90 <col>
  91 <col>
  92 </colgroup>
  93 <thead><tr>
  94 <th>
  95                 <p>
  96                   Name
  97                 </p>
  98               </th>
  99 <th>
 100                 <p>
 101                   Description
 102                 </p>
 103               </th>
 104 </tr></thead>
 105 <tbody>
 106 <tr>
 107 <td>
 108                 <p>
 109                   <a class="link" href="basic_signal_set/add.html" title="basic_signal_set::add"><span class="bold"><strong>add</strong></span></a>
 110                 </p>
 111               </td>
 112 <td>
 113                 <p>
 114                   Add a signal to a signal_set.
 115                 </p>
 116               </td>
 117 </tr>
 118 <tr>
 119 <td>
 120                 <p>
 121                   <a class="link" href="basic_signal_set/async_wait.html" title="basic_signal_set::async_wait"><span class="bold"><strong>async_wait</strong></span></a>
 122                 </p>
 123               </td>
 124 <td>
 125                 <p>
 126                   Start an asynchronous operation to wait for a signal to be delivered.
 127                 </p>
 128               </td>
 129 </tr>
 130 <tr>
 131 <td>
 132                 <p>
 133                   <a class="link" href="basic_signal_set/basic_signal_set.html" title="basic_signal_set::basic_signal_set"><span class="bold"><strong>basic_signal_set</strong></span></a>
 134                 </p>
 135               </td>
 136 <td>
 137                 <p>
 138                   Construct a signal set without adding any signals.
 139                 </p>
 140                 <p>
 141                   Construct a signal set and add one signal.
 142                 </p>
 143                 <p>
 144                   Construct a signal set and add two signals.
 145                 </p>
 146                 <p>
 147                   Construct a signal set and add three signals.
 148                 </p>
 149               </td>
 150 </tr>
 151 <tr>
 152 <td>
 153                 <p>
 154                   <a class="link" href="basic_signal_set/cancel.html" title="basic_signal_set::cancel"><span class="bold"><strong>cancel</strong></span></a>
 155                 </p>
 156               </td>
 157 <td>
 158                 <p>
 159                   Cancel all operations associated with the signal set.
 160                 </p>
 161               </td>
 162 </tr>
 163 <tr>
 164 <td>
 165                 <p>
 166                   <a class="link" href="basic_signal_set/clear.html" title="basic_signal_set::clear"><span class="bold"><strong>clear</strong></span></a>
 167                 </p>
 168               </td>
 169 <td>
 170                 <p>
 171                   Remove all signals from a signal_set.
 172                 </p>
 173               </td>
 174 </tr>
 175 <tr>
 176 <td>
 177                 <p>
 178                   <a class="link" href="basic_signal_set/get_io_service.html" title="basic_signal_set::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a>
 179                 </p>
 180               </td>
 181 <td>
 182                 <p>
 183                   Get the io_service associated with the object.
 184                 </p>
 185               </td>
 186 </tr>
 187 <tr>
 188 <td>
 189                 <p>
 190                   <a class="link" href="basic_signal_set/remove.html" title="basic_signal_set::remove"><span class="bold"><strong>remove</strong></span></a>
 191                 </p>
 192               </td>
 193 <td>
 194                 <p>
 195                   Remove a signal from a signal_set.
 196                 </p>
 197               </td>
 198 </tr>
 199 </tbody>
 200 </table></div>
 201 <h5>
 202 <a name="boost_asio.reference.signal_set.h2"></a>
 203         <span><a name="boost_asio.reference.signal_set.protected_member_functions"></a></span><a class="link" href="signal_set.html#boost_asio.reference.signal_set.protected_member_functions">Protected
 204         Member Functions</a>
 205       </h5>
 206 <div class="informaltable"><table class="table">
 207 <colgroup>
 208 <col>
 209 <col>
 210 </colgroup>
 211 <thead><tr>
 212 <th>
 213                 <p>
 214                   Name
 215                 </p>
 216               </th>
 217 <th>
 218                 <p>
 219                   Description
 220                 </p>
 221               </th>
 222 </tr></thead>
 223 <tbody>
 224 <tr>
 225 <td>
 226                 <p>
 227                   <a class="link" href="basic_signal_set/get_implementation.html" title="basic_signal_set::get_implementation"><span class="bold"><strong>get_implementation</strong></span></a>
 228                 </p>
 229               </td>
 230 <td>
 231                 <p>
 232                   Get the underlying implementation of the I/O object.
 233                 </p>
 234               </td>
 235 </tr>
 236 <tr>
 237 <td>
 238                 <p>
 239                   <a class="link" href="basic_signal_set/get_service.html" title="basic_signal_set::get_service"><span class="bold"><strong>get_service</strong></span></a>
 240                 </p>
 241               </td>
 242 <td>
 243                 <p>
 244                   Get the service associated with the I/O object.
 245                 </p>
 246               </td>
 247 </tr>
 248 </tbody>
 249 </table></div>
 250 <h5>
 251 <a name="boost_asio.reference.signal_set.h3"></a>
 252         <span><a name="boost_asio.reference.signal_set.protected_data_members"></a></span><a class="link" href="signal_set.html#boost_asio.reference.signal_set.protected_data_members">Protected
 253         Data Members</a>
 254       </h5>
 255 <div class="informaltable"><table class="table">
 256 <colgroup>
 257 <col>
 258 <col>
 259 </colgroup>
 260 <thead><tr>
 261 <th>
 262                 <p>
 263                   Name
 264                 </p>
 265               </th>
 266 <th>
 267                 <p>
 268                   Description
 269                 </p>
 270               </th>
 271 </tr></thead>
 272 <tbody>
 273 <tr>
 274 <td>
 275                 <p>
 276                   <a class="link" href="basic_signal_set/implementation.html" title="basic_signal_set::implementation"><span class="bold"><strong>implementation</strong></span></a>
 277                 </p>
 278               </td>
 279 <td>
 280                 <p>
 281                   (Deprecated: Use get_implementation().) The underlying implementation
 282                   of the I/O object.
 283                 </p>
 284               </td>
 285 </tr>
 286 <tr>
 287 <td>
 288                 <p>
 289                   <a class="link" href="basic_signal_set/service.html" title="basic_signal_set::service"><span class="bold"><strong>service</strong></span></a>
 290                 </p>
 291               </td>
 292 <td>
 293                 <p>
 294                   (Deprecated: Use get_service().) The service associated with the
 295                   I/O object.
 296                 </p>
 297               </td>
 298 </tr>
 299 </tbody>
 300 </table></div>
 301 <p>
 302         The <a class="link" href="basic_signal_set.html" title="basic_signal_set"><code class="computeroutput"><span class="identifier">basic_signal_set</span></code></a>
 303         class template provides the ability to perform an asynchronous wait for one
 304         or more signals to occur.
 305       </p>
 306 <p>
 307         Most applications will use the <a class="link" href="signal_set.html" title="signal_set"><code class="computeroutput"><span class="identifier">signal_set</span></code></a> typedef.
 308       </p>
 309 <h5>
 310 <a name="boost_asio.reference.signal_set.h4"></a>
 311         <span><a name="boost_asio.reference.signal_set.thread_safety"></a></span><a class="link" href="signal_set.html#boost_asio.reference.signal_set.thread_safety">Thread
 312         Safety</a>
 313       </h5>
 314 <p>
 315         <span class="bold"><strong>Distinct</strong></span> <span class="bold"><strong>objects:</strong></span>
 316         Safe.
 317       </p>
 318 <p>
 319         <span class="bold"><strong>Shared</strong></span> <span class="bold"><strong>objects:</strong></span>
 320         Unsafe.
 321       </p>
 322 <h5>
 323 <a name="boost_asio.reference.signal_set.h5"></a>
 324         <span><a name="boost_asio.reference.signal_set.example"></a></span><a class="link" href="signal_set.html#boost_asio.reference.signal_set.example">Example</a>
 325       </h5>
 326 <p>
 327         Performing an asynchronous wait:
 328       </p>
 329 <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span>
 330     <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">error</span><span class="special">,</span>
 331     <span class="keyword">int</span> <span class="identifier">signal_number</span><span class="special">)</span>
 332 <span class="special">{</span>
 333   <span class="keyword">if</span> <span class="special">(!</span><span class="identifier">error</span><span class="special">)</span>
 334   <span class="special">{</span>
 335     <span class="comment">// A signal occurred.</span>
 336   <span class="special">}</span>
 337 <span class="special">}</span>
 338
 339 <span class="special">...</span>
 340
 341 <span class="comment">// Construct a signal set registered for process termination.</span>
 342 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">signal_set</span> <span class="identifier">signals</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">,</span> <span class="identifier">SIGINT</span><span class="special">,</span> <span class="identifier">SIGTERM</span><span class="special">);</span>
 343
 344 <span class="comment">// Start an asynchronous wait for one of the signals to occur.</span>
 345 <span class="identifier">signals</span><span class="special">.</span><span class="identifier">async_wait</span><span class="special">(</span><span class="identifier">handler</span><span class="special">);</span>
 346 </pre>
 347 <h5>
 348 <a name="boost_asio.reference.signal_set.h6"></a>
 349         <span><a name="boost_asio.reference.signal_set.queueing_of_signal_notifications"></a></span><a class="link" href="signal_set.html#boost_asio.reference.signal_set.queueing_of_signal_notifications">Queueing
 350         of signal notifications</a>
 351       </h5>
 352 <p>
 353         If a signal is registered with a signal_set, and the signal occurs when there
 354         are no waiting handlers, then the signal notification is queued. The next
 355         async_wait operation on that signal_set will dequeue the notification. If
 356         multiple notifications are queued, subsequent async_wait operations dequeue
 357         them one at a time. Signal notifications are dequeued in order of ascending
 358         signal number.
 359       </p>
 360 <p>
 361         If a signal number is removed from a signal_set (using the <code class="computeroutput"><span class="identifier">remove</span></code> or <code class="computeroutput"><span class="identifier">erase</span></code>
 362         member functions) then any queued notifications for that signal are discarded.
 363       </p>
 364 <h5>
 365 <a name="boost_asio.reference.signal_set.h7"></a>
 366         <span><a name="boost_asio.reference.signal_set.multiple_registration_of_signals"></a></span><a class="link" href="signal_set.html#boost_asio.reference.signal_set.multiple_registration_of_signals">Multiple
 367         registration of signals</a>
 368       </h5>
 369 <p>
 370         The same signal number may be registered with different signal_set objects.
 371         When the signal occurs, one handler is called for each signal_set object.
 372       </p>
 373 <p>
 374         Note that multiple registration only works for signals that are registered
 375         using Asio. The application must not also register a signal handler using
 376         functions such as <code class="computeroutput"><span class="identifier">signal</span><span class="special">()</span></code> or <code class="computeroutput"><span class="identifier">sigaction</span><span class="special">()</span></code>.
 377       </p>
 378 <h5>
 379 <a name="boost_asio.reference.signal_set.h8"></a>
 380         <span><a name="boost_asio.reference.signal_set.signal_masking_on_posix_platforms"></a></span><a class="link" href="signal_set.html#boost_asio.reference.signal_set.signal_masking_on_posix_platforms">Signal
 381         masking on POSIX platforms</a>
 382       </h5>
 383 <p>
 384         POSIX allows signals to be blocked using functions such as <code class="computeroutput"><span class="identifier">sigprocmask</span><span class="special">()</span></code>
 385         and <code class="computeroutput"><span class="identifier">pthread_sigmask</span><span class="special">()</span></code>.
 386         For signals to be delivered, programs must ensure that any signals registered
 387         using signal_set objects are unblocked in at least one thread.
 388       </p>
 389 <h5>
 390 <a name="boost_asio.reference.signal_set.h9"></a>
 391         <span><a name="boost_asio.reference.signal_set.requirements"></a></span><a class="link" href="signal_set.html#boost_asio.reference.signal_set.requirements">Requirements</a>
 392       </h5>
 393 <p>
 394         <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/signal_set.hpp</code>
 395       </p>
 396 <p>
 397         <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code>
 398       </p>
 399 </div>
 400 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 401 <td align="left"></td>
 402 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2012 Christopher M. Kohlhoff<p>
 403         Distributed under the Boost Software License, Version 1.0. (See accompanying
 404         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>)
 405       </p>
 406 </div></td>
 407 </tr></table>
 408 <hr>
 409 <div class="spirit-nav">
 410 <a accesskey="p" href="service_already_exists/service_already_exists.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="signal_set_service.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 411 </div>
 412 </body>
 413 </html>