io.undertow.protocols.http2

Class Http2StreamSourceChannel

java.lang.Object

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

io.undertow.protocols.http2.AbstractHttp2StreamSourceChannel

io.undertow.protocols.http2.Http2StreamSourceChannel

All Implemented Interfaces:

Http2Stream, Closeable, AutoCloseable, Channel, InterruptibleChannel, ReadableByteChannel, ScatteringByteChannel, CloseableChannel, Configurable, StreamSourceChannel, SuspendableReadChannel

public class Http2StreamSourceChannel
extends AbstractHttp2StreamSourceChannel
implements Http2Stream

Author:

Stuart Douglas

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Http2StreamSourceChannel.TrailersHandler

Field Summary

Fields inherited from interface org.xnio.channels.Configurable

EMPTY

Method Summary

Modifier and Type	Method and Description
protected void	channelForciblyClosed()
protected void	complete() Method that is invoked when all data has been read.
ChannelListener<Http2StreamSourceChannel>	getCompletionListener()
HeaderMap	getHeaders()
Http2HeadersStreamSinkChannel	getResponseChannel()
int	getStreamId()
Http2StreamSourceChannel.TrailersHandler	getTrailersHandler()
protected void	handleHeaderData(FrameHeaderData headerData)
boolean	isIgnoreForceClose()
int	read(ByteBuffer dst)
long	read(ByteBuffer[] dsts)
long	read(ByteBuffer[] dsts, int offset, int length)
void	setCompletionListener(ChannelListener<Http2StreamSourceChannel> completionListener)
void	setIgnoreForceClose(boolean ignoreForceClose)
void	setTrailersHandler(Http2StreamSourceChannel.TrailersHandler trailersHandler)
String	toString()
long	transferTo(long count, ByteBuffer throughBuffer, StreamSinkChannel streamSinkChannel) Transfers bytes into the given channel target.
long	transferTo(long position, long count, FileChannel target) Transfers bytes into the given file from this channel.
protected long	updateFrameDataRemaining(PooledByteBuffer data, long frameDataRemaining)

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

getFramedChannel, getHttp2Channel, lastFrame, markStreamBroken

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

addCloseTask, awaitReadable, awaitReadable, close, dataReady, getCloseSetter, getIoThread, getMaxStreamSize, getOption, getReadFrameCount, getReadSetter, getReadThread, getWorker, isComplete, isLastFrame, isOpen, isReadResumed, processFrameData, resumeReads, setMaxStreamSize, setOption, shutdownReads, supportsOption, suspendReads, wakeupReads

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

handleHeaderData

protected void handleHeaderData(FrameHeaderData headerData)

Overrides:

handleHeaderData in class AbstractHttp2StreamSourceChannel

updateFrameDataRemaining

protected long updateFrameDataRemaining(PooledByteBuffer data,
                                        long frameDataRemaining)

Overrides:

updateFrameDataRemaining in class AbstractFramedStreamSourceChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>

getResponseChannel

public Http2HeadersStreamSinkChannel getResponseChannel()

read

public int read(ByteBuffer dst)
         throws IOException

Specified by:

read in interface ReadableByteChannel

Overrides:

read in class AbstractFramedStreamSourceChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>

Throws:

IOException

read

public long read(ByteBuffer[] dsts,
                 int offset,
                 int length)
          throws IOException

Specified by:

read in interface ScatteringByteChannel

Overrides:

read in class AbstractFramedStreamSourceChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>

Throws:

IOException

read

public long read(ByteBuffer[] dsts)
          throws IOException

Specified by:

read in interface ScatteringByteChannel

Overrides:

read in class AbstractFramedStreamSourceChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>

Throws:

IOException

transferTo

public long transferTo(long count,
                       ByteBuffer throughBuffer,
                       StreamSinkChannel streamSinkChannel)
                throws IOException

Description copied from interface: StreamSourceChannel

Transfers bytes into the given channel target. On some platforms, this may avoid copying bytes between user and kernel space. On other platforms, bytes are passed through the throughBuffer parameter's buffer space. On entry, throughBuffer will be cleared. On exit, the buffer will be flipped for emptying, and may possibly be empty or may contain data. If this method returns a value less than count, then the remaining data in throughBuffer may contain data read from this channel which must be written to target to complete the operation. Note that using a direct buffer may provide an intermediate performance gain on platforms without zero-copy facilities.

If the current thread is interrupted when this method is called, it may throw a InterruptedIOException; however, if this exception is thrown, the InterruptedIOException.bytesTransferred field is guaranteed to be 0. Note that the return value is the amount of data that was actually transferred to the StreamSinkChannel. The actual amount of data read could be larger than this, and can be calculated by adding the return value and the amount of data left in throughBuffer.

Specified by:

transferTo in interface StreamSourceChannel

Overrides:

transferTo in class AbstractFramedStreamSourceChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>

Parameters:

count - the number of bytes to be transferred

throughBuffer - the buffer to copy through.

streamSinkChannel - the destination to write to

Returns:

the number of bytes (possibly 0) that were actually transferred, or -1 if the end of input was reached

Throws:

IOException - if an I/O error occurs

transferTo

public long transferTo(long position,
                       long count,
                       FileChannel target)
                throws IOException

Description copied from interface: StreamSourceChannel

Transfers bytes into the given file from this channel. Using this method in preference to FileChannel.transferFrom(ReadableByteChannel, long, long) may provide a performance advantage on some platforms.

If the current thread is interrupted when this method is called, it may throw a InterruptedIOException; however, if this exception is thrown, the InterruptedIOException.bytesTransferred field is guaranteed to be 0.

Specified by:

transferTo in interface StreamSourceChannel

Overrides:

transferTo in class AbstractFramedStreamSourceChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>

Parameters:

position - the position within the file from which the transfer is to begin

count - the number of bytes to be transferred

target - the file to write to

Returns:

the number of bytes (possibly 0) that were actually transferred

Throws:

IOException - if an I/O error occurs

complete

protected void complete()
                 throws IOException

Description copied from class: AbstractFramedStreamSourceChannel

Method that is invoked when all data has been read.

Overrides:

complete in class AbstractFramedStreamSourceChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>

Throws:

IOException

getHeaders

public HeaderMap getHeaders()

getCompletionListener

public ChannelListener<Http2StreamSourceChannel> getCompletionListener()

setCompletionListener

public void setCompletionListener(ChannelListener<Http2StreamSourceChannel> completionListener)

channelForciblyClosed

protected void channelForciblyClosed()

Overrides:

channelForciblyClosed in class AbstractFramedStreamSourceChannel<Http2Channel,AbstractHttp2StreamSourceChannel,AbstractHttp2StreamSinkChannel>

setIgnoreForceClose

public void setIgnoreForceClose(boolean ignoreForceClose)

isIgnoreForceClose

public boolean isIgnoreForceClose()

getStreamId

public int getStreamId()

Specified by:

getStreamId in interface Http2Stream

getTrailersHandler

public Http2StreamSourceChannel.TrailersHandler getTrailersHandler()

setTrailersHandler

public void setTrailersHandler(Http2StreamSourceChannel.TrailersHandler trailersHandler)

toString

public String toString()

Overrides:

toString in class Object