Http2Channel (Undertow 1.4.13.Final-SNAPSHOT API)

java.lang.Object
- io.undertow.server.protocol.framed.AbstractFramedChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>
- - io.undertow.protocols.http2.Http2Channel

All Implemented Interfaces:

Attachable, Closeable, AutoCloseable, Channel, InterruptibleChannel, org.xnio.channels.BoundChannel, org.xnio.channels.CloseableChannel, org.xnio.channels.Configurable, org.xnio.channels.ConnectedChannel
```
public class Http2Channel
extends AbstractFramedChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>
implements Attachable
```
HTTP2 channel.

Author:

Stuart Douglas

Field Summary

Fields
Modifier and Type	Field and Description
`static HttpString`	`AUTHORITY`
`static String`	`CLEARTEXT_UPGRADE_STRING`
`static int`	`DEFAULT_INITIAL_WINDOW_SIZE`
`static int`	`DEFAULT_MAX_FRAME_SIZE`
`static int`	`ERROR_CANCEL`
`static int`	`ERROR_COMPRESSION_ERROR`
`static int`	`ERROR_CONNECT_ERROR`
`static int`	`ERROR_ENHANCE_YOUR_CALM`
`static int`	`ERROR_FLOW_CONTROL_ERROR`
`static int`	`ERROR_FRAME_SIZE_ERROR`
`static int`	`ERROR_INADEQUATE_SECURITY`
`static int`	`ERROR_INTERNAL_ERROR`
`static int`	`ERROR_NO_ERROR`
`static int`	`ERROR_PROTOCOL_ERROR`
`static int`	`ERROR_REFUSED_STREAM`
`static int`	`ERROR_SETTINGS_TIMEOUT`
`static int`	`ERROR_STREAM_CLOSED`
`static int`	`FLOW_CONTROL_MIN_WINDOW`
`static int`	`MAX_FRAME_SIZE`
`static HttpString`	`METHOD`
`static HttpString`	`PATH`
`static HttpString`	`SCHEME`
`static HttpString`	`STATUS`

Fields inherited from interface org.xnio.channels.Configurable
EMPTY

Constructor Summary

