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.http.nio; 29 30 import java.io.IOException; 31 import java.nio.channels.ReadableByteChannel; 32 33 import org.apache.http.HttpException; 34 import org.apache.http.HttpMessage; 35 36 /** 37 * Abstract HTTP message parser for non-blocking connections. 38 * 39 * @since 4.0 40 */ 41 public interface NHttpMessageParser<T extends HttpMessage> { 42 43 /** 44 * Resets the parser. The parser will be ready to start parsing another 45 * HTTP message. 46 */ 47 void reset(); 48 49 /** 50 * Fills the internal buffer of the parser with input data from the 51 * given {@link ReadableByteChannel}. 52 * 53 * @param channel the input channel 54 * @return number of bytes read. 55 * @throws IOException in case of an I/O error. 56 */ 57 int fillBuffer(ReadableByteChannel channel) 58 throws IOException; 59 60 /** 61 * Attempts to parse a complete message head from the content of the 62 * internal buffer. If the message in the input buffer is incomplete 63 * this method will return {@code null}. 64 * 65 * @return HTTP message head, if available, {@code null} otherwise. 66 * @throws IOException in case of an I/O error. 67 * @throws HttpException in case the HTTP message is malformed or 68 * violates the HTTP protocol. 69 */ 70 T parse() throws IOException, HttpException; 71 72 }