mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-31 20:30:37 +00:00
39 lines
12 KiB
HTML
39 lines
12 KiB
HTML
<!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="Generated trait containing gRPC methods that should be implemented for use with HeartbeatServer."><title>Heartbeat in api::v1::meta::heartbeat_server - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="api" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../../../static.files/storage-41dd4d93.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Heartbeat</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../api/index.html">api</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Heartbeat</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.HeartbeatStream" title="HeartbeatStream">HeartbeatStream</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.ask_leader" title="ask_leader">ask_leader</a></li><li><a href="#tymethod.heartbeat" title="heartbeat">heartbeat</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In api::<wbr>v1::<wbr>meta::<wbr>heartbeat_<wbr>server</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../../index.html">api</a>::<wbr><a href="../../index.html">v1</a>::<wbr><a href="../index.html">meta</a>::<wbr><a href="index.html">heartbeat_server</a></div><h1>Trait <span class="trait">Heartbeat</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><pre class="rust item-decl"><code>pub trait Heartbeat:
|
||
<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>
|
||
+ <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>
|
||
+ 'static {
|
||
type <a href="#associatedtype.HeartbeatStream" class="associatedtype">HeartbeatStream</a>: Stream<Item = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../struct.HeartbeatResponse.html" title="struct api::v1::meta::HeartbeatResponse">HeartbeatResponse</a>, Status>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static;
|
||
|
||
// Required methods
|
||
fn <a href="#tymethod.heartbeat" class="fn">heartbeat</a><'life0, 'async_trait>(
|
||
&'life0 self,
|
||
request: Request<Streaming<<a class="struct" href="../struct.HeartbeatRequest.html" title="struct api::v1::meta::HeartbeatRequest">HeartbeatRequest</a>>>,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Response<Self::<a class="associatedtype" href="trait.Heartbeat.html#associatedtype.HeartbeatStream" title="type api::v1::meta::heartbeat_server::Heartbeat::HeartbeatStream">HeartbeatStream</a>>, Status>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
||
<span class="where">where 'life0: 'async_trait,
|
||
Self: 'async_trait</span>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.ask_leader" class="fn">ask_leader</a><'life0, 'async_trait>(
|
||
&'life0 self,
|
||
request: Request<<a class="struct" href="../struct.AskLeaderRequest.html" title="struct api::v1::meta::AskLeaderRequest">AskLeaderRequest</a>>,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Response<<a class="struct" href="../struct.AskLeaderResponse.html" title="struct api::v1::meta::AskLeaderResponse">AskLeaderResponse</a>>, Status>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
||
<span class="where">where 'life0: 'async_trait,
|
||
Self: 'async_trait</span>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Generated trait containing gRPC methods that should be implemented for use with HeartbeatServer.</p>
|
||
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.HeartbeatStream" class="method"><h4 class="code-header">type <a href="#associatedtype.HeartbeatStream" class="associatedtype">HeartbeatStream</a>: Stream<Item = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../struct.HeartbeatResponse.html" title="struct api::v1::meta::HeartbeatResponse">HeartbeatResponse</a>, Status>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static</h4></section></summary><div class="docblock"><p>Server streaming response type for the Heartbeat method.</p>
|
||
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.heartbeat" class="method"><h4 class="code-header">fn <a href="#tymethod.heartbeat" class="fn">heartbeat</a><'life0, 'async_trait>(
|
||
&'life0 self,
|
||
request: Request<Streaming<<a class="struct" href="../struct.HeartbeatRequest.html" title="struct api::v1::meta::HeartbeatRequest">HeartbeatRequest</a>>>,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Response<Self::<a class="associatedtype" href="trait.Heartbeat.html#associatedtype.HeartbeatStream" title="type api::v1::meta::heartbeat_server::Heartbeat::HeartbeatStream">HeartbeatStream</a>>, Status>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
||
'life0: 'async_trait,
|
||
Self: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Heartbeat, there may be many contents of the heartbeat, such as:</p>
|
||
<ol>
|
||
<li>Metadata to be registered to meta server and discoverable by other nodes.</li>
|
||
<li>Some performance metrics, such as Load, CPU usage, etc.</li>
|
||
<li>The number of computing tasks being executed.</li>
|
||
</ol>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.ask_leader" class="method"><h4 class="code-header">fn <a href="#tymethod.ask_leader" class="fn">ask_leader</a><'life0, 'async_trait>(
|
||
&'life0 self,
|
||
request: Request<<a class="struct" href="../struct.AskLeaderRequest.html" title="struct api::v1::meta::AskLeaderRequest">AskLeaderRequest</a>>,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Response<<a class="struct" href="../struct.AskLeaderResponse.html" title="struct api::v1::meta::AskLeaderResponse">AskLeaderResponse</a>>, Status>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
||
'life0: 'async_trait,
|
||
Self: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Ask leader’s endpoint.</p>
|
||
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../../../trait.impl/greptime_proto/v1/meta/heartbeat_server/trait.Heartbeat.js" async></script></section></div></main></body></html> |