Constructors
Constructor and Description
`Http2Channel(org.xnio.StreamConnection connectedStreamChannel, String protocol, ByteBufferPool bufferPool, PooledByteBuffer data, boolean clientSide, boolean fromUpgrade, boolean prefaceRequired, ByteBuffer initialOtherSideSettings, org.xnio.OptionMap settings)`
`Http2Channel(org.xnio.StreamConnection connectedStreamChannel, String protocol, ByteBufferPool bufferPool, PooledByteBuffer data, boolean clientSide, boolean fromUpgrade, boolean prefaceRequired, org.xnio.OptionMap settings)`
`Http2Channel(org.xnio.StreamConnection connectedStreamChannel, String protocol, ByteBufferPool bufferPool, PooledByteBuffer data, boolean clientSide, boolean fromUpgrade, org.xnio.OptionMap settings)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> void`	`addToAttachmentList(AttachmentKey<AttachmentList<T>> key, T value)` Add a value to a list-typed attachment key.
`protected void`	`closeSubChannels()` Method that is called when the channel is being forcibly closed, and all sub stream sink/source channels should also be forcibly closed.
`protected AbstractHttp2StreamSourceChannel`	`createChannel(FrameHeaderData frameHeaderData, PooledByteBuffer frameData)` Method that creates the actual stream source channel implementation that is in use.
`protected AbstractHttp2StreamSourceChannel`	`createChannelImpl(FrameHeaderData frameHeaderData, PooledByteBuffer frameData)`
`Http2HeadersStreamSinkChannel`	`createInitialUpgradeResponseStream()` Creates a response stream to respond to the initial HTTP upgrade
`Http2HeadersStreamSinkChannel`	`createStream(HeaderMap requestHeaders)` Creates a strema using a HEADERS frame
`<T> T`	`getAttachment(AttachmentKey<T> key)` Get an attachment value.
`<T> List<T>`	`getAttachmentList(AttachmentKey<? extends List<T>> key)` Gets a list attachment value.
`int`	`getHttp2Version()`
`int`	`getInitialReceiveWindowSize()`
`int`	`getInitialSendWindowSize()`
`String`	`getProtocol()`
`int`	`getReceiveMaxFrameSize()`
`int`	`getSendMaxFrameSize()`
`SSLSession`	`getSslSession()`
`protected void`	`handleBrokenSinkChannel(Throwable e)` Method that is invoked when then write side of a channel is broken.
`protected void`	`handleBrokenSourceChannel(Throwable e)` Method that is invoked when the read side of the channel is broken.
`void`	`handleWindowUpdate(int streamId, int deltaWindowSize)`
`boolean`	`isClient()`
`protected boolean`	`isLastFrameReceived()` Returns true if the protocol specific final frame has been received.
`protected boolean`	`isLastFrameSent()`
`boolean`	`isPeerGoneAway()`
`boolean`	`isPushEnabled()`
`boolean`	`isThisGoneAway()`
`protected void`	`lastDataRead()` Method than is invoked when read() returns -1.
`protected FrameHeaderData`	`parseFrame(ByteBuffer data)` Attempts to parse an incoming frame header from the data in the buffer.
`<T> T`	`putAttachment(AttachmentKey<T> key, T value)` Set an attachment value.
`<T> T`	`removeAttachment(AttachmentKey<T> key)` Remove an attachment, returning its previous value.
`void`	`sendGoAway(int status)`
`void`	`sendGoAway(int status, org.xnio.ChannelExceptionHandler<AbstractHttp2StreamSinkChannel> exceptionHandler)`
`void`	`sendPing(byte[] data)`
`void`	`sendPing(byte[] data, org.xnio.ChannelExceptionHandler<AbstractHttp2StreamSinkChannel> exceptionHandler)`
`Http2HeadersStreamSinkChannel`	`sendPushPromise(int associatedStreamId, HeaderMap requestHeaders, HeaderMap responseHeaders)`
`void`	`sendRstStream(int streamId, int statusCode)`
`void`	`sendUpdateWindowSize(int streamId, int delta)`
`void`	`updateReceiveFlowControlWindow(int read)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CLEARTEXT_UPGRADE_STRING
```
public static final String CLEARTEXT_UPGRADE_STRING
```
    See Also:
    
    Constant Field Values
  - METHOD
```
public static final HttpString METHOD
```
  - PATH
```
public static final HttpString PATH
```
  - SCHEME
```
public static final HttpString SCHEME
```
  - AUTHORITY
```
public static final HttpString AUTHORITY
```
  - STATUS
```
public static final HttpString STATUS
```
  - ERROR_NO_ERROR
```
public static final int ERROR_NO_ERROR
```
    See Also:
    
    Constant Field Values
  - ERROR_PROTOCOL_ERROR
```
public static final int ERROR_PROTOCOL_ERROR
```
    See Also:
    
    Constant Field Values
  - ERROR_INTERNAL_ERROR
```
public static final int ERROR_INTERNAL_ERROR
```
    See Also:
    
    Constant Field Values
  - ERROR_FLOW_CONTROL_ERROR
```
public static final int ERROR_FLOW_CONTROL_ERROR
```
    See Also:
    
    Constant Field Values
  - ERROR_SETTINGS_TIMEOUT
```
public static final int ERROR_SETTINGS_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - ERROR_STREAM_CLOSED
```
public static final int ERROR_STREAM_CLOSED
```
    See Also:
    
    Constant Field Values
  - ERROR_FRAME_SIZE_ERROR
```
public static final int ERROR_FRAME_SIZE_ERROR
```
    See Also:
    
    Constant Field Values
  - ERROR_REFUSED_STREAM
```
public static final int ERROR_REFUSED_STREAM
```
    See Also:
    
    Constant Field Values
  - ERROR_CANCEL
```
public static final int ERROR_CANCEL
```
    See Also:
    
    Constant Field Values
  - ERROR_COMPRESSION_ERROR
```
public static final int ERROR_COMPRESSION_ERROR
```
    See Also:
    
    Constant Field Values
  - ERROR_CONNECT_ERROR
