greptimedb/frontend/heartbeat/index.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="API documentation for the Rust `heartbeat` mod in crate `frontend`."><title>frontend::heartbeat - 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-1ed95124.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="frontend" data-themes="" data-resource-suffix="" data-rustdoc-version="1.98.1 (48a229cea 2026-09-01)" data-channel="1.98.1" data-search-js="search-9944d736.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-417ebf0a.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 mod"><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="#">Module heartbeat</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../frontend/index.html">frontend</a><span class="version">1.4.0-alpha.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module heartbeat</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate frontend</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">frontend</a></div><h1>Module <span>heartbeat</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/frontend/heartbeat.rs.html#15-762">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.FrontendHeartbeatExtensions.html" title="struct frontend::heartbeat::FrontendHeartbeatExtensions">Frontend<wbr>Heartbeat<wbr>Extensions</a></dt><dd>A shareable, ordered registry of frontend heartbeat extensions.</dd><dt><a class="struct" href="struct.FrontendHeartbeatExtensionsInner.html" title="struct frontend::heartbeat::FrontendHeartbeatExtensionsInner">Frontend<wbr>Heartbeat<wbr>Extensions<wbr>Inner</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.HeartbeatConnection.html" title="struct frontend::heartbeat::HeartbeatConnection">Heartbeat<wbr>Connection</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.HeartbeatRunner.html" title="struct frontend::heartbeat::HeartbeatRunner">Heartbeat<wbr>Runner</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.HeartbeatTask.html" title="struct frontend::heartbeat::HeartbeatTask">Heartbeat<wbr>Task</a></dt><dd>The frontend task that sends [<code>HeartbeatRequest</code>] values to metasrv in the background.</dd><dt><a class="struct" href="struct.IsolatedHeartbeatResponseHandler.html" title="struct frontend::heartbeat::IsolatedHeartbeatResponseHandler">Isolated<wbr>Heartbeat<wbr>Response<wbr>Handler</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.MetaHeartbeatConnector.html" title="struct frontend::heartbeat::MetaHeartbeatConnector">Meta<wbr>Heartbeat<wbr>Connector</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.MetaHeartbeatSender.html" title="struct frontend::heartbeat::MetaHeartbeatSender">Meta<wbr>Heartbeat<wbr>Sender</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.MetaHeartbeatStream.html" title="struct frontend::heartbeat::MetaHeartbeatStream">Meta<wbr>Heartbeat<wbr>Stream</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.ConnectionEnd.html" title="enum frontend::heartbeat::ConnectionEnd">Connection<wbr>End</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="enum" href="enum.RegistrationError.html" title="enum frontend::heartbeat::RegistrationError">Registration<wbr>Error</a></dt><dd>The reason a frontend heartbeat extension was not registered.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.FrontendHeartbeatExtension.html" title="trait frontend::heartbeat::FrontendHeartbeatExtension">Frontend<wbr>Heartbeat<wbr>Extension</a></dt><dd>An extension to frontend heartbeat requests, responses, and lifecycle events.</dd><dt><a class="trait" href="trait.HeartbeatConnector.html" title="trait frontend::heartbeat::HeartbeatConnector">Heartbeat<wbr>Connector</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="trait" href="trait.HeartbeatRequestSender.html" title="trait frontend::heartbeat::HeartbeatRequestSender">Heartbeat<wbr>Request<wbr>Sender</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="trait" href="trait.HeartbeatResponseStream.html" title="trait frontend::heartbeat::HeartbeatResponseStream">Heartbeat<wbr>Response<wbr>Stream</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.frontend_peer_addr.html" title="fn frontend::heartbeat::frontend_peer_addr">frontend_<wbr>peer_<wbr>addr</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.heartbeat_response_handler_executor.html" title="fn frontend::heartbeat::heartbeat_response_handler_executor">heartbeat_<wbr>response_<wbr>handler_<wbr>executor</a></dt><dd>Builds the frontend heartbeat response handler chain.</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.FrontendHeartbeatExtensionResult.html" title="type frontend::heartbeat::FrontendHeartbeatExtensionResult">Frontend<wbr>Heartbeat<wbr>Extension<wbr>Result</a></dt><dd>The result type returned by a <a href="trait.FrontendHeartbeatExtension.html" title="trait frontend::heartbeat::FrontendHeartbeatExtension"><code>FrontendHeartbeatExtension</code></a>.</dd></dl></section></div></main></body></html>