org.apache.http.nio.NHttpMessageParser Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of httpcore-nio Show documentation
Show all versions of httpcore-nio Show documentation
Apache HttpComponents Core (non-blocking I/O)
/*
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* .
*
*/
package org.apache.http.nio;
import java.io.IOException;
import java.nio.channels.ReadableByteChannel;
import org.apache.http.HttpException;
import org.apache.http.HttpMessage;
/**
* Abstract HTTP message parser for non-blocking connections.
*
* @since 4.0
*/
public interface NHttpMessageParser {
/**
* Resets the parser. The parser will be ready to start parsing another
* HTTP message.
*/
void reset();
/**
* Fills the internal buffer of the parser with input data from the
* given {@link ReadableByteChannel}.
*
* @param channel the input channel
* @return number of bytes read.
* @throws IOException in case of an I/O error.
*/
int fillBuffer(ReadableByteChannel channel)
throws IOException;
/**
* Attempts to parse a complete message head from the content of the
* internal buffer. If the message in the input buffer is incomplete
* this method will return {@code null}.
*
* @return HTTP message head, if available, {@code null} otherwise.
* @throws IOException in case of an I/O error.
* @throws HttpException in case the HTTP message is malformed or
* violates the HTTP protocol.
*/
T parse() throws IOException, HttpException;
}