```
public static final int ERROR_CONNECT_ERROR
```
    See Also:
    
    Constant Field Values
  - ERROR_ENHANCE_YOUR_CALM
```
public static final int ERROR_ENHANCE_YOUR_CALM
```
    See Also:
    
    Constant Field Values
  - ERROR_INADEQUATE_SECURITY
```
public static final int ERROR_INADEQUATE_SECURITY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_INITIAL_WINDOW_SIZE
```
public static final int DEFAULT_INITIAL_WINDOW_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_FRAME_SIZE
```
public static final int DEFAULT_MAX_FRAME_SIZE
```
    See Also:
    
    Constant Field Values
  - MAX_FRAME_SIZE
```
public static final int MAX_FRAME_SIZE
```
    See Also:
    
    Constant Field Values
  - FLOW_CONTROL_MIN_WINDOW
```
public static final int FLOW_CONTROL_MIN_WINDOW
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Http2Channel
```
public Http2Channel(org.xnio.StreamConnection connectedStreamChannel,
                    String protocol,
                    ByteBufferPool bufferPool,
                    PooledByteBuffer data,
                    boolean clientSide,
                    boolean fromUpgrade,
                    org.xnio.OptionMap settings)
```
  - Http2Channel
```
public Http2Channel(org.xnio.StreamConnection connectedStreamChannel,
                    String protocol,
                    ByteBufferPool bufferPool,
                    PooledByteBuffer data,
                    boolean clientSide,
                    boolean fromUpgrade,
                    boolean prefaceRequired,
                    org.xnio.OptionMap settings)
```
  - Http2Channel
```
public Http2Channel(org.xnio.StreamConnection connectedStreamChannel,
                    String protocol,
                    ByteBufferPool bufferPool,
                    PooledByteBuffer data,
                    boolean clientSide,
                    boolean fromUpgrade,
                    boolean prefaceRequired,
                    ByteBuffer initialOtherSideSettings,
                    org.xnio.OptionMap settings)
```
- Method Detail
  - createChannel
```
protected AbstractHttp2StreamSourceChannel createChannel(FrameHeaderData frameHeaderData,
                                                         PooledByteBuffer frameData)
                                                  throws IOException
```
    Description copied from class: AbstractFramedChannel
    
    Method that creates the actual stream source channel implementation that is in use.
    
    Specified by:
    
    createChannel in class AbstractFramedChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>
    
    Parameters:
    
    frameHeaderData - The header data, as returned by AbstractFramedChannel.parseFrame(java.nio.ByteBuffer)
    
    frameData - Any additional data for the frame that has already been read. This may not be the complete frame contents
    
    Returns:
    
    A new stream source channel
    
    Throws:
    
    IOException
  - createChannelImpl
```
protected AbstractHttp2StreamSourceChannel createChannelImpl(FrameHeaderData frameHeaderData,
                                                             PooledByteBuffer frameData)
                                                      throws IOException
```
    Throws:
    
    IOException
  - parseFrame
```
protected FrameHeaderData parseFrame(ByteBuffer data)
                              throws IOException
