01: /*
02: * $HeadURL: https://svn.apache.org/repos/asf/httpcomponents/httpcore/tags/4.0-beta1/module-nio/src/main/java/org/apache/http/nio/ContentEncoder.java $
03: * $Revision: 613298 $
04: * $Date: 2008-01-18 23:09:22 +0100 (Fri, 18 Jan 2008) $
05: *
06: * ====================================================================
07: * Licensed to the Apache Software Foundation (ASF) under one
08: * or more contributor license agreements. See the NOTICE file
09: * distributed with this work for additional information
10: * regarding copyright ownership. The ASF licenses this file
11: * to you under the Apache License, Version 2.0 (the
12: * "License"); you may not use this file except in compliance
13: * with the License. You may obtain a copy of the License at
14: *
15: * http://www.apache.org/licenses/LICENSE-2.0
16: *
17: * Unless required by applicable law or agreed to in writing,
18: * software distributed under the License is distributed on an
19: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20: * KIND, either express or implied. See the License for the
21: * specific language governing permissions and limitations
22: * under the License.
23: * ====================================================================
24: *
25: * This software consists of voluntary contributions made by many
26: * individuals on behalf of the Apache Software Foundation. For more
27: * information on the Apache Software Foundation, please see
28: * <http://www.apache.org/>.
29: *
30: */
31:
32: package org.apache.http.nio;
33:
34: import java.io.IOException;
35: import java.nio.ByteBuffer;
36:
37: /**
38: * Abstract HTTP content encoder. HTTP content encoders can be used
39: * to apply the required coding transformation and write entity
40: * content to the underlying channel in small chunks.
41: *
42: * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
43: */
44: public interface ContentEncoder {
45:
46: /**
47: * Writes a portion of entity content to the underlying channel.
48: *
49: * @param src The buffer from which content is to be retrieved
50: * @return The number of bytes read, possibly zero
51: * @throws IOException if I/O error occurs while writing content
52: */
53: int write(ByteBuffer src) throws IOException;
54:
55: /**
56: * Terminates the content stream.
57: *
58: * @throws IOException if I/O error occurs while writing content
59: */
60: void complete() throws IOException;
61:
62: /**
63: * Returns <tt>true</tt> if the entity has been transferred in its
64: * entirety.
65: *
66: * @return <tt>true</tt> if all the content has been produced,
67: * <tt>false</tt> otherwise.
68: */
69: boolean isCompleted();
70:
71: }
|