|
|
<!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 `signalfd` mod in crate `nix`."><meta name="keywords" content="rust, rustlang, rust-lang, signalfd"><title>nix::sys::signalfd - 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 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><a href='../../../nix/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><p class='location'>Module signalfd</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#structs">Structs</a></li><li><a href="#constants">Constants</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../../index.html'>nix</a>::<wbr><a href='../index.html'>sys</a></p><script>window.sidebarCurrent = {name: 'signalfd', 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"><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/signalfd.rs.html#1-170' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../index.html'>nix</a>::<wbr><a href='../index.html'>sys</a>::<wbr><a class="mod" href=''>signalfd</a></span></h1><div class='docblock'><p>Interface for the <code>signalfd</code> syscall.</p>
|
|
|
<h1 id="signal-discarding" class="section-header"><a href="#signal-discarding">Signal discarding</a></h1>
|
|
|
<p>When a signal can't be delivered to a process (or thread), it will become a pending signal.
|
|
|
Failure to deliver could happen if the signal is blocked by every thread in the process or if
|
|
|
the signal handler is still handling a previous signal.</p>
|
|
|
<p>If a signal is sent to a process (or thread) that already has a pending signal of the same
|
|
|
type, it will be discarded. This means that if signals of the same type are received faster than
|
|
|
they are processed, some of those signals will be dropped. Because of this limitation,
|
|
|
<code>signalfd</code> in itself cannot be used for reliable communication between processes or threads.</p>
|
|
|
<p>Once the signal is unblocked, or the signal handler is finished, and a signal is still pending
|
|
|
(ie. not consumed from a signalfd) it will be delivered to the signal handler.</p>
|
|
|
<p>Please note that signal discarding is not specific to <code>signalfd</code>, but also happens with regular
|
|
|
signal handlers.</p>
|
|
|
</div><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
|
|
|
<table><tr><td><code>pub use sys::<a class="mod" href="../../../nix/sys/signal/index.html" title="mod nix::sys::signal">signal</a>;</code></td></tr><tr><td><code>pub use sys::signal::<a class="struct" href="../../../nix/sys/signal/struct.SigSet.html" title="struct nix::sys::signal::SigSet">SigSet</a>;</code></td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.SfdFlags.html" title='nix::sys::signalfd::SfdFlags struct'>SfdFlags</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.SignalFd.html" title='nix::sys::signalfd::SignalFd struct'>SignalFd</a></td><td class='docblock-short'><p>A helper struct for creating, reading and closing a <code>signalfd</code> instance.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.siginfo.html" title='nix::sys::signalfd::siginfo struct'>siginfo</a></td><td class='docblock-short'></td></tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="constant" href="constant.SIGNALFD_NEW.html" title='nix::sys::signalfd::SIGNALFD_NEW constant'>SIGNALFD_NEW</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="constant" href="constant.SIGNALFD_SIGINFO_SIZE.html" title='nix::sys::signalfd::SIGNALFD_SIGINFO_SIZE constant'>SIGNALFD_SIGINFO_SIZE</a></td><td class='docblock-short'></td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="fn" href="fn.signalfd.html" title='nix::sys::signalfd::signalfd fn'>signalfd</a></td><td class='docblock-short'><p>Creates a new file descriptor for reading 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 = "nix";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html> |
