plumtree/src/main/java/org/apache/tuweni/plumtree/PeerRepository.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.tuweni.plumtree;

import java.util.Collection;
import java.util.List;

/**
 * Repository of active peers associating with a gossip tree.
 */
public interface PeerRepository {

  void addEager(Peer peer);

  /**
   * Provides the list of all the peers connected.
   * 
   * @return the list of peers
   */
  List<Peer> peers();

  /**
   * Provides the list of all lazy peers connected.
   * 
   * @return the list of peers to push to lazily
   */
  Collection<Peer> lazyPushPeers();

  /**
   * Provides the list of all eager peers connected.
   * 
   * @return the list of peers to push to eagerly
   */
  Collection<Peer> eagerPushPeers();

  /**
   * Removes a peer from the repository
   * 
   * @param peer the peer to remove
   */
  void removePeer(Peer peer);

  /**
   * Moves a peer to the list of lazy peers
   * 
   * @param peer the peer to move
   * @return true if the move was effective
   */
  boolean moveToLazy(Peer peer);

  /**
   * Moves a peer to the list of eager peers.
   * 
   * @param peer the peer to move
   */
  void moveToEager(Peer peer);

  /**
   * Proposes a peer as a new peer.
   * 
   * @param peer a peer to be considered for addition
   */
  void considerNewPeer(Peer peer);
}