334 lines
14 KiB
HTML
334 lines
14 KiB
HTML
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
|
|
<title>signal_set</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="service_already_exists/service_already_exists.html" title="service_already_exists::service_already_exists">
|
||
|
|
<link rel="next" href="signal_set_base.html" title="signal_set_base">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
</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="service_already_exists/service_already_exists.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="signal_set_base.html"><img src="../../next.png" alt="Next"></a>
|
||
|
|
</div>
|
||
|
|
<div class="section">
|
||
|
|
<div class="titlepage"><div><div><h3 class="title">
|
||
|
|
<a name="asio.reference.signal_set"></a><a class="link" href="signal_set.html" title="signal_set">signal_set</a>
|
||
|
|
</h3></div></div></div>
|
||
|
|
<p>
|
||
|
|
<a class="indexterm" name="asio.indexterm.signal_set"></a>
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
Typedef for the typical usage of a signal set.
|
||
|
|
</p>
|
||
|
|
<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>
|
||
|
|
</pre>
|
||
|
|
<h5>
|
||
|
|
<a name="asio.reference.signal_set.h0"></a>
|
||
|
|
<span><a name="asio.reference.signal_set.types"></a></span><a class="link" href="signal_set.html#asio.reference.signal_set.types">Types</a>
|
||
|
|
</h5>
|
||
|
|
<div class="informaltable"><table class="table">
|
||
|
|
<colgroup>
|
||
|
|
<col>
|
||
|
|
<col>
|
||
|
|
</colgroup>
|
||
|
|
<thead><tr>
|
||
|
|
<th>
|
||
|
|
<p>
|
||
|
|
Name
|
||
|
|
</p>
|
||
|
|
</th>
|
||
|
|
<th>
|
||
|
|
<p>
|
||
|
|
Description
|
||
|
|
</p>
|
||
|
|
</th>
|
||
|
|
</tr></thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="basic_signal_set__rebind_executor.html" title="basic_signal_set::rebind_executor"><span class="bold"><strong>rebind_executor</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Rebinds the signal set type to another executor.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="basic_signal_set/executor_type.html" title="basic_signal_set::executor_type"><span class="bold"><strong>executor_type</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
The type of the executor associated with the object.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="basic_signal_set/flags.html" title="basic_signal_set::flags"><span class="bold"><strong>flags</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Enumeration representing the different types of flags that may
|
||
|
|
specified when adding a signal to a set.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="basic_signal_set/flags_t.html" title="basic_signal_set::flags_t"><span class="bold"><strong>flags_t</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Portability typedef.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table></div>
|
||
|
|
<h5>
|
||
|
|
<a name="asio.reference.signal_set.h1"></a>
|
||
|
|
<span><a name="asio.reference.signal_set.member_functions"></a></span><a class="link" href="signal_set.html#asio.reference.signal_set.member_functions">Member
|
||
|
|
Functions</a>
|
||
|
|
</h5>
|
||
|
|
<div class="informaltable"><table class="table">
|
||
|
|
<colgroup>
|
||
|
|
<col>
|
||
|
|
<col>
|
||
|
|
</colgroup>
|
||
|
|
<thead><tr>
|
||
|
|
<th>
|
||
|
|
<p>
|
||
|
|
Name
|
||
|
|
</p>
|
||
|
|
</th>
|
||
|
|
<th>
|
||
|
|
<p>
|
||
|
|
Description
|
||
|
|
</p>
|
||
|
|
</th>
|
||
|
|
</tr></thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="basic_signal_set/add.html" title="basic_signal_set::add"><span class="bold"><strong>add</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Add a signal to a signal_set. <br> <span class="silver"> —</span><br> Add a signal to a signal_set
|
||
|
|
with the specified flags.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<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>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Start an asynchronous operation to wait for a signal to be delivered.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<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> <span class="silver">[constructor]</span>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Construct a signal set without adding any signals. <br> <span class="silver"> —</span><br>
|
||
|
|
Construct a signal set and add one signal. <br> <span class="silver"> —</span><br> Construct
|
||
|
|
a signal set and add two signals. <br> <span class="silver"> —</span><br> Construct a signal
|
||
|
|
set and add three signals.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="basic_signal_set/cancel.html" title="basic_signal_set::cancel"><span class="bold"><strong>cancel</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Cancel all operations associated with the signal set.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="basic_signal_set/clear.html" title="basic_signal_set::clear"><span class="bold"><strong>clear</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Remove all signals from a signal_set.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="basic_signal_set/get_executor.html" title="basic_signal_set::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Get the executor associated with the object.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="basic_signal_set/remove.html" title="basic_signal_set::remove"><span class="bold"><strong>remove</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Remove a signal from a signal_set.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<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> <span class="silver">[destructor]</span>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Destroys the signal set.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table></div>
|
||
|
|
<p>
|
||
|
|
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>
|
||
|
|
class provides the ability to perform an asynchronous wait for one or more
|
||
|
|
signals to occur.
|
||
|
|
</p>
|
||
|
|
<h5>
|
||
|
|
<a name="asio.reference.signal_set.h2"></a>
|
||
|
|
<span><a name="asio.reference.signal_set.thread_safety"></a></span><a class="link" href="signal_set.html#asio.reference.signal_set.thread_safety">Thread
|
||
|
|
Safety</a>
|
||
|
|
</h5>
|
||
|
|
<p>
|
||
|
|
<span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
<span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
|
||
|
|
</p>
|
||
|
|
<h5>
|
||
|
|
<a name="asio.reference.signal_set.h3"></a>
|
||
|
|
<span><a name="asio.reference.signal_set.example"></a></span><a class="link" href="signal_set.html#asio.reference.signal_set.example">Example</a>
|
||
|
|
</h5>
|
||
|
|
<p>
|
||
|
|
Performing an asynchronous wait:
|
||
|
|
</p>
|
||
|
|
<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span>
|
||
|
|
<span class="keyword">const</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">error</span><span class="special">,</span>
|
||
|
|
<span class="keyword">int</span> <span class="identifier">signal_number</span><span class="special">)</span>
|
||
|
|
<span class="special">{</span>
|
||
|
|
<span class="keyword">if</span> <span class="special">(!</span><span class="identifier">error</span><span class="special">)</span>
|
||
|
|
<span class="special">{</span>
|
||
|
|
<span class="comment">// A signal occurred.</span>
|
||
|
|
<span class="special">}</span>
|
||
|
|
<span class="special">}</span>
|
||
|
|
|
||
|
|
<span class="special">...</span>
|
||
|
|
|
||
|
|
<span class="comment">// Construct a signal set registered for process termination.</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">my_context</span><span class="special">,</span> <span class="identifier">SIGINT</span><span class="special">,</span> <span class="identifier">SIGTERM</span><span class="special">);</span>
|
||
|
|
|
||
|
|
<span class="comment">// Start an asynchronous wait for one of the signals to occur.</span>
|
||
|
|
<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>
|
||
|
|
</pre>
|
||
|
|
<h5>
|
||
|
|
<a name="asio.reference.signal_set.h4"></a>
|
||
|
|
<span><a name="asio.reference.signal_set.queueing_of_signal_notifications"></a></span><a class="link" href="signal_set.html#asio.reference.signal_set.queueing_of_signal_notifications">Queueing
|
||
|
|
of signal notifications</a>
|
||
|
|
</h5>
|
||
|
|
<p>
|
||
|
|
If a signal is registered with a signal_set, and the signal occurs when there
|
||
|
|
are no waiting handlers, then the signal notification is queued. The next
|
||
|
|
async_wait operation on that signal_set will dequeue the notification. If
|
||
|
|
multiple notifications are queued, subsequent async_wait operations dequeue
|
||
|
|
them one at a time. Signal notifications are dequeued in order of ascending
|
||
|
|
signal number.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
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>
|
||
|
|
member functions) then any queued notifications for that signal are discarded.
|
||
|
|
</p>
|
||
|
|
<h5>
|
||
|
|
<a name="asio.reference.signal_set.h5"></a>
|
||
|
|
<span><a name="asio.reference.signal_set.multiple_registration_of_signals"></a></span><a class="link" href="signal_set.html#asio.reference.signal_set.multiple_registration_of_signals">Multiple
|
||
|
|
registration of signals</a>
|
||
|
|
</h5>
|
||
|
|
<p>
|
||
|
|
The same signal number may be registered with different signal_set objects.
|
||
|
|
When the signal occurs, one handler is called for each signal_set object.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
Note that multiple registration only works for signals that are registered
|
||
|
|
using Asio. The application must not also register a signal handler using
|
||
|
|
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>.
|
||
|
|
</p>
|
||
|
|
<h5>
|
||
|
|
<a name="asio.reference.signal_set.h6"></a>
|
||
|
|
<span><a name="asio.reference.signal_set.signal_masking_on_posix_platforms"></a></span><a class="link" href="signal_set.html#asio.reference.signal_set.signal_masking_on_posix_platforms">Signal
|
||
|
|
masking on POSIX platforms</a>
|
||
|
|
</h5>
|
||
|
|
<p>
|
||
|
|
POSIX allows signals to be blocked using functions such as <code class="computeroutput"><span class="identifier">sigprocmask</span><span class="special">()</span></code>
|
||
|
|
and <code class="computeroutput"><span class="identifier">pthread_sigmask</span><span class="special">()</span></code>.
|
||
|
|
For signals to be delivered, programs must ensure that any signals registered
|
||
|
|
using signal_set objects are unblocked in at least one thread.
|
||
|
|
</p>
|
||
|
|
<h5>
|
||
|
|
<a name="asio.reference.signal_set.h7"></a>
|
||
|
|
<span><a name="asio.reference.signal_set.requirements"></a></span><a class="link" href="signal_set.html#asio.reference.signal_set.requirements">Requirements</a>
|
||
|
|
</h5>
|
||
|
|
<p>
|
||
|
|
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/signal_set.hpp</code>
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<div class="copyright-footer">Copyright © 2003-2023 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>
|
||
|
|
<hr>
|
||
|
|
<div class="spirit-nav">
|
||
|
|
<a accesskey="p" href="service_already_exists/service_already_exists.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="signal_set_base.html"><img src="../../next.png" alt="Next"></a>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|