io.undertow.websockets.core

Class StreamSinkFrameChannel

java.lang.Object

io.undertow.websockets.core.StreamSinkFrameChannel

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:

WebSocket07FrameSinkChannel

public abstract class StreamSinkFrameChannel
extends Object
implements org.xnio.channels.StreamSinkChannel

Author:

Norman Maurer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	StreamSinkFrameChannel.ChannelState

Field Summary

Fields

Modifier and Type	Field and Description
protected org.xnio.channels.StreamSinkChannel	channel
protected long	payloadSize The payload size
protected WebSocketChannel	wsChannel

Fields inherited from interface org.xnio.channels.Configurable

EMPTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StreamSinkFrameChannel(org.xnio.channels.StreamSinkChannel channel, WebSocketChannel wsChannel, WebSocketFrameType type, long payloadSize)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activate() Mark this channel as active
boolean	areExtensionsSupported() true if extendsions are supported for the WebSocketFrameType.
void	awaitWritable()
void	awaitWritable(long time, TimeUnit timeUnit)
protected long	bytesToWrite() Return the bytes which need to get written before the frame is complete
protected void	checkClosed() Throws an IOException if the isOpen() returns false
void	close() Closes the channel.
protected abstract ByteBuffer	createFrameEnd() Create the ByteBuffer that marks the end of the frame
protected abstract ByteBuffer	createFrameStart() Create the ByteBuffer that will be written as start of the frame.
protected void	endFrameComplete() Is called once the end of the frame was witten.
boolean	flush()
protected boolean	flush0()
protected void	frameStartComplete() Is called once the start of the frame was witten.
org.xnio.ChannelListener.Setter<? extends org.xnio.channels.StreamSinkChannel>	getCloseSetter()
org.xnio.XnioIoThread	getIoThread()
<T> T	getOption(org.xnio.Option<T> option)
long	getPayloadSize()
int	getRsv() Return the RSV for the extension.
protected StreamSinkFrameChannel.ChannelState	getState()
WebSocketFrameType	getType() Return the WebSocketFrameType for which the StreamSinkFrameChannel was obtained.
WebSocketChannel	getWebSocketChannel()
org.xnio.XnioWorker	getWorker()
org.xnio.ChannelListener.SimpleSetter<? extends StreamSinkFrameChannel>	getWriteSetter()
org.xnio.XnioExecutor	getWriteThread()
protected boolean	isActive() Return true if this StreamSinkFrameChannel is currently in use.
boolean	isFinalFragment() Return true if this StreamSinkFrameChannel is the final fragement
boolean	isFragmentationSupported() true if fragementation is supported for the WebSocketFrameType.
boolean	isOpen()
boolean	isWriteResumed()
void	resumeWrites()
void	setFinalFragment(boolean finalFragment) Set if this StreamSinkFrameChannel is the final fragement.
<T> T	setOption(org.xnio.Option<T> option, T value)
void	setRsv(int rsv) Set the RSV which is used for extensions.
void	shutdownWrites()
boolean	supportsOption(org.xnio.Option<?> option)
void	suspendWrites()
long	transferFrom(FileChannel src, long position, long count)
long	transferFrom(org.xnio.channels.StreamSourceChannel source, long count, ByteBuffer throughBuffer)
protected long	transferFrom0(FileChannel src, long position, long count)
void	wakeupWrites()
int	write(ByteBuffer src)
long	write(ByteBuffer[] srcs)
long	write(ByteBuffer[] srcs, int offset, int length)
protected long	write0(ByteBuffer[] srcs, int offset, int length)

Methods inherited from class java.lang.Object

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

Field Detail

channel

protected final org.xnio.channels.StreamSinkChannel channel

wsChannel

protected final WebSocketChannel wsChannel

payloadSize

protected final long payloadSize

The payload size

Constructor Detail

StreamSinkFrameChannel

protected StreamSinkFrameChannel(org.xnio.channels.StreamSinkChannel channel,
                      WebSocketChannel wsChannel,
                      WebSocketFrameType type,
                      long payloadSize)

Method Detail

getWriteSetter

public org.xnio.ChannelListener.SimpleSetter<? extends StreamSinkFrameChannel> getWriteSetter()

Specified by:

getWriteSetter in interface org.xnio.channels.StreamSinkChannel

Specified by:

getWriteSetter in interface org.xnio.channels.SuspendableWriteChannel

getPayloadSize

public long getPayloadSize()

getRsv

public int getRsv()

Return the RSV for the extension. Default is 0.

isFinalFragment

public boolean isFinalFragment()

Return true if this StreamSinkFrameChannel is the final fragement

setFinalFragment

public void setFinalFragment(boolean finalFragment)

Set if this StreamSinkFrameChannel is the final fragement.

This can only be set before any write or transfer operations where passed to the wrapped StreamSinkChannel, after that an IllegalStateException will be thrown.

setRsv

public void setRsv(int rsv)

Set the RSV which is used for extensions.

This can only be set before any write or transfer operations where passed to the wrapped StreamSinkChannel, after that an IllegalStateException will be thrown.

createFrameStart

protected abstract ByteBuffer createFrameStart()

Create the ByteBuffer that will be written as start of the frame.

Returns:

The ByteBuffer which will be used to start a frame

createFrameEnd

protected abstract ByteBuffer createFrameEnd()

Create the ByteBuffer that marks the end of the frame

Returns:

The ByteBuffer that marks the end of the frame

isFragmentationSupported

public boolean isFragmentationSupported()

true if fragementation is supported for the WebSocketFrameType.

areExtensionsSupported

public boolean areExtensionsSupported()

true if extendsions are supported for the WebSocketFrameType.

frameStartComplete

protected void frameStartComplete()

Is called once the start of the frame was witten. Sub-classes may override this to free up resources

endFrameComplete

protected void endFrameComplete()

Is called once the end of the frame was witten. Sub-classes may override this to free up resources

flush0

protected boolean flush0()
                  throws IOException

Throws:

IOException

activate

protected final void activate()

Mark this channel as active

getType

public WebSocketFrameType getType()

Return the WebSocketFrameType for which the StreamSinkFrameChannel was obtained.

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 final void close()

Closes the channel.

If this channel has not been previously closed and fully flushed then this will result in the web socket channel becoming broken and unusable.

As per the XNIO contract clients should use shutdownWrites() and flush() for normal shutdowns.

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

Specified by:

close in interface org.xnio.channels.SuspendableWriteChannel

write

public long write(ByteBuffer[] srcs,
         int offset,
         int length)
           throws IOException

Specified by:

write in interface GatheringByteChannel

Throws:

IOException

write0

protected long write0(ByteBuffer[] srcs,
          int offset,
          int length)
               throws IOException

Throws:

IOException

See Also:

StreamSinkChannel#write(ByteBuffer[], int, int)}

write

public final long write(ByteBuffer[] srcs)
                 throws IOException

Specified by:

write in interface GatheringByteChannel

Throws:

IOException

write

public final int write(ByteBuffer src)
                throws IOException

Specified by:

write in interface WritableByteChannel

Throws:

IOException

transferFrom

public final long transferFrom(FileChannel src,
                long position,
                long count)
                        throws IOException

Specified by:

transferFrom in interface org.xnio.channels.StreamSinkChannel

Throws:

IOException

transferFrom0

protected long transferFrom0(FileChannel src,
                 long position,
                 long count)
                      throws IOException

Throws:

IOException

See Also:

StreamSinkChannel.transferFrom(FileChannel, long, long)

transferFrom

public long transferFrom(org.xnio.channels.StreamSourceChannel source,
                long count,
                ByteBuffer throughBuffer)
                  throws IOException

Specified by:

transferFrom in interface org.xnio.channels.StreamSinkChannel

Throws:

IOException

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

Specified by:

isOpen in interface org.xnio.channels.SuspendableWriteChannel

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.StreamSinkChannel> getCloseSetter()

Specified by:

getCloseSetter in interface org.xnio.channels.CloseableChannel

Specified by:

getCloseSetter in interface org.xnio.channels.StreamSinkChannel

Specified by:

getCloseSetter in interface org.xnio.channels.SuspendableWriteChannel

suspendWrites

public void suspendWrites()

Specified by:

suspendWrites in interface org.xnio.channels.SuspendableWriteChannel

resumeWrites

public void resumeWrites()

Specified by:

resumeWrites in interface org.xnio.channels.SuspendableWriteChannel

isActive

protected final boolean isActive()

Return true if this StreamSinkFrameChannel is currently in use.

isWriteResumed

public boolean isWriteResumed()

Specified by:

isWriteResumed in interface org.xnio.channels.SuspendableWriteChannel

wakeupWrites

public void wakeupWrites()

Specified by:

wakeupWrites in interface org.xnio.channels.SuspendableWriteChannel

shutdownWrites

public void shutdownWrites()
                    throws IOException

Specified by:

shutdownWrites in interface org.xnio.channels.SuspendableWriteChannel

Throws:

IOException

awaitWritable

public void awaitWritable()
                   throws IOException

Specified by:

awaitWritable in interface org.xnio.channels.SuspendableWriteChannel

Throws:

IOException

awaitWritable

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

Specified by:

awaitWritable in interface org.xnio.channels.SuspendableWriteChannel

Throws:

IOException

getState

protected StreamSinkFrameChannel.ChannelState getState()

getWriteThread

public org.xnio.XnioExecutor getWriteThread()

Specified by:

getWriteThread in interface org.xnio.channels.SuspendableWriteChannel

flush

public final boolean flush()
                    throws IOException

Specified by:

flush in interface org.xnio.channels.SuspendableWriteChannel

Throws:

IOException

bytesToWrite

protected final long bytesToWrite()

Return the bytes which need to get written before the frame is complete

checkClosed

protected final void checkClosed()
                          throws IOException

Throws an IOException if the isOpen() returns false

Throws:

IOException

getWebSocketChannel

public WebSocketChannel getWebSocketChannel()