public class Http2FrameAdapter extends Object implements Http2FrameListener
Http2FrameListener
.Constructor and Description |
---|
Http2FrameAdapter() |
Modifier and Type | Method and Description |
---|---|
int |
onDataRead(ChannelHandlerContext ctx,
int streamId,
ByteBuf data,
int padding,
boolean endOfStream)
Handles an inbound
DATA frame. |
void |
onGoAwayRead(ChannelHandlerContext ctx,
int lastStreamId,
long errorCode,
ByteBuf debugData)
Handles an inbound GO_AWAY frame.
|
void |
onHeadersRead(ChannelHandlerContext ctx,
int streamId,
Http2Headers headers,
int padding,
boolean endStream)
Handles an inbound HEADERS frame.
|
void |
onHeadersRead(ChannelHandlerContext ctx,
int streamId,
Http2Headers headers,
int streamDependency,
short weight,
boolean exclusive,
int padding,
boolean endStream)
Handles an inbound HEADERS frame with priority information specified.
|
void |
onPingAckRead(ChannelHandlerContext ctx,
ByteBuf data)
Handles an inbound PING acknowledgment.
|
void |
onPingRead(ChannelHandlerContext ctx,
ByteBuf data)
Handles an inbound PING frame.
|
void |
onPriorityRead(ChannelHandlerContext ctx,
int streamId,
int streamDependency,
short weight,
boolean exclusive)
Handles an inbound PRIORITY frame.
|
void |
onPushPromiseRead(ChannelHandlerContext ctx,
int streamId,
int promisedStreamId,
Http2Headers headers,
int padding)
Handles an inbound PUSH_PROMISE frame.
|
void |
onRstStreamRead(ChannelHandlerContext ctx,
int streamId,
long errorCode)
Handles an inbound RST_STREAM frame.
|
void |
onSettingsAckRead(ChannelHandlerContext ctx)
Handles an inbound SETTINGS acknowledgment frame.
|
void |
onSettingsRead(ChannelHandlerContext ctx,
Http2Settings settings)
Handles an inbound SETTINGS frame.
|
void |
onUnknownFrame(ChannelHandlerContext ctx,
byte frameType,
int streamId,
Http2Flags flags,
ByteBuf payload)
Handler for a frame not defined by the HTTP/2 spec.
|
void |
onWindowUpdateRead(ChannelHandlerContext ctx,
int streamId,
int windowSizeIncrement)
Handles an inbound WINDOW_UPDATE frame.
|
public int onDataRead(ChannelHandlerContext ctx, int streamId, ByteBuf data, int padding, boolean endOfStream) throws Http2Exception
Http2FrameListener
DATA
frame.onDataRead
in interface Http2FrameListener
ctx
- the context from the handler where the frame was read.streamId
- the subject stream for the frame.data
- payload buffer for the frame. This buffer will be released by the codec.padding
- the number of padding bytes found at the end of the frame.endOfStream
- Indicates whether this is the last frame to be sent from the remote
endpoint for this stream.WINDOW_UPDATE
). Returning a value
equal to the length of data
+ padding
will effectively opt-out of
application-level flow control for this frame. Returning a value less than the length
of data
+ padding
will defer the returning of the processed bytes,
which the application must later return via
Http2InboundFlowState#returnProcessedBytes(ChannelHandlerContext, int)
. The
returned value must be >= 0
and <= data.readableBytes()
+
padding
.Http2Exception
public void onHeadersRead(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int padding, boolean endStream) throws Http2Exception
Http2FrameListener
Only one of the following methods will be called for each HEADERS frame sequence. One will be called when the END_HEADERS flag has been received.
Http2FrameListener.onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, boolean)
Http2FrameListener.onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, short, boolean, int, boolean)
Http2FrameListener.onPushPromiseRead(ChannelHandlerContext, int, int, Http2Headers, int)
To say it another way; the Http2Headers
will contain all of the headers
for the current message exchange step (additional queuing is not necessary).
onHeadersRead
in interface Http2FrameListener
ctx
- the context from the handler where the frame was read.streamId
- the subject stream for the frame.headers
- the received headers.padding
- the number of padding bytes found at the end of the frame.endStream
- Indicates whether this is the last frame to be sent from the remote endpoint
for this stream.Http2Exception
public void onHeadersRead(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int streamDependency, short weight, boolean exclusive, int padding, boolean endStream) throws Http2Exception
Http2FrameListener
Only one of the following methods will be called for each HEADERS frame sequence. One will be called when the END_HEADERS flag has been received.
Http2FrameListener.onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, boolean)
Http2FrameListener.onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, short, boolean, int, boolean)
Http2FrameListener.onPushPromiseRead(ChannelHandlerContext, int, int, Http2Headers, int)
To say it another way; the Http2Headers
will contain all of the headers
for the current message exchange step (additional queuing is not necessary).
onHeadersRead
in interface Http2FrameListener
ctx
- the context from the handler where the frame was read.streamId
- the subject stream for the frame.headers
- the received headers.streamDependency
- the stream on which this stream depends, or 0 if dependent on the
connection.weight
- the new weight for the stream.exclusive
- whether or not the stream should be the exclusive dependent of its parent.padding
- the number of padding bytes found at the end of the frame.endStream
- Indicates whether this is the last frame to be sent from the remote endpoint
for this stream.Http2Exception
public void onPriorityRead(ChannelHandlerContext ctx, int streamId, int streamDependency, short weight, boolean exclusive) throws Http2Exception
Http2FrameListener
onPriorityRead
in interface Http2FrameListener
ctx
- the context from the handler where the frame was read.streamId
- the subject stream for the frame.streamDependency
- the stream on which this stream depends, or 0 if dependent on the
connection.weight
- the new weight for the stream.exclusive
- whether or not the stream should be the exclusive dependent of its parent.Http2Exception
public void onRstStreamRead(ChannelHandlerContext ctx, int streamId, long errorCode) throws Http2Exception
Http2FrameListener
onRstStreamRead
in interface Http2FrameListener
ctx
- the context from the handler where the frame was read.streamId
- the stream that is terminating.errorCode
- the error code identifying the type of failure.Http2Exception
public void onSettingsAckRead(ChannelHandlerContext ctx) throws Http2Exception
Http2FrameListener
onSettingsAckRead
in interface Http2FrameListener
ctx
- the context from the handler where the frame was read.Http2Exception
public void onSettingsRead(ChannelHandlerContext ctx, Http2Settings settings) throws Http2Exception
Http2FrameListener
onSettingsRead
in interface Http2FrameListener
ctx
- the context from the handler where the frame was read.settings
- the settings received from the remote endpoint.Http2Exception
public void onPingRead(ChannelHandlerContext ctx, ByteBuf data) throws Http2Exception
Http2FrameListener
onPingRead
in interface Http2FrameListener
ctx
- the context from the handler where the frame was read.data
- the payload of the frame. If this buffer needs to be retained by the listener
they must make a copy.Http2Exception
public void onPingAckRead(ChannelHandlerContext ctx, ByteBuf data) throws Http2Exception
Http2FrameListener
onPingAckRead
in interface Http2FrameListener
ctx
- the context from the handler where the frame was read.data
- the payload of the frame. If this buffer needs to be retained by the listener
they must make a copy.Http2Exception
public void onPushPromiseRead(ChannelHandlerContext ctx, int streamId, int promisedStreamId, Http2Headers headers, int padding) throws Http2Exception
Http2FrameListener
Promised requests MUST be cacheable
(see [RFC7231], Section 4.2.3) and
MUST be safe (see [RFC7231], Section 4.2.1).
If these conditions do not hold the application MUST throw a Http2Exception.StreamException
with
error type Http2Error.PROTOCOL_ERROR
.
Only one of the following methods will be called for each HEADERS frame sequence. One will be called when the END_HEADERS flag has been received.
Http2FrameListener.onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, boolean)
Http2FrameListener.onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, short, boolean, int, boolean)
Http2FrameListener.onPushPromiseRead(ChannelHandlerContext, int, int, Http2Headers, int)
To say it another way; the Http2Headers
will contain all of the headers
for the current message exchange step (additional queuing is not necessary).
onPushPromiseRead
in interface Http2FrameListener
ctx
- the context from the handler where the frame was read.streamId
- the stream the frame was sent on.promisedStreamId
- the ID of the promised stream.headers
- the received headers.padding
- the number of padding bytes found at the end of the frame.Http2Exception
public void onGoAwayRead(ChannelHandlerContext ctx, int lastStreamId, long errorCode, ByteBuf debugData) throws Http2Exception
Http2FrameListener
onGoAwayRead
in interface Http2FrameListener
ctx
- the context from the handler where the frame was read.lastStreamId
- the last known stream of the remote endpoint.errorCode
- the error code, if abnormal closure.debugData
- application-defined debug data. If this buffer needs to be retained by the
listener they must make a copy.Http2Exception
public void onWindowUpdateRead(ChannelHandlerContext ctx, int streamId, int windowSizeIncrement) throws Http2Exception
Http2FrameListener
onWindowUpdateRead
in interface Http2FrameListener
ctx
- the context from the handler where the frame was read.streamId
- the stream the frame was sent on.windowSizeIncrement
- the increased number of bytes of the remote endpoint's flow
control window.Http2Exception
public void onUnknownFrame(ChannelHandlerContext ctx, byte frameType, int streamId, Http2Flags flags, ByteBuf payload)
Http2FrameListener
onUnknownFrame
in interface Http2FrameListener
ctx
- the context from the handler where the frame was read.frameType
- the frame type from the HTTP/2 header.streamId
- the stream the frame was sent on.flags
- the flags in the frame header.payload
- the payload of the frame.Copyright © 2008–2015 The Netty Project. All rights reserved.