Top Fields Constructors Methods
io.undertow.websockets.core

public abstract Class StreamSinkFrameChannel

extends AbstractFramedStreamSinkChannel<WebSocketChannel, StreamSourceFrameChannel, StreamSinkFrameChannel>
Class Inheritance
Known Direct Subclasses
io.undertow.websockets.core.protocol.version07.WebSocket07FrameSinkChannel
Imports
io.undertow.server.protocol.framed.AbstractFramedStreamSinkChannel
Author
Norman Maurer

Field Summary

Modifier and TypeField and Description
private int
rsv

private final WebSocketFrameType
type

Constructor Summary

AccessConstructor and Description
protected
StreamSinkFrameChannel(WebSocketChannel channel, WebSocketFrameType type)

Method Summary

Modifier and TypeMethod and Description
public boolean
areExtensionsSupported()

true if extensions are supported for the WebSocketFrameType.

public int
getRsv()

Return the RSV for the extension.

public WebSocketFrameType
getType()

Return the WebSocketFrameType for which the StreamSinkFrameChannel was obtained.

public WebSocketChannel
getWebSocketChannel()

public boolean
isFinalFragment()

public boolean
isFragmentationSupported()

true if fragmentation is supported for the WebSocketFrameType.

protected boolean
isLastFrame()

Implements abstract io.undertow.server.protocol.framed.AbstractFramedStreamSinkChannel.isLastFrame.

public void
setRsv(int rsv)

Set the RSV which is used for extensions.

Inherited from io.undertow.server.protocol.framed.AbstractFramedStreamSinkChannel:
awaitWritableawaitWritablechannelForciblyClosedclosecreateFrameHeaderflushgetAwaitWritableTimeoutgetBuffergetChannelgetCloseSettergetIoThreadgetOptiongetWorkergetWriteSettergetWriteThreadhandleFlushCompleteisBrokenisBufferFullisFinalFrameQueuedisFirstDataWrittenisFlushRequiredOnEmptyBufferisOpenisReadyForFlushisWriteResumedisWritesShutdownmarkBrokenpreWriteTransformresumeWritesresumeWritesInternalsafeToSendsendsendInternalsetOptionshutdownWritessupportsOptionsuspendWritestransferFromtransferFromwakeupWriteswritewritewritewriteFinalwriteFinalwriteFinal

Field Detail

rsvback to summary
private int rsv
typeback to summary
private final WebSocketFrameType type

Constructor Detail

StreamSinkFrameChannelback to summary
protected StreamSinkFrameChannel(WebSocketChannel channel, WebSocketFrameType type)

Method Detail

areExtensionsSupportedback to summary
public boolean areExtensionsSupported()

true if extensions are supported for the WebSocketFrameType.

getRsvback to summary
public int getRsv()

Return the RSV for the extension. Default is 0.

getTypeback to summary
public WebSocketFrameType getType()

Return the WebSocketFrameType for which the StreamSinkFrameChannel was obtained.

getWebSocketChannelback to summary
public WebSocketChannel getWebSocketChannel()
isFinalFragmentback to summary
public boolean isFinalFragment()
isFragmentationSupportedback to summary
public boolean isFragmentationSupported()

true if fragmentation is supported for the WebSocketFrameType.

isLastFrameback to summary
protected boolean isLastFrame()

Implements abstract io.undertow.server.protocol.framed.AbstractFramedStreamSinkChannel.isLastFrame.

Returns:boolean

Doc from io.undertow.server.protocol.framed.AbstractFramedStreamSinkChannel.isLastFrame.

true If this is the last frame that will be sent on this connection

Annotations
@Override
setRsvback to summary
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 org.xnio.channels.StreamSinkChannel, after that an IllegalStateException will be thrown.