io.undertow.websockets.core

Class StreamSourceFrameChannel

java.lang.Object

io.undertow.server.protocol.framed.AbstractFramedStreamSourceChannel<WebSocketChannel,StreamSourceFrameChannel,StreamSinkFrameChannel>

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 AbstractFramedStreamSourceChannel<WebSocketChannel,StreamSourceFrameChannel,StreamSinkFrameChannel>

Base class for processes Frame bases StreamSourceChannels.

Author:

Norman Maurer

Field Summary

Fields

Modifier and Type	Field and Description
protected WebSocketFrameType	type

Fields inherited from interface org.xnio.channels.Configurable

EMPTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StreamSourceFrameChannel(WebSocketChannel wsChannel, WebSocketFrameType type, long payloadSize, int rsv, boolean finalFragment, org.xnio.Pooled<ByteBuffer> pooled, long frameLength)
protected	StreamSourceFrameChannel(WebSocketChannel wsChannel, WebSocketFrameType type, long payloadSize, org.xnio.Pooled<ByteBuffer> pooled, long frameLength)

Method Summary

Methods

Modifier and Type	Method and Description
void	discard() Discard the frame, which means all data that would be part of the frame will be discarded.
void	finalFrame()
protected WebSocketChannel	getFramedChannel()
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()
boolean	isFinalFragment() Flag to indicate if this frame is the final fragment in a message.

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

awaitReadable, awaitReadable, close, complete, getCloseSetter, getIoThread, getOption, getReadFrameCount, getReadSetter, getReadThread, getWorker, handleHeaderData, isComplete, isOpen, isReadResumed, lastFrame, read, read, read, resumeReads, setOption, shutdownReads, supportsOption, suspendReads, transferTo, transferTo, 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

Constructor Detail

StreamSourceFrameChannel

protected StreamSourceFrameChannel(WebSocketChannel wsChannel,
                        WebSocketFrameType type,
                        long payloadSize,
                        org.xnio.Pooled<ByteBuffer> pooled,
                        long frameLength)

StreamSourceFrameChannel

protected StreamSourceFrameChannel(WebSocketChannel wsChannel,
                        WebSocketFrameType type,
                        long payloadSize,
                        int rsv,
                        boolean finalFragment,
                        org.xnio.Pooled<ByteBuffer> pooled,
                        long frameLength)

Method Detail

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.

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 AbstractFramedStreamSourceChannel.close()

Throws:

IOException

getFramedChannel

protected WebSocketChannel getFramedChannel()

Overrides:

getFramedChannel in class AbstractFramedStreamSourceChannel<WebSocketChannel,StreamSourceFrameChannel,StreamSinkFrameChannel>

getWebSocketChannel

public WebSocketChannel getWebSocketChannel()

finalFrame

public void finalFrame()