io.undertow.websockets.core

Class StreamSourceFrameChannel

java.lang.Object

io.undertow.websockets.core.StreamSourceFrameChannel

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, InterruptibleChannel, ReadableByteChannel, ScatteringByteChannel, org.xnio.channels.CloseableChannel, org.xnio.channels.Configurable, org.xnio.channels.StreamSourceChannel, org.xnio.channels.SuspendableReadChannel

Direct Known Subclasses:

FixedPayloadFrameSourceChannel

public abstract class StreamSourceFrameChannel
extends Object
implements org.xnio.channels.StreamSourceChannel

Base class for processes Frame bases StreamSourceChannels.

Author:

Norman Maurer

Field Summary

Fields

Modifier and Type	Field and Description
protected org.xnio.channels.StreamSourceChannel	channel
protected WebSocketFrameType	type
protected WebSocketChannel	wsChannel

Fields inherited from interface org.xnio.channels.Configurable

EMPTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StreamSourceFrameChannel(WebSocketChannel.StreamSourceChannelControl streamSourceChannelControl, org.xnio.channels.StreamSourceChannel channel, WebSocketChannel wsChannel, WebSocketFrameType type, long payloadSize)
protected	StreamSourceFrameChannel(WebSocketChannel.StreamSourceChannelControl streamSourceChannelControl, org.xnio.channels.StreamSourceChannel channel, WebSocketChannel wsChannel, WebSocketFrameType type, long payloadSize, int rsv, boolean finalFragment)

Method Summary

Methods

Modifier and Type	Method and Description
void	awaitReadable()
void	awaitReadable(long time, TimeUnit timeUnit)
void	close()
protected void	complete() Is called once the whole frame was read.
void	discard() Discard the frame, which means all data that would be part of the frame will be discarded.
org.xnio.ChannelListener.Setter<? extends org.xnio.channels.StreamSourceChannel>	getCloseSetter()
org.xnio.XnioIoThread	getIoThread()
<T> T	getOption(org.xnio.Option<T> option)
long	getPayloadSize() Return the payload size of -1if unknown on creation
org.xnio.ChannelListener.SimpleSetter<? extends StreamSourceFrameChannel>	getReadSetter()
org.xnio.XnioExecutor	getReadThread()
int	getRsv() Return the rsv which is used for extensions.
WebSocketFrameType	getType() Return the WebSocketFrameType or null if its not known at the calling time.
WebSocketChannel	getWebSocketChannel()
org.xnio.XnioWorker	getWorker()
protected abstract boolean	isComplete() Returns true if the frame was complete.
boolean	isFinalFragment() Flag to indicate if this frame is the final fragment in a message.
boolean	isOpen()
boolean	isReadResumed()
protected void	queueListener(org.xnio.ChannelListener<StreamSourceFrameChannel> listener)
int	read(ByteBuffer dst)
long	read(ByteBuffer[] dsts)
long	read(ByteBuffer[] dsts, int offset, int length)
protected abstract int	read0(ByteBuffer dst)
protected abstract long	read0(ByteBuffer[] dsts)
protected abstract long	read0(ByteBuffer[] dsts, int offset, int length)
void	resumeReads()
<T> T	setOption(org.xnio.Option<T> option, T value)
void	shutdownReads()
boolean	supportsOption(org.xnio.Option<?> option)
void	suspendReads()
long	transferTo(long count, ByteBuffer throughBuffer, org.xnio.channels.StreamSinkChannel target)
long	transferTo(long position, long count, FileChannel target)
protected abstract long	transferTo0(long count, ByteBuffer throughBuffer, org.xnio.channels.StreamSinkChannel target)
protected abstract long	transferTo0(long position, long count, FileChannel target)
void	wakeupReads()

Methods inherited from class java.lang.Object

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

Field Detail

type

protected final WebSocketFrameType type

channel

protected final org.xnio.channels.StreamSourceChannel channel

wsChannel

protected final WebSocketChannel wsChannel

Constructor Detail

StreamSourceFrameChannel

protected StreamSourceFrameChannel(WebSocketChannel.StreamSourceChannelControl streamSourceChannelControl,
                        org.xnio.channels.StreamSourceChannel channel,
                        WebSocketChannel wsChannel,
                        WebSocketFrameType type,
                        long payloadSize)

StreamSourceFrameChannel

protected StreamSourceFrameChannel(WebSocketChannel.StreamSourceChannelControl streamSourceChannelControl,
                        org.xnio.channels.StreamSourceChannel channel,
                        WebSocketChannel wsChannel,
                        WebSocketFrameType type,
                        long payloadSize,
                        int rsv,
                        boolean finalFragment)

Method Detail

getPayloadSize

public long getPayloadSize()

Return the payload size of -1if unknown on creation

Returns:

payloadSize

isComplete

protected abstract boolean isComplete()

Returns true if the frame was complete.

read

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

Specified by:

read in interface ScatteringByteChannel

Throws:

IOException

read0

protected abstract long read0(ByteBuffer[] dsts,
         int offset,
         int length)
                       throws IOException

Throws:

IOException

See Also:

ScatteringByteChannel.read(ByteBuffer[], int, int)

read

public final long read(ByteBuffer[] dsts)
                throws IOException

Specified by:

read in interface ScatteringByteChannel

Throws:

IOException

read0

protected abstract long read0(ByteBuffer[] dsts)
                       throws IOException

Throws:

IOException

See Also:

ScatteringByteChannel.read(ByteBuffer[])

read

public final int read(ByteBuffer dst)
               throws IOException

Specified by:

read in interface ReadableByteChannel

Throws:

IOException

read0

protected abstract int read0(ByteBuffer dst)
                      throws IOException

Throws:

IOException

See Also:

ReadableByteChannel.read(ByteBuffer)

transferTo

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

Specified by:

transferTo in interface org.xnio.channels.StreamSourceChannel

Throws:

IOException

transferTo0

protected abstract long transferTo0(long position,
               long count,
               FileChannel target)
                             throws IOException

Throws:

IOException

See Also:

StreamSourceChannel.transferTo(long, long, FileChannel)

transferTo

public final long transferTo(long count,
              ByteBuffer throughBuffer,
              org.xnio.channels.StreamSinkChannel target)
                      throws IOException

Specified by:

transferTo in interface org.xnio.channels.StreamSourceChannel

Throws:

IOException

transferTo0

protected abstract long transferTo0(long count,
               ByteBuffer throughBuffer,
               org.xnio.channels.StreamSinkChannel target)
                             throws IOException

Throws:

IOException

See Also:

StreamSourceChannel.transferTo(long, ByteBuffer, StreamSinkChannel)

complete

protected void complete()
                 throws IOException

Is called once the whole frame was read.

Throws:

IOException

getType

public WebSocketFrameType getType()

Return the WebSocketFrameType or null if its not known at the calling time.

isFinalFragment

public boolean isFinalFragment()

Flag to indicate if this frame is the final fragment in a message. The first fragment (frame) may also be the final fragment.

getRsv

public int getRsv()

Return the rsv which is used for extensions.

getReadSetter

public org.xnio.ChannelListener.SimpleSetter<? extends StreamSourceFrameChannel> getReadSetter()

Specified by:

getReadSetter in interface org.xnio.channels.StreamSourceChannel

Specified by:

getReadSetter in interface org.xnio.channels.SuspendableReadChannel

getWorker

public org.xnio.XnioWorker getWorker()

Specified by:

getWorker in interface org.xnio.channels.CloseableChannel

getIoThread

public org.xnio.XnioIoThread getIoThread()

Specified by:

getIoThread in interface org.xnio.channels.CloseableChannel

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface InterruptibleChannel

Specified by:

close in interface org.xnio.channels.CloseableChannel

Throws:

IOException

queueListener

protected final void queueListener(org.xnio.ChannelListener<StreamSourceFrameChannel> listener)

discard

public void discard()
             throws IOException

Discard the frame, which means all data that would be part of the frame will be discarded. Once all is discarded it will call close()

Throws:

IOException

suspendReads

public void suspendReads()

Specified by:

suspendReads in interface org.xnio.channels.SuspendableReadChannel

resumeReads

public void resumeReads()

Specified by:

resumeReads in interface org.xnio.channels.SuspendableReadChannel

isReadResumed

public boolean isReadResumed()

Specified by:

isReadResumed in interface org.xnio.channels.SuspendableReadChannel

wakeupReads

public void wakeupReads()

Specified by:

wakeupReads in interface org.xnio.channels.SuspendableReadChannel

shutdownReads

public void shutdownReads()
                   throws IOException

Specified by:

shutdownReads in interface org.xnio.channels.SuspendableReadChannel

Throws:

IOException

awaitReadable

public void awaitReadable()
                   throws IOException

Specified by:

awaitReadable in interface org.xnio.channels.SuspendableReadChannel

Throws:

IOException

awaitReadable

public void awaitReadable(long time,
                 TimeUnit timeUnit)
                   throws IOException

Specified by:

awaitReadable in interface org.xnio.channels.SuspendableReadChannel

Throws:

IOException

getReadThread

public org.xnio.XnioExecutor getReadThread()

Specified by:

getReadThread in interface org.xnio.channels.SuspendableReadChannel

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

supportsOption

public boolean supportsOption(org.xnio.Option<?> option)

Specified by:

supportsOption in interface org.xnio.channels.Configurable

getOption

public <T> T getOption(org.xnio.Option<T> option)
            throws IOException

Specified by:

getOption in interface org.xnio.channels.Configurable

Throws:

IOException

setOption

public <T> T setOption(org.xnio.Option<T> option,
              T value)
            throws IOException

Specified by:

setOption in interface org.xnio.channels.Configurable

Throws:

IOException

getCloseSetter

public org.xnio.ChannelListener.Setter<? extends org.xnio.channels.StreamSourceChannel> getCloseSetter()

Specified by:

getCloseSetter in interface org.xnio.channels.CloseableChannel

Specified by:

getCloseSetter in interface org.xnio.channels.StreamSourceChannel

Specified by:

getCloseSetter in interface org.xnio.channels.SuspendableReadChannel

getWebSocketChannel

public WebSocketChannel getWebSocketChannel()