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
28 package org.apache.hc.core5.http.nio;
29
30 import java.io.IOException;
31 import java.nio.ByteBuffer;
32 import java.util.List;
33
34 import org.apache.hc.core5.http.Header;
35
36 /**
37 * Abstract HTTP content encoder. HTTP content encoders can be used
38 * to apply the required coding transformation and write entity
39 * content to the underlying channel in small chunks.
40 *
41 * @since 4.0
42 */
43 public interface ContentEncoder {
44
45 /**
46 * Writes a portion of entity content to the underlying channel.
47 *
48 * @param src The buffer from which content is to be retrieved
49 * @return The number of bytes read, possibly zero
50 * @throws IOException if I/O error occurs while writing content
51 */
52 int write(ByteBuffer src) throws IOException;
53
54 /**
55 * Terminates the content stream.
56 *
57 * @throws IOException if I/O error occurs while writing content
58 */
59 void complete(List<? extends Header> trailers) throws IOException;
60
61 /**
62 * Returns {@code true} if the entity has been transferred in its
63 * entirety.
64 *
65 * @return {@code true} if all the content has been produced,
66 * {@code false} otherwise.
67 */
68 boolean isCompleted();
69
70 }