| <!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="Source of the Rust file `/root/.cargo/git/checkouts/tokio-377c595163f99a10/dfe252d/tokio/src/net/unix/listener.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>listener.rs - source</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="../../../../source-script.js"></script><script defer src="../../../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../../tokio/index.html"><div class="logo-container"><img class="rust-logo" src="../../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../../tokio/index.html"><img class="rust-logo" src="../../../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::io::{Interest, PollEvented}; |
| <span class="kw">use </span><span class="kw">crate</span>::net::unix::{SocketAddr, UnixStream}; |
| |
| <span class="kw">use </span>std::convert::TryFrom; |
| <span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::io; |
| <span class="kw">use </span>std::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd}; |
| <span class="kw">use </span>std::os::unix::net; |
| <span class="kw">use </span>std::path::Path; |
| <span class="kw">use </span>std::task::{Context, Poll}; |
| |
| <span class="macro">cfg_net_unix! </span>{ |
| <span class="doccomment">/// A Unix socket which can accept connections from other Unix sockets. |
| /// |
| /// You can accept a new connection by using the [`accept`](`UnixListener::accept`) method. |
| /// |
| /// A `UnixListener` can be turned into a `Stream` with [`UnixListenerStream`]. |
| /// |
| /// [`UnixListenerStream`]: https://docs.rs/tokio-stream/0.1/tokio_stream/wrappers/struct.UnixListenerStream.html |
| /// |
| /// # Errors |
| /// |
| /// Note that accepting a connection can lead to various errors and not all |
| /// of them are necessarily fatal ‒ for example having too many open file |
| /// descriptors or the other side closing the connection while it waits in |
| /// an accept queue. These would terminate the stream if not handled in any |
| /// way. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use tokio::net::UnixListener; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let listener = UnixListener::bind("/path/to/the/socket").unwrap(); |
| /// loop { |
| /// match listener.accept().await { |
| /// Ok((stream, _addr)) => { |
| /// println!("new client!"); |
| /// } |
| /// Err(e) => { /* connection failed */ } |
| /// } |
| /// } |
| /// } |
| /// ``` |
| </span><span class="kw">pub struct </span>UnixListener { |
| io: PollEvented<mio::net::UnixListener>, |
| } |
| } |
| |
| <span class="kw">impl </span>UnixListener { |
| <span class="doccomment">/// Creates a new `UnixListener` bound to the specified path. |
| /// |
| /// # Panics |
| /// |
| /// This function panics if it is not called from within a runtime with |
| /// IO enabled. |
| /// |
| /// The runtime is usually set implicitly when this function is called |
| /// from a future driven by a tokio runtime, otherwise runtime can be set |
| /// explicitly with [`Runtime::enter`](crate::runtime::Runtime::enter) function. |
| </span><span class="attribute">#[track_caller] |
| </span><span class="kw">pub fn </span>bind<P>(path: P) -> io::Result<UnixListener> |
| <span class="kw">where |
| </span>P: AsRef<Path>, |
| { |
| <span class="kw">let </span>listener = mio::net::UnixListener::bind(path)<span class="question-mark">?</span>; |
| <span class="kw">let </span>io = PollEvented::new(listener)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(UnixListener { io }) |
| } |
| |
| <span class="doccomment">/// Creates new `UnixListener` from a `std::os::unix::net::UnixListener `. |
| /// |
| /// This function is intended to be used to wrap a UnixListener from the |
| /// standard library in the Tokio equivalent. The conversion assumes |
| /// nothing about the underlying listener; it is left up to the user to set |
| /// it in non-blocking mode. |
| /// |
| /// # Panics |
| /// |
| /// This function panics if it is not called from within a runtime with |
| /// IO enabled. |
| /// |
| /// The runtime is usually set implicitly when this function is called |
| /// from a future driven by a tokio runtime, otherwise runtime can be set |
| /// explicitly with [`Runtime::enter`](crate::runtime::Runtime::enter) function. |
| </span><span class="attribute">#[track_caller] |
| </span><span class="kw">pub fn </span>from_std(listener: net::UnixListener) -> io::Result<UnixListener> { |
| <span class="kw">let </span>listener = mio::net::UnixListener::from_std(listener); |
| <span class="kw">let </span>io = PollEvented::new(listener)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(UnixListener { io }) |
| } |
| |
| <span class="doccomment">/// Turns a [`tokio::net::UnixListener`] into a [`std::os::unix::net::UnixListener`]. |
| /// |
| /// The returned [`std::os::unix::net::UnixListener`] will have nonblocking mode |
| /// set as `true`. Use [`set_nonblocking`] to change the blocking mode if needed. |
| /// |
| /// # Examples |
| /// |
| /// ```rust,no_run |
| /// use std::error::Error; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> Result<(), Box<dyn Error>> { |
| /// let tokio_listener = tokio::net::UnixListener::bind("127.0.0.1:0")?; |
| /// let std_listener = tokio_listener.into_std()?; |
| /// std_listener.set_nonblocking(false)?; |
| /// Ok(()) |
| /// } |
| /// ``` |
| /// |
| /// [`tokio::net::UnixListener`]: UnixListener |
| /// [`std::os::unix::net::UnixListener`]: std::os::unix::net::UnixListener |
| /// [`set_nonblocking`]: fn@std::os::unix::net::UnixListener::set_nonblocking |
| </span><span class="kw">pub fn </span>into_std(<span class="self">self</span>) -> io::Result<std::os::unix::net::UnixListener> { |
| <span class="self">self</span>.io |
| .into_inner() |
| .map(|io| io.into_raw_fd()) |
| .map(|raw_fd| <span class="kw">unsafe </span>{ net::UnixListener::from_raw_fd(raw_fd) }) |
| } |
| |
| <span class="doccomment">/// Returns the local socket address of this listener. |
| </span><span class="kw">pub fn </span>local_addr(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<SocketAddr> { |
| <span class="self">self</span>.io.local_addr().map(SocketAddr) |
| } |
| |
| <span class="doccomment">/// Returns the value of the `SO_ERROR` option. |
| </span><span class="kw">pub fn </span>take_error(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<<span class="prelude-ty">Option</span><io::Error>> { |
| <span class="self">self</span>.io.take_error() |
| } |
| |
| <span class="doccomment">/// Accepts a new incoming connection to this listener. |
| /// |
| /// # Cancel safety |
| /// |
| /// This method is cancel safe. If the method is used as the event in a |
| /// [`tokio::select!`](crate::select) statement and some other branch |
| /// completes first, then it is guaranteed that no new connections were |
| /// accepted by this method. |
| </span><span class="kw">pub async fn </span>accept(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<(UnixStream, SocketAddr)> { |
| <span class="kw">let </span>(mio, addr) = <span class="self">self |
| </span>.io |
| .registration() |
| .async_io(Interest::READABLE, || <span class="self">self</span>.io.accept()) |
| .<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>addr = SocketAddr(addr); |
| <span class="kw">let </span>stream = UnixStream::new(mio)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>((stream, addr)) |
| } |
| |
| <span class="doccomment">/// Polls to accept a new incoming connection to this listener. |
| /// |
| /// If there is no connection to accept, `Poll::Pending` is returned and the |
| /// current task will be notified by a waker. Note that on multiple calls |
| /// to `poll_accept`, only the `Waker` from the `Context` passed to the most |
| /// recent call is scheduled to receive a wakeup. |
| </span><span class="kw">pub fn </span>poll_accept(<span class="kw-2">&</span><span class="self">self</span>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<io::Result<(UnixStream, SocketAddr)>> { |
| <span class="kw">let </span>(sock, addr) = <span class="macro">ready!</span>(<span class="self">self</span>.io.registration().poll_read_io(cx, || <span class="self">self</span>.io.accept()))<span class="question-mark">?</span>; |
| <span class="kw">let </span>addr = SocketAddr(addr); |
| <span class="kw">let </span>sock = UnixStream::new(sock)<span class="question-mark">?</span>; |
| Poll::Ready(<span class="prelude-val">Ok</span>((sock, addr))) |
| } |
| } |
| |
| <span class="kw">impl </span>TryFrom<std::os::unix::net::UnixListener> <span class="kw">for </span>UnixListener { |
| <span class="kw">type </span>Error = io::Error; |
| |
| <span class="doccomment">/// Consumes stream, returning the tokio I/O object. |
| /// |
| /// This is equivalent to |
| /// [`UnixListener::from_std(stream)`](UnixListener::from_std). |
| </span><span class="kw">fn </span>try_from(stream: std::os::unix::net::UnixListener) -> io::Result<<span class="self">Self</span>> { |
| <span class="self">Self</span>::from_std(stream) |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>UnixListener { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="self">self</span>.io.fmt(f) |
| } |
| } |
| |
| <span class="kw">impl </span>AsRawFd <span class="kw">for </span>UnixListener { |
| <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&</span><span class="self">self</span>) -> RawFd { |
| <span class="self">self</span>.io.as_raw_fd() |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |