rlpx/src/main/java/org/apache/tuweni/rlpx/wire/SubProtocolHandler.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.rlpx.wire;

import org.apache.tuweni.bytes.Bytes;
import org.apache.tuweni.concurrent.AsyncCompletion;

/**
 * Handler managing messages and new connections of peers related for a given subprotocol.
 */
public interface SubProtocolHandler {

  /**
   * Handle an incoming wire protocol message
   *
   * @param connection the peer connection
   * @param messageType the type of the message
   * @param message the message to be handled
   * @return a handle tracking the completion of the handling of the message.
   */
  AsyncCompletion handle(WireConnection connection, int messageType, Bytes message);

  /**
   * Handle a new peer connection
   * 
   * @param connection the new peer connection
   * @return a handle to the completion of the addition of the new peer.
   */
  AsyncCompletion handleNewPeerConnection(WireConnection connection);

  /**
   * Stops a subprotocol operations.
   *
   * @return a handle to track when the subprotocol operations have stopped
   */
  AsyncCompletion stop();
}