|
|
<!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 `poll` fn in crate `nix`."><meta name="keywords" content="rust, rustlang, rust-lang, poll"><title>nix::poll::poll - 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 fn"><!--[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><div class="sidebar-elems"><p class='location'><a href='../index.html'>nix</a>::<wbr><a href='index.html'>poll</a></p><script>window.sidebarCurrent = {name: 'poll', ty: 'fn', 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/poll.rs.html#133-141' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='../index.html'>nix</a>::<wbr><a href='index.html'>poll</a>::<wbr><a class="fn" href=''>poll</a></span></h1><pre class='rust fn'>pub fn poll(fds: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="struct" href="../../nix/poll/struct.PollFd.html" title="struct nix::poll::PollFd">PollFd</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, timeout: <a class="type" href="../../libc/unix/type.c_int.html" title="type libc::unix::c_int">c_int</a>) -> <a class="type" href="../../nix/type.Result.html" title="type nix::Result">Result</a><<a class="type" href="../../libc/unix/type.c_int.html" title="type libc::unix::c_int">c_int</a>></pre><div class='docblock'><p><code>poll</code> waits for one of a set of file descriptors to become ready to perform I/O.
|
|
|
(<a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/poll.html"><code>poll(2)</code></a>)</p>
|
|
|
<p><code>fds</code> contains all <a href="struct.PollFd.html"><code>PollFd</code></a> to poll.
|
|
|
The function will return as soon as any event occur for any of these <code>PollFd</code>s.</p>
|
|
|
<p>The <code>timeout</code> argument specifies the number of milliseconds that <code>poll()</code>
|
|
|
should block waiting for a file descriptor to become ready. The call
|
|
|
will block until either:</p>
|
|
|
<ul>
|
|
|
<li>a file descriptor becomes ready;</li>
|
|
|
<li>the call is interrupted by a signal handler; or</li>
|
|
|
<li>the timeout expires.</li>
|
|
|
</ul>
|
|
|
<p>Note that the timeout interval will be rounded up to the system clock
|
|
|
granularity, and kernel scheduling delays mean that the blocking
|
|
|
interval may overrun by a small amount. Specifying a negative value
|
|
|
in timeout means an infinite timeout. Specifying a timeout of zero
|
|
|
causes <code>poll()</code> to return immediately, even if no file descriptors are
|
|
|
ready.</p>
|
|
|
</div></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> |