```
    Description copied from class: AbstractFramedChannel
    
    Attempts to parse an incoming frame header from the data in the buffer.
    
    Specified by:
    
    parseFrame in class AbstractFramedChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>
    
    Parameters:
    
    data - The data that has been read from the channel
    
    Returns:
    
    The frame header data, or null if the data was incomplete
    
    Throws:
    
    IOException - If the data could not be parsed.
  - lastDataRead
```
protected void lastDataRead()
```
    Description copied from class: AbstractFramedChannel
    
    Method than is invoked when read() returns -1.
    
    Overrides:
    
    lastDataRead in class AbstractFramedChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>
  - isLastFrameReceived
```
protected boolean isLastFrameReceived()
```
    Description copied from class: AbstractFramedChannel
    
    Returns true if the protocol specific final frame has been received.
    
    Specified by:
    
    isLastFrameReceived in class AbstractFramedChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>
    
    Returns:
    
    true If the last frame has been received
  - isLastFrameSent
```
protected boolean isLastFrameSent()
```
    Specified by:
    
    isLastFrameSent in class AbstractFramedChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>
    
    Returns:
    
    true If the last frame has been sent
  - handleBrokenSourceChannel
```
protected void handleBrokenSourceChannel(Throwable e)
```
    Description copied from class: AbstractFramedChannel
    
    Method that is invoked when the read side of the channel is broken. This generally happens on a protocol error.
    
    Specified by:
    
    handleBrokenSourceChannel in class AbstractFramedChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>
  - handleBrokenSinkChannel
```
protected void handleBrokenSinkChannel(Throwable e)
```
    Description copied from class: AbstractFramedChannel
    
    Method that is invoked when then write side of a channel is broken. This generally happens on a protocol error.
    
    Specified by:
    
    handleBrokenSinkChannel in class AbstractFramedChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>
  - closeSubChannels
```
protected void closeSubChannels()
```
    Description copied from class: AbstractFramedChannel
    
    Method that is called when the channel is being forcibly closed, and all sub stream sink/source channels should also be forcibly closed.
    
    Specified by:
    
    closeSubChannels in class AbstractFramedChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>
  - getHttp2Version
```
public int getHttp2Version()
```
  - getInitialSendWindowSize
```
public int getInitialSendWindowSize()
```
  - getInitialReceiveWindowSize
```
public int getInitialReceiveWindowSize()
```
  - handleWindowUpdate
```
public void handleWindowUpdate(int streamId,
                               int deltaWindowSize)
                        throws IOException
```
    Throws:
    
    IOException
  - sendPing
```
public void sendPing(byte[] data)
```
  - sendPing
```
public void sendPing(byte[] data,
                     org.xnio.ChannelExceptionHandler<AbstractHttp2StreamSinkChannel> exceptionHandler)
```
  - sendGoAway
```
public void sendGoAway(int status)
```
  - sendGoAway
```
public void sendGoAway(int status,
                       org.xnio.ChannelExceptionHandler<AbstractHttp2StreamSinkChannel> exceptionHandler)
```
  - sendUpdateWindowSize
```
public void sendUpdateWindowSize(int streamId,
                                 int delta)
                          throws IOException
```
    Throws:
    
    IOException
  - getSslSession
```
public SSLSession getSslSession()
```
  - updateReceiveFlowControlWindow
```
public void updateReceiveFlowControlWindow(int read)
                                    throws IOException
```
    Throws:
    
    IOException
  - createStream
```
public Http2HeadersStreamSinkChannel createStream(HeaderMap requestHeaders)
                                           throws IOException
```
    Creates a strema using a HEADERS frame
    
    Parameters:
    
    requestHeaders -
    
    Returns:
    
    Throws:
    
    IOException
  - sendPushPromise
```
public Http2HeadersStreamSinkChannel sendPushPromise(int associatedStreamId,
                                                     HeaderMap requestHeaders,
                                                     HeaderMap responseHeaders)
                                              throws IOException
```
    Throws:
    
    IOException
  - isClient
```
public boolean isClient()
```
  - getAttachment
```
public <T> T getAttachment(AttachmentKey<T> key)
```
    Description copied from interface: Attachable
    
    Get an attachment value. If no attachment exists for this key, null is returned.
    
    Specified by:
    
    getAttachment in interface Attachable
    
    Type Parameters:
    
    T - the value type
    
    Parameters:
    
    key - the attachment key
    
    Returns:
    
    the value, or null if there is none
  - getAttachmentList
```
public <T> List<T> getAttachmentList(AttachmentKey<? extends List<T>> key)
```
    Description copied from interface: Attachable
    
    Gets a list attachment value. If not attachment exists for this key an empty list is returned
    
    Specified by:
    
    getAttachmentList in interface Attachable
    
    Type Parameters:
    
    T - the value type
    
    Parameters:
    
    key - the attachment key
    
    Returns:
    
    the value, or an empty list if there is none
  - putAttachment
```
public <T> T putAttachment(AttachmentKey<T> key,
                           T value)
