com.gemstone.gemfire.distributed.internal.HealthMonitor Maven / Gradle / Ivy

/*
 * Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
 *
 * 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. See accompanying
 * LICENSE file.
 */
   
package com.gemstone.gemfire.distributed.internal;

import com.gemstone.gemfire.admin.GemFireHealth;

/**
 * Represents a thread that monitor the health of the vm it lives in.
 * @author Darrel Schneider
 * @since 3.5
 */
public interface HealthMonitor {
  /**
   * Returns the id of this monitor instance. Each instance is given
   * a unique id when it is created.
   */
  public int getId();
  /**
   * Resets the current health status to zero.
   */
  public void resetStatus();
  /**
   * Returns the diagnosis of the desired status.
   */
  public String[] getDiagnosis(GemFireHealth.Health healthCode);
  /**
   * Stops the monitor so it no longer checks for health.
   * Once stopped a monitor can not be started.
   */
  public void stop();
}