io.undertow.protocols.http2

Class Http2DataStreamSinkChannel

java.lang.Object

io.undertow.server.protocol.framed.AbstractFramedStreamSinkChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>

io.undertow.protocols.http2.AbstractHttp2StreamSinkChannel

io.undertow.protocols.http2.Http2StreamSinkChannel

io.undertow.protocols.http2.Http2DataStreamSinkChannel

All Implemented Interfaces:

Http2Stream, Closeable, AutoCloseable, Channel, GatheringByteChannel, InterruptibleChannel, WritableByteChannel, CloseableChannel, Configurable, StreamSinkChannel, SuspendableWriteChannel

Direct Known Subclasses:

Http2HeadersStreamSinkChannel, Http2PushPromiseStreamSinkChannel

public class Http2DataStreamSinkChannel
extends Http2StreamSinkChannel
implements Http2Stream

Headers channel

Author:

Stuart Douglas

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Http2DataStreamSinkChannel.TrailersProducer

Field Summary

Fields inherited from interface org.xnio.channels.Configurable

EMPTY

Method Summary

Modifier and Type	Method and Description
protected void	channelForciblyClosed() Called when a channel has been forcibly closed, and data (frames) have already been written.
protected SendFrameHeader	createFrameHeaderImpl()
boolean	flush() Flush any waiting partial send or write.
ChannelListener<Http2DataStreamSinkChannel>	getCompletionListener()
HeaderMap	getHeaders()
Http2DataStreamSinkChannel.TrailersProducer	getTrailersProducer()
protected void	handleFlushComplete(boolean finalFrame)
protected boolean	isFlushRequiredOnEmptyBuffer()
void	setCompletionListener(ChannelListener<Http2DataStreamSinkChannel> completionListener)
void	setTrailersProducer(Http2DataStreamSinkChannel.TrailersProducer trailersProducer)
protected void	writeBeforeHeaderBlock(ByteBuffer buffer)

Methods inherited from class io.undertow.protocols.http2.Http2StreamSinkChannel

allocateAll, createFrameHeader, getStreamId, grabFlowControlBytes

Methods inherited from class io.undertow.protocols.http2.AbstractHttp2StreamSinkChannel

isLastFrame

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

awaitWritable, awaitWritable, close, getBuffer, getChannel, getCloseSetter, getIoThread, getOption, getWorker, getWriteSetter, getWriteThread, isBroken, isBufferFull, isFinalFrameQueued, isFirstDataWritten, isOpen, isReadyForFlush, isWriteResumed, isWritesShutdown, markBroken, preWriteTransform, 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

Methods inherited from interface io.undertow.protocols.http2.Http2Stream

getStreamId

Method Detail

getTrailersProducer

public Http2DataStreamSinkChannel.TrailersProducer getTrailersProducer()

setTrailersProducer

public void setTrailersProducer(Http2DataStreamSinkChannel.TrailersProducer trailersProducer)

createFrameHeaderImpl

protected SendFrameHeader createFrameHeaderImpl()

Specified by:

createFrameHeaderImpl in class Http2StreamSinkChannel

flush

public boolean flush()
              throws IOException

Description copied from interface: SuspendableWriteChannel

Flush any waiting partial send or write. If there is no data to flush, or if the flush completed successfully, this method will return true. If there is data to flush which cannot be immediately written, this method will return false. If this method returns true after SuspendableWriteChannel.shutdownWrites() was called on this channel, the write listener will no longer be invoked on this channel. If this is case and additionally this is a write-only channel or the read side was previously shut down, then the channel will automatically be closed.

Specified by:

flush in interface SuspendableWriteChannel

Overrides:

flush in class AbstractFramedStreamSinkChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>

Returns:

true if the message was flushed, or false if the result would block

Throws:

IOException - if an I/O error occurs

writeBeforeHeaderBlock

protected void writeBeforeHeaderBlock(ByteBuffer buffer)

isFlushRequiredOnEmptyBuffer

protected boolean isFlushRequiredOnEmptyBuffer()

Overrides:

isFlushRequiredOnEmptyBuffer in class AbstractFramedStreamSinkChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>

getHeaders

public HeaderMap getHeaders()

handleFlushComplete

protected void handleFlushComplete(boolean finalFrame)

Overrides:

handleFlushComplete in class Http2StreamSinkChannel

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 Http2StreamSinkChannel

Throws:

IOException

getCompletionListener

public ChannelListener<Http2DataStreamSinkChannel> getCompletionListener()

setCompletionListener

public void setCompletionListener(ChannelListener<Http2DataStreamSinkChannel> completionListener)