1 /* 2 * ==================================================================== 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * ==================================================================== 20 * 21 * This software consists of voluntary contributions made by many 22 * individuals on behalf of the Apache Software Foundation. For more 23 * information on the Apache Software Foundation, please see 24 * <http://www.apache.org/>. 25 * 26 */ 27 package org.apache.hc.core5.http.nio; 28 29 import java.io.IOException; 30 import java.nio.ByteBuffer; 31 import java.util.List; 32 33 import org.apache.hc.core5.http.Header; 34 import org.apache.hc.core5.http.HttpException; 35 36 /** 37 * Abstract asynchronous data consumer. 38 * 39 * @since 5.0 40 */ 41 public interface AsyncDataConsumer extends ResourceHolder { 42 43 /** 44 * Triggered to signal ability of the underlying data stream to receive 45 * data capacity update. The data consumer can choose to write data 46 * immediately inside the call or asynchronously at some later point. 47 * 48 * @param capacityChannel the channel for capacity updates. 49 * @throws IOException in case of an I/O error. 50 */ 51 void updateCapacity(CapacityChannel capacityChannel) throws IOException; 52 53 /** 54 * Triggered to pass incoming data to the data consumer. The consumer must 55 * consume the entire content of the data buffer. The consumer must stop 56 * incrementing its capacity on the capacity channel if it is unable to 57 * accept more data. Once the data consumer has handled accumulated data 58 * or allocated more intermediate storage it can update its capacity 59 * information on the capacity channel. 60 * 61 * @param src data source. 62 * @throws IOException in case of an I/O error. 63 */ 64 void consume(ByteBuffer src) throws IOException; 65 66 /** 67 * Triggered to signal termination of the data stream. 68 * 69 * @param trailers data stream trailers. 70 * @throws HttpException in case of an HTTP protocol violation. 71 * @throws IOException in case of an I/O error. 72 */ 73 void streamEnd(List<? extends Header> trailers) throws HttpException, IOException; 74 75 }