| <!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/registry/src/github.com-1ecc6299db9ec823/tonic-0.6.2/src/transport/channel/endpoint.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>endpoint.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="../../../../tonic/index.html"><div class="logo-container"> |
| <img src="https://raw.githubusercontent.com/tokio-rs/website/master/public/img/icons/tonic.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../../tonic/index.html"> |
| <img src="https://raw.githubusercontent.com/tokio-rs/website/master/public/img/icons/tonic.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> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| <span id="383">383</span> |
| <span id="384">384</span> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| <span id="392">392</span> |
| <span id="393">393</span> |
| <span id="394">394</span> |
| <span id="395">395</span> |
| <span id="396">396</span> |
| <span id="397">397</span> |
| <span id="398">398</span> |
| <span id="399">399</span> |
| <span id="400">400</span> |
| <span id="401">401</span> |
| <span id="402">402</span> |
| <span id="403">403</span> |
| <span id="404">404</span> |
| <span id="405">405</span> |
| <span id="406">406</span> |
| <span id="407">407</span> |
| <span id="408">408</span> |
| <span id="409">409</span> |
| <span id="410">410</span> |
| <span id="411">411</span> |
| <span id="412">412</span> |
| <span id="413">413</span> |
| <span id="414">414</span> |
| <span id="415">415</span> |
| <span id="416">416</span> |
| <span id="417">417</span> |
| <span id="418">418</span> |
| <span id="419">419</span> |
| <span id="420">420</span> |
| <span id="421">421</span> |
| <span id="422">422</span> |
| <span id="423">423</span> |
| <span id="424">424</span> |
| <span id="425">425</span> |
| <span id="426">426</span> |
| <span id="427">427</span> |
| <span id="428">428</span> |
| <span id="429">429</span> |
| <span id="430">430</span> |
| <span id="431">431</span> |
| <span id="432">432</span> |
| <span id="433">433</span> |
| <span id="434">434</span> |
| <span id="435">435</span> |
| <span id="436">436</span> |
| <span id="437">437</span> |
| <span id="438">438</span> |
| <span id="439">439</span> |
| <span id="440">440</span> |
| <span id="441">441</span> |
| <span id="442">442</span> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">super</span>::<span class="kw">super</span>::service; |
| <span class="kw">use </span><span class="kw">super</span>::Channel; |
| <span class="attribute">#[cfg(feature = <span class="string">"tls"</span>)] |
| </span><span class="kw">use </span><span class="kw">super</span>::ClientTlsConfig; |
| <span class="attribute">#[cfg(feature = <span class="string">"tls"</span>)] |
| </span><span class="kw">use </span><span class="kw">crate</span>::transport::service::TlsConnector; |
| <span class="kw">use </span><span class="kw">crate</span>::transport::Error; |
| <span class="kw">use </span>bytes::Bytes; |
| <span class="kw">use </span>http::{ |
| uri::{InvalidUri, Uri}, |
| HeaderValue, |
| }; |
| <span class="kw">use </span>std::{ |
| convert::{TryFrom, TryInto}, |
| fmt, |
| str::FromStr, |
| time::Duration, |
| }; |
| <span class="kw">use </span>tower::make::MakeConnection; |
| |
| <span class="doccomment">/// Channel builder. |
| /// |
| /// This struct is used to build and configure HTTP/2 channels. |
| </span><span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub struct </span>Endpoint { |
| <span class="kw">pub</span>(<span class="kw">crate</span>) uri: Uri, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) user_agent: <span class="prelude-ty">Option</span><HeaderValue>, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) timeout: <span class="prelude-ty">Option</span><Duration>, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) concurrency_limit: <span class="prelude-ty">Option</span><usize>, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) rate_limit: <span class="prelude-ty">Option</span><(u64, Duration)>, |
| <span class="attribute">#[cfg(feature = <span class="string">"tls"</span>)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) tls: <span class="prelude-ty">Option</span><TlsConnector>, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) buffer_size: <span class="prelude-ty">Option</span><usize>, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) init_stream_window_size: <span class="prelude-ty">Option</span><u32>, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) init_connection_window_size: <span class="prelude-ty">Option</span><u32>, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) tcp_keepalive: <span class="prelude-ty">Option</span><Duration>, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) tcp_nodelay: bool, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) http2_keep_alive_interval: <span class="prelude-ty">Option</span><Duration>, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) http2_keep_alive_timeout: <span class="prelude-ty">Option</span><Duration>, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) http2_keep_alive_while_idle: <span class="prelude-ty">Option</span><bool>, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) connect_timeout: <span class="prelude-ty">Option</span><Duration>, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) http2_adaptive_window: <span class="prelude-ty">Option</span><bool>, |
| } |
| |
| <span class="kw">impl </span>Endpoint { |
| <span class="comment">// FIXME: determine if we want to expose this or not. This is really |
| // just used in codegen for a shortcut. |
| </span><span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub fn </span>new<D>(dst: D) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, Error> |
| <span class="kw">where |
| </span>D: TryInto<<span class="self">Self</span>>, |
| D::Error: Into<<span class="kw">crate</span>::Error>, |
| { |
| <span class="kw">let </span>me = dst.try_into().map_err(|e| Error::from_source(e.into()))<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(me) |
| } |
| |
| <span class="doccomment">/// Convert an `Endpoint` from a static string. |
| /// |
| /// # Panics |
| /// |
| /// This function panics if the argument is an invalid URI. |
| /// |
| /// ``` |
| /// # use tonic::transport::Endpoint; |
| /// Endpoint::from_static("https://example.com"); |
| /// ``` |
| </span><span class="kw">pub fn </span>from_static(s: <span class="kw-2">&</span><span class="lifetime">'static </span>str) -> <span class="self">Self </span>{ |
| <span class="kw">let </span>uri = Uri::from_static(s); |
| <span class="self">Self</span>::from(uri) |
| } |
| |
| <span class="doccomment">/// Convert an `Endpoint` from shared bytes. |
| /// |
| /// ``` |
| /// # use tonic::transport::Endpoint; |
| /// Endpoint::from_shared("https://example.com".to_string()); |
| /// ``` |
| </span><span class="kw">pub fn </span>from_shared(s: <span class="kw">impl </span>Into<Bytes>) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, InvalidUri> { |
| <span class="kw">let </span>uri = Uri::from_maybe_shared(s.into())<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(<span class="self">Self</span>::from(uri)) |
| } |
| |
| <span class="doccomment">/// Set a custom user-agent header. |
| /// |
| /// `user_agent` will be prepended to Tonic's default user-agent string (`tonic/x.x.x`). |
| /// It must be a value that can be converted into a valid `http::HeaderValue` or building |
| /// the endpoint will fail. |
| /// ``` |
| /// # use tonic::transport::Endpoint; |
| /// # let mut builder = Endpoint::from_static("https://example.com"); |
| /// builder.user_agent("Greeter").expect("Greeter should be a valid header value"); |
| /// // user-agent: "Greeter tonic/x.x.x" |
| /// ``` |
| </span><span class="kw">pub fn </span>user_agent<T>(<span class="self">self</span>, user_agent: T) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, Error> |
| <span class="kw">where |
| </span>T: TryInto<HeaderValue>, |
| { |
| user_agent |
| .try_into() |
| .map(|ua| Endpoint { |
| user_agent: <span class="prelude-val">Some</span>(ua), |
| ..<span class="self">self |
| </span>}) |
| .map_err(|<span class="kw">_</span>| Error::new_invalid_user_agent()) |
| } |
| |
| <span class="doccomment">/// Apply a timeout to each request. |
| /// |
| /// ``` |
| /// # use tonic::transport::Endpoint; |
| /// # use std::time::Duration; |
| /// # let mut builder = Endpoint::from_static("https://example.com"); |
| /// builder.timeout(Duration::from_secs(5)); |
| /// ``` |
| /// |
| /// # Notes |
| /// |
| /// This does **not** set the timeout metadata (`grpc-timeout` header) on |
| /// the request, meaning the server will not be informed of this timeout, |
| /// for that use [`Request::set_timeout`]. |
| /// |
| /// [`Request::set_timeout`]: crate::Request::set_timeout |
| </span><span class="kw">pub fn </span>timeout(<span class="self">self</span>, dur: Duration) -> <span class="self">Self </span>{ |
| Endpoint { |
| timeout: <span class="prelude-val">Some</span>(dur), |
| ..<span class="self">self |
| </span>} |
| } |
| |
| <span class="doccomment">/// Apply a timeout to connecting to the uri. |
| /// |
| /// Defaults to no timeout. |
| /// |
| /// ``` |
| /// # use tonic::transport::Endpoint; |
| /// # use std::time::Duration; |
| /// # let mut builder = Endpoint::from_static("https://example.com"); |
| /// builder.connect_timeout(Duration::from_secs(5)); |
| /// ``` |
| </span><span class="kw">pub fn </span>connect_timeout(<span class="self">self</span>, dur: Duration) -> <span class="self">Self </span>{ |
| Endpoint { |
| connect_timeout: <span class="prelude-val">Some</span>(dur), |
| ..<span class="self">self |
| </span>} |
| } |
| |
| <span class="doccomment">/// Set whether TCP keepalive messages are enabled on accepted connections. |
| /// |
| /// If `None` is specified, keepalive is disabled, otherwise the duration |
| /// specified will be the time to remain idle before sending TCP keepalive |
| /// probes. |
| /// |
| /// Default is no keepalive (`None`) |
| /// |
| </span><span class="kw">pub fn </span>tcp_keepalive(<span class="self">self</span>, tcp_keepalive: <span class="prelude-ty">Option</span><Duration>) -> <span class="self">Self </span>{ |
| Endpoint { |
| tcp_keepalive, |
| ..<span class="self">self |
| </span>} |
| } |
| |
| <span class="doccomment">/// Apply a concurrency limit to each request. |
| /// |
| /// ``` |
| /// # use tonic::transport::Endpoint; |
| /// # let mut builder = Endpoint::from_static("https://example.com"); |
| /// builder.concurrency_limit(256); |
| /// ``` |
| </span><span class="kw">pub fn </span>concurrency_limit(<span class="self">self</span>, limit: usize) -> <span class="self">Self </span>{ |
| Endpoint { |
| concurrency_limit: <span class="prelude-val">Some</span>(limit), |
| ..<span class="self">self |
| </span>} |
| } |
| |
| <span class="doccomment">/// Apply a rate limit to each request. |
| /// |
| /// ``` |
| /// # use tonic::transport::Endpoint; |
| /// # use std::time::Duration; |
| /// # let mut builder = Endpoint::from_static("https://example.com"); |
| /// builder.rate_limit(32, Duration::from_secs(1)); |
| /// ``` |
| </span><span class="kw">pub fn </span>rate_limit(<span class="self">self</span>, limit: u64, duration: Duration) -> <span class="self">Self </span>{ |
| Endpoint { |
| rate_limit: <span class="prelude-val">Some</span>((limit, duration)), |
| ..<span class="self">self |
| </span>} |
| } |
| |
| <span class="doccomment">/// Sets the [`SETTINGS_INITIAL_WINDOW_SIZE`][spec] option for HTTP2 |
| /// stream-level flow control. |
| /// |
| /// Default is 65,535 |
| /// |
| /// [spec]: https://http2.github.io/http2-spec/#SETTINGS_INITIAL_WINDOW_SIZE |
| </span><span class="kw">pub fn </span>initial_stream_window_size(<span class="self">self</span>, sz: <span class="kw">impl </span>Into<<span class="prelude-ty">Option</span><u32>>) -> <span class="self">Self </span>{ |
| Endpoint { |
| init_stream_window_size: sz.into(), |
| ..<span class="self">self |
| </span>} |
| } |
| |
| <span class="doccomment">/// Sets the max connection-level flow control for HTTP2 |
| /// |
| /// Default is 65,535 |
| </span><span class="kw">pub fn </span>initial_connection_window_size(<span class="self">self</span>, sz: <span class="kw">impl </span>Into<<span class="prelude-ty">Option</span><u32>>) -> <span class="self">Self </span>{ |
| Endpoint { |
| init_connection_window_size: sz.into(), |
| ..<span class="self">self |
| </span>} |
| } |
| |
| <span class="doccomment">/// Configures TLS for the endpoint. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"tls"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"tls"</span>)))] |
| </span><span class="kw">pub fn </span>tls_config(<span class="self">self</span>, tls_config: ClientTlsConfig) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, Error> { |
| <span class="prelude-val">Ok</span>(Endpoint { |
| tls: <span class="prelude-val">Some</span>( |
| tls_config |
| .tls_connector(<span class="self">self</span>.uri.clone()) |
| .map_err(Error::from_source)<span class="question-mark">?</span>, |
| ), |
| ..<span class="self">self |
| </span>}) |
| } |
| |
| <span class="doccomment">/// Set the value of `TCP_NODELAY` option for accepted connections. Enabled by default. |
| </span><span class="kw">pub fn </span>tcp_nodelay(<span class="self">self</span>, enabled: bool) -> <span class="self">Self </span>{ |
| Endpoint { |
| tcp_nodelay: enabled, |
| ..<span class="self">self |
| </span>} |
| } |
| |
| <span class="doccomment">/// Set http2 KEEP_ALIVE_INTERVAL. Uses `hyper`'s default otherwise. |
| </span><span class="kw">pub fn </span>http2_keep_alive_interval(<span class="self">self</span>, interval: Duration) -> <span class="self">Self </span>{ |
| Endpoint { |
| http2_keep_alive_interval: <span class="prelude-val">Some</span>(interval), |
| ..<span class="self">self |
| </span>} |
| } |
| |
| <span class="doccomment">/// Set http2 KEEP_ALIVE_TIMEOUT. Uses `hyper`'s default otherwise. |
| </span><span class="kw">pub fn </span>keep_alive_timeout(<span class="self">self</span>, duration: Duration) -> <span class="self">Self </span>{ |
| Endpoint { |
| http2_keep_alive_timeout: <span class="prelude-val">Some</span>(duration), |
| ..<span class="self">self |
| </span>} |
| } |
| |
| <span class="doccomment">/// Set http2 KEEP_ALIVE_WHILE_IDLE. Uses `hyper`'s default otherwise. |
| </span><span class="kw">pub fn </span>keep_alive_while_idle(<span class="self">self</span>, enabled: bool) -> <span class="self">Self </span>{ |
| Endpoint { |
| http2_keep_alive_while_idle: <span class="prelude-val">Some</span>(enabled), |
| ..<span class="self">self |
| </span>} |
| } |
| |
| <span class="doccomment">/// Sets whether to use an adaptive flow control. Uses `hyper`'s default otherwise. |
| </span><span class="kw">pub fn </span>http2_adaptive_window(<span class="self">self</span>, enabled: bool) -> <span class="self">Self </span>{ |
| Endpoint { |
| http2_adaptive_window: <span class="prelude-val">Some</span>(enabled), |
| ..<span class="self">self |
| </span>} |
| } |
| |
| <span class="doccomment">/// Create a channel from this config. |
| </span><span class="kw">pub async fn </span>connect(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><Channel, Error> { |
| <span class="kw">let </span><span class="kw-2">mut </span>http = hyper::client::connect::HttpConnector::new(); |
| http.enforce_http(<span class="bool-val">false</span>); |
| http.set_nodelay(<span class="self">self</span>.tcp_nodelay); |
| http.set_keepalive(<span class="self">self</span>.tcp_keepalive); |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"tls"</span>)] |
| </span><span class="kw">let </span>connector = service::connector(http, <span class="self">self</span>.tls.clone()); |
| |
| <span class="attribute">#[cfg(not(feature = <span class="string">"tls"</span>))] |
| </span><span class="kw">let </span>connector = service::connector(http); |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(connect_timeout) = <span class="self">self</span>.connect_timeout { |
| <span class="kw">let </span><span class="kw-2">mut </span>connector = hyper_timeout::TimeoutConnector::new(connector); |
| connector.set_connect_timeout(<span class="prelude-val">Some</span>(connect_timeout)); |
| Channel::connect(connector, <span class="self">self</span>.clone()).<span class="kw">await |
| </span>} <span class="kw">else </span>{ |
| Channel::connect(connector, <span class="self">self</span>.clone()).<span class="kw">await |
| </span>} |
| } |
| |
| <span class="doccomment">/// Create a channel from this config. |
| /// |
| /// The channel returned by this method does not attempt to connect to the endpoint until first |
| /// use. |
| </span><span class="kw">pub fn </span>connect_lazy(<span class="kw-2">&</span><span class="self">self</span>) -> Channel { |
| <span class="kw">let </span><span class="kw-2">mut </span>http = hyper::client::connect::HttpConnector::new(); |
| http.enforce_http(<span class="bool-val">false</span>); |
| http.set_nodelay(<span class="self">self</span>.tcp_nodelay); |
| http.set_keepalive(<span class="self">self</span>.tcp_keepalive); |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"tls"</span>)] |
| </span><span class="kw">let </span>connector = service::connector(http, <span class="self">self</span>.tls.clone()); |
| |
| <span class="attribute">#[cfg(not(feature = <span class="string">"tls"</span>))] |
| </span><span class="kw">let </span>connector = service::connector(http); |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(connect_timeout) = <span class="self">self</span>.connect_timeout { |
| <span class="kw">let </span><span class="kw-2">mut </span>connector = hyper_timeout::TimeoutConnector::new(connector); |
| connector.set_connect_timeout(<span class="prelude-val">Some</span>(connect_timeout)); |
| Channel::new(connector, <span class="self">self</span>.clone()) |
| } <span class="kw">else </span>{ |
| Channel::new(connector, <span class="self">self</span>.clone()) |
| } |
| } |
| |
| <span class="doccomment">/// Connect with a custom connector. |
| /// |
| /// This allows you to build a [Channel](struct.Channel.html) that uses a non-HTTP transport. |
| /// See the `uds` example for an example on how to use this function to build channel that |
| /// uses a Unix socket transport. |
| /// |
| /// The [`connect_timeout`](Endpoint::connect_timeout) will still be applied. |
| </span><span class="kw">pub async fn </span>connect_with_connector<C>(<span class="kw-2">&</span><span class="self">self</span>, connector: C) -> <span class="prelude-ty">Result</span><Channel, Error> |
| <span class="kw">where |
| </span>C: MakeConnection<Uri> + Send + <span class="lifetime">'static</span>, |
| C::Connection: Unpin + Send + <span class="lifetime">'static</span>, |
| C::Future: Send + <span class="lifetime">'static</span>, |
| <span class="kw">crate</span>::Error: From<C::Error> + Send + <span class="lifetime">'static</span>, |
| { |
| <span class="attribute">#[cfg(feature = <span class="string">"tls"</span>)] |
| </span><span class="kw">let </span>connector = service::connector(connector, <span class="self">self</span>.tls.clone()); |
| |
| <span class="attribute">#[cfg(not(feature = <span class="string">"tls"</span>))] |
| </span><span class="kw">let </span>connector = service::connector(connector); |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(connect_timeout) = <span class="self">self</span>.connect_timeout { |
| <span class="kw">let </span><span class="kw-2">mut </span>connector = hyper_timeout::TimeoutConnector::new(connector); |
| connector.set_connect_timeout(<span class="prelude-val">Some</span>(connect_timeout)); |
| Channel::connect(connector, <span class="self">self</span>.clone()).<span class="kw">await |
| </span>} <span class="kw">else </span>{ |
| Channel::connect(connector, <span class="self">self</span>.clone()).<span class="kw">await |
| </span>} |
| } |
| |
| <span class="doccomment">/// Connect with a custom connector lazily. |
| /// |
| /// This allows you to build a [Channel](struct.Channel.html) that uses a non-HTTP transport |
| /// connec to it lazily. |
| /// |
| /// See the `uds` example for an example on how to use this function to build channel that |
| /// uses a Unix socket transport. |
| </span><span class="kw">pub fn </span>connect_with_connector_lazy<C>(<span class="kw-2">&</span><span class="self">self</span>, connector: C) -> <span class="prelude-ty">Result</span><Channel, Error> |
| <span class="kw">where |
| </span>C: MakeConnection<Uri> + Send + <span class="lifetime">'static</span>, |
| C::Connection: Unpin + Send + <span class="lifetime">'static</span>, |
| C::Future: Send + <span class="lifetime">'static</span>, |
| <span class="kw">crate</span>::Error: From<C::Error> + Send + <span class="lifetime">'static</span>, |
| { |
| <span class="attribute">#[cfg(feature = <span class="string">"tls"</span>)] |
| </span><span class="kw">let </span>connector = service::connector(connector, <span class="self">self</span>.tls.clone()); |
| |
| <span class="attribute">#[cfg(not(feature = <span class="string">"tls"</span>))] |
| </span><span class="kw">let </span>connector = service::connector(connector); |
| |
| <span class="prelude-val">Ok</span>(Channel::new(connector, <span class="self">self</span>.clone())) |
| } |
| |
| <span class="doccomment">/// Get the endpoint uri. |
| /// |
| /// ``` |
| /// # use tonic::transport::Endpoint; |
| /// # use http::Uri; |
| /// let endpoint = Endpoint::from_static("https://example.com"); |
| /// |
| /// assert_eq!(endpoint.uri(), &Uri::from_static("https://example.com")); |
| /// ``` |
| </span><span class="kw">pub fn </span>uri(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>Uri { |
| <span class="kw-2">&</span><span class="self">self</span>.uri |
| } |
| } |
| |
| <span class="kw">impl </span>From<Uri> <span class="kw">for </span>Endpoint { |
| <span class="kw">fn </span>from(uri: Uri) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| uri, |
| user_agent: <span class="prelude-val">None</span>, |
| concurrency_limit: <span class="prelude-val">None</span>, |
| rate_limit: <span class="prelude-val">None</span>, |
| timeout: <span class="prelude-val">None</span>, |
| <span class="attribute">#[cfg(feature = <span class="string">"tls"</span>)] |
| </span>tls: <span class="prelude-val">None</span>, |
| buffer_size: <span class="prelude-val">None</span>, |
| init_stream_window_size: <span class="prelude-val">None</span>, |
| init_connection_window_size: <span class="prelude-val">None</span>, |
| tcp_keepalive: <span class="prelude-val">None</span>, |
| tcp_nodelay: <span class="bool-val">true</span>, |
| http2_keep_alive_interval: <span class="prelude-val">None</span>, |
| http2_keep_alive_timeout: <span class="prelude-val">None</span>, |
| http2_keep_alive_while_idle: <span class="prelude-val">None</span>, |
| connect_timeout: <span class="prelude-val">None</span>, |
| http2_adaptive_window: <span class="prelude-val">None</span>, |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>TryFrom<Bytes> <span class="kw">for </span>Endpoint { |
| <span class="kw">type </span>Error = InvalidUri; |
| |
| <span class="kw">fn </span>try_from(t: Bytes) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, <span class="self">Self</span>::Error> { |
| <span class="self">Self</span>::from_shared(t) |
| } |
| } |
| |
| <span class="kw">impl </span>TryFrom<String> <span class="kw">for </span>Endpoint { |
| <span class="kw">type </span>Error = InvalidUri; |
| |
| <span class="kw">fn </span>try_from(t: String) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, <span class="self">Self</span>::Error> { |
| <span class="self">Self</span>::from_shared(t.into_bytes()) |
| } |
| } |
| |
| <span class="kw">impl </span>TryFrom<<span class="kw-2">&</span><span class="lifetime">'static </span>str> <span class="kw">for </span>Endpoint { |
| <span class="kw">type </span>Error = InvalidUri; |
| |
| <span class="kw">fn </span>try_from(t: <span class="kw-2">&</span><span class="lifetime">'static </span>str) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, <span class="self">Self</span>::Error> { |
| <span class="self">Self</span>::from_shared(t.as_bytes()) |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Endpoint { |
| <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 { |
| f.debug_struct(<span class="string">"Endpoint"</span>).finish() |
| } |
| } |
| |
| <span class="kw">impl </span>FromStr <span class="kw">for </span>Endpoint { |
| <span class="kw">type </span><span class="prelude-val">Err </span>= InvalidUri; |
| |
| <span class="kw">fn </span>from_str(s: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, <span class="self">Self</span>::Err> { |
| <span class="self">Self</span>::try_from(s.to_string()) |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="tonic" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
