io.netty.handler.codec.http2

Class DefaultHttp2DataFrame

java.lang.Object

io.netty.handler.codec.http2.AbstractHttp2StreamFrame

io.netty.handler.codec.http2.DefaultHttp2DataFrame

All Implemented Interfaces:

io.netty.buffer.ByteBufHolder, Http2DataFrame, Http2Frame, Http2StreamFrame, io.netty.util.ReferenceCounted

public final class DefaultHttp2DataFrame
extends AbstractHttp2StreamFrame
implements Http2DataFrame

The default Http2DataFrame implementation.

Constructor Summary

Constructors

Constructor and Description
DefaultHttp2DataFrame(boolean endStream) Equivalent to new DefaultHttp2DataFrame(Unpooled.EMPTY_BUFFER, endStream).
DefaultHttp2DataFrame(io.netty.buffer.ByteBuf content) Equivalent to new DefaultHttp2DataFrame(content, false).
DefaultHttp2DataFrame(io.netty.buffer.ByteBuf content, boolean endStream) Equivalent to new DefaultHttp2DataFrame(content, endStream, 0).
DefaultHttp2DataFrame(io.netty.buffer.ByteBuf content, boolean endStream, int padding) Construct a new data message.

Method Summary

Modifier and Type	Method and Description
io.netty.buffer.ByteBuf	content() Payload of DATA frame.
DefaultHttp2DataFrame	copy()
DefaultHttp2DataFrame	duplicate()
boolean	equals(Object o) Returns true if o has equal stream to this object.
int	hashCode()
int	initialFlowControlledBytes() Returns the number of bytes that are flow-controlled initially, so even if the Http2DataFrame.content() is consumed this will not change.
boolean	isEndStream() Returns true if the END_STREAM flag is set.
String	name() Returns the name of the HTTP/2 frame e.g.
int	padding() Frame padding to use.
int	refCnt()
boolean	release()
boolean	release(int decrement)
DefaultHttp2DataFrame	replace(io.netty.buffer.ByteBuf content)
DefaultHttp2DataFrame	retain()
DefaultHttp2DataFrame	retain(int increment)
DefaultHttp2DataFrame	retainedDuplicate()
DefaultHttp2DataFrame	stream(Http2FrameStream stream) Set the Http2FrameStream object for this frame.
String	toString()
DefaultHttp2DataFrame	touch()
DefaultHttp2DataFrame	touch(Object hint)

Methods inherited from class io.netty.handler.codec.http2.AbstractHttp2StreamFrame

stream

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.netty.handler.codec.http2.Http2StreamFrame

stream

Constructor Detail

DefaultHttp2DataFrame

public DefaultHttp2DataFrame(io.netty.buffer.ByteBuf content)

Equivalent to new DefaultHttp2DataFrame(content, false).

Parameters:

content - non-null payload

DefaultHttp2DataFrame

public DefaultHttp2DataFrame(boolean endStream)

Equivalent to new DefaultHttp2DataFrame(Unpooled.EMPTY_BUFFER, endStream).

Parameters:

endStream - whether this data should terminate the stream

DefaultHttp2DataFrame

public DefaultHttp2DataFrame(io.netty.buffer.ByteBuf content,
                             boolean endStream)

Equivalent to new DefaultHttp2DataFrame(content, endStream, 0).

Parameters:

content - non-null payload

endStream - whether this data should terminate the stream

DefaultHttp2DataFrame

public DefaultHttp2DataFrame(io.netty.buffer.ByteBuf content,
                             boolean endStream,
                             int padding)

Construct a new data message.

Parameters:

content - non-null payload

endStream - whether this data should terminate the stream

padding - additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).

Method Detail

stream

public DefaultHttp2DataFrame stream(Http2FrameStream stream)

Description copied from interface: Http2StreamFrame

Set the Http2FrameStream object for this frame.

Specified by:

stream in interface Http2StreamFrame

Overrides:

stream in class AbstractHttp2StreamFrame

name

public String name()

Description copied from interface: Http2Frame

Returns the name of the HTTP/2 frame e.g. DATA, GOAWAY, etc.

Specified by:

name in interface Http2Frame

isEndStream

public boolean isEndStream()

Description copied from interface: Http2DataFrame

Returns true if the END_STREAM flag is set.

Specified by:

isEndStream in interface Http2DataFrame

padding

public int padding()

Description copied from interface: Http2DataFrame

Frame padding to use. Will be non-negative and less than 256.

Specified by:

padding in interface Http2DataFrame

content

public io.netty.buffer.ByteBuf content()

Description copied from interface: Http2DataFrame

Payload of DATA frame. Will not be null.

Specified by:

content in interface io.netty.buffer.ByteBufHolder

Specified by:

content in interface Http2DataFrame

initialFlowControlledBytes

public int initialFlowControlledBytes()

Description copied from interface: Http2DataFrame

Returns the number of bytes that are flow-controlled initially, so even if the Http2DataFrame.content() is consumed this will not change.

Specified by:

initialFlowControlledBytes in interface Http2DataFrame

copy

public DefaultHttp2DataFrame copy()

Specified by:

copy in interface io.netty.buffer.ByteBufHolder

Specified by:

copy in interface Http2DataFrame

duplicate

public DefaultHttp2DataFrame duplicate()

Specified by:

duplicate in interface io.netty.buffer.ByteBufHolder

Specified by:

duplicate in interface Http2DataFrame

retainedDuplicate

public DefaultHttp2DataFrame retainedDuplicate()

Specified by:

retainedDuplicate in interface io.netty.buffer.ByteBufHolder

Specified by:

retainedDuplicate in interface Http2DataFrame

replace

public DefaultHttp2DataFrame replace(io.netty.buffer.ByteBuf content)

Specified by:

replace in interface io.netty.buffer.ByteBufHolder

Specified by:

replace in interface Http2DataFrame

refCnt

public int refCnt()

Specified by:

refCnt in interface io.netty.util.ReferenceCounted

release

public boolean release()

Specified by:

release in interface io.netty.util.ReferenceCounted

release

public boolean release(int decrement)

Specified by:

release in interface io.netty.util.ReferenceCounted

retain

public DefaultHttp2DataFrame retain()

Specified by:

retain in interface io.netty.buffer.ByteBufHolder

Specified by:

retain in interface Http2DataFrame

Specified by:

retain in interface io.netty.util.ReferenceCounted

retain

public DefaultHttp2DataFrame retain(int increment)

Specified by:

retain in interface io.netty.buffer.ByteBufHolder

Specified by:

retain in interface Http2DataFrame

Specified by:

retain in interface io.netty.util.ReferenceCounted

toString

public String toString()

Overrides:

toString in class Object

touch

public DefaultHttp2DataFrame touch()

Specified by:

touch in interface io.netty.buffer.ByteBufHolder

Specified by:

touch in interface Http2DataFrame

Specified by:

touch in interface io.netty.util.ReferenceCounted

touch

public DefaultHttp2DataFrame touch(Object hint)

Specified by:

touch in interface io.netty.buffer.ByteBufHolder

Specified by:

touch in interface Http2DataFrame

Specified by:

touch in interface io.netty.util.ReferenceCounted

equals

public boolean equals(Object o)

Description copied from class: AbstractHttp2StreamFrame

Returns true if o has equal stream to this object.

Overrides:

equals in class AbstractHttp2StreamFrame

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractHttp2StreamFrame