| <!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/h2-0.3.19/src/frame/ping.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>ping.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="../../../h2/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="../../../h2/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> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::frame::{Error, Frame, Head, Kind, StreamId}; |
| <span class="kw">use </span>bytes::BufMut; |
| |
| <span class="kw">const </span>ACK_FLAG: u8 = <span class="number">0x1</span>; |
| |
| <span class="kw">pub type </span>Payload = [u8; <span class="number">8</span>]; |
| |
| <span class="attribute">#[derive(Debug, Eq, PartialEq)] |
| </span><span class="kw">pub struct </span>Ping { |
| ack: bool, |
| payload: Payload, |
| } |
| |
| <span class="comment">// This was just 8 randomly generated bytes. We use something besides just |
| // zeroes to distinguish this specific PING from any other. |
| </span><span class="kw">const </span>SHUTDOWN_PAYLOAD: Payload = [<span class="number">0x0b</span>, <span class="number">0x7b</span>, <span class="number">0xa2</span>, <span class="number">0xf0</span>, <span class="number">0x8b</span>, <span class="number">0x9b</span>, <span class="number">0xfe</span>, <span class="number">0x54</span>]; |
| <span class="kw">const </span>USER_PAYLOAD: Payload = [<span class="number">0x3b</span>, <span class="number">0x7c</span>, <span class="number">0xdb</span>, <span class="number">0x7a</span>, <span class="number">0x0b</span>, <span class="number">0x87</span>, <span class="number">0x16</span>, <span class="number">0xb4</span>]; |
| |
| <span class="kw">impl </span>Ping { |
| <span class="attribute">#[cfg(feature = <span class="string">"unstable"</span>)] |
| </span><span class="kw">pub const </span>SHUTDOWN: Payload = SHUTDOWN_PAYLOAD; |
| |
| <span class="attribute">#[cfg(not(feature = <span class="string">"unstable"</span>))] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>SHUTDOWN: Payload = SHUTDOWN_PAYLOAD; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"unstable"</span>)] |
| </span><span class="kw">pub const </span>USER: Payload = USER_PAYLOAD; |
| |
| <span class="attribute">#[cfg(not(feature = <span class="string">"unstable"</span>))] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>USER: Payload = USER_PAYLOAD; |
| |
| <span class="kw">pub fn </span>new(payload: Payload) -> Ping { |
| Ping { |
| ack: <span class="bool-val">false</span>, |
| payload, |
| } |
| } |
| |
| <span class="kw">pub fn </span>pong(payload: Payload) -> Ping { |
| Ping { ack: <span class="bool-val">true</span>, payload } |
| } |
| |
| <span class="kw">pub fn </span>is_ack(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.ack |
| } |
| |
| <span class="kw">pub fn </span>payload(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>Payload { |
| <span class="kw-2">&</span><span class="self">self</span>.payload |
| } |
| |
| <span class="kw">pub fn </span>into_payload(<span class="self">self</span>) -> Payload { |
| <span class="self">self</span>.payload |
| } |
| |
| <span class="doccomment">/// Builds a `Ping` frame from a raw frame. |
| </span><span class="kw">pub fn </span>load(head: Head, bytes: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><Ping, Error> { |
| <span class="macro">debug_assert_eq!</span>(head.kind(), <span class="kw">crate</span>::frame::Kind::Ping); |
| |
| <span class="comment">// PING frames are not associated with any individual stream. If a PING |
| // frame is received with a stream identifier field value other than |
| // 0x0, the recipient MUST respond with a connection error |
| // (Section 5.4.1) of type PROTOCOL_ERROR. |
| </span><span class="kw">if </span>!head.stream_id().is_zero() { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidStreamId); |
| } |
| |
| <span class="comment">// In addition to the frame header, PING frames MUST contain 8 octets of opaque |
| // data in the payload. |
| </span><span class="kw">if </span>bytes.len() != <span class="number">8 </span>{ |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::BadFrameSize); |
| } |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>payload = [<span class="number">0</span>; <span class="number">8</span>]; |
| payload.copy_from_slice(bytes); |
| |
| <span class="comment">// The PING frame defines the following flags: |
| // |
| // ACK (0x1): When set, bit 0 indicates that this PING frame is a PING |
| // response. An endpoint MUST set this flag in PING responses. An |
| // endpoint MUST NOT respond to PING frames containing this flag. |
| </span><span class="kw">let </span>ack = head.flag() & ACK_FLAG != <span class="number">0</span>; |
| |
| <span class="prelude-val">Ok</span>(Ping { ack, payload }) |
| } |
| |
| <span class="kw">pub fn </span>encode<B: BufMut>(<span class="kw-2">&</span><span class="self">self</span>, dst: <span class="kw-2">&mut </span>B) { |
| <span class="kw">let </span>sz = <span class="self">self</span>.payload.len(); |
| <span class="macro">tracing::trace!</span>(<span class="string">"encoding PING; ack={} len={}"</span>, <span class="self">self</span>.ack, sz); |
| |
| <span class="kw">let </span>flags = <span class="kw">if </span><span class="self">self</span>.ack { ACK_FLAG } <span class="kw">else </span>{ <span class="number">0 </span>}; |
| <span class="kw">let </span>head = Head::new(Kind::Ping, flags, StreamId::zero()); |
| |
| head.encode(sz, dst); |
| dst.put_slice(<span class="kw-2">&</span><span class="self">self</span>.payload); |
| } |
| } |
| |
| <span class="kw">impl</span><T> From<Ping> <span class="kw">for </span>Frame<T> { |
| <span class="kw">fn </span>from(src: Ping) -> Frame<T> { |
| Frame::Ping(src) |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="h2" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
