SpdyChannel (Undertow 1.3.0.CR1 API)

java.lang.Object
- io.undertow.server.protocol.framed.AbstractFramedChannel<SpdyChannel,SpdyStreamSourceChannel,SpdyStreamSinkChannel>
- - io.undertow.protocols.spdy.SpdyChannel

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 SpdyChannel
extends AbstractFramedChannel<SpdyChannel,SpdyStreamSourceChannel,SpdyStreamSinkChannel>
implements Attachable
```
SPDY channel.

Author:

Stuart Douglas

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CLOSE_INTERNAL_ERROR`
`static int`	`CLOSE_OK`
`static int`	`CLOSE_PROTOCOL_ERROR`
`static int`	`RST_STATUS_CANCEL`
`static int`	`RST_STATUS_FLOW_CONTROL_ERROR`
`static int`	`RST_STATUS_FRAME_TOO_LARGE`
`static int`	`RST_STATUS_INTERNAL_ERROR`
`static int`	`RST_STATUS_INVALID_STREAM`
`static int`	`RST_STATUS_PROTOCOL_ERROR`
`static int`	`RST_STATUS_REFUSED_STREAM`
`static int`	`RST_STATUS_STREAM_ALREADY_CLOSED`
`static int`	`RST_STATUS_STREAM_IN_USE`
`static int`	`RST_STATUS_UNSUPPORTED_VERSION`

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

Constructor Summary

Constructors
Constructor and Description
`SpdyChannel(org.xnio.StreamConnection connectedStreamChannel, ByteBufferPool bufferPool, PooledByteBuffer data, ByteBufferPool heapBufferPool, boolean clientSide, org.xnio.OptionMap options)`

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 SpdyStreamSourceChannel`	`createChannel(FrameHeaderData frameHeaderData, PooledByteBuffer frameData)` Method that creates the actual stream source channel implementation that is in use.
`SpdySynStreamStreamSinkChannel`	`createStream(HeaderMap requestHeaders)`
`SpdySynStreamStreamSinkChannel`	`createStream(int associatedStreamId, HeaderMap requestHeaders)`
`<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`	`getSpdyVersion()`
`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`	`isOpen()`
`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<SpdyStreamSinkChannel> exceptionHandler)`
`void`	`sendPing(int id)`
`void`	`sendPing(int id, org.xnio.ChannelExceptionHandler<SpdyStreamSinkChannel> exceptionHandler)`
`void`	`sendRstStream(int streamId, int statusCode)`
`void`	`sendUpdateWindowSize(int streamId, int delta)`
`void`	`updateReceiveFlowControlWindow(int read)`

Methods inherited from class io.undertow.server.protocol.framed.AbstractFramedChannel
addCloseTask, close, createIdleTimeoutChannel, flushSenders, getBufferPool, getCloseSetter, getDestinationAddress, getFramePriority, getIdleTimeout, getIoThread, getLocalAddress, getLocalAddress, getOption, getPeerAddress, getPeerAddress, getReceiveSetter, getSourceAddress, getUnderlyingConnection, getWorker, isReadsBroken, isReceivesResumed, isWritesBroken, markReadsBroken, markWritesBroken, queueFrame, recalculateHeldFrames, receive, resumeReceives, setIdleTimeout, setOption, supportsOption, suspendReceives, toString, writeExceptionHandler

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

- Field Detail
  - CLOSE_OK
```
public static final int CLOSE_OK
```
    See Also:
    
    Constant Field Values
  - CLOSE_PROTOCOL_ERROR
```
public static final int CLOSE_PROTOCOL_ERROR
```
    See Also:
    
    Constant Field Values
  - CLOSE_INTERNAL_ERROR
```
public static final int CLOSE_INTERNAL_ERROR
```
    See Also:
    
    Constant Field Values
  - RST_STATUS_PROTOCOL_ERROR
```
public static final int RST_STATUS_PROTOCOL_ERROR
```
    See Also:
    
    Constant Field Values
  - RST_STATUS_INVALID_STREAM
```
public static final int RST_STATUS_INVALID_STREAM
```
    See Also:
    
    Constant Field Values
  - RST_STATUS_REFUSED_STREAM
```
public static final int RST_STATUS_REFUSED_STREAM
```
    See Also:
    
    Constant Field Values
  - RST_STATUS_UNSUPPORTED_VERSION
```
public static final int RST_STATUS_UNSUPPORTED_VERSION
```
    See Also:
    
    Constant Field Values
  - RST_STATUS_CANCEL
```
public static final int RST_STATUS_CANCEL
```
    See Also:
    
    Constant Field Values
  - RST_STATUS_INTERNAL_ERROR
```
public static final int RST_STATUS_INTERNAL_ERROR
```
    See Also:
    
    Constant Field Values
  - RST_STATUS_FLOW_CONTROL_ERROR
```
public static final int RST_STATUS_FLOW_CONTROL_ERROR
```
    See Also:
    
    Constant Field Values
  - RST_STATUS_STREAM_IN_USE
```
public static final int RST_STATUS_STREAM_IN_USE
```
    See Also:
    
    Constant Field Values
  - RST_STATUS_STREAM_ALREADY_CLOSED
```
public static final int RST_STATUS_STREAM_ALREADY_CLOSED
```
    See Also:
    
    Constant Field Values
  - RST_STATUS_FRAME_TOO_LARGE
```
public static final int RST_STATUS_FRAME_TOO_LARGE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SpdyChannel
```
public SpdyChannel(org.xnio.StreamConnection connectedStreamChannel,
                   ByteBufferPool bufferPool,
                   PooledByteBuffer data,
                   ByteBufferPool heapBufferPool,
                   boolean clientSide,
                   org.xnio.OptionMap options)
```
- Method Detail
  - createChannel
