KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > coyote > InputBuffer


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 package org.apache.coyote;
19
20 import java.io.IOException JavaDoc;
21
22 import org.apache.tomcat.util.buf.ByteChunk;
23
24
25 /**
26  * Input buffer.
27  *
28  * This class is used only in the protocol implementation. All reading from tomcat ( or adapter ) should be done
29  * using Request.doRead().
30  *
31  *
32  * @author Remy Maucherat
33  */
34 public interface InputBuffer {
35
36
37     /** Return from the input stream.
38         IMPORTANT: the current model assumes that the protocol will 'own' the
39         buffer and return a pointer to it in ByteChunk ( i.e. the param will
40         have chunk.getBytes()==null before call, and the result after the call ).
41     */
42     public int doRead(ByteChunk chunk, Request request)
43         throws IOException JavaDoc;
44
45
46 }
47
Popular Tags