PeerDiscoveryStatus.java

/*
 * Copyright ConsenSys AG.
 *
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
package org.hyperledger.besu.ethereum.p2p.discovery;

import java.util.Locale;

/** The status of a {@link DiscoveryPeer}, in relation to the peer discovery state machine. */
public enum PeerDiscoveryStatus {

  /**
   * Represents a newly discovered {@link DiscoveryPeer}, prior to commencing the bonding exchange.
   */
  KNOWN,

  /**
   * Bonding with this peer is in progress. If we're unable to establish communication and/or
   * complete the bonding exchange, the {@link DiscoveryPeer} remains in this state, until we
   * ultimately desist.
   */
  BONDING,

  /**
   * We have successfully bonded with this {@link DiscoveryPeer}, and we are able to exchange
   * messages with them.
   */
  BONDED,

  /** We have requested the ENR record from this {@link DiscoveryPeer} */
  ENR_REQUESTED;

  @Override
  public String toString() {
    return name().toLowerCase(Locale.ROOT);
  }
}