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.entity;
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 import org.apache.hc.core5.http.nio.AsyncDataConsumer;
36 import org.apache.hc.core5.http.nio.CapacityChannel;
37
38 /**
39 * Abstract binary data consumer.
40 *
41 * @since 5.0
42 */
43 public abstract class AbstractBinDataConsumer implements AsyncDataConsumer {
44
45 private static final ByteBuffer EMPTY = ByteBuffer.wrap(new byte[0]);
46
47 /**
48 * Triggered to obtain the capacity increment.
49 *
50 * @return the number of bytes this consumer is prepared to process.
51 */
52 protected abstract int capacityIncrement();
53
54 /**
55 * Triggered to pass incoming data packet to the data consumer.
56 *
57 * @param src the data packet.
58 * @param endOfStream flag indicating whether this data packet is the last in the data stream.
59 *
60 */
61 protected abstract void data(ByteBuffer src, boolean endOfStream) throws IOException;
62
63 /**
64 * Triggered to signal completion of data processing.
65 */
66 protected abstract void completed() throws IOException;
67
68 @Override
69 public final void updateCapacity(final CapacityChannel capacityChannel) throws IOException {
70 capacityChannel.update(capacityIncrement());
71 }
72
73 @Override
74 public final void consume(final ByteBuffer src) throws IOException {
75 data(src, false);
76 }
77
78 @Override
79 public final void streamEnd(final List<? extends Header> trailers) throws HttpException, IOException {
80 data(EMPTY, true);
81 completed();
82 }
83
84 }