Top Inners Fields Constructors Methods
org.glassfish.grizzly.http2.frames

public abstract Class Http2Frame

extends Object
implements Cacheable
Class Inheritance
All Implemented Interfaces
org.glassfish.grizzly.Cacheable
Known Direct Subclasses
org.glassfish.grizzly.http2.frames.PingFrame, org.glassfish.grizzly.http2.frames.PriorityFrame, org.glassfish.grizzly.http2.frames.RstStreamFrame, org.glassfish.grizzly.http2.frames.SettingsFrame, org.glassfish.grizzly.http2.frames.UnknownFrame, org.glassfish.grizzly.http2.frames.WindowUpdateFrame, org.glassfish.grizzly.http2.frames.DataFrame, org.glassfish.grizzly.http2.frames.GoAwayFrame, org.glassfish.grizzly.http2.frames.HeaderBlockFragment
Imports
java.util.Map, org.glassfish.grizzly.Buffer, .Cacheable, org.glassfish.grizzly.memory.MemoryManager

Nested and Inner Type Summary

Modifier and TypeClass and Description
protected abstract static class
Http2Frame.Http2FrameBuilder<T extends Http2Frame.Http2FrameBuilder>

Field Summary

Modifier and TypeField and Description
protected static final boolean
DONT_RECYCLE

private int
flags

public static final int
FRAME_HEADER_SIZE

protected Buffer
frameBuffer

protected int
length

private int
streamId

Constructor Summary

AccessConstructor and Description
protected
Http2Frame()

Method Summary

Modifier and TypeMethod and Description
protected abstract int
calcLength()

Returns: the length of this frame.

public void
clearFlag(final int flag)

private static String
flagsToString(int flags, final Map<Integer, String> flagsNameMap)

protected abstract Map<Integer, String>
getFlagNamesMap()

Returns: the Map with flag bit - to - flag name mapping

public int
getFlags()

Returns: flags for the frame.

public int
getLength()

Returns: the length of this frame.

public int
getStreamId()

Returns: the stream ID associated with the frame.

public abstract int
getType()

Returns: the type of the frame.

public String
headerToString()

public boolean
isFlagSet(final int flag)

protected void
onPayloadUpdated()

The method should be invoked once packet payload is updated

public void
recycle()

Implements org.glassfish.grizzly.Cacheable.recycle.

protected void
serializeFrameHeader(final Buffer buffer)

public void
setFlag(final int flag)

protected void
setFlags(final int
the flags for this frame
flags)

Sets flags for the frame.

protected void
setFrameBuffer(Buffer frameBuffer)

protected void
setStreamId(final int
the stream ID of this frame.
streamId)

Sets the stream ID associated with the data frame.

public Buffer
toBuffer()

public abstract Buffer
toBuffer(final MemoryManager<E extends Buffer> memoryManager)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

DONT_RECYCLEback to summary
protected static final boolean DONT_RECYCLE
flagsback to summary
private int flags
FRAME_HEADER_SIZEback to summary
public static final int FRAME_HEADER_SIZE
frameBufferback to summary
protected Buffer frameBuffer
lengthback to summary
protected int length
streamIdback to summary
private int streamId

Constructor Detail

Http2Frameback to summary
protected Http2Frame()

Method Detail

calcLengthback to summary
protected abstract int calcLength()
Returns:int

the length of this frame.

clearFlagback to summary
public void clearFlag(final int flag)
flagsToStringback to summary
private static String flagsToString(int flags, final Map<Integer, String> flagsNameMap)
getFlagNamesMapback to summary
protected abstract Map<Integer, String> getFlagNamesMap()
Returns:Map<Integer, String>

the Map with flag bit - to - flag name mapping

getFlagsback to summary
public int getFlags()
Returns:int

flags for the frame. Only the first 8 bits are relevant.

getLengthback to summary
public int getLength()
Returns:int

the length of this frame.

getStreamIdback to summary
public int getStreamId()
Returns:int

the stream ID associated with the frame.

getTypeback to summary
public abstract int getType()
Returns:int

the type of the frame.

headerToStringback to summary
public String headerToString()
isFlagSetback to summary
public boolean isFlagSet(final int flag)
onPayloadUpdatedback to summary
protected void onPayloadUpdated()

The method should be invoked once packet payload is updated

recycleback to summary
public void recycle()

Implements org.glassfish.grizzly.Cacheable.recycle.

Annotations
@Override
serializeFrameHeaderback to summary
protected void serializeFrameHeader(final Buffer buffer)
setFlagback to summary
public void setFlag(final int flag)
setFlagsback to summary
protected void setFlags(final int flags)

Sets flags for the frame. Only the first 8 bits are relevant.

Parameters
flags:int

the flags for this frame

setFrameBufferback to summary
protected void setFrameBuffer(Buffer frameBuffer)
setStreamIdback to summary
protected void setStreamId(final int streamId)

Sets the stream ID associated with the data frame.

Parameters
streamId:int

the stream ID of this frame.

toBufferback to summary
public Buffer toBuffer()
toBufferback to summary
public abstract Buffer toBuffer(final MemoryManager<E extends Buffer> memoryManager)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override
org.glassfish.grizzly.http2.frames back to summary

protected abstract Class Http2Frame.Http2FrameBuilder<T extends Http2Frame.Http2FrameBuilder>

extends Object
Class Inheritance
  • java.lang.Object
  • org.glassfish.grizzly.http2.frames.Http2Frame.Http2FrameBuilder
Known Direct Subclasses
org.glassfish.grizzly.http2.frames.PingFrame.PingFrameBuilder, org.glassfish.grizzly.http2.frames.PriorityFrame.PriorityFrameBuilder, org.glassfish.grizzly.http2.frames.RstStreamFrame.RstStreamFrameBuilder, org.glassfish.grizzly.http2.frames.SettingsFrame.SettingsFrameBuilder, org.glassfish.grizzly.http2.frames.WindowUpdateFrame.WindowUpdateFrameBuilder, org.glassfish.grizzly.http2.frames.DataFrame.DataFrameBuilder, org.glassfish.grizzly.http2.frames.GoAwayFrame.GoAwayFrameBuilder, org.glassfish.grizzly.http2.frames.HeaderBlockFragment.HeaderBlockFragmentBuilder

Field Summary

Modifier and TypeField and Description
protected int
flags

protected int
streamId

Constructor Summary

AccessConstructor and Description
protected
Http2FrameBuilder()

Method Summary

Modifier and TypeMethod and Description
public abstract Http2Frame
build()

public T
clearFlag(final int flag)

protected abstract T
getThis()

public T
setFlag(final int flag)

protected void
setHeaderValuesTo(final Http2Frame frame)

public T
streamId(final int streamId)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

flagsback to summary
protected int flags
streamIdback to summary
protected int streamId

Constructor Detail

Http2FrameBuilderback to summary
protected Http2FrameBuilder()

Method Detail

buildback to summary
public abstract Http2Frame build()
clearFlagback to summary
public T clearFlag(final int flag)
Annotations
@SuppressWarnings:unused
getThisback to summary
protected abstract T getThis()
setFlagback to summary
public T setFlag(final int flag)
setHeaderValuesToback to summary
protected void setHeaderValuesTo(final Http2Frame frame)
streamIdback to summary
public T streamId(final int streamId)