```
protected SpdyStreamSourceChannel 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<SpdyChannel,SpdyStreamSourceChannel,SpdyStreamSinkChannel>
    
    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
  - 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<SpdyChannel,SpdyStreamSourceChannel,SpdyStreamSinkChannel>
    
    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<SpdyChannel,SpdyStreamSourceChannel,SpdyStreamSinkChannel>
  - isOpen
```
public boolean isOpen()
```
    Specified by:
    
    isOpen in interface Channel
    
    Overrides:
    
    isOpen in class AbstractFramedChannel<SpdyChannel,SpdyStreamSourceChannel,SpdyStreamSinkChannel>
  - 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<SpdyChannel,SpdyStreamSourceChannel,SpdyStreamSinkChannel>
    
    Returns:
    
    true If the last frame has been received
  - isLastFrameSent
```
protected boolean isLastFrameSent()
```
    Specified by:
    
    isLastFrameSent in class AbstractFramedChannel<SpdyChannel,SpdyStreamSourceChannel,SpdyStreamSinkChannel>
    
    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<SpdyChannel,SpdyStreamSourceChannel,SpdyStreamSinkChannel>
  - 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<SpdyChannel,SpdyStreamSourceChannel,SpdyStreamSinkChannel>
  - 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<SpdyChannel,SpdyStreamSourceChannel,SpdyStreamSinkChannel>
  - getSpdyVersion
```
public int getSpdyVersion()
```
  - handleWindowUpdate
```
public void handleWindowUpdate(int streamId,
                               int deltaWindowSize)
                        throws IOException
```
    Throws:
    
    IOException
  - sendPing
```
public void sendPing(int id)
```
  - sendPing
```
public void sendPing(int id,
                     org.xnio.ChannelExceptionHandler<SpdyStreamSinkChannel> exceptionHandler)
```
  - sendGoAway
```
public void sendGoAway(int status)
```
  - sendGoAway
```
public void sendGoAway(int status,
                       org.xnio.ChannelExceptionHandler<SpdyStreamSinkChannel> exceptionHandler)
```
  - sendUpdateWindowSize
```
public void sendUpdateWindowSize(int streamId,
                                 int delta)
```
  - getSslSession
```
public SSLSession getSslSession()
```
  - updateReceiveFlowControlWindow
```
public void updateReceiveFlowControlWindow(int read)
```
  - createStream
```
public SpdySynStreamStreamSinkChannel createStream(HeaderMap requestHeaders)
                                            throws IOException
```
    Throws:
    
    IOException
  - createStream
```
public SpdySynStreamStreamSinkChannel createStream(int associatedStreamId,
                                                   HeaderMap requestHeaders)
                                            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)
```

Class SpdyChannel

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

CLOSE_OK

CLOSE_PROTOCOL_ERROR

CLOSE_INTERNAL_ERROR

RST_STATUS_PROTOCOL_ERROR

RST_STATUS_INVALID_STREAM

RST_STATUS_REFUSED_STREAM

RST_STATUS_UNSUPPORTED_VERSION

RST_STATUS_CANCEL

RST_STATUS_INTERNAL_ERROR

RST_STATUS_FLOW_CONTROL_ERROR

RST_STATUS_STREAM_IN_USE

RST_STATUS_STREAM_ALREADY_CLOSED

RST_STATUS_FRAME_TOO_LARGE

Constructor Detail

SpdyChannel

Method Detail

createChannel

parseFrame

lastDataRead

isOpen

isLastFrameReceived

isLastFrameSent

handleBrokenSourceChannel

handleBrokenSinkChannel

closeSubChannels

getSpdyVersion

handleWindowUpdate

sendPing

sendPing

sendGoAway

sendGoAway

sendUpdateWindowSize

getSslSession

updateReceiveFlowControlWindow

createStream

createStream

isClient

getAttachment

getAttachmentList

putAttachment

removeAttachment

addToAttachmentList

sendRstStream