mirror of
https://github.com/fafhrd91/actix-net
synced 2025-02-07 06:44:23 +01:00
25 lines
5.2 KiB
HTML
25 lines
5.2 KiB
HTML
|
<!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="Creates a new listener which will receive notifications when the current process receives the specified signal `kind`."><title>signal in actix_rt::signal::unix - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-b778ab399e080a4b.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="actix_rt" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0-nightly (7608018cb 2024-09-29)" data-channel="nightly" data-search-js="search-e056c65ede92db13.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../../../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-54bc299d2a5e4e43.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-0111fcff984fae8f.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../../../actix_rt/index.html"><img src="https://actix.rs/img/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../../actix_rt/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../../../actix_rt/index.html">actix_<wbr>rt</a><span class="version">2.10.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">signal</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#errors" title="Errors">Errors</a></li><li><a href="#panics" title="Panics">Panics</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In actix_<wbr>rt::<wbr>signal::<wbr>unix</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../../index.html">actix_rt</a>::<wbr><a href="../index.html">signal</a>::<wbr><a href="index.html">unix</a></span><h1>Function <span class="fn">signal</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><pre class="rust item-decl"><code>pub fn signal(kind: <a class="struct" href="struct.SignalKind.html" title="struct actix_rt::signal::unix::SignalKind">SignalKind</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.Signal.html" title="struct actix_rt::signal::unix::Signal">Signal</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates a new listener which will receive notifications when the current
|
||
|
|
process receives the specified signal <code>kind</code>.</p>
|
||
|
|
<p>This function will create a new stream which binds to the default reactor.
|
||
|
|
The <code>Signal</code> stream is an infinite stream which will receive
|
||
|
|
notifications whenever a signal is received. More documentation can be
|
||
|
|
found on <code>Signal</code> itself, but to reiterate:</p>
|
||
|
|
<ul>
|
||
|
|
<li>Signals may be coalesced beyond what the kernel already does.</li>
|
||
|
|
<li>Once a signal handler is registered with the process the underlying
|
||
|
|
libc signal handler is never unregistered.</li>
|
||
|
|
</ul>
|
||
|
|
<p>A <code>Signal</code> stream can be created for a particular signal number
|
||
|
|
multiple times. When a signal is received then all the associated
|
||
|
|
channels will receive the signal notification.</p>
|
||
|
|
<h2 id="errors"><a class="doc-anchor" href="#errors">§</a>Errors</h2>
|
||
|
|
<ul>
|
||
|
|
<li>If the lower-level C functions fail for some reason.</li>
|
||
|
|
<li>If the previous initialization of this specific signal failed.</li>
|
||
|
|
<li>If the signal is one of
|
||
|
|
<a href="fn@signal_hook_registry::register#panics"><code>signal_hook::FORBIDDEN</code></a></li>
|
||
|
|
</ul>
|
||
|
|
<h2 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h2>
|
||
|
|
<p>This function panics if there is no current reactor set, or if the <code>rt</code>
|
||
|
|
feature flag is not enabled.</p>
|
||
|
|
</div></details></section></div></main></body></html>
|