262 lines
42 KiB
HTML
262 lines
42 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 `UdpSocket` struct in crate `tokio_udp`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, UdpSocket">
|
|||
|
|
|
|||
|
|
<title>tokio_udp::UdpSocket - 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 struct">
|
|||
|
|
<!--[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'>Struct UdpSocket</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.bind">bind</a><a href="#method.from_std">from_std</a><a href="#method.local_addr">local_addr</a><a href="#method.connect">connect</a><a href="#method.poll_send">poll_send</a><a href="#method.poll_recv">poll_recv</a><a href="#method.poll_send_to">poll_send_to</a><a href="#method.send_dgram">send_dgram</a><a href="#method.poll_recv_from">poll_recv_from</a><a href="#method.recv_dgram">recv_dgram</a><a href="#method.broadcast">broadcast</a><a href="#method.set_broadcast">set_broadcast</a><a href="#method.multicast_loop_v4">multicast_loop_v4</a><a href="#method.set_multicast_loop_v4">set_multicast_loop_v4</a><a href="#method.multicast_ttl_v4">multicast_ttl_v4</a><a href="#method.set_multicast_ttl_v4">set_multicast_ttl_v4</a><a href="#method.multicast_loop_v6">multicast_loop_v6</a><a href="#method.set_multicast_loop_v6">set_multicast_loop_v6</a><a href="#method.ttl">ttl</a><a href="#method.set_ttl">set_ttl</a><a href="#method.join_multicast_v4">join_multicast_v4</a><a href="#method.join_multicast_v6">join_multicast_v6</a><a href="#method.leave_multicast_v4">leave_multicast_v4</a><a href="#method.leave_multicast_v6">leave_multicast_v6</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-AsRawFd">AsRawFd</a><a href="#impl-Debug">Debug</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'>tokio_udp</a></p><script>window.sidebarCurrent = {name: 'UdpSocket', ty: 'struct', 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">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>tokio_udp</a>::<wbr><a class="struct" href=''>UdpSocket</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/tokio_udp/socket.rs.html#13-15' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct UdpSocket { /* fields omitted */ }</pre></div><div class='docblock'><p>An I/O object representing a UDP socket.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='methods' class='small-section-header'>
|
|||
|
|
Methods<a href='#methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../tokio_udp/struct.UdpSocket.html" title="struct tokio_udp::UdpSocket">UdpSocket</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#17-393' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.bind' class="method"><span id='bind.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.bind' class='fnname'>bind</a>(addr: &<a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="../tokio_udp/struct.UdpSocket.html" title="struct tokio_udp::UdpSocket">UdpSocket</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#20-23' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This function will create a new UDP socket and attempt to bind it to
|
|||
|
|
the <code>addr</code> provided.</p>
|
|||
|
|
</div><h4 id='method.from_std' class="method"><span id='from_std.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.from_std' class='fnname'>from_std</a>(socket: <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/udp/struct.UdpSocket.html" title="struct std::net::udp::UdpSocket">UdpSocket</a>, handle: &<a class="struct" href="../tokio_reactor/struct.Handle.html" title="struct tokio_reactor::Handle">Handle</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="../tokio_udp/struct.UdpSocket.html" title="struct tokio_udp::UdpSocket">UdpSocket</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#41-46' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new <code>UdpSocket</code> from the previously bound socket provided.</p>
|
|||
|
|
<p>The socket given will be registered with the event loop that <code>handle</code>
|
|||
|
|
is associated with. This function requires that <code>socket</code> has previously
|
|||
|
|
been bound to an address to work correctly.</p>
|
|||
|
|
<p>This can be used in conjunction with net2's <code>UdpBuilder</code> interface to
|
|||
|
|
configure a socket before it's handed off, such as setting options like
|
|||
|
|
<code>reuse_address</code> or binding to multiple addresses.</p>
|
|||
|
|
<p>Use <code>Handle::default()</code> to lazily bind to an event loop, just like <code>bind</code> does.</p>
|
|||
|
|
</div><h4 id='method.local_addr' class="method"><span id='local_addr.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.local_addr' class='fnname'>local_addr</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#49-51' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the local address that this socket is bound to.</p>
|
|||
|
|
</div><h4 id='method.connect' class="method"><span id='connect.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.connect' class='fnname'>connect</a>(&self, addr: &<a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#56-58' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Connects the UDP socket setting the default destination for send() and
|
|||
|
|
limiting packets that are read via recv from the address specified in
|
|||
|
|
<code>addr</code>.</p>
|
|||
|
|
</div><h4 id='method.poll_send' class="method"><span id='poll_send.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.poll_send' class='fnname'>poll_send</a>(&mut self, buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="type" href="../futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#87-98' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sends data on the socket to the remote address to which it is connected.</p>
|
|||
|
|
<p>The <a href="#method.connect"><code>connect</code></a> method will connect this socket to a remote address. This
|
|||
|
|
method will fail if the socket is not connected.</p>
|
|||
|
|
<h1 id="return" class="section-header"><a href="#return">Return</a></h1>
|
|||
|
|
<p>On success, returns <code>Ok(Async::Ready(num_bytes_written))</code>.</p>
|
|||
|
|
<p>If the socket is not ready for writing, the method returns
|
|||
|
|
<code>Ok(Async::NotReady)</code> and arranges for the current task to receive a
|
|||
|
|
notification when the socket becomes writable.</p>
|
|||
|
|
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
|||
|
|
<p>This function will panic if called from outside of a task context.</p>
|
|||
|
|
</div><h4 id='method.poll_recv' class="method"><span id='poll_recv.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.poll_recv' class='fnname'>poll_recv</a>(&mut self, buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="type" href="../futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#132-143' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Receives a single datagram message on the socket from the remote address to
|
|||
|
|
which it is connected. On success, returns the number of bytes read.</p>
|
|||
|
|
<p>The function must be called with valid byte array <code>buf</code> of sufficient size to
|
|||
|
|
hold the message bytes. If a message is too long to fit in the supplied buffer,
|
|||
|
|
excess bytes may be discarded.</p>
|
|||
|
|
<p>The <a href="#method.connect"><code>connect</code></a> method will connect this socket to a remote address. This
|
|||
|
|
method will fail if the socket is not connected.</p>
|
|||
|
|
<h1 id="return-1" class="section-header"><a href="#return-1">Return</a></h1>
|
|||
|
|
<p>On success, returns <code>Ok(Async::Ready(num_bytes_read))</code>.</p>
|
|||
|
|
<p>If no data is available for reading, the method returns
|
|||
|
|
<code>Ok(Async::NotReady)</code> and arranges for the current task to receive a
|
|||
|
|
notification when the socket becomes receivable or is closed.</p>
|
|||
|
|
<h1 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h1>
|
|||
|
|
<p>This function will panic if called from outside of a task context.</p>
|
|||
|
|
</div><h4 id='method.poll_send_to' class="method"><span id='poll_send_to.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.poll_send_to' class='fnname'>poll_send_to</a>(<br> &mut self, <br> buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> target: &<a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a><br>) -> <a class="type" href="../futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#171-182' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sends data on the socket to the given address. On success, returns the
|
|||
|
|
number of bytes written.</p>
|
|||
|
|
<p>This will return an error when the IP version of the local socket
|
|||
|
|
does not match that of <code>target</code>.</p>
|
|||
|
|
<h1 id="return-2" class="section-header"><a href="#return-2">Return</a></h1>
|
|||
|
|
<p>On success, returns <code>Ok(Async::Ready(num_bytes_written))</code>.</p>
|
|||
|
|
<p>If the socket is not ready for writing, the method returns
|
|||
|
|
<code>Ok(Async::NotReady)</code> and arranges for the current task to receive a
|
|||
|
|
notification when the socket becomes writable.</p>
|
|||
|
|
<h1 id="panics-2" class="section-header"><a href="#panics-2">Panics</a></h1>
|
|||
|
|
<p>This function will panic if called from outside of a task context.</p>
|
|||
|
|
</div><h4 id='method.send_dgram' class="method"><span id='send_dgram.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.send_dgram' class='fnname'>send_dgram</a><T>(self, buf: T, addr: &<a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a>) -> <a class="struct" href="../tokio_udp/struct.SendDgram.html" title="struct tokio_udp::SendDgram">SendDgram</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#198-202' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a future that will write the entire contents of the buffer
|
|||
|
|
<code>buf</code> provided as a datagram to this socket.</p>
|
|||
|
|
<p>The returned future will return after data has been written to the
|
|||
|
|
outbound socket. The future will resolve to the stream as well as the
|
|||
|
|
buffer (for reuse if needed).</p>
|
|||
|
|
<p>Any error which happens during writing will cause both the stream and
|
|||
|
|
the buffer to get destroyed. Note that failure to write the entire
|
|||
|
|
buffer is considered an error for the purposes of sending a datagram.</p>
|
|||
|
|
<p>The <code>buf</code> parameter here only requires the <code>AsRef<[u8]></code> trait, which
|
|||
|
|
should be broadly applicable to accepting data which can be converted
|
|||
|
|
to a slice.</p>
|
|||
|
|
</div><h4 id='method.poll_recv_from' class="method"><span id='poll_recv_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.poll_recv_from' class='fnname'>poll_recv_from</a>(<br> &mut self, <br> buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br>) -> <a class="type" href="../futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#220-231' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Receives data from the socket. On success, returns the number of bytes
|
|||
|
|
read and the address from whence the data came.</p>
|
|||
|
|
<h1 id="panics-3" class="section-header"><a href="#panics-3">Panics</a></h1>
|
|||
|
|
<p>This function will panic if called outside the context of a future's
|
|||
|
|
task.</p>
|
|||
|
|
</div><h4 id='method.recv_dgram' class="method"><span id='recv_dgram.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.recv_dgram' class='fnname'>recv_dgram</a><T>(self, buf: T) -> <a class="struct" href="../tokio_udp/struct.RecvDgram.html" title="struct tokio_udp::RecvDgram">RecvDgram</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsMut.html" title="trait core::convert::AsMut">AsMut</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#246-250' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a future that receive a datagram to be written to the buffer
|
|||
|
|
provided.</p>
|
|||
|
|
<p>The returned future will return after a datagram has been received on
|
|||
|
|
this socket. The future will resolve to the socket, the buffer, the
|
|||
|
|
amount of data read, and the address the data was received from.</p>
|
|||
|
|
<p>An error during reading will cause the socket and buffer to get
|
|||
|
|
destroyed.</p>
|
|||
|
|
<p>The <code>buf</code> parameter here only requires the <code>AsMut<[u8]></code> trait, which
|
|||
|
|
should be broadly applicable to accepting data which can be converted
|
|||
|
|
to a slice.</p>
|
|||
|
|
</div><h4 id='method.broadcast' class="method"><span id='broadcast.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.broadcast' class='fnname'>broadcast</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#257-259' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Gets the value of the <code>SO_BROADCAST</code> option for this socket.</p>
|
|||
|
|
<p>For more information about this option, see <a href="#method.set_broadcast"><code>set_broadcast</code></a>.</p>
|
|||
|
|
</div><h4 id='method.set_broadcast' class="method"><span id='set_broadcast.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_broadcast' class='fnname'>set_broadcast</a>(&self, on: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#265-267' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the value of the <code>SO_BROADCAST</code> option for this socket.</p>
|
|||
|
|
<p>When enabled, this socket is allowed to send packets to a broadcast
|
|||
|
|
address.</p>
|
|||
|
|
</div><h4 id='method.multicast_loop_v4' class="method"><span id='multicast_loop_v4.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.multicast_loop_v4' class='fnname'>multicast_loop_v4</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#274-276' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Gets the value of the <code>IP_MULTICAST_LOOP</code> option for this socket.</p>
|
|||
|
|
<p>For more information about this option, see <a href="#method.set_multicast_loop_v4"><code>set_multicast_loop_v4</code></a>.</p>
|
|||
|
|
</div><h4 id='method.set_multicast_loop_v4' class="method"><span id='set_multicast_loop_v4.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_multicast_loop_v4' class='fnname'>set_multicast_loop_v4</a>(&self, on: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#285-287' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the value of the <code>IP_MULTICAST_LOOP</code> option for this socket.</p>
|
|||
|
|
<p>If enabled, multicast packets will be looped back to the local socket.</p>
|
|||
|
|
<h1 id="note" class="section-header"><a href="#note">Note</a></h1>
|
|||
|
|
<p>This may not have any affect on IPv6 sockets.</p>
|
|||
|
|
</div><h4 id='method.multicast_ttl_v4' class="method"><span id='multicast_ttl_v4.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.multicast_ttl_v4' class='fnname'>multicast_ttl_v4</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#294-296' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Gets the value of the <code>IP_MULTICAST_TTL</code> option for this socket.</p>
|
|||
|
|
<p>For more information about this option, see <a href="#method.set_multicast_ttl_v4"><code>set_multicast_ttl_v4</code></a>.</p>
|
|||
|
|
</div><h4 id='method.set_multicast_ttl_v4' class="method"><span id='set_multicast_ttl_v4.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_multicast_ttl_v4' class='fnname'>set_multicast_ttl_v4</a>(&self, ttl: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#307-309' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the value of the <code>IP_MULTICAST_TTL</code> option for this socket.</p>
|
|||
|
|
<p>Indicates the time-to-live value of outgoing multicast packets for
|
|||
|
|
this socket. The default value is 1 which means that multicast packets
|
|||
|
|
don't leave the local network unless explicitly requested.</p>
|
|||
|
|
<h1 id="note-1" class="section-header"><a href="#note-1">Note</a></h1>
|
|||
|
|
<p>This may not have any affect on IPv6 sockets.</p>
|
|||
|
|
</div><h4 id='method.multicast_loop_v6' class="method"><span id='multicast_loop_v6.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.multicast_loop_v6' class='fnname'>multicast_loop_v6</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#316-318' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Gets the value of the <code>IPV6_MULTICAST_LOOP</code> option for this socket.</p>
|
|||
|
|
<p>For more information about this option, see <a href="#method.set_multicast_loop_v6"><code>set_multicast_loop_v6</code></a>.</p>
|
|||
|
|
</div><h4 id='method.set_multicast_loop_v6' class="method"><span id='set_multicast_loop_v6.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_multicast_loop_v6' class='fnname'>set_multicast_loop_v6</a>(&self, on: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#327-329' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the value of the <code>IPV6_MULTICAST_LOOP</code> option for this socket.</p>
|
|||
|
|
<p>Controls whether this socket sees the multicast packets it sends itself.</p>
|
|||
|
|
<h1 id="note-2" class="section-header"><a href="#note-2">Note</a></h1>
|
|||
|
|
<p>This may not have any affect on IPv4 sockets.</p>
|
|||
|
|
</div><h4 id='method.ttl' class="method"><span id='ttl.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.ttl' class='fnname'>ttl</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#336-338' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Gets the value of the <code>IP_TTL</code> option for this socket.</p>
|
|||
|
|
<p>For more information about this option, see <a href="#method.set_ttl"><code>set_ttl</code></a>.</p>
|
|||
|
|
</div><h4 id='method.set_ttl' class="method"><span id='set_ttl.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_ttl' class='fnname'>set_ttl</a>(&self, ttl: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#344-346' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the value for the <code>IP_TTL</code> option on this socket.</p>
|
|||
|
|
<p>This value sets the time-to-live field that is used in every packet sent
|
|||
|
|
from this socket.</p>
|
|||
|
|
</div><h4 id='method.join_multicast_v4' class="method"><span id='join_multicast_v4.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.join_multicast_v4' class='fnname'>join_multicast_v4</a>(<br> &self, <br> multiaddr: &<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv4Addr.html" title="struct std::net::ip::Ipv4Addr">Ipv4Addr</a>, <br> interface: &<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv4Addr.html" title="struct std::net::ip::Ipv4Addr">Ipv4Addr</a><br>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#355-359' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Executes an operation of the <code>IP_ADD_MEMBERSHIP</code> type.</p>
|
|||
|
|
<p>This function specifies a new multicast group for this socket to join.
|
|||
|
|
The address must be a valid multicast address, and <code>interface</code> is the
|
|||
|
|
address of the local interface with which the system should join the
|
|||
|
|
multicast group. If it's equal to <code>INADDR_ANY</code> then an appropriate
|
|||
|
|
interface is chosen by the system.</p>
|
|||
|
|
</div><h4 id='method.join_multicast_v6' class="method"><span id='join_multicast_v6.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.join_multicast_v6' class='fnname'>join_multicast_v6</a>(<br> &self, <br> multiaddr: &<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv6Addr.html" title="struct std::net::ip::Ipv6Addr">Ipv6Addr</a>, <br> interface: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><br>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#366-370' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Executes an operation of the <code>IPV6_ADD_MEMBERSHIP</code> type.</p>
|
|||
|
|
<p>This function specifies a new multicast group for this socket to join.
|
|||
|
|
The address must be a valid multicast address, and <code>interface</code> is the
|
|||
|
|
index of the interface to join/leave (or 0 to indicate any interface).</p>
|
|||
|
|
</div><h4 id='method.leave_multicast_v4' class="method"><span id='leave_multicast_v4.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.leave_multicast_v4' class='fnname'>leave_multicast_v4</a>(<br> &self, <br> multiaddr: &<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv4Addr.html" title="struct std::net::ip::Ipv4Addr">Ipv4Addr</a>, <br> interface: &<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv4Addr.html" title="struct std::net::ip::Ipv4Addr">Ipv4Addr</a><br>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#377-381' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Executes an operation of the <code>IP_DROP_MEMBERSHIP</code> type.</p>
|
|||
|
|
<p>For more information about this option, see <a href="#method.join_multicast_v4"><code>join_multicast_v4</code></a>.</p>
|
|||
|
|
</div><h4 id='method.leave_multicast_v6' class="method"><span id='leave_multicast_v6.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.leave_multicast_v6' class='fnname'>leave_multicast_v6</a>(<br> &self, <br> multiaddr: &<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv6Addr.html" title="struct std::net::ip::Ipv6Addr">Ipv6Addr</a>, <br> interface: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><br>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#388-392' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Executes an operation of the <code>IPV6_DROP_MEMBERSHIP</code> type.</p>
|
|||
|
|
<p>For more information about this option, see <a href="#method.join_multicast_v6"><code>join_multicast_v6</code></a>.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementations' class='small-section-header'>
|
|||
|
|
Trait Implementations<a href='#implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div id='implementations-list'>
|
|||
|
|
<h3 id='impl-AsRawFd' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/trait.AsRawFd.html" title="trait std::sys::unix::ext::io::AsRawFd">AsRawFd</a> for <a class="struct" href="../tokio_udp/struct.UdpSocket.html" title="struct tokio_udp::UdpSocket">UdpSocket</a></code><a href='#impl-AsRawFd' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#406-410' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.as_raw_fd' class="method"><span id='as_raw_fd.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/trait.AsRawFd.html#tymethod.as_raw_fd' class='fnname'>as_raw_fd</a>(&self) -> <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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#407-409' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Extracts the raw file descriptor. <a href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/trait.AsRawFd.html#tymethod.as_raw_fd">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../tokio_udp/struct.UdpSocket.html" title="struct tokio_udp::UdpSocket">UdpSocket</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#395-399' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_udp/socket.rs.html#396-398' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
|||
|
|
</div></div></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 class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../tokio_udp/struct.UdpSocket.html" title="struct tokio_udp::UdpSocket">UdpSocket</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 class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../tokio_udp/struct.UdpSocket.html" title="struct tokio_udp::UdpSocket">UdpSocket</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>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../";
|
|||
|
|
window.currentCrate = "tokio_udp";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|