Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	WsFrameBase.NoopTransformation For use by the client implementation that needs to obtain payload data without the need for unmasking.
protected static enum	WsFrameBase.ReadState WAITING - not suspended Server case: waiting for a notification that data is ready to be read from the socket, the socket is registered to the poller Client case: data has been read from the socket and is waiting for data to be processed PROCESSING - not suspended Server case: reading from the socket and processing the data Client case: processing the data if such has already been read and more data will be read from the socket SUSPENDING_WAIT - suspended, a call to suspend() was made while in WAITING state.
private static enum	WsFrameBase.State
private abstract static class	WsFrameBase.TerminalTransformation
private class	WsFrameBase.UnmaskTransformation For use by the server implementation that needs to obtain payload data and unmask it before any further processing.

Field Summary

Modifier and Type	Field and Description
private MessageHandler	binaryMsgHandler
private boolean	continuationExpected
private final ByteBuffer	controlBufferBinary
private final CharBuffer	controlBufferText
private boolean	fin
protected final ByteBuffer	inputBuffer
private final byte[]	mask
private int	maskIndex
private ByteBuffer	messageBufferBinary
private CharBuffer	messageBufferText
private byte	opCode
private volatile boolean	open
private long	payloadLength
private volatile long	payloadWritten
private static final AtomicReferenceFieldUpdater<WsFrameBase, WsFrameBase.ReadState>	READ_STATE_UPDATER
private volatile WsFrameBase.ReadState	readState
private int	rsv
private static final StringManager	sm
private volatile WsFrameBase.State	state
private boolean	textMessage
private MessageHandler	textMsgHandler
private final Transformation	transformation
private final CharsetDecoder	utf8DecoderControl
private final CharsetDecoder	utf8DecoderMessage
protected final WsSession	wsSession

Access	Constructor and Description
public	WsFrameBase(WsSession wsSession, Transformation transformation)

Method Summary

Modifier and Type	Method and Description
protected static long	byteArrayToLong(byte[] b, int start, int len)
protected void	changeReadState(WsFrameBase.ReadState newState)
protected boolean	changeReadState(WsFrameBase.ReadState oldState, WsFrameBase.ReadState newState)
private void	checkRoomHeaders()
private void	checkRoomPayload()
protected abstract Log	getLog()
protected WsFrameBase.ReadState	getReadState()
protected Transformation	getTransformation()
private void	handleThrowableOnSend(Throwable t)
protected abstract boolean	isMasked()
protected boolean	isOpen()
protected boolean	isSuspended()
private void	makeRoom()
private void	newFrame()
private void	newMessage()
private boolean	processData()
private boolean	processDataBinary()
private boolean	processDataControl()
private boolean	processDataText()
private boolean	Returns: `true` if sufficient data was present to process all of the initial header processInitialHeader()
protected void	processInputBuffer()
private boolean	Returns: `true` if sufficient data was present to complete the processing of the header processRemainingHeader()
public void	resume()
protected abstract void	resumeProcessing() This method will be invoked when the read operation is resumed.
protected void	sendMessageBinary(ByteBuffer msg, boolean last)
protected void	sendMessageText(boolean last)
public void	suspend()
private boolean	swallowInput()
protected void	updateStats(long Size of message payload payloadLength) Hook for updating server side statistics.
private boolean	usePartial()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

binaryMsgHandler	back to summary
private MessageHandler binaryMsgHandler

continuationExpected	back to summary
private boolean continuationExpected

controlBufferBinary	back to summary
private final ByteBuffer controlBufferBinary

controlBufferText	back to summary
private final CharBuffer controlBufferText

fin	back to summary
private boolean fin

inputBuffer	back to summary
protected final ByteBuffer inputBuffer

mask	back to summary
private final byte[] mask

maskIndex	back to summary
private int maskIndex

messageBufferBinary	back to summary
private ByteBuffer messageBufferBinary

messageBufferText	back to summary
private CharBuffer messageBufferText

opCode	back to summary
private byte opCode

open	back to summary
private volatile boolean open

payloadLength	back to summary
private long payloadLength

payloadWritten	back to summary
private volatile long payloadWritten

READ_STATE_UPDATER	back to summary
private static final AtomicReferenceFieldUpdater<WsFrameBase, WsFrameBase.ReadState> READ_STATE_UPDATER

readState	back to summary
private volatile WsFrameBase.ReadState readState

rsv	back to summary
private int rsv

sm	back to summary
private static final StringManager sm

state	back to summary
private volatile WsFrameBase.State state

textMessage	back to summary
private boolean textMessage

textMsgHandler	back to summary
private MessageHandler textMsgHandler

transformation	back to summary
private final Transformation transformation

utf8DecoderControl	back to summary
private final CharsetDecoder utf8DecoderControl

utf8DecoderMessage	back to summary
private final CharsetDecoder utf8DecoderMessage

wsSession	back to summary
protected final WsSession wsSession

WsFrameBase	back to summary
public WsFrameBase(WsSession wsSession, Transformation transformation)

Method Detail

byteArrayToLong	back to summary
protected static long byteArrayToLong(byte[] b, int start, int len) throws IOException

changeReadState	back to summary
protected void changeReadState(WsFrameBase.ReadState newState)

changeReadState	back to summary
protected boolean changeReadState(WsFrameBase.ReadState oldState, WsFrameBase.ReadState newState)

checkRoomHeaders	back to summary
private void checkRoomHeaders()

checkRoomPayload	back to summary
private void checkRoomPayload()

getLog	back to summary
protected abstract Log getLog()

getReadState	back to summary
protected WsFrameBase.ReadState getReadState()

getTransformation	back to summary
protected Transformation getTransformation()

handleThrowableOnSend	back to summary
private void handleThrowableOnSend(Throwable t) throws WsIOException

isMasked	back to summary
protected abstract boolean isMasked()

isOpen	back to summary
protected boolean isOpen()

isSuspended	back to summary
protected boolean isSuspended()

makeRoom	back to summary
private void makeRoom()

newFrame	back to summary
private void newFrame()

newMessage	back to summary
private void newMessage()

processData	back to summary
private boolean processData() throws IOException

processDataBinary	back to summary
private boolean processDataBinary() throws IOException

processDataControl	back to summary
private boolean processDataControl() throws IOException

processDataText	back to summary
private boolean processDataText() throws IOException

processInitialHeader	back to summary
private boolean processInitialHeader() throws IOException Returns:boolean `true` if sufficient data was present to process all of the initial header

processInputBuffer	back to summary
protected void processInputBuffer() throws IOException

processRemainingHeader	back to summary
private boolean processRemainingHeader() throws IOException Returns:boolean `true` if sufficient data was present to complete the processing of the header

resume	back to summary
public void resume()

resumeProcessing	back to summary
protected abstract void resumeProcessing() This method will be invoked when the read operation is resumed. As the suspend of the read operation can be invoked at any time, when implementing this method one should consider that there might still be data remaining into the internal buffers that needs to be processed before reading again from the socket.

sendMessageBinary	back to summary
protected void sendMessageBinary(ByteBuffer msg, boolean last) throws WsIOException Annotations @SuppressWarnings:unchecked

sendMessageText	back to summary
protected void sendMessageText(boolean last) throws WsIOException Annotations @SuppressWarnings:unchecked

suspend	back to summary
public void suspend()

swallowInput	back to summary
private boolean swallowInput()

updateStats

back to summary

protected void updateStats(long payloadLength)

Hook for updating server side statistics. Called on every frame received.

Parameters

payloadLength:long: Size of message payload

usePartial	back to summary
private boolean usePartial()

org.apache.tomcat.websocket back to summary

private final Class WsFrameBase.NoopTransformation

Class Inheritance

extends TerminalTransformation

java.lang.Object
org.apache.tomcat.websocket.WsFrameBase.TerminalTransformation
org.apache.tomcat.websocket.WsFrameBase.NoopTransformation

For use by the client implementation that needs to obtain payload data without the need for unmasking.

Constructor Summary

Access	Constructor and Description
private	NoopTransformation()

Method Summary

Modifier and Type	Method and Description
public TransformationResult	getMoreData(byte The opcode for the frame currently being processed opCode, boolean Is this the final frame in this WebSocket message? fin, int The reserved bits for the frame currently being processed rsv, ByteBuffer The buffer in which the data is to be written dest) Implements org.apache.tomcat.websocket.Transformation.getMoreData. Obtain more input data.
public List<MessagePart>	sendMessagePart(List<MessagePart> The list of messages to be transformed messageParts) Implements org.apache.tomcat.websocket.Transformation.sendMessagePart. Takes the provided list of messages, transforms them, passes the transformed list on to the next transformation (if any) and then returns the resulting list of message parts after all of the transformations have been applied.

Inherited from org.apache.tomcat.websocket.WsFrameBase.TerminalTransformation:: close getExtensionResponse setNext validateRsv validateRsvBits

Constructor Detail

NoopTransformation	back to summary
private NoopTransformation()

Method Detail

getMoreData

back to summary

public TransformationResult getMoreData(byte opCode, boolean fin, int rsv, ByteBuffer dest)

Implements org.apache.tomcat.websocket.Transformation.getMoreData.

Doc from org.apache.tomcat.websocket.Transformation.getMoreData.

Obtain more input data.

Parameters

opCode:byte: The opcode for the frame currently being processed
fin:boolean: Is this the final frame in this WebSocket message?
rsv:int: The reserved bits for the frame currently being processed
dest:ByteBuffer: The buffer in which the data is to be written

Returns:TransformationResult

The result of trying to read more data from the transform

Annotations

@Override

sendMessagePart

back to summary

public List<MessagePart> sendMessagePart(List<MessagePart> messageParts)

Implements org.apache.tomcat.websocket.Transformation.sendMessagePart.

Doc from org.apache.tomcat.websocket.Transformation.sendMessagePart.

Takes the provided list of messages, transforms them, passes the transformed list on to the next transformation (if any) and then returns the resulting list of message parts after all of the transformations have been applied.

Parameters

messageParts:List<MessagePart>: The list of messages to be transformed

Returns:List<MessagePart>

The list of messages after this any any subsequent transformations have been applied. The size of the returned list may be bigger or smaller than the size of the input list

Annotations

@Override

org.apache.tomcat.websocket back to summary

protected final Enum WsFrameBase.ReadState

Class Inheritance

extends Enum<WsFrameBase.ReadState>

java.lang.Object
java.lang.Enum
org.apache.tomcat.websocket.WsFrameBase.ReadState

WAITING            - not suspended
                     Server case: waiting for a notification that data is ready to be read from the socket, the
                                  socket is registered to the poller
                     Client case: data has been read from the socket and is waiting for data to be processed

PROCESSING         - not suspended
                     Server case: reading from the socket and processing the data
                     Client case: processing the data if such has already been read and more data will be read
                                  from the socket

SUSPENDING_WAIT    - suspended, a call to suspend() was made while in WAITING state. A call to resume() will do
                     nothing and will transition to WAITING state

SUSPENDING_PROCESS - suspended, a call to suspend() was made while in PROCESSING state. A call to resume() will
                     do nothing and will transition to PROCESSING state

SUSPENDED          - suspended
                     Server case: processing data finished (SUSPENDING_PROCESS) / a notification was received
                                  that data is ready to be read from the socket (SUSPENDING_WAIT), socket is not
                                  registered to the poller
                     Client case: processing data finished (SUSPENDING_PROCESS) / data has been read from the
                                  socket and is available for processing (SUSPENDING_WAIT)
                     A call to resume() will:
                     Server case: register the socket to the poller
                     Client case: resume data processing

CLOSING            - not suspended, a close will be sent


    resume           data to be        resume
    no action        processed         no action
 |---------------| |---------------| |----------|
 |               v |               v v          |
 |  |----------WAITING«--------PROCESSING----|  |
 |  |             ^   processing             |  |
 |  |             |   finished               |  |
 |  |             |                          |  |
 | suspend        |                     suspend |
 |  |             |                          |  |
 |  |          resume                        |  |
 |  |    register socket to poller (server)  |  |
 |  |    resume data processing (client)     |  |
 |  |             |                          |  |
 |  v             |                          v  |
SUSPENDING_WAIT   |                  SUSPENDING_PROCESS
 |                |                             |
 | data available |        processing finished  |
 |-------------»SUSPENDED«----------------------|

Field Summary

Modifier and Type	Field and Description
public static final WsFrameBase.ReadState	CLOSING
private final boolean	isSuspended
public static final WsFrameBase.ReadState	PROCESSING
public static final WsFrameBase.ReadState	SUSPENDED
public static final WsFrameBase.ReadState	SUSPENDING_PROCESS
public static final WsFrameBase.ReadState	SUSPENDING_WAIT
public static final WsFrameBase.ReadState	WAITING

Constructor Summary

Access	Constructor and Description
private	ReadState(boolean isSuspended)

Method Summary

