<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `signal` mod in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, signal"><title>actix_web::actix::signal - Rust</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><p class='location'>Module signal</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class='location'><a href='../../index.html'>actix_web</a>::<wbr><a href='../index.html'>actix</a></p><script>window.sidebarCurrent = {name: 'signal', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span></span><span class='in-band'>Module <a href='../../index.html'>actix_web</a>::<wbr><a href='../index.html'>actix</a>::<wbr><a class="mod" href=''>signal</a></span></h1><div class='docblock'><p>An actor implementation of Unix signal handling</p>
<p>This module implements asynchronous signal handling for Actix. For each
signal <code>ProcessSignals</code> actor sends <code>Signal</code> message to all subscriber. To
subscriber, send <code>Subscribe</code> message to <code>ProcessSignals</code> actor.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">actix</span>::<span class="ident">actors</span>::<span class="ident">signal</span>;
<span class="kw">use</span> <span class="ident">actix</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
<span class="kw">struct</span> <span class="ident">Signals</span>;
<span class="kw">impl</span> <span class="ident">Actor</span> <span class="kw">for</span> <span class="ident">Signals</span> {
<span class="kw">type</span> <span class="ident">Context</span> <span class="op">=</span> <span class="ident">Context</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>;
}
<span class="comment">// Shutdown system on and of `SIGINT`, `SIGTERM`, `SIGQUIT` signals</span>
<span class="kw">impl</span> <span class="ident">Handler</span><span class="op"><</span><span class="ident">signal</span>::<span class="ident">Signal</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Signals</span> {
<span class="kw">type</span> <span class="prelude-ty">Result</span> <span class="op">=</span> ();
<span class="kw">fn</span> <span class="ident">handle</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">msg</span>: <span class="ident">signal</span>::<span class="ident">Signal</span>, <span class="kw">_</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">Context</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>) {
<span class="kw">match</span> <span class="ident">msg</span>.<span class="number">0</span> {
<span class="ident">signal</span>::<span class="ident">SignalType</span>::<span class="ident">Int</span> <span class="op">=></span> {
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"SIGINT received, exiting"</span>);
<span class="ident">System</span>::<span class="ident">current</span>().<span class="ident">stop</span>();
}
<span class="ident">signal</span>::<span class="ident">SignalType</span>::<span class="ident">Hup</span> <span class="op">=></span> {
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"SIGHUP received, reloading"</span>);
}
<span class="ident">signal</span>::<span class="ident">SignalType</span>::<span class="ident">Term</span> <span class="op">=></span> {
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"SIGTERM received, stopping"</span>);
<span class="ident">System</span>::<span class="ident">current</span>().<span class="ident">stop</span>();
}
<span class="ident">signal</span>::<span class="ident">SignalType</span>::<span class="ident">Quit</span> <span class="op">=></span> {
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"SIGQUIT received, exiting"</span>);
<span class="ident">System</span>::<span class="ident">current</span>().<span class="ident">stop</span>();
}
<span class="kw">_</span> <span class="op">=></span> (),
}
}
}
<span class="kw">fn</span> <span class="ident">main</span>() {
<span class="comment">// initialize system</span>
<span class="ident">System</span>::<span class="ident">run</span>(<span class="op">||</span> {
<span class="comment">// Start signals handler</span>
<span class="kw">let</span> <span class="ident">addr</span> <span class="op">=</span> <span class="ident">Signals</span>.<span class="ident">start</span>();
<span class="comment">// send SIGTERM</span>
<span class="ident">std</span>::<span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">||</span> {
<span class="comment">// emulate SIGNTERM</span>
<span class="ident">addr</span>.<span class="ident">do_send</span>(<span class="ident">signal</span>::<span class="ident">Signal</span>(<span class="ident">signal</span>::<span class="ident">SignalType</span>::<span class="ident">Term</span>));
});
});
<span class="ident">std</span>::<span class="ident">process</span>::<span class="ident">exit</span>(<span class="number">0</span>);
}</pre>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.DefaultSignalsHandler.html"
title='struct actix_web::actix::signal::DefaultSignalsHandler'>DefaultSignalsHandler</a></td>
<td class='docblock-short'>
<p>Default signals handler. This actor sends <code>SystemExit</code> message to <code>System</code>
actor for each of <code>SIGINT</code>, <code>SIGTERM</code>, <code>SIGQUIT</code> signals.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.ProcessSignals.html"
title='struct actix_web::actix::signal::ProcessSignals'>ProcessSignals</a></td>
<td class='docblock-short'>
<p>An actor implementation of Unix signal handling</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Signal.html"
title='struct actix_web::actix::signal::Signal'>Signal</a></td>
<td class='docblock-short'>
<p>Process signal message</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Subscribe.html"
title='struct actix_web::actix::signal::Subscribe'>Subscribe</a></td>
<td class='docblock-short'>
<p>Subscribe to process signals.</p>
</td>
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
<tr class=' module-item'>
<td><a class="enum" href="enum.SignalType.html"
title='enum actix_web::actix::signal::SignalType'>SignalType</a></td>
<td class='docblock-short'>
<p>Different types of process signals</p>
</td>
</tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "actix_web";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>