| <!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="Cleaning up signals."><meta name="keywords" content="rust, rustlang, rust-lang, cleanup"><title>signal_hook::cleanup - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[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">☰</button><a class="sidebar-logo" href="../../signal_hook/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../signal_hook/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module cleanup</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#functions">Functions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">signal_hook</a>::<wbr><a class="mod" href="#">cleanup</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/signal_hook/cleanup.rs.html#1-207">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Cleaning up signals.</p> |
| <p>The routines in this module allow resetting the signals of an application back to defaults. |
| This is intended for the following situation:</p> |
| <ul> |
| <li>A terminal signal (eg. a <code>SIGTERM</code>, <code>SIGINT</code> or something similar) is received.</li> |
| <li>The application resets the signal handlers to defaults.</li> |
| <li>The application proceeds to perform some kind of shutdown (saving data, cleaning up, …).</li> |
| <li>If another such signal is received, the application is terminated right away the hard way, |
| without finishing the shutdown.</li> |
| </ul> |
| <p>The alternative of leaving the original signals in place might be problematic in case the |
| shutdown takes a long time or when it gets stuck. In such case the application would appear to |
| ignore the signal and just refuse to die.</p> |
| <p>There are two ways to perform the reset:</p> |
| <ul> |
| <li>Registering the reset as part of the signal handlers. This is more reliable (even in case the |
| application is already stuck in some kind of infinite loop, it would still work). This is |
| done by <a href="fn.register.html" title="register">register</a>.</li> |
| <li>Manually resetting the handlers just before the shutdown. This is done with <a href="fn.cleanup_signal.html" title="cleanup_signal">cleanup_signal</a>.</li> |
| </ul> |
| </div></details><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.cleanup_raw.html" title="signal_hook::cleanup::cleanup_raw fn">cleanup_raw</a></div><div class="item-right docblock-short">Resets the signal handler to the default one.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.cleanup_signal.html" title="signal_hook::cleanup::cleanup_signal fn">cleanup_signal</a></div><div class="item-right docblock-short">Resets the signal handler to the default one and removes all its hooks.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.register.html" title="signal_hook::cleanup::register fn">register</a></div><div class="item-right docblock-short">Register a cleanup after receiving a signal.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="signal_hook" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