Modifier and Type	Method and Description
public boolean	isSuspended()
public static WsFrameBase.ReadState	valueOf(String name)
public static WsFrameBase.ReadState[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CLOSING	back to summary
public static final WsFrameBase.ReadState CLOSING

isSuspended	back to summary
private final boolean isSuspended

PROCESSING	back to summary
public static final WsFrameBase.ReadState PROCESSING

SUSPENDED	back to summary
public static final WsFrameBase.ReadState SUSPENDED

SUSPENDING_PROCESS	back to summary
public static final WsFrameBase.ReadState SUSPENDING_PROCESS

SUSPENDING_WAIT	back to summary
public static final WsFrameBase.ReadState SUSPENDING_WAIT

WAITING	back to summary
public static final WsFrameBase.ReadState WAITING

Constructor Detail

ReadState	back to summary
private ReadState(boolean isSuspended)

Method Detail

isSuspended	back to summary
public boolean isSuspended()

valueOf	back to summary
public static WsFrameBase.ReadState valueOf(String name)

values	back to summary
public static WsFrameBase.ReadState[] values()

org.apache.tomcat.websocket back to summary

private final Enum WsFrameBase.State

Class Inheritance

extends Enum<WsFrameBase.State>

java.lang.Object
java.lang.Enum
org.apache.tomcat.websocket.WsFrameBase.State

Field Summary

Modifier and Type	Field and Description
public static final WsFrameBase.State	DATA
public static final WsFrameBase.State	NEW_FRAME
public static final WsFrameBase.State	PARTIAL_HEADER

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static WsFrameBase.State	valueOf(String name)
public static WsFrameBase.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DATA	back to summary
public static final WsFrameBase.State DATA

NEW_FRAME	back to summary
public static final WsFrameBase.State NEW_FRAME

PARTIAL_HEADER	back to summary
public static final WsFrameBase.State PARTIAL_HEADER

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static WsFrameBase.State valueOf(String name)

values	back to summary
public static WsFrameBase.State[] values()

org.apache.tomcat.websocket back to summary

private abstract Class WsFrameBase.TerminalTransformation

Class Inheritance

extends Object
implements Transformation

java.lang.Object
org.apache.tomcat.websocket.WsFrameBase.TerminalTransformation

All Implemented Interfaces

org.apache.tomcat.websocket.Transformation

Known Direct Subclasses

org.apache.tomcat.websocket.WsFrameBase.NoopTransformation, org.apache.tomcat.websocket.WsFrameBase.UnmaskTransformation

Constructor Summary

Access	Constructor and Description
private	TerminalTransformation()

Method Summary

Modifier and Type	Method and Description
public void	close() Implements org.apache.tomcat.websocket.Transformation.close. Clean-up any resources that were used by the transformation.
public Extension	getExtensionResponse() Implements org.apache.tomcat.websocket.Transformation.getExtensionResponse. Obtain the extension that describes the information to be returned to the client.
public void	setNext(Transformation The next transformation t) Implements org.apache.tomcat.websocket.Transformation.setNext. Sets the next transformation in the pipeline.
public boolean	validateRsv(int The RSV bits received as an int in the range zero to seven with RSV1 as the MSB and RSV3 as the LSB rsv, byte The opCode received opCode) Implements org.apache.tomcat.websocket.Transformation.validateRsv. Validates the RSV and opcode combination (assumed to have been extracted from a WebSocket Frame) for this extension.
public boolean	validateRsvBits(int The RSV bits marked as in use so far as an int in the range zero to seven with RSV1 as the MSB and RSV3 as the LSB i) Implements org.apache.tomcat.websocket.Transformation.validateRsvBits. Validate that the RSV bit(s) required by this transformation are not being used by another extension.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

TerminalTransformation	back to summary
private TerminalTransformation()

Method Detail

back to summary

public void close()

Implements org.apache.tomcat.websocket.Transformation.close.

Doc from org.apache.tomcat.websocket.Transformation.close.

Clean-up any resources that were used by the transformation.

Annotations

@Override

getExtensionResponse

back to summary

public Extension getExtensionResponse()

Implements org.apache.tomcat.websocket.Transformation.getExtensionResponse.

Doc from org.apache.tomcat.websocket.Transformation.getExtensionResponse.

Obtain the extension that describes the information to be returned to the client.

Returns:Extension

The extension information that describes the parameters that have been agreed for this transformation

Annotations

@Override

setNext

back to summary

public void setNext(Transformation t)

Implements org.apache.tomcat.websocket.Transformation.setNext.

Doc from org.apache.tomcat.websocket.Transformation.setNext.

Sets the next transformation in the pipeline.

Parameters

t:Transformation: The next transformation

Annotations

@Override

validateRsv back to summary

public boolean validateRsv(int rsv, byte opCode)

Implements org.apache.tomcat.websocket.Transformation.validateRsv.

Doc from org.apache.tomcat.websocket.Transformation.validateRsv.

Validates the RSV and opcode combination (assumed to have been extracted from a WebSocket Frame) for this extension. The implementation is expected to unset any RSV bits it has validated before passing the remaining RSV bits to the next transformation in the pipeline.

Anything other than a value of zero for rsv is invalid.

Parameters

rsv:int: The RSV bits received as an int in the range zero to seven with RSV1 as the MSB and RSV3 as the LSB
opCode:byte: The opCode received

Returns:boolean

true if the RSV is valid otherwise false

Annotations

@Override

validateRsvBits back to summary

public boolean validateRsvBits(int i)

Implements org.apache.tomcat.websocket.Transformation.validateRsvBits.

Doc from org.apache.tomcat.websocket.Transformation.validateRsvBits.

Validate that the RSV bit(s) required by this transformation are not being used by another extension. The implementation is expected to set any bits it requires before passing the set of in-use bits to the next transformation.

Parameters

i:int: The RSV bits marked as in use so far as an int in the range zero to seven with RSV1 as the MSB and RSV3 as the LSB

Returns:boolean

true if the combination of RSV bits used by the transformations in the pipeline do not conflict otherwise false

Annotations

@Override

org.apache.tomcat.websocket back to summary

private final Class WsFrameBase.UnmaskTransformation

Class Inheritance

extends TerminalTransformation

java.lang.Object
org.apache.tomcat.websocket.WsFrameBase.TerminalTransformation
org.apache.tomcat.websocket.WsFrameBase.UnmaskTransformation

For use by the server implementation that needs to obtain payload data and unmask it before any further processing.

Constructor Summary

Access	Constructor and Description
private	UnmaskTransformation()

Method Summary

Modifier and Type	Method and Description
public TransformationResult	getMoreData(byte The opcode for the frame currently being processed opCode, boolean Is this the final frame in this WebSocket message? fin, int The reserved bits for the frame currently being processed rsv, ByteBuffer The buffer in which the data is to be written dest) Implements org.apache.tomcat.websocket.Transformation.getMoreData. Obtain more input data.
public List<MessagePart>	sendMessagePart(List<MessagePart> The list of messages to be transformed messageParts) Implements org.apache.tomcat.websocket.Transformation.sendMessagePart. Takes the provided list of messages, transforms them, passes the transformed list on to the next transformation (if any) and then returns the resulting list of message parts after all of the transformations have been applied.

Inherited from org.apache.tomcat.websocket.WsFrameBase.TerminalTransformation:: close getExtensionResponse setNext validateRsv validateRsvBits

Constructor Detail

UnmaskTransformation	back to summary
private UnmaskTransformation()

Method Detail

getMoreData

back to summary

public TransformationResult getMoreData(byte opCode, boolean fin, int rsv, ByteBuffer dest)

Implements org.apache.tomcat.websocket.Transformation.getMoreData.

Doc from org.apache.tomcat.websocket.Transformation.getMoreData.

Obtain more input data.

Parameters

opCode:byte: The opcode for the frame currently being processed
fin:boolean: Is this the final frame in this WebSocket message?
rsv:int: The reserved bits for the frame currently being processed
dest:ByteBuffer: The buffer in which the data is to be written

Returns:TransformationResult

The result of trying to read more data from the transform

Annotations

@Override

sendMessagePart

back to summary

public List<MessagePart> sendMessagePart(List<MessagePart> messageParts)

Implements org.apache.tomcat.websocket.Transformation.sendMessagePart.

Doc from org.apache.tomcat.websocket.Transformation.sendMessagePart.

Parameters

messageParts:List<MessagePart>: The list of messages to be transformed

Returns:List<MessagePart>

The list of messages after this any any subsequent transformations have been applied. The size of the returned list may be bigger or smaller than the size of the input list

Annotations

@Override

public abstract Class WsFrameBase

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class WsFrameBase.NoopTransformation

Constructor Summary

Method Summary

Constructor Detail

Method Detail

protected final Enum WsFrameBase.ReadState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum WsFrameBase.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private abstract Class WsFrameBase.TerminalTransformation

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class WsFrameBase.UnmaskTransformation

Constructor Summary

Method Summary

Constructor Detail

Method Detail