Package io.netty5.handler.codec.http2

Class DefaultHttp2DataFrame

java.lang.Object

io.netty5.handler.codec.http2.AbstractHttp2StreamFrame

io.netty5.handler.codec.http2.DefaultHttp2DataFrame

All Implemented Interfaces:

Http2DataFrame, Http2Frame, Http2StreamFrame, io.netty5.util.Resource<Http2DataFrame>, AutoCloseable

@UnstableApi
public final class DefaultHttp2DataFrame
extends AbstractHttp2StreamFrame
implements Http2DataFrame

The default Http2DataFrame implementation.

Constructor Summary

Constructors

Constructor	Description
DefaultHttp2DataFrame(boolean endStream)	Equivalent to new DefaultHttp2DataFrame(Unpooled.EMPTY_BUFFER, endStream).
DefaultHttp2DataFrame(io.netty5.util.Send<io.netty5.buffer.Buffer> content)	Equivalent to new DefaultHttp2DataFrame(content, false).
DefaultHttp2DataFrame(io.netty5.util.Send<io.netty5.buffer.Buffer> content, boolean endStream)	Equivalent to new DefaultHttp2DataFrame(content, endStream, 0).
DefaultHttp2DataFrame(io.netty5.util.Send<io.netty5.buffer.Buffer> content, boolean endStream, int padding)	Construct a new data message.

Method Summary

Modifier and Type	Method	Description
void	close()
io.netty5.buffer.Buffer	content()	Payload of DATA frame.
DefaultHttp2DataFrame	copy()	Produce a copy of this data frame, which contain a copy of the frame contents.
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	isAccessible()
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.
io.netty5.util.Send<Http2DataFrame>	send()
DefaultHttp2DataFrame	stream(Http2FrameStream stream)	Set the Http2FrameStream object for this frame.
String	toString()
DefaultHttp2DataFrame	touch(Object hint)

Methods inherited from class io.netty5.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.netty5.handler.codec.http2.Http2StreamFrame

stream

Constructor Detail

DefaultHttp2DataFrame

public DefaultHttp2DataFrame(io.netty5.util.Send<io.netty5.buffer.Buffer> 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.netty5.util.Send<io.netty5.buffer.Buffer> 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.netty5.util.Send<io.netty5.buffer.Buffer> 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.netty5.buffer.Buffer content()

Description copied from interface: Http2DataFrame

Payload of DATA frame. Will not be null.

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()

Description copied from interface: Http2DataFrame

Produce a copy of this data frame, which contain a copy of the frame contents.

Specified by:

copy in interface Http2DataFrame

Returns:

A copy of this data frame.

toString

public String toString()

Overrides:

toString in class Object

send

public io.netty5.util.Send<Http2DataFrame> send()

Specified by:

send in interface io.netty5.util.Resource<Http2DataFrame>

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface io.netty5.util.Resource<Http2DataFrame>

isAccessible

public boolean isAccessible()

Specified by:

isAccessible in interface io.netty5.util.Resource<Http2DataFrame>

touch

public DefaultHttp2DataFrame touch(Object hint)

Specified by:

touch in interface io.netty5.util.Resource<Http2DataFrame>

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