Package io.netty.handler.codec.http2
Class Http2Flags
java.lang.Object
io.netty.handler.codec.http2.Http2Flags
Provides utility methods for accessing specific flags as defined by the HTTP/2 spec.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final short
static final short
static final short
static final short
static final short
private short
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
ack()
Determines whether the flag is set indicating that this frame is an ACK.ack
(boolean ack) Sets theACK
flag.boolean
Determines whether theEND_HEADERS
flag is set.endOfHeaders
(boolean endOfHeaders) Sets theEND_HEADERS
flag.boolean
Determines whether theEND_STREAM
flag is set.endOfStream
(boolean endOfStream) Sets theEND_STREAM
flag.boolean
int
Gets the number of bytes expected for the priority fields of the payload.int
Gets the length in bytes of the padding presence field expected in the payload.int
hashCode()
boolean
isFlagSet
(short mask) Indicates whether or not a particular flag is set.boolean
For frames that include padding, indicates if thePADDED
field is present.paddingPresent
(boolean paddingPresent) Sets thePADDED
flag.boolean
Determines whether the flag is set indicating the presence of the exclusive, stream dependency, and weight fields in a HEADERS frame.priorityPresent
(boolean priorityPresent) Sets thePRIORITY
flag.setFlag
(boolean on, short mask) Generic method to set any flag.toString()
short
value()
Gets the underlying flags value.
-
Field Details
-
END_STREAM
public static final short END_STREAM- See Also:
-
END_HEADERS
public static final short END_HEADERS- See Also:
-
ACK
public static final short ACK- See Also:
-
PADDED
public static final short PADDED- See Also:
-
PRIORITY
public static final short PRIORITY- See Also:
-
value
private short value
-
-
Constructor Details
-
Http2Flags
public Http2Flags() -
Http2Flags
public Http2Flags(short value)
-
-
Method Details
-
value
public short value()Gets the underlying flags value. -
endOfStream
public boolean endOfStream()Determines whether theEND_STREAM
flag is set. Only applies to DATA and HEADERS frames. -
endOfHeaders
public boolean endOfHeaders()Determines whether theEND_HEADERS
flag is set. Only applies for HEADERS, PUSH_PROMISE, and CONTINUATION frames. -
priorityPresent
public boolean priorityPresent()Determines whether the flag is set indicating the presence of the exclusive, stream dependency, and weight fields in a HEADERS frame. -
ack
public boolean ack()Determines whether the flag is set indicating that this frame is an ACK. Only applies for SETTINGS and PING frames. -
paddingPresent
public boolean paddingPresent()For frames that include padding, indicates if thePADDED
field is present. Only applies to DATA, HEADERS, PUSH_PROMISE and CONTINUATION frames. -
getNumPriorityBytes
public int getNumPriorityBytes()Gets the number of bytes expected for the priority fields of the payload. This is determined by thepriorityPresent()
flag. -
getPaddingPresenceFieldLength
public int getPaddingPresenceFieldLength()Gets the length in bytes of the padding presence field expected in the payload. This is determined by thepaddingPresent()
flag. -
endOfStream
Sets theEND_STREAM
flag. -
endOfHeaders
Sets theEND_HEADERS
flag. -
priorityPresent
Sets thePRIORITY
flag. -
paddingPresent
Sets thePADDED
flag. -
ack
Sets theACK
flag. -
setFlag
Generic method to set any flag.- Parameters:
on
- if the flag should be enabled or disabled.mask
- the mask that identifies the bit for the flag.- Returns:
- this instance.
-
isFlagSet
public boolean isFlagSet(short mask) Indicates whether or not a particular flag is set.- Parameters:
mask
- the mask identifying the bit for the particular flag being tested- Returns:
true
if the flag is set
-
hashCode
public int hashCode() -
equals
-
toString
-