|
|
|
|
|
<!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` fn in crate `nix`."><meta name="keywords" content="rust, rustlang, rust-lang, signal"><title>nix::sys::signal::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><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="shortcut icon" href="../../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[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><a href='../../../nix/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='../../index.html'>nix</a>::<wbr><a href='../index.html'>sys</a>::<wbr><a href='index.html'>signal</a></p><script>window.sidebarCurrent = {name: 'signal', ty: 'fn', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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><a class='srclink' href='../../../src/nix/sys/signal.rs.html#571-586' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='../../index.html'>nix</a>::<wbr><a href='../index.html'>sys</a>::<wbr><a href='index.html'>signal</a>::<wbr><a class="fn" href=''>signal</a></span></h1><pre class='rust fn'>pub unsafe fn signal(signal: <a class="enum" href="../../../nix/sys/signal/enum.Signal.html" title="enum nix::sys::signal::Signal">Signal</a>, handler: <a class="enum" href="../../../nix/sys/signal/enum.SigHandler.html" title="enum nix::sys::signal::SigHandler">SigHandler</a>) -> <a class="type" href="../../../nix/type.Result.html" title="type nix::Result">Result</a><<a class="enum" href="../../../nix/sys/signal/enum.SigHandler.html" title="enum nix::sys::signal::SigHandler">SigHandler</a>></pre><div class='docblock'><p>Signal management (see <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/signal.html">signal(3p)</a>)</p>
|
|
|
|
|
|
<p>Installs <code>handler</code> for the given <code>signal</code>, returning the previous signal
|
|
|
|
|
|
handler. <code>signal</code> should only be used following another call to <code>signal</code> or
|
|
|
|
|
|
if the current handler is the default. The return value of <code>signal</code> is
|
|
|
|
|
|
undefined after setting the handler with <a href="fn.sigaction.html"><code>sigaction</code></a>.</p>
|
|
|
|
|
|
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
|
|
|
|
|
<p>If the pointer to the previous signal handler is invalid, undefined
|
|
|
|
|
|
behavior could be invoked when casting it back to a <a href="struct.SigAction.html"><code>SigAction</code></a>.</p>
|
|
|
|
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|
|
|
|
|
<p>Ignore <code>SIGINT</code>:</p>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">unsafe</span> { <span class="ident">signal</span>::<span class="ident">signal</span>(<span class="ident">Signal</span>::<span class="ident">SIGINT</span>, <span class="ident">SigHandler</span>::<span class="ident">SigIgn</span>) }.<span class="ident">unwrap</span>();</pre></div>
|
|
|
|
|
|
<p>Use a signal handler to set a flag variable:</p>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="macro">lazy_static</span><span class="macro">!</span> {
|
|
|
|
|
|
<span class="kw">static</span> <span class="kw-2">ref</span> <span class="ident">SIGNALED</span>: <span class="ident">AtomicBool</span> <span class="op">=</span> <span class="ident">AtomicBool</span>::<span class="ident">new</span>(<span class="bool-val">false</span>);
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">extern</span> <span class="kw">fn</span> <span class="ident">handle_sigint</span>(<span class="ident">signal</span>: <span class="ident">libc</span>::<span class="ident">c_int</span>) {
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">signal</span> <span class="op">=</span> <span class="ident">Signal</span>::<span class="ident">from_c_int</span>(<span class="ident">signal</span>).<span class="ident">unwrap</span>();
|
|
|
|
|
|
<span class="ident">SIGNALED</span>.<span class="ident">store</span>(<span class="ident">signal</span> <span class="op">=</span><span class="op">=</span> <span class="ident">Signal</span>::<span class="ident">SIGINT</span>, <span class="ident">Ordering</span>::<span class="ident">Relaxed</span>);
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">fn</span> <span class="ident">main</span>() {
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">handler</span> <span class="op">=</span> <span class="ident">SigHandler</span>::<span class="ident">Handler</span>(<span class="ident">handle_sigint</span>);
|
|
|
|
|
|
<span class="kw">unsafe</span> { <span class="ident">signal</span>::<span class="ident">signal</span>(<span class="ident">Signal</span>::<span class="ident">SIGINT</span>, <span class="ident">handler</span>) }.<span class="ident">unwrap</span>();
|
|
|
|
|
|
}</pre></div>
|
|
|
|
|
|
<h1 id="errors" class="section-header"><a href="#errors">Errors</a></h1>
|
|
|
|
|
|
<p>Returns <a href="../../enum.Error.html#variant.UnsupportedOperation"><code>Error::UnsupportedOperation</code></a> if <code>handler</code> is
|
|
|
|
|
|
<a href="struct.SigAction.html"><code>SigAction</code></a>. Use <a href="fn.sigaction.html"><code>sigaction</code></a> instead.</p>
|
|
|
|
|
|
<p><code>signal</code> also returns any error from <code>libc::signal</code>, such as when an attempt
|
|
|
|
|
|
is made to catch a signal that cannot be caught or to ignore a signal that
|
|
|
|
|
|
cannot be ignored.</p>
|
|
|
|
|
|
</div></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 = "nix";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>
|