```
    Description copied from interface: Attachable
    
    Set an attachment value. If an attachment for this key was already set, return the original value. If the value being set is null, the attachment key is removed.
    
    Specified by:
    
    putAttachment in interface Attachable
    
    Type Parameters:
    
    T - the value type
    
    Parameters:
    
    key - the attachment key
    
    value - the new value
    
    Returns:
    
    the old value, or null if there was none
  - removeAttachment
```
public <T> T removeAttachment(AttachmentKey<T> key)
```
    Description copied from interface: Attachable
    
    Remove an attachment, returning its previous value.
    
    Specified by:
    
    removeAttachment in interface Attachable
    
    Type Parameters:
    
    T - the value type
    
    Parameters:
    
    key - the attachment key
    
    Returns:
    
    the old value, or null if there was none
  - addToAttachmentList
```
public <T> void addToAttachmentList(AttachmentKey<AttachmentList<T>> key,
                                    T value)
```
    Description copied from interface: Attachable
    
    Add a value to a list-typed attachment key. If the key is not mapped, add such a mapping.
    
    Specified by:
    
    addToAttachmentList in interface Attachable
    
    Type Parameters:
    
    T - the list value type
    
    Parameters:
    
    key - the attachment key
    
    value - the value to add
  - sendRstStream
```
public void sendRstStream(int streamId,
                          int statusCode)
```
  - createInitialUpgradeResponseStream
```
public Http2HeadersStreamSinkChannel createInitialUpgradeResponseStream()
```
    Creates a response stream to respond to the initial HTTP upgrade
    
    Returns:
  - isPushEnabled
```
public boolean isPushEnabled()
```
  - isPeerGoneAway
```
public boolean isPeerGoneAway()
```
  - isThisGoneAway
```
public boolean isThisGoneAway()
```
  - getReceiveMaxFrameSize
```
public int getReceiveMaxFrameSize()
```
  - getSendMaxFrameSize
```
public int getSendMaxFrameSize()
```
  - getProtocol
```
public String getProtocol()
```

Class Http2Channel

Field Summary

Fields inherited from interface org.xnio.channels.Configurable

Constructor Summary

Method Summary

Methods inherited from class io.undertow.server.protocol.framed.AbstractFramedChannel

Methods inherited from class java.lang.Object

Field Detail

CLEARTEXT_UPGRADE_STRING

METHOD

PATH

SCHEME

AUTHORITY

STATUS

ERROR_NO_ERROR

ERROR_PROTOCOL_ERROR

ERROR_INTERNAL_ERROR

ERROR_FLOW_CONTROL_ERROR

ERROR_SETTINGS_TIMEOUT

ERROR_STREAM_CLOSED

ERROR_FRAME_SIZE_ERROR

ERROR_REFUSED_STREAM

ERROR_CANCEL

ERROR_COMPRESSION_ERROR

ERROR_CONNECT_ERROR

ERROR_ENHANCE_YOUR_CALM

ERROR_INADEQUATE_SECURITY

DEFAULT_INITIAL_WINDOW_SIZE

DEFAULT_MAX_FRAME_SIZE

MAX_FRAME_SIZE

FLOW_CONTROL_MIN_WINDOW

Constructor Detail

Http2Channel

Http2Channel

Http2Channel

Method Detail

createChannel

createChannelImpl

parseFrame

lastDataRead

isLastFrameReceived

isLastFrameSent

handleBrokenSourceChannel

handleBrokenSinkChannel

closeSubChannels

getHttp2Version

getInitialSendWindowSize

getInitialReceiveWindowSize

handleWindowUpdate

sendPing

sendPing

sendGoAway

sendGoAway

sendUpdateWindowSize

getSslSession

updateReceiveFlowControlWindow

createStream

sendPushPromise

isClient

getAttachment

getAttachmentList

putAttachment

removeAttachment

addToAttachmentList

sendRstStream

createInitialUpgradeResponseStream

isPushEnabled

isPeerGoneAway

isThisGoneAway

getReceiveMaxFrameSize

getSendMaxFrameSize

getProtocol