risingwave_meta/rpc/election/
mod.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
// Copyright 2024 RisingWave Labs
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

pub mod dummy;
pub mod sql;

use serde::Serialize;
use tokio::sync::watch::Receiver;

use crate::MetaResult;

const META_ELECTION_KEY: &str = "__meta_election_";

#[derive(Debug, Serialize)]
pub struct ElectionMember {
    pub id: String,
    pub is_leader: bool,
}

#[async_trait::async_trait]
pub trait ElectionClient: Send + Sync + 'static {
    async fn init(&self) -> MetaResult<()> {
        Ok(())
    }

    fn id(&self) -> MetaResult<String>;
    /// Run the long-running election process.
    ///
    /// Returns when the leader status is lost, or the stop signal is received.
    async fn run_once(&self, ttl: i64, stop: Receiver<()>) -> MetaResult<()>;
    fn subscribe(&self) -> Receiver<bool>;
    async fn leader(&self) -> MetaResult<Option<ElectionMember>>;
    async fn get_members(&self) -> MetaResult<Vec<ElectionMember>>;
    fn is_leader(&self) -> bool;
}