content: /*
   * 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.cassandra.sidecar.coordination;
  
  
  import io.vertx.core.Future;
  import org.apache.cassandra.sidecar.client.SidecarInstance;
  
  /**
   * Interface to provide health information for other Sidecar instances
   */
  public interface SidecarPeerHealthProvider
  {
      /**
       * Possible Health States
       */
      enum Health
      {
          /**
           * Peer Sidecar is alive
           */
          UP,
  
          /**
           * Peer Sidecar is not unreachable
           */
          DOWN
      }
  
      /**
       * @param instance the instance where the health check will be executed
       * @return a future with the {@link Health} of the {@code instance}
       */
      Future<Health> health(SidecarInstance instance);
  }
  