mirror of
https://github.com/fafhrd91/actix-web
synced 2025-01-19 22:24:40 +01:00
39 lines
5.9 KiB
HTML
39 lines
5.9 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="Completes when a “ctrl-c” notification is sent to the process."><title>ctrl_c in actix_web::rt::signal - 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-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="actix_web" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (bdbbb6c6a 2024-05-26)" data-channel="nightly" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-df360f571f6edeae.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_web/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_web/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../../../actix_web/index.html">actix_web</a><span class="version">4.6.0</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In actix_web::rt::signal</a></h2></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"><h1>Function <a href="../../index.html">actix_web</a>::<wbr><a href="../index.html">rt</a>::<wbr><a href="index.html">signal</a>::<wbr><a class="fn" href="#">ctrl_c</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub async fn ctrl_c() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</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>Completes when a “ctrl-c” notification is sent to the process.</p>
|
||
|
|
<p>While signals are handled very differently between Unix and Windows, both
|
||
|
|
platforms support receiving a signal on “ctrl-c”. This function provides a
|
||
|
|
portable API for receiving this notification.</p>
|
||
|
|
<p>Once the returned future is polled, a listener is registered. The future
|
||
|
|
will complete on the first received <code>ctrl-c</code> <strong>after</strong> the initial call to
|
||
|
|
either <code>Future::poll</code> or <code>.await</code>.</p>
|
||
|
|
<h2 id="caveats"><a class="doc-anchor" href="#caveats">§</a>Caveats</h2>
|
||
|
|
<p>On Unix platforms, the first time that a <code>Signal</code> instance is registered for a
|
||
|
|
particular signal kind, an OS signal-handler is installed which replaces the
|
||
|
|
default platform behavior when that signal is received, <strong>for the duration of
|
||
|
|
the entire process</strong>.</p>
|
||
|
|
<p>For example, Unix systems will terminate a process by default when it
|
||
|
|
receives a signal generated by <code>"CTRL+C"</code> on the terminal. But, when a
|
||
|
|
<code>ctrl_c</code> stream is created to listen for this signal, the time it arrives,
|
||
|
|
it will be translated to a stream event, and the process will continue to
|
||
|
|
execute. <strong>Even if this <code>Signal</code> instance is dropped, subsequent <code>SIGINT</code>
|
||
|
|
deliveries will end up captured by Tokio, and the default platform behavior
|
||
|
|
will NOT be reset</strong>.</p>
|
||
|
|
<p>Thus, applications should take care to ensure the expected signal behavior
|
||
|
|
occurs as expected after listening for specific signals.</p>
|
||
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::signal;
|
||
|
|
|
||
|
|
<span class="attr">#[tokio::main]
|
||
|
|
</span><span class="kw">async fn </span>main() {
|
||
|
|
<span class="macro">println!</span>(<span class="string">"waiting for ctrl-c"</span>);
|
||
|
|
|
||
|
|
signal::ctrl_c().<span class="kw">await</span>.expect(<span class="string">"failed to listen for event"</span>);
|
||
|
|
|
||
|
|
<span class="macro">println!</span>(<span class="string">"received ctrl-c event"</span>);
|
||
|
|
}</code></pre></div>
|
||
|
|
<p>Listen in the background:</p>
|
||
|
|
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>tokio::spawn(<span class="kw">async move </span>{
|
||
|
|
tokio::signal::ctrl_c().<span class="kw">await</span>.unwrap();
|
||
|
|
<span class="comment">// Your handler here
|
||
|
|
</span>});</code></pre></div>
|
||
|
|
</div></details></section></div></main></body></html>
|