01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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;
21:
22: import org.apache.tomcat.util.buf.ByteChunk;
23:
24: /**
25: * Input buffer.
26: *
27: * This class is used only in the protocol implementation. All reading from tomcat ( or adapter ) should be done
28: * using Request.doRead().
29: *
30: *
31: * @author Remy Maucherat
32: */
33: public interface InputBuffer {
34:
35: /** Return from the input stream.
36: IMPORTANT: the current model assumes that the protocol will 'own' the
37: buffer and return a pointer to it in ByteChunk ( i.e. the param will
38: have chunk.getBytes()==null before call, and the result after the call ).
39: */
40: public int doRead(ByteChunk chunk, Request request)
41: throws IOException;
42:
43: }
|