SpdyStreamStreamSinkChannel (Undertow 1.3.0.CR1 API)

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

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, GatheringByteChannel, InterruptibleChannel, WritableByteChannel, org.xnio.channels.CloseableChannel, org.xnio.channels.Configurable, org.xnio.channels.StreamSinkChannel, org.xnio.channels.SuspendableWriteChannel

Direct Known Subclasses:

SpdySynReplyStreamSinkChannel, SpdySynStreamStreamSinkChannel
```
public abstract class SpdyStreamStreamSinkChannel
extends SpdyStreamSinkChannel
```
Author:

Stuart Douglas

Field Summary
- Fields inherited from interface org.xnio.channels.Configurable
  EMPTY

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected PooledByteBuffer[]`	`allocateAll(PooledByteBuffer[] allHeaderBuffers, PooledByteBuffer currentBuffer)`
`protected void`	`channelForciblyClosed()` Called when a channel has been forcibly closed, and data (frames) have already been written.
`protected SendFrameHeader`	`createFrameHeader()`
`protected abstract SendFrameHeader`	`createFrameHeaderImpl()`
`protected PooledByteBuffer[]`	`createHeaderBlock(PooledByteBuffer firstHeaderBuffer, PooledByteBuffer[] allHeaderBuffers, ByteBuffer firstBuffer, HeaderMap headers, boolean unidirectional)`
`protected abstract Deflater`	`getDeflater()`
`int`	`getStreamId()`
`protected int`	`grabFlowControlBytes(int toSend)` This method should be called before sending.
`protected void`	`handleFlushComplete(boolean finalFrame)`

Methods inherited from class io.undertow.protocols.spdy.SpdyStreamSinkChannel
isLastFrame

Methods inherited from class io.undertow.server.protocol.framed.AbstractFramedStreamSinkChannel
awaitWritable, awaitWritable, close, createFrameFooter, flush, getBuffer, getChannel, getCloseSetter, getIoThread, getOption, getWorker, getWriteSetter, getWriteThread, isBroken, isFinalFrameQueued, isFirstDataWritten, isFlushRequiredOnEmptyBuffer, isOpen, isReadyForFlush, isWriteResumed, isWritesShutdown, markBroken, resumeWrites, resumeWritesInternal, safeToSend, send, sendInternal, setOption, shutdownWrites, supportsOption, suspendWrites, transferFrom, transferFrom, wakeupWrites, write, write, write, writeFinal, writeFinal, writeFinal

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

- Method Detail
  - getStreamId
```
public int getStreamId()
```
  - channelForciblyClosed
```
protected void channelForciblyClosed()
                              throws IOException
```
    Description copied from class: AbstractFramedStreamSinkChannel
    
    Called when a channel has been forcibly closed, and data (frames) have already been written. The action this should take is protocol dependent, e.g. for SPDY a RST_STREAM should be sent, for websockets the channel should be closed. By default this will just close the underlying channel
    
    Overrides:
    
    channelForciblyClosed in class AbstractFramedStreamSinkChannel<SpdyChannel,SpdyStreamSourceChannel,SpdyStreamSinkChannel>
    
    Throws:
    
    IOException
  - createFrameHeader
```
protected final SendFrameHeader createFrameHeader()
```
    Overrides:
    
    createFrameHeader in class AbstractFramedStreamSinkChannel<SpdyChannel,SpdyStreamSourceChannel,SpdyStreamSinkChannel>
  - handleFlushComplete
```
protected void handleFlushComplete(boolean finalFrame)
```
    Overrides:
    
    handleFlushComplete in class AbstractFramedStreamSinkChannel<SpdyChannel,SpdyStreamSourceChannel,SpdyStreamSinkChannel>
  - createHeaderBlock
```
protected PooledByteBuffer[] createHeaderBlock(PooledByteBuffer firstHeaderBuffer,
                                               PooledByteBuffer[] allHeaderBuffers,
                                               ByteBuffer firstBuffer,
                                               HeaderMap headers,
                                               boolean unidirectional)
```
  - createFrameHeaderImpl
```
protected abstract SendFrameHeader createFrameHeaderImpl()
```
  - grabFlowControlBytes
```
protected int grabFlowControlBytes(int toSend)
```
    This method should be called before sending. It will return the amount of data that can be sent, taking into account the stream and connection flow control windows, and the toSend parameter.
    It will decrement the flow control windows by the amount that can be sent, so this method should only be called as a frame is being queued.
    
    Returns:
    
    The number of bytes that can be sent
  - getDeflater
```
protected abstract Deflater getDeflater()
```
  - allocateAll
```
protected PooledByteBuffer[] allocateAll(PooledByteBuffer[] allHeaderBuffers,
                                         PooledByteBuffer currentBuffer)
```

Class SpdyStreamStreamSinkChannel

Field Summary

Fields inherited from interface org.xnio.channels.Configurable

Method Summary

Methods inherited from class io.undertow.protocols.spdy.SpdyStreamSinkChannel

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

Methods inherited from class java.lang.Object

Method Detail

getStreamId

channelForciblyClosed

createFrameHeader

handleFlushComplete

createHeaderBlock

createFrameHeaderImpl

grabFlowControlBytes

getDeflater

allocateAll