| <!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/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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> |
| </pre><pre class="rust"><code><span class="doccomment">//! Client implementation and builder. |
| |
| </span><span class="kw">mod </span>endpoint; |
| <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">mod </span>tls; |
| |
| <span class="kw">pub use </span>endpoint::Endpoint; |
| <span class="attribute">#[cfg(feature = <span class="string">"tls"</span>)] |
| </span><span class="kw">pub use </span>tls::ClientTlsConfig; |
| |
| <span class="kw">use </span><span class="kw">super</span>::service::{Connection, DynamicServiceStream}; |
| <span class="kw">use </span><span class="kw">crate</span>::body::BoxBody; |
| <span class="kw">use </span>bytes::Bytes; |
| <span class="kw">use </span>http::{ |
| uri::{InvalidUri, Uri}, |
| Request, Response, |
| }; |
| <span class="kw">use </span>hyper::client::connect::Connection <span class="kw">as </span>HyperConnection; |
| <span class="kw">use </span>std::{ |
| fmt, |
| future::Future, |
| hash::Hash, |
| pin::Pin, |
| task::{Context, Poll}, |
| }; |
| <span class="kw">use </span>tokio::{ |
| io::{AsyncRead, AsyncWrite}, |
| sync::mpsc::{channel, Sender}, |
| }; |
| |
| <span class="kw">use </span>tower::balance::p2c::Balance; |
| <span class="kw">use </span>tower::{ |
| buffer::{<span class="self">self</span>, Buffer}, |
| discover::{Change, Discover}, |
| util::{BoxService, Either}, |
| Service, |
| }; |
| |
| <span class="kw">type </span>Svc = Either<Connection, BoxService<Request<BoxBody>, Response<hyper::Body>, <span class="kw">crate</span>::Error>>; |
| |
| <span class="kw">const </span>DEFAULT_BUFFER_SIZE: usize = <span class="number">1024</span>; |
| |
| <span class="doccomment">/// A default batteries included `transport` channel. |
| /// |
| /// This provides a fully featured http2 gRPC client based on [`hyper::Client`] |
| /// and `tower` services. |
| /// |
| /// # Multiplexing requests |
| /// |
| /// Sending a request on a channel requires a `&mut self` and thus can only send |
| /// one request in flight. This is intentional and is required to follow the `Service` |
| /// contract from the `tower` library which this channel implementation is built on |
| /// top of. |
| /// |
| /// `tower` itself has a concept of `poll_ready` which is the main mechanism to apply |
| /// back pressure. `poll_ready` takes a `&mut self` and when it returns `Poll::Ready` |
| /// we know the `Service` is able to accept only one request before we must `poll_ready` |
| /// again. Due to this fact any `async fn` that wants to poll for readiness and submit |
| /// the request must have a `&mut self` reference. |
| /// |
| /// To work around this and to ease the use of the channel, `Channel` provides a |
| /// `Clone` implementation that is _cheap_. This is because at the very top level |
| /// the channel is backed by a `tower_buffer::Buffer` which runs the connection |
| /// in a background task and provides a `mpsc` channel interface. Due to this |
| /// cloning the `Channel` type is cheap and encouraged. |
| </span><span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub struct </span>Channel { |
| svc: Buffer<Svc, Request<BoxBody>>, |
| } |
| |
| <span class="doccomment">/// A future that resolves to an HTTP response. |
| /// |
| /// This is returned by the `Service::call` on [`Channel`]. |
| </span><span class="kw">pub struct </span>ResponseFuture { |
| inner: buffer::future::ResponseFuture<<Svc <span class="kw">as </span>Service<Request<BoxBody>>>::Future>, |
| } |
| |
| <span class="kw">impl </span>Channel { |
| <span class="doccomment">/// Create an [`Endpoint`] builder that can create [`Channel`]s. |
| </span><span class="kw">pub fn </span>builder(uri: Uri) -> Endpoint { |
| Endpoint::from(uri) |
| } |
| |
| <span class="doccomment">/// Create an `Endpoint` from a static string. |
| /// |
| /// ``` |
| /// # use tonic::transport::Channel; |
| /// Channel::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) -> Endpoint { |
| <span class="kw">let </span>uri = Uri::from_static(s); |
| <span class="self">Self</span>::builder(uri) |
| } |
| |
| <span class="doccomment">/// Create an `Endpoint` from shared bytes. |
| /// |
| /// ``` |
| /// # use tonic::transport::Channel; |
| /// Channel::from_shared("https://example.com"); |
| /// ``` |
| </span><span class="kw">pub fn </span>from_shared(s: <span class="kw">impl </span>Into<Bytes>) -> <span class="prelude-ty">Result</span><Endpoint, 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>::builder(uri)) |
| } |
| |
| <span class="doccomment">/// Balance a list of [`Endpoint`]'s. |
| /// |
| /// This creates a [`Channel`] that will load balance accross all the |
| /// provided endpoints. |
| </span><span class="kw">pub fn </span>balance_list(list: <span class="kw">impl </span>Iterator<Item = Endpoint>) -> <span class="self">Self </span>{ |
| <span class="kw">let </span>(channel, tx) = <span class="self">Self</span>::balance_channel(DEFAULT_BUFFER_SIZE); |
| list.for_each(|endpoint| { |
| tx.try_send(Change::Insert(endpoint.uri.clone(), endpoint)) |
| .unwrap(); |
| }); |
| |
| channel |
| } |
| |
| <span class="doccomment">/// Balance a list of [`Endpoint`]'s. |
| /// |
| /// This creates a [`Channel`] that will listen to a stream of change events and will add or remove provided endpoints. |
| </span><span class="kw">pub fn </span>balance_channel<K>(capacity: usize) -> (<span class="self">Self</span>, Sender<Change<K, Endpoint>>) |
| <span class="kw">where |
| </span>K: Hash + Eq + Send + Clone + <span class="lifetime">'static</span>, |
| { |
| <span class="kw">let </span>(tx, rx) = channel(capacity); |
| <span class="kw">let </span>list = DynamicServiceStream::new(rx); |
| (<span class="self">Self</span>::balance(list, DEFAULT_BUFFER_SIZE), tx) |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new<C>(connector: C, endpoint: Endpoint) -> <span class="self">Self |
| </span><span class="kw">where |
| </span>C: Service<Uri> + Send + <span class="lifetime">'static</span>, |
| C::Error: Into<<span class="kw">crate</span>::Error> + Send, |
| C::Future: Unpin + Send, |
| C::Response: AsyncRead + AsyncWrite + HyperConnection + Unpin + Send + <span class="lifetime">'static</span>, |
| { |
| <span class="kw">let </span>buffer_size = endpoint.buffer_size.unwrap_or(DEFAULT_BUFFER_SIZE); |
| |
| <span class="kw">let </span>svc = Connection::lazy(connector, endpoint); |
| <span class="kw">let </span>svc = Buffer::new(Either::A(svc), buffer_size); |
| |
| Channel { svc } |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">async fn </span>connect<C>(connector: C, endpoint: Endpoint) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, <span class="kw">super</span>::Error> |
| <span class="kw">where |
| </span>C: Service<Uri> + Send + <span class="lifetime">'static</span>, |
| C::Error: Into<<span class="kw">crate</span>::Error> + Send, |
| C::Future: Unpin + Send, |
| C::Response: AsyncRead + AsyncWrite + HyperConnection + Unpin + Send + <span class="lifetime">'static</span>, |
| { |
| <span class="kw">let </span>buffer_size = endpoint.buffer_size.unwrap_or(DEFAULT_BUFFER_SIZE); |
| |
| <span class="kw">let </span>svc = Connection::connect(connector, endpoint) |
| .<span class="kw">await |
| </span>.map_err(<span class="kw">super</span>::Error::from_source)<span class="question-mark">?</span>; |
| <span class="kw">let </span>svc = Buffer::new(Either::A(svc), buffer_size); |
| |
| <span class="prelude-val">Ok</span>(Channel { svc }) |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>balance<D>(discover: D, buffer_size: usize) -> <span class="self">Self |
| </span><span class="kw">where |
| </span>D: Discover<Service = Connection> + Unpin + Send + <span class="lifetime">'static</span>, |
| D::Error: Into<<span class="kw">crate</span>::Error>, |
| D::Key: Hash + Send + Clone, |
| { |
| <span class="kw">let </span>svc = Balance::new(discover); |
| |
| <span class="kw">let </span>svc = BoxService::new(svc); |
| <span class="kw">let </span>svc = Buffer::new(Either::B(svc), buffer_size); |
| |
| Channel { svc } |
| } |
| } |
| |
| <span class="kw">impl </span>Service<http::Request<BoxBody>> <span class="kw">for </span>Channel { |
| <span class="kw">type </span>Response = http::Response<<span class="kw">super</span>::Body>; |
| <span class="kw">type </span>Error = <span class="kw">super</span>::Error; |
| <span class="kw">type </span>Future = ResponseFuture; |
| |
| <span class="kw">fn </span>poll_ready(<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="prelude-ty">Result</span><(), <span class="self">Self</span>::Error>> { |
| Service::poll_ready(<span class="kw-2">&mut </span><span class="self">self</span>.svc, cx).map_err(<span class="kw">super</span>::Error::from_source) |
| } |
| |
| <span class="kw">fn </span>call(<span class="kw-2">&mut </span><span class="self">self</span>, request: http::Request<BoxBody>) -> <span class="self">Self</span>::Future { |
| <span class="kw">let </span>inner = Service::call(<span class="kw-2">&mut </span><span class="self">self</span>.svc, request); |
| |
| ResponseFuture { inner } |
| } |
| } |
| |
| <span class="kw">impl </span>Future <span class="kw">for </span>ResponseFuture { |
| <span class="kw">type </span>Output = <span class="prelude-ty">Result</span><Response<hyper::Body>, <span class="kw">super</span>::Error>; |
| |
| <span class="kw">fn </span>poll(<span class="kw-2">mut </span><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">let </span>val = <span class="macro">futures_util::ready!</span>(Pin::new(<span class="kw-2">&mut </span><span class="self">self</span>.inner).poll(cx)) |
| .map_err(<span class="kw">super</span>::Error::from_source)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(val).into() |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Channel { |
| <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">"Channel"</span>).finish() |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>ResponseFuture { |
| <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">"ResponseFuture"</span>).finish() |
| } |
| } |
| </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> |
