confignode/src/main/java/org/apache/iotdb/confignode/manager/load/heartbeat/IRegionGroupCache.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */
package org.apache.iotdb.confignode.manager.load.heartbeat;

import org.apache.iotdb.common.rpc.thrift.TConsensusGroupId;

public interface IRegionGroupCache {

  /**
   * Cache the newest HeartbeatSample
   *
   * @param newHeartbeatSample The newest HeartbeatSample
   */
  void cacheHeartbeatSample(RegionHeartbeatSample newHeartbeatSample);

  /**
   * Remove the specific sample cache if exists
   *
   * @param dataNodeId DataNodeId
   */
  void removeCacheIfExists(Integer dataNodeId);

  /**
   * Invoking periodically to update RegionGroups' load statistics
   *
   * @return true if some load statistic changed
   */
  boolean updateLoadStatistic();

  /**
   * Get RegionGroup's latest leader
   *
   * @return The DataNodeId of the latest leader
   */
  int getLeaderDataNodeId();

  /**
   * Get RegionGroup's ConsensusGroupId
   *
   * @return TConsensusGroupId
   */
  TConsensusGroupId getConsensusGroupId();
}