mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-17 05:20:37 +00:00
3 lines
6.4 KiB
HTML
3 lines
6.4 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="API documentation for the Rust `election` mod in crate `common_meta`."><title>common_meta::election - 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="common_meta" 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 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 election</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../common_meta/index.html">common_<wbr>meta</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module election</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</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 common_<wbr>meta</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">common_meta</a></div><h1>Module <span>election</span> <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/common_meta/election.rs.html#15-242">Source</a> </span></div><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="etcd/index.html" title="mod common_meta::election::etcd">etcd</a></dt><dt><a class="mod" href="rds/index.html" title="mod common_meta::election::rds">rds</a></dt></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.LeaderValue.html" title="struct common_meta::election::LeaderValue">Leader<wbr>Value</a></dt><dd>The value of the leader. It is used to store the leader’s address.</dd><dt><a class="struct" href="struct.MetasrvNodeInfo.html" title="struct common_meta::election::MetasrvNodeInfo">Metasrv<wbr>Node<wbr>Info</a></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.LeaderChangeMessage.html" title="enum common_meta::election::LeaderChangeMessage">Leader<wbr>Change<wbr>Message</a></dt><dd>Messages sent when the leader changes.</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.CANDIDATE_LEASE_SECS.html" title="constant common_meta::election::CANDIDATE_LEASE_SECS">CANDIDATE_<wbr>LEASE_<wbr>SECS</a></dt><dt><a class="constant" href="constant.KEEP_ALIVE_INTERVAL_SECS.html" title="constant common_meta::election::KEEP_ALIVE_INTERVAL_SECS">KEEP_<wbr>ALIVE_<wbr>INTERVAL_<wbr>SECS</a><span title="Restricted Visibility"> 🔒</span> </dt></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.Election.html" title="trait common_meta::election::Election">Election</a></dt><dt><a class="trait" href="trait.LeaderKey.html" title="trait common_meta::election::LeaderKey">Leader<wbr>Key</a></dt><dd>LeaderKey is a key that represents the leader of metasrv.
|
||
The structure is corresponding to [etcd_client::LeaderKey].</dd></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.listen_leader_change.html" title="fn common_meta::election::listen_leader_change">listen_<wbr>leader_<wbr>change</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.send_leader_change_and_set_flags.html" title="fn common_meta::election::send_leader_change_and_set_flags">send_<wbr>leader_<wbr>change_<wbr>and_<wbr>set_<wbr>flags</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Sends a leader change message to the channel and sets the <code>is_leader</code> flag.
|
||
If a leader is elected, it will also set the <code>leader_infancy</code> flag to true.</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.ElectionRef.html" title="type common_meta::election::ElectionRef">Election<wbr>Ref</a></dt></dl></section></div></main></body></html> |