59 lines
13 KiB
HTML
59 lines
13 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="epoll support."><meta name="keywords" content="rust, rustlang, rust-lang, epoll"><title>rustix::io::epoll - 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" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled><link rel="stylesheet" type="text/css" 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="../../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module epoll</a></h2><div class="sidebar-elems"><section><div class="block"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../rustix/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><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"><button type="button">?</button></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></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Module <a href="../../index.html">rustix</a>::<wbr><a href="../index.html">io</a>::<wbr><a class="mod" href="#">epoll</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></span></h1><span class="out-of-band"><a class="srclink" href="../../../src/rustix/backend/linux_raw/io/epoll.rs.html#1-404">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>epoll support.</p>
|
||
<p>This is an experiment, and it isn’t yet clear whether epoll is the right
|
||
level of abstraction at which to introduce safety. But it works fairly well
|
||
in simple examples 🙂.</p>
|
||
<h2 id="examples"><a href="#examples">Examples</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">io_lifetimes::AsFd</span>;
|
||
<span class="kw">use</span> <span class="ident">rustix::io::epoll</span>::{<span class="self">self</span>, <span class="ident">Epoll</span>};
|
||
<span class="kw">use</span> <span class="ident">rustix::io</span>::{<span class="ident">ioctl_fionbio</span>, <span class="ident">read</span>, <span class="ident">write</span>};
|
||
<span class="kw">use</span> <span class="ident">rustix::net</span>::{
|
||
<span class="ident">accept</span>, <span class="ident">bind_v4</span>, <span class="ident">listen</span>, <span class="ident">socket</span>, <span class="ident">AddressFamily</span>, <span class="ident">Ipv4Addr</span>, <span class="ident">Protocol</span>, <span class="ident">SocketAddrV4</span>,
|
||
<span class="ident">SocketType</span>,
|
||
};
|
||
<span class="kw">use</span> <span class="ident">std::os::unix::io::AsRawFd</span>;
|
||
|
||
<span class="comment">// Create a socket and listen on it.</span>
|
||
<span class="kw">let</span> <span class="ident">listen_sock</span> <span class="op">=</span> <span class="ident">socket</span>(<span class="ident">AddressFamily::INET</span>, <span class="ident">SocketType::STREAM</span>, <span class="ident">Protocol::default</span>())<span class="question-mark">?</span>;
|
||
<span class="ident">bind_v4</span>(<span class="kw-2">&</span><span class="ident">listen_sock</span>, <span class="kw-2">&</span><span class="ident">SocketAddrV4::new</span>(<span class="ident">Ipv4Addr::LOCALHOST</span>, <span class="number">0</span>))<span class="question-mark">?</span>;
|
||
<span class="ident">listen</span>(<span class="kw-2">&</span><span class="ident">listen_sock</span>, <span class="number">1</span>)<span class="question-mark">?</span>;
|
||
|
||
<span class="comment">// Create an epoll object. Using `Owning` here means the epoll object will</span>
|
||
<span class="comment">// take ownership of the file descriptors registered with it.</span>
|
||
<span class="kw">let</span> <span class="ident">epoll</span> <span class="op">=</span> <span class="ident">Epoll::new</span>(<span class="ident">epoll::CreateFlags::CLOEXEC</span>, <span class="ident">epoll::Owning::new</span>())<span class="question-mark">?</span>;
|
||
|
||
<span class="comment">// Remember the socket raw fd, which we use for comparisons only.</span>
|
||
<span class="kw">let</span> <span class="ident">raw_listen_sock</span> <span class="op">=</span> <span class="ident">listen_sock</span>.<span class="ident">as_fd</span>().<span class="ident">as_raw_fd</span>();
|
||
|
||
<span class="comment">// Register the socket with the epoll object.</span>
|
||
<span class="ident">epoll</span>.<span class="ident">add</span>(<span class="ident">listen_sock</span>, <span class="ident">epoll::EventFlags::IN</span>)<span class="question-mark">?</span>;
|
||
|
||
<span class="comment">// Process events.</span>
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">event_list</span> <span class="op">=</span> <span class="ident">epoll::EventVec::with_capacity</span>(<span class="number">4</span>);
|
||
<span class="kw">loop</span> {
|
||
<span class="ident">epoll</span>.<span class="ident">wait</span>(<span class="kw-2">&mut</span> <span class="ident">event_list</span>, <span class="op">-</span><span class="number">1</span>)<span class="question-mark">?</span>;
|
||
<span class="kw">for</span> (<span class="ident">_event_flags</span>, <span class="ident">target</span>) <span class="kw">in</span> <span class="kw-2">&</span><span class="ident">event_list</span> {
|
||
<span class="kw">if</span> <span class="ident">target</span>.<span class="ident">as_raw_fd</span>() <span class="op">==</span> <span class="ident">raw_listen_sock</span> {
|
||
<span class="comment">// Accept a new connection, set it to non-blocking, and</span>
|
||
<span class="comment">// register to be notified when it's ready to write to.</span>
|
||
<span class="kw">let</span> <span class="ident">conn_sock</span> <span class="op">=</span> <span class="ident">accept</span>(<span class="kw-2">&</span><span class="kw-2">*</span><span class="ident">target</span>)<span class="question-mark">?</span>;
|
||
<span class="ident">ioctl_fionbio</span>(<span class="kw-2">&</span><span class="ident">conn_sock</span>, <span class="bool-val">true</span>)<span class="question-mark">?</span>;
|
||
<span class="ident">epoll</span>.<span class="ident">add</span>(<span class="ident">conn_sock</span>, <span class="ident">epoll::EventFlags::OUT</span> <span class="op">|</span> <span class="ident">epoll::EventFlags::ET</span>)<span class="question-mark">?</span>;
|
||
} <span class="kw">else</span> {
|
||
<span class="comment">// Write a message to the stream and then unregister it.</span>
|
||
<span class="ident">write</span>(<span class="kw-2">&</span><span class="kw-2">*</span><span class="ident">target</span>, <span class="string">b"hello\n"</span>)<span class="question-mark">?</span>;
|
||
<span class="kw">let</span> <span class="kw">_</span> <span class="op">=</span> <span class="ident">epoll</span>.<span class="ident">del</span>(<span class="ident">target</span>)<span class="question-mark">?</span>;
|
||
}
|
||
}
|
||
}</code></pre></div>
|
||
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Borrowing.html" title="rustix::io::epoll::Borrowing struct">Borrowing</a></div><div class="item-right docblock-short"><p>A type implementing <a href="trait.Context.html" title="Context"><code>Context</code></a> where the <code>Data</code> type is <code>BorrowedFd<'a></code>.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CreateFlags.html" title="rustix::io::epoll::CreateFlags struct">CreateFlags</a></div><div class="item-right docblock-short"><p><code>EPOLL_*</code> for use with <a href="struct.Epoll.html#method.new" title="Epoll::new"><code>Epoll::new</code></a>.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Epoll.html" title="rustix::io::epoll::Epoll struct">Epoll</a></div><div class="item-right docblock-short"><p>An “epoll”, an interface to an OS object allowing one to repeatedly wait
|
||
for events from a set of file descriptors efficiently.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EventFlags.html" title="rustix::io::epoll::EventFlags struct">EventFlags</a></div><div class="item-right docblock-short"><p><code>EPOLL*</code> for use with <a href="struct.Epoll.html#method.add" title="Epoll::add"><code>Epoll::add</code></a>.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EventVec.html" title="rustix::io::epoll::EventVec struct">EventVec</a></div><div class="item-right docblock-short"><p>A vector of <code>Event</code>s, plus context for interpreting them.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Iter.html" title="rustix::io::epoll::Iter struct">Iter</a></div><div class="item-right docblock-short"><p>An iterator over the <code>Event</code>s in an <code>EventVec</code>.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Owning.html" title="rustix::io::epoll::Owning struct">Owning</a></div><div class="item-right docblock-short"><p>A type implementing <a href="trait.Context.html" title="Context"><code>Context</code></a> where the <code>Data</code> type is <code>T</code>, a type
|
||
implementing <code>From<OwnedFd></code> and <code>From<T> for OwnedFd</code>.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Ref.html" title="rustix::io::epoll::Ref struct">Ref</a></div><div class="item-right docblock-short"><p>A reference to a <code>T</code>.</p>
|
||
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Context.html" title="rustix::io::epoll::Context trait">Context</a></div><div class="item-right docblock-short"><p>A trait for data stored within an <a href="struct.Epoll.html"><code>Epoll</code></a> instance.</p>
|
||
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |