com.couchbase.client.core.endpoint.EndpointState Maven / Gradle / Ivy

/*
 * Copyright (c) 2018 Couchbase, Inc.
 *
 * 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.
 */

package com.couchbase.client.core.endpoint;

/**
 * Represents all states an {@link Endpoint} can be in.
 *
 * @since 2.0.0
 */
public enum EndpointState {

  /**
   * The endpoint is disconnected and not trying to connect.
   */
  DISCONNECTED,

  /**
   * The endpoint is disconnected but trying to connect right now.
   */
  CONNECTING,

  /**
   * The endpoint is connected.
   *
   * This is the only state where it can actually try to serve traffic in the
   * expected way.
   */
  CONNECTED,

  /**
   * The endpoint is currently disconnecting.
   */
  DISCONNECTING

}