mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-05 11:38:44 +00:00
74 lines
21 KiB
HTML
74 lines
21 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="API documentation for the Rust `ControlMessage` enum in crate `nix`."><meta name="keywords" content="rust, rustlang, rust-lang, ControlMessage"><title>nix::sys::socket::ControlMessage - 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></head><body class="rustdoc enum"><!--[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><p class='location'>Enum ControlMessage</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.ScmRights">ScmRights</a><a href="#variant.ScmTimestamp">ScmTimestamp</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../../index.html'>nix</a>::<wbr><a href='../index.html'>sys</a>::<wbr><a href='index.html'>socket</a></p><script>window.sidebarCurrent = {name: 'ControlMessage', ty: 'enum', 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"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><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='in-band'>Enum <a href='../../index.html'>nix</a>::<wbr><a href='../index.html'>sys</a>::<wbr><a href='index.html'>socket</a>::<wbr><a class="enum" href=''>ControlMessage</a></span><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/sys/socket/mod.rs.html#431-508' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust enum'>pub enum ControlMessage<'a> {
|
|||
|
|
ScmRights(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="type" href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/type.RawFd.html" title="type std::sys::unix::ext::io::RawFd">RawFd</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>),
|
|||
|
|
ScmTimestamp(&'a <a class="struct" href="../../../nix/sys/time/struct.TimeVal.html" title="struct nix::sys::time::TimeVal">TimeVal</a>),
|
|||
|
|
// some variants omitted
|
|||
|
|
}</pre></div><div class='docblock'><p>A type-safe wrapper around a single control message. More types may
|
|||
|
|
be added to this enum; do not exhaustively pattern-match it.
|
|||
|
|
<a href="http://man7.org/linux/man-pages/man3/cmsg.3.html">Further reading</a></p>
|
|||
|
|
</div><h2 id='variants' class='variants small-section-header'>
|
|||
|
|
Variants<a href='#variants' class='anchor'></a></h2>
|
|||
|
|
<span id="variant.ScmRights" class="variant small-section-header"><a href="#variant.ScmRights" class="anchor field"></a><span id='ScmRights.v' class='invisible'><code>ScmRights(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="type" href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/type.RawFd.html" title="type std::sys::unix::ext::io::RawFd">RawFd</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>)</code></span></span><div class='docblock'><p>A message of type <code>SCM_RIGHTS</code>, containing an array of file
|
|||
|
|
descriptors passed between processes.</p>
|
|||
|
|
<p>See the description in the "Ancillary messages" section of the
|
|||
|
|
<a href="http://man7.org/linux/man-pages/man7/unix.7.html">unix(7) man page</a>.</p>
|
|||
|
|
</div><span id="variant.ScmTimestamp" class="variant small-section-header"><a href="#variant.ScmTimestamp" class="anchor field"></a><span id='ScmTimestamp.v' class='invisible'><code>ScmTimestamp(&'a <a class="struct" href="../../../nix/sys/time/struct.TimeVal.html" title="struct nix::sys::time::TimeVal">TimeVal</a>)</code></span></span><div class='docblock'><p>A message of type <code>SCM_TIMESTAMP</code>, containing the time the
|
|||
|
|
packet was received by the kernel.</p>
|
|||
|
|
<p>See the kernel's explanation in "SO_TIMESTAMP" of
|
|||
|
|
<a href="https://www.kernel.org/doc/Documentation/networking/timestamping.txt">networking/timestamping</a>.</p>
|
|||
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">nix</span>::<span class="ident">sys</span>::<span class="ident">socket</span>::<span class="kw-2">*</span>;
|
|||
|
|
<span class="kw">use</span> <span class="ident">nix</span>::<span class="ident">sys</span>::<span class="ident">uio</span>::<span class="ident">IoVec</span>;
|
|||
|
|
<span class="kw">use</span> <span class="ident">nix</span>::<span class="ident">sys</span>::<span class="ident">time</span>::<span class="kw-2">*</span>;
|
|||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">time</span>::<span class="kw-2">*</span>;
|
|||
|
|
|
|||
|
|
<span class="comment">// Set up</span>
|
|||
|
|
<span class="kw">let</span> <span class="ident">message1</span> <span class="op">=</span> <span class="string">"Ohayō!"</span>.<span class="ident">as_bytes</span>();
|
|||
|
|
<span class="kw">let</span> <span class="ident">message2</span> <span class="op">=</span> <span class="string">"Jā ne"</span>.<span class="ident">as_bytes</span>();
|
|||
|
|
<span class="kw">let</span> <span class="ident">in_socket</span> <span class="op">=</span> <span class="ident">socket</span>(<span class="ident">AddressFamily</span>::<span class="ident">Inet</span>, <span class="ident">SockType</span>::<span class="ident">Datagram</span>, <span class="ident">SockFlag</span>::<span class="ident">empty</span>(), <span class="prelude-val">None</span>).<span class="ident">unwrap</span>();
|
|||
|
|
<span class="ident">setsockopt</span>(<span class="ident">in_socket</span>, <span class="ident">sockopt</span>::<span class="ident">ReceiveTimestamp</span>, <span class="kw-2">&</span><span class="bool-val">true</span>).<span class="ident">unwrap</span>();
|
|||
|
|
<span class="ident">bind</span>(<span class="ident">in_socket</span>, <span class="kw-2">&</span><span class="ident">SockAddr</span>::<span class="ident">new_inet</span>(<span class="ident">InetAddr</span>::<span class="ident">new</span>(<span class="ident">IpAddr</span>::<span class="ident">new_v4</span>(<span class="number">127</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">1</span>), <span class="number">0</span>))).<span class="ident">unwrap</span>();
|
|||
|
|
<span class="kw">let</span> <span class="ident">address</span> <span class="op">=</span> <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Ok</span>(<span class="ident">address</span>) <span class="op">=</span> <span class="ident">getsockname</span>(<span class="ident">in_socket</span>) { <span class="ident">address</span> } <span class="kw">else</span> { <span class="macro">unreachable</span><span class="macro">!</span>() };
|
|||
|
|
|
|||
|
|
<span class="comment">// Send both</span>
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="prelude-val">Ok</span>(<span class="ident">message1</span>.<span class="ident">len</span>()) <span class="op">==</span> <span class="ident">sendmsg</span>(<span class="ident">in_socket</span>, <span class="kw-2">&</span>[<span class="ident">IoVec</span>::<span class="ident">from_slice</span>(<span class="ident">message1</span>)], <span class="kw-2">&</span>[], <span class="ident">MsgFlags</span>::<span class="ident">empty</span>(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="ident">address</span>)));
|
|||
|
|
<span class="kw">let</span> <span class="ident">time</span> <span class="op">=</span> <span class="ident">SystemTime</span>::<span class="ident">now</span>();
|
|||
|
|
<span class="ident">std</span>::<span class="ident">thread</span>::<span class="ident">sleep</span>(<span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="number">250</span>));
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="prelude-val">Ok</span>(<span class="ident">message2</span>.<span class="ident">len</span>()) <span class="op">==</span> <span class="ident">sendmsg</span>(<span class="ident">in_socket</span>, <span class="kw-2">&</span>[<span class="ident">IoVec</span>::<span class="ident">from_slice</span>(<span class="ident">message2</span>)], <span class="kw-2">&</span>[], <span class="ident">MsgFlags</span>::<span class="ident">empty</span>(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="ident">address</span>)));
|
|||
|
|
<span class="kw">let</span> <span class="ident">delay</span> <span class="op">=</span> <span class="ident">time</span>.<span class="ident">elapsed</span>().<span class="ident">unwrap</span>();
|
|||
|
|
|
|||
|
|
<span class="comment">// Receive the first</span>
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buffer1</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="number">0u8</span>; <span class="ident">message1</span>.<span class="ident">len</span>() <span class="op">+</span> <span class="ident">message2</span>.<span class="ident">len</span>()];
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">time1</span>: <span class="ident">CmsgSpace</span><span class="op"><</span><span class="ident">TimeVal</span><span class="op">></span> <span class="op">=</span> <span class="ident">CmsgSpace</span>::<span class="ident">new</span>();
|
|||
|
|
<span class="kw">let</span> <span class="ident">received1</span> <span class="op">=</span> <span class="ident">recvmsg</span>(<span class="ident">in_socket</span>, <span class="kw-2">&</span>[<span class="ident">IoVec</span>::<span class="ident">from_mut_slice</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buffer1</span>)], <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">time1</span>), <span class="ident">MsgFlags</span>::<span class="ident">empty</span>()).<span class="ident">unwrap</span>();
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">time1</span> <span class="op">=</span> <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">ControlMessage</span>::<span class="ident">ScmTimestamp</span>(<span class="kw-2">&</span><span class="ident">time1</span>)) <span class="op">=</span> <span class="ident">received1</span>.<span class="ident">cmsgs</span>().<span class="ident">next</span>() { <span class="ident">time1</span> } <span class="kw">else</span> { <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Unexpected or no control message"</span>) };
|
|||
|
|
|
|||
|
|
<span class="comment">// Receive the second</span>
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buffer2</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="number">0u8</span>; <span class="ident">message1</span>.<span class="ident">len</span>() <span class="op">+</span> <span class="ident">message2</span>.<span class="ident">len</span>()];
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">time2</span>: <span class="ident">CmsgSpace</span><span class="op"><</span><span class="ident">TimeVal</span><span class="op">></span> <span class="op">=</span> <span class="ident">CmsgSpace</span>::<span class="ident">new</span>();
|
|||
|
|
<span class="kw">let</span> <span class="ident">received2</span> <span class="op">=</span> <span class="ident">recvmsg</span>(<span class="ident">in_socket</span>, <span class="kw-2">&</span>[<span class="ident">IoVec</span>::<span class="ident">from_mut_slice</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buffer2</span>)], <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">time2</span>), <span class="ident">MsgFlags</span>::<span class="ident">empty</span>()).<span class="ident">unwrap</span>();
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">time2</span> <span class="op">=</span> <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">ControlMessage</span>::<span class="ident">ScmTimestamp</span>(<span class="kw-2">&</span><span class="ident">time2</span>)) <span class="op">=</span> <span class="ident">received2</span>.<span class="ident">cmsgs</span>().<span class="ident">next</span>() { <span class="ident">time2</span> } <span class="kw">else</span> { <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Unexpected or no control message"</span>) };
|
|||
|
|
|
|||
|
|
<span class="comment">// Swap if needed; UDP is unordered</span>
|
|||
|
|
<span class="kw">match</span> (<span class="ident">received1</span>.<span class="ident">bytes</span>, <span class="ident">received2</span>.<span class="ident">bytes</span>, <span class="ident">message1</span>.<span class="ident">len</span>(), <span class="ident">message2</span>.<span class="ident">len</span>()) {
|
|||
|
|
(<span class="ident">l1</span>, <span class="ident">l2</span>, <span class="ident">m1</span>, <span class="ident">m2</span>) <span class="kw">if</span> <span class="ident">l1</span> <span class="op">==</span> <span class="ident">m1</span> <span class="op">&&</span> <span class="ident">l2</span> <span class="op">==</span> <span class="ident">m2</span> <span class="op">=></span> {},
|
|||
|
|
(<span class="ident">l2</span>, <span class="ident">l1</span>, <span class="ident">m1</span>, <span class="ident">m2</span>) <span class="kw">if</span> <span class="ident">l1</span> <span class="op">==</span> <span class="ident">m1</span> <span class="op">&&</span> <span class="ident">l2</span> <span class="op">==</span> <span class="ident">m2</span> <span class="op">=></span> {
|
|||
|
|
<span class="ident">std</span>::<span class="ident">mem</span>::<span class="ident">swap</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">time1</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">time2</span>);
|
|||
|
|
<span class="ident">std</span>::<span class="ident">mem</span>::<span class="ident">swap</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buffer1</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buffer2</span>);
|
|||
|
|
},
|
|||
|
|
<span class="kw">_</span> <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Wrong packets"</span>),
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
<span class="comment">// Compare results</span>
|
|||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?} @ {:?}, {:?} @ {:?}, {:?}"</span>, <span class="ident">buffer1</span>, <span class="ident">time1</span>, <span class="ident">buffer2</span>, <span class="ident">time2</span>, <span class="ident">delay</span>);
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">message1</span> <span class="op">==</span> <span class="kw-2">&</span><span class="ident">buffer1</span>[<span class="number">0</span>..(<span class="ident">message1</span>.<span class="ident">len</span>())], <span class="string">"{:?} == {:?}"</span>, <span class="ident">message1</span>, <span class="ident">buffer1</span>);
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">message2</span> <span class="op">==</span> <span class="kw-2">&</span><span class="ident">buffer2</span>[<span class="number">0</span>..(<span class="ident">message2</span>.<span class="ident">len</span>())], <span class="string">"{:?} == {:?}"</span>, <span class="ident">message2</span>, <span class="ident">buffer2</span>);
|
|||
|
|
<span class="kw">let</span> <span class="ident">time</span> <span class="op">=</span> <span class="ident">time2</span> <span class="op">-</span> <span class="ident">time1</span>;
|
|||
|
|
<span class="kw">let</span> <span class="ident">time</span> <span class="op">=</span> <span class="ident">Duration</span>::<span class="ident">new</span>(<span class="ident">time</span>.<span class="ident">num_seconds</span>() <span class="kw">as</span> <span class="ident">u64</span>, <span class="ident">time</span>.<span class="ident">num_nanoseconds</span>() <span class="kw">as</span> <span class="ident">u32</span>);
|
|||
|
|
<span class="kw">let</span> <span class="ident">difference</span> <span class="op">=</span> <span class="kw">if</span> <span class="ident">delay</span> <span class="op"><</span> <span class="ident">time</span> { <span class="ident">time</span> <span class="op">-</span> <span class="ident">delay</span> } <span class="kw">else</span> { <span class="ident">delay</span> <span class="op">-</span> <span class="ident">time</span> };
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">difference</span>.<span class="ident">subsec_nanos</span>() <span class="op"><</span> <span class="number">5_000_000</span>, <span class="string">"{}ns < 5ms"</span>, <span class="ident">difference</span>.<span class="ident">subsec_nanos</span>());
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">difference</span>.<span class="ident">as_secs</span>() <span class="op">==</span> <span class="number">0</span>);
|
|||
|
|
|
|||
|
|
<span class="comment">// Close socket</span>
|
|||
|
|
<span class="ident">nix</span>::<span class="ident">unistd</span>::<span class="ident">close</span>(<span class="ident">in_socket</span>).<span class="ident">unwrap</span>();</pre>
|
|||
|
|
</div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="../../../nix/sys/socket/enum.ControlMessage.html" title="enum nix::sys::socket::ControlMessage">ControlMessage</a><'a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="../../../nix/sys/socket/enum.ControlMessage.html" title="enum nix::sys::socket::ControlMessage">ControlMessage</a><'a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></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>
|