org.apache.tuweni.scuttlebutt.lib.model.StreamHandler Maven / Gradle / Ivy

Go to download
/*
 * 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.scuttlebutt.lib.model;

/**
 * A handler consuming a stream.
 * 
 * @param  the type of stream
 */
public interface StreamHandler {

  /**
   * Handles a new item from the result stream.
   *
   * @param item the item appearing in the stream
   */
  void onMessage(T item);

  /**
   * Invoked when the stream has been closed.
   */
  void onStreamEnd();

  /**
   * Invoked when there is an error in the stream.
   *
   * @param ex the underlying error
   */
  void onStreamError(Exception ex);
}