io.netty.handler.codec.http2

Class DefaultHttp2HeadersFrame

java.lang.Object

io.netty.handler.codec.http2.AbstractHttp2StreamFrame

io.netty.handler.codec.http2.DefaultHttp2HeadersFrame

All Implemented Interfaces:

Http2Frame, Http2HeadersFrame, Http2StreamFrame

@UnstableApi
public final class DefaultHttp2HeadersFrame
extends AbstractHttp2StreamFrame
implements Http2HeadersFrame

The default Http2HeadersFrame implementation.

Constructor Summary

Constructors

Constructor and Description
DefaultHttp2HeadersFrame(Http2Headers headers) Equivalent to new DefaultHttp2HeadersFrame(headers, false).
DefaultHttp2HeadersFrame(Http2Headers headers, boolean endStream) Equivalent to new DefaultHttp2HeadersFrame(headers, endStream, 0).
DefaultHttp2HeadersFrame(Http2Headers headers, boolean endStream, int padding) Construct a new headers message.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Returns true if o has equal stream to this object.
int	hashCode()
Http2Headers	headers() A complete header list.
boolean	isEndStream() true if this frame is the last one in this direction of the stream.
String	name() Returns the name of the HTTP/2 frame e.g.
int	padding() Frame padding to use.
DefaultHttp2HeadersFrame	streamId(int streamId) Sets the identifier of the stream this frame applies to.
String	toString()

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

streamId

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

streamId

Constructor Detail

DefaultHttp2HeadersFrame

public DefaultHttp2HeadersFrame(Http2Headers headers)

Equivalent to new DefaultHttp2HeadersFrame(headers, false).

Parameters:

headers - the non-null headers to send

DefaultHttp2HeadersFrame

public DefaultHttp2HeadersFrame(Http2Headers headers,
                                boolean endStream)

Equivalent to new DefaultHttp2HeadersFrame(headers, endStream, 0).

Parameters:

headers - the non-null headers to send

DefaultHttp2HeadersFrame

public DefaultHttp2HeadersFrame(Http2Headers headers,
                                boolean endStream,
                                int padding)

Construct a new headers message.

Parameters:

headers - the non-null headers to send

endStream - whether these headers 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

streamId

public DefaultHttp2HeadersFrame streamId(int streamId)

Description copied from interface: Http2StreamFrame

Sets the identifier of the stream this frame applies to. This method may be called at most once.

NOTE: This method is supposed to be called by the HTTP/2 transport only. It must not be called by users.

Specified by:

streamId in interface Http2StreamFrame

Overrides:

streamId in class AbstractHttp2StreamFrame

Returns:

this

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

headers

public Http2Headers headers()

Description copied from interface: Http2HeadersFrame

A complete header list. CONTINUATION frames are automatically handled.

Specified by:

headers in interface Http2HeadersFrame

isEndStream

public boolean isEndStream()

Description copied from interface: Http2HeadersFrame

true if this frame is the last one in this direction of the stream.

Specified by:

isEndStream in interface Http2HeadersFrame

padding

public int padding()

Description copied from interface: Http2HeadersFrame

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

Specified by:

padding in interface Http2HeadersFrame

toString

public String toString()

Overrides:

toString in class Object

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