<!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 `actix-tls/src/connect/tcp.rs`."><title>tcp.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-b778ab399e080a4b.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="actix_tls" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0-nightly (7608018cb 2024-09-29)" data-channel="nightly" data-search-js="search-e056c65ede92db13.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../../../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="../../../static.files/src-script-e66d777a5a92e9b2.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-54bc299d2a5e4e43.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-0111fcff984fae8f.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">actix_tls/connect/</div>tcp.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"> <a href="#1" id="1">1</a> <a href="#2" id="2">2</a> <a href="#3" id="3">3</a> <a href="#4" id="4">4</a> <a href="#5" id="5">5</a> <a href="#6" id="6">6</a> <a href="#7" id="7">7</a> <a href="#8" id="8">8</a> <a href="#9" id="9">9</a> <a href="#10" id="10">10</a> <a href="#11" id="11">11</a> <a href="#12" id="12">12</a> <a href="#13" id="13">13</a> <a href="#14" id="14">14</a> <a href="#15" id="15">15</a> <a href="#16" id="16">16</a> <a href="#17" id="17">17</a> <a href="#18" id="18">18</a> <a href="#19" id="19">19</a> <a href="#20" id="20">20</a> <a href="#21" id="21">21</a> <a href="#22" id="22">22</a> <a href="#23" id="23">23</a> <a href="#24" id="24">24</a> <a href="#25" id="25">25</a> <a href="#26" id="26">26</a> <a href="#27" id="27">27</a> <a href="#28" id="28">28</a> <a href="#29" id="29">29</a> <a href="#30" id="30">30</a> <a href="#31" id="31">31</a> <a href="#32" id="32">32</a> <a href="#33" id="33">33</a> <a href="#34" id="34">34</a> <a href="#35" id="35">35</a> <a href="#36" id="36">36</a> <a href="#37" id="37">37</a> <a href="#38" id="38">38</a> <a href="#39" id="39">39</a> <a href="#40" id="40">40</a> <a href="#41" id="41">41</a> <a href="#42" id="42">42</a> <a href="#43" id="43">43</a> <a href="#44" id="44">44</a> <a href="#45" id="45">45</a> <a href="#46" id="46">46</a> <a href="#47" id="47">47</a> <a href="#48" id="48">48</a> <a href="#49" id="49">49</a> <a href="#50" id="50">50</a> <a href="#51" id="51">51</a> <a href="#52" id="52">52</a> <a href="#53" id="53">53</a> <a href="#54" id="54">54</a> <a href="#55" id="55">55</a> <a href="#56" id="56">56</a> <a href="#57" id="57">57</a> <a href="#58" id="58">58</a> <a href="#59" id="59">59</a> <a href="#60" id="60">60</a> <a href="#61" id="61">61</a> <a href="#62" id="62">62</a> <a href="#63" id="63">63</a> <a href="#64" id="64">64</a> <a href="#65" id="65">65</a> <a href="#66" id="66">66</a> <a href="#67" id="67">67</a> <a href="#68" id="68">68</a> <a href="#69" id="69">69</a> <a href="#70" id="70">70</a> <a href="#71" id="71">71</a> <a href="#72" id="72">72</a> <a href="#73" id="73">73</a> <a href="#74" id="74">74</a> <a href="#75" id="75">75</a> <a href="#76" id="76">76</a> <a href="#77" id="77">77</a> <a href="#78" id="78">78</a> <a href="#79" id="79">79</a> <a href="#80" id="80">80</a> <a href="#81" id="81">81</a> <a href="#82" id="82">82</a> <a href="#83" id="83">83</a> <a href="#84" id="84">84</a> <a href="#85" id="85">85</a> <a href="#86" id="86">86</a> <a href="#87" id="87">87</a> <a href="#88" id="88">88</a> <a href="#89" id="89">89</a> <a href="#90" id="90">90</a> <a href="#91" id="91">91</a> <a href="#92" id="92">92</a> <a href="#93" id="93">93</a> <a href="#94" id="94">94</a> <a href="#95" id="95">95</a> <a href="#96" id="96">96</a> <a href="#97" id="97">97</a> <a href="#98" id="98">98</a> <a href="#99" id="99">99</a> <a href="#100" id="100">100</a> <a href="#101" id="101">101</a> <a href="#102" id="102">102</a> <a href="#103" id="103">103</a> <a href="#104" id="104">104</a> <a href="#105" id="105">105</a> <a href="#106" id="106">106</a> <a href="#107" id="107">107</a> <a href="#108" id="108">108</a> <a href="#109" id="109">109</a> <a href="#110" id="110">110</a> <a href="#111" id="111">111</a> <a href="#112" id="112">112</a> <a href="#113" id="113">113</a> <a href="#114" id="114">114</a> <a href="#115" id="115">115</a> <a href="#116" id="116">116</a> <a href="#117" id="117">117</a> <a href="#118" id="118">118</a> <a href="#119" id="119">119</a> <a href="#120" id="120">120</a> <a href="#121" id="121">121</a> <a href="#122" id="122">122</a> <a href="#123" id="123">123</a> <a href="#124" id="124">124</a> <a href="#125" id="125">125</a> <a href="#126" id="126">126</a> <a href="#127" id="127">127</a> <a href="#128" id="128">128</a> <a href="#129" id="129">129</a> <a href="#130" id="130">130</a> <a href="#131" id="131">131</a> <a href="#132" id="132">132</a> <a href="#133" id="133">133</a> <a href="#134" id="134">134</a> <a href="#135" id="135">135</a> <a href="#136" id="136">136</a> <a href="#137" id="137">137</a> <a href="#138" id="138">138</a> <a href="#139" id="139">139</a> <a href="#140" id="140">140</a> <a href="#141" id="141">141</a> <a href="#142" id="142">142</a> <a href="#143" id="143">143</a> <a href="#144" id="144">144</a> <a href="#145" id="145">145</a> <a href="#146" id="146">146</a> <a href="#147" id="147">147</a> <a href="#148" id="148">148</a> <a href="#149" id="149">149</a> <a href="#150" id="150">150</a> <a href="#151" id="151">151</a> <a href="#152" id="152">152</a> <a href="#153" id="153">153</a> <a href="#154" id="154">154</a> <a href="#155" id="155">155</a> <a href="#156" id="156">156</a> <a href="#157" id="157">157</a> <a href="#158" id="158">158</a> <a href="#159" id="159">159</a> <a href="#160" id="160">160</a> <a href="#161" id="161">161</a> <a href="#162" id="162">162</a> <a href="#163" id="163">163</a> <a href="#164" id="164">164</a> <a href="#165" id="165">165</a> <a href="#166" id="166">166</a> <a href="#167" id="167">167</a> <a href="#168" id="168">168</a> <a href="#169" id="169">169</a> <a href="#170" id="170">170</a> <a href="#171" id="171">171</a> <a href="#172" id="172">172</a> <a href="#173" id="173">173</a> <a href="#174" id="174">174</a> <a href="#175" id="175">175</a> <a href="#176" id="176">176</a> <a href="#177" id="177">177</a> <a href="#178" id="178">178</a> <a href="#179" id="179">179</a> <a href="#180" id="180">180</a> <a href="#181" id="181">181</a> <a href="#182" id="182">182</a> <a href="#183" id="183">183</a> <a href="#184" id="184">184</a> <a href="#185" id="185">185</a> <a href="#186" id="186">186</a> <a href="#187" id="187">187</a> <a href="#188" id="188">188</a> <a href="#189" id="189">189</a> <a href="#190" id="190">190</a> <a href="#191" id="191">191</a> <a href="#192" id="192">192</a> <a href="#193" id="193">193</a> <a href="#194" id="194">194</a> <a href="#195" id="195">195</a> <a href="#196" id="196">196</a> <a href="#197" id="197">197</a> <a href="#198" id="198">198</a> <a href="#199" id="199">199</a> <a href="#200" id="200">200</a> <a href="#201" id="201">201</a> <a href="#202" id="202">202</a> <a href="#203" id="203">203</a> <a href="#204" id="204">204</a></pre></div><pre class="rust"><code><span class="doccomment">//! TCP connector service. //! //! See [`TcpConnector`] for main connector service factory docs. </span><span class="kw">use </span>std::{ collections::VecDeque, future::Future, io, net::{IpAddr, SocketAddr, SocketAddrV4, SocketAddrV6}, pin::Pin, task::{Context, Poll}, }; <span class="kw">use </span>actix_rt::net::{TcpSocket, TcpStream}; <span class="kw">use </span>actix_service::{Service, ServiceFactory}; <span class="kw">use </span>actix_utils::future::{ok, Ready}; <span class="kw">use </span>futures_core::ready; <span class="kw">use </span>tokio_util::sync::ReusableBoxFuture; <span class="kw">use </span>tracing::{error, trace}; <span class="kw">use super</span>::{connect_addrs::ConnectAddrs, error::ConnectError, ConnectInfo, Connection, Host}; <span class="doccomment">/// TCP connector service factory. </span><span class="attr">#[derive(Debug, Clone, Copy, Default)] #[non_exhaustive] </span><span class="kw">pub struct </span>TcpConnector; <span class="kw">impl </span>TcpConnector { <span class="doccomment">/// Returns a new TCP connector service. </span><span class="kw">pub fn </span>service(<span class="kw-2">&</span><span class="self">self</span>) -> TcpConnectorService { TcpConnectorService::default() } } <span class="kw">impl</span><R: Host> ServiceFactory<ConnectInfo<R>> <span class="kw">for </span>TcpConnector { <span class="kw">type </span>Response = Connection<R, TcpStream>; <span class="kw">type </span>Error = ConnectError; <span class="kw">type </span>Config = (); <span class="kw">type </span>Service = TcpConnectorService; <span class="kw">type </span>InitError = (); <span class="kw">type </span>Future = Ready<<span class="prelude-ty">Result</span><<span class="self">Self</span>::Service, <span class="self">Self</span>::InitError>>; <span class="kw">fn </span>new_service(<span class="kw-2">&</span><span class="self">self</span>, <span class="kw">_</span>: ()) -> <span class="self">Self</span>::Future { ok(<span class="self">self</span>.service()) } } <span class="doccomment">/// TCP connector service. </span><span class="attr">#[derive(Debug, Copy, Clone, Default)] #[non_exhaustive] </span><span class="kw">pub struct </span>TcpConnectorService; <span class="kw">impl</span><R: Host> Service<ConnectInfo<R>> <span class="kw">for </span>TcpConnectorService { <span class="kw">type </span>Response = Connection<R, TcpStream>; <span class="kw">type </span>Error = ConnectError; <span class="kw">type </span>Future = TcpConnectorFut<R>; <span class="macro">actix_service::always_ready!</span>(); <span class="kw">fn </span>call(<span class="kw-2">&</span><span class="self">self</span>, req: ConnectInfo<R>) -> <span class="self">Self</span>::Future { <span class="kw">let </span>port = req.port(); <span class="kw">let </span>ConnectInfo { request: req, addr, local_addr, .. } = req; TcpConnectorFut::new(req, port, local_addr, addr) } } <span class="doccomment">/// Connect future for TCP service. </span><span class="attr">#[doc(hidden)] </span><span class="kw">pub enum </span>TcpConnectorFut<R> { Response { req: <span class="prelude-ty">Option</span><R>, port: u16, local_addr: <span class="prelude-ty">Option</span><IpAddr>, addrs: <span class="prelude-ty">Option</span><VecDeque<SocketAddr>>, stream: ReusableBoxFuture<<span class="lifetime">'static</span>, <span class="prelude-ty">Result</span><TcpStream, io::Error>>, }, Error(<span class="prelude-ty">Option</span><ConnectError>), } <span class="kw">impl</span><R: Host> TcpConnectorFut<R> { <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new( req: R, port: u16, local_addr: <span class="prelude-ty">Option</span><IpAddr>, addr: ConnectAddrs, ) -> TcpConnectorFut<R> { <span class="kw">if </span>addr.is_unresolved() { <span class="macro">error!</span>(<span class="string">"TCP connector: unresolved connection address"</span>); <span class="kw">return </span>TcpConnectorFut::Error(<span class="prelude-val">Some</span>(ConnectError::Unresolved)); } <span class="macro">trace!</span>( <span class="string">"TCP connector: connecting to {} on port {}"</span>, req.hostname(), port ); <span class="kw">match </span>addr { ConnectAddrs::None => <span class="macro">unreachable!</span>(<span class="string">"none variant already checked"</span>), ConnectAddrs::One(addr) => TcpConnectorFut::Response { req: <span class="prelude-val">Some</span>(req), port, local_addr, addrs: <span class="prelude-val">None</span>, stream: ReusableBoxFuture::new(connect(addr, local_addr)), }, <span class="comment">// When resolver returns multiple socket addr for request they would be popped from // front end of queue and returns with the first successful TCP connection. </span>ConnectAddrs::Multi(<span class="kw-2">mut </span>addrs) => { <span class="kw">let </span>addr = addrs.pop_front().unwrap(); TcpConnectorFut::Response { req: <span class="prelude-val">Some</span>(req), port, local_addr, addrs: <span class="prelude-val">Some</span>(addrs), stream: ReusableBoxFuture::new(connect(addr, local_addr)), } } } } } <span class="kw">impl</span><R: Host> Future <span class="kw">for </span>TcpConnectorFut<R> { <span class="kw">type </span>Output = <span class="prelude-ty">Result</span><Connection<R, TcpStream>, ConnectError>; <span class="kw">fn </span>poll(<span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<<span class="self">Self</span>::Output> { <span class="kw">match </span><span class="self">self</span>.get_mut() { TcpConnectorFut::Error(err) => Poll::Ready(<span class="prelude-val">Err</span>(err.take().unwrap())), TcpConnectorFut::Response { req, port, local_addr, addrs, stream, } => <span class="kw">loop </span>{ <span class="kw">match </span><span class="macro">ready!</span>(stream.poll(cx)) { <span class="prelude-val">Ok</span>(sock) => { <span class="kw">let </span>req = req.take().unwrap(); <span class="macro">trace!</span>( <span class="string">"TCP connector: successfully connected to {:?} - {:?}"</span>, req.hostname(), sock.peer_addr() ); <span class="kw">return </span>Poll::Ready(<span class="prelude-val">Ok</span>(Connection::new(req, sock))); } <span class="prelude-val">Err</span>(err) => { <span class="macro">trace!</span>( <span class="string">"TCP connector: failed to connect to {:?} port: {}"</span>, req.as_ref().unwrap().hostname(), port, ); <span class="kw">if let </span><span class="prelude-val">Some</span>(addr) = addrs.as_mut().and_then(|addrs| addrs.pop_front()) { stream.set(connect(addr, <span class="kw-2">*</span>local_addr)); } <span class="kw">else </span>{ <span class="kw">return </span>Poll::Ready(<span class="prelude-val">Err</span>(ConnectError::Io(err))); } } } }, } } } <span class="kw">async fn </span>connect(addr: SocketAddr, local_addr: <span class="prelude-ty">Option</span><IpAddr>) -> io::Result<TcpStream> { <span class="comment">// use local addr if connect asks for it </span><span class="kw">match </span>local_addr { <span class="prelude-val">Some</span>(ip_addr) => { <span class="kw">let </span>socket = <span class="kw">match </span>ip_addr { IpAddr::V4(ip_addr) => { <span class="kw">let </span>socket = TcpSocket::new_v4()<span class="question-mark">?</span>; <span class="kw">let </span>addr = SocketAddr::V4(SocketAddrV4::new(ip_addr, <span class="number">0</span>)); socket.bind(addr)<span class="question-mark">?</span>; socket } IpAddr::V6(ip_addr) => { <span class="kw">let </span>socket = TcpSocket::new_v6()<span class="question-mark">?</span>; <span class="kw">let </span>addr = SocketAddr::V6(SocketAddrV6::new(ip_addr, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>)); socket.bind(addr)<span class="question-mark">?</span>; socket } }; socket.connect(addr).<span class="kw">await </span>} <span class="prelude-val">None </span>=> TcpStream::connect(addr).<span class="kw">await</span>, } } </code></pre></div></section></main></body></html>