io.netty.incubator.codec.bhttp

Class BinaryHttpParser

java.lang.Object

io.netty.incubator.codec.bhttp.BinaryHttpParser

public final class BinaryHttpParser
extends java.lang.Object

Parser that parse ByteBuf into HttpObjects, implementing Binary Representation of HTTP Messages.

Constructor Summary

Constructors

Constructor and Description
BinaryHttpParser(int maxFieldSectionSize) Creates a new instance

Method Summary

Modifier and Type	Method and Description
io.netty.handler.codec.http.HttpObject	parse(io.netty.buffer.ByteBuf in, boolean completeBodyReceived) Parse the given ByteBuf and converts it to HttpObjects.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BinaryHttpParser

public BinaryHttpParser(int maxFieldSectionSize)

Creates a new instance

Parameters:

maxFieldSectionSize - the maximum size of the field-section (in bytes)

Method Detail

parse

public io.netty.handler.codec.http.HttpObject parse(io.netty.buffer.ByteBuf in,
                                                    boolean completeBodyReceived)

Parse the given ByteBuf and converts it to HttpObjects. This method should be called in a loop until it returns null.

    for (;;) {
        HttpObject msg = parser.parse(in, completeBodyReceived);
        if (msg == null) {
            // Try again later once there are more readable bytes in the input buffer.
            return;
        }
        // Do something with the msg.
    }
 

The returned HttpObject will form a valid sequence like:

 1 HttpMessage, 0-n HttpContent, 1 LastHttpContent.
 

It might also use the shortcut of FullHttpMessage to represent a full sequence.

Parameters:

in - the ByteBuf to parse.

completeBodyReceived - true if we should consider the end of body to be received, false otherwise.

Returns:

the HttpObject or null if this method should be called again later once there are more readable bytes in the input ByteBuf.