Module io.netty.codec.http2

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, 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(Send<Buffer> content)	Equivalent to new DefaultHttp2DataFrame(content, false).
DefaultHttp2DataFrame(Send<Buffer> content, boolean endStream)	Equivalent to new DefaultHttp2DataFrame(content, endStream, 0).
DefaultHttp2DataFrame(Send<Buffer> content, boolean endStream, int padding)	Construct a new data message.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the resource, making it inaccessible.
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()	Check if this object is accessible.
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.
Send<Http2DataFrame>	send()	Send this object instance to another Thread, transferring the ownership to the recipient.
DefaultHttp2DataFrame	stream(Http2FrameStream stream)	Set the Http2FrameStream object for this frame.
String	toString()
DefaultHttp2DataFrame	touch(Object hint)	Record the current access location for debugging purposes.

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(Send<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(Send<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(Send<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 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 Send<Http2DataFrame> send()

Description copied from interface: Resource

Send this object instance to another Thread, transferring the ownership to the recipient.

The object must be in a state where it can be sent, which includes at least being accessible.

When sent, this instance will immediately become inaccessible, as if by closing it. All attempts at accessing an object that has been sent, even if that object has not yet been received, should cause an exception to be thrown.

Calling Resource.close() on an object that has been sent will have no effect, so this method is safe to call within a try-with-resources statement.

Specified by:

send in interface Resource<Http2DataFrame>

close

public void close()

Description copied from interface: Resource

Close the resource, making it inaccessible.

Note, this method is not thread-safe unless otherwise specified.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Resource<Http2DataFrame>

isAccessible

public boolean isAccessible()

Description copied from interface: Resource

Check if this object is accessible.

Specified by:

isAccessible in interface Resource<Http2DataFrame>

Returns:

true if this object is still valid and can be accessed, otherwise false if, for instance, this object has been dropped/deallocated, or been sent elsewhere.

touch

public DefaultHttp2DataFrame touch(Object hint)

Description copied from interface: Resource

Record the current access location for debugging purposes. This information may be included if the resource throws a life-cycle related exception, or if it leaks. If this resource has already been closed, then this method has no effect.

Specified by:

touch in interface Resource<Http2DataFrame>

Parameters:

hint - An optional hint about this access and its context. May be null.

Returns:

This resource instance.

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