Top Fields Constructors Methods
org.apache.tomcat.websocket.server

public Class WsFrameServer

extends WsFrameBase
Class Inheritance
Imports
java.io.EOFException, .IOException, java.nio.ByteBuffer, org.apache.coyote.http11.upgrade.UpgradeInfo, org.apache.juli.logging.Log, .LogFactory, org.apache.tomcat.util.net.AbstractEndpoint.Handler.SocketState, .SocketEvent, .SocketWrapperBase, org.apache.tomcat.util.res.StringManager, org.apache.tomcat.websocket.Transformation, .WsFrameBase, .WsIOException, .WsSession

Field Summary

Modifier and TypeField and Description
private final ClassLoader
applicationClassLoader

private final Log
log

private static final StringManager
sm

Hides org.apache.tomcat.websocket.WsFrameBase.sm.

private final SocketWrapperBase<?>
socketWrapper

private final UpgradeInfo
upgradeInfo

Inherited from org.apache.tomcat.websocket.WsFrameBase:
inputBufferwsSession

Constructor Summary

AccessConstructor and Description
public
WsFrameServer(SocketWrapperBase<?> socketWrapper, UpgradeInfo upgradeInfo, WsSession wsSession, Transformation transformation, ClassLoader applicationClassLoader)

Method Summary

Modifier and TypeMethod and Description
private AbstractEndpoint.Handler.SocketState
doOnDataAvailable()

protected Log
getLog()

Implements abstract org.apache.tomcat.websocket.WsFrameBase.getLog.

protected Transformation
getTransformation()

Overrides org.apache.tomcat.websocket.WsFrameBase.getTransformation.

protected boolean
isMasked()

Implements abstract org.apache.tomcat.websocket.WsFrameBase.isMasked.

protected boolean
isOpen()

Overrides org.apache.tomcat.websocket.WsFrameBase.isOpen.

pack-priv AbstractEndpoint.Handler.SocketState
notifyDataAvailable()

private void
onDataAvailable()

Called when there is data in the ServletInputStream to process.

protected void
resumeProcessing()

Implements abstract org.apache.tomcat.websocket.WsFrameBase.resumeProcessing.

This method will be invoked when the read operation is resumed.

protected void
sendMessageBinary(ByteBuffer msg, boolean last)

Overrides org.apache.tomcat.websocket.WsFrameBase.sendMessageBinary.

protected void
sendMessageText(boolean last)

Overrides org.apache.tomcat.websocket.WsFrameBase.sendMessageText.

protected void
updateStats(long
Size of message payload
payloadLength)

Overrides org.apache.tomcat.websocket.WsFrameBase.updateStats.

Hook for updating server side statistics.

Inherited from org.apache.tomcat.websocket.WsFrameBase:
byteArrayToLongchangeReadStatechangeReadStategetReadStateisSuspendedprocessInputBufferresumesuspend

Field Detail

applicationClassLoaderback to summary
private final ClassLoader applicationClassLoader
logback to summary
private final Log log
smback to summary
private static final StringManager sm

Hides org.apache.tomcat.websocket.WsFrameBase.sm.

socketWrapperback to summary
private final SocketWrapperBase<?> socketWrapper
upgradeInfoback to summary
private final UpgradeInfo upgradeInfo

Constructor Detail

WsFrameServerback to summary
public WsFrameServer(SocketWrapperBase<?> socketWrapper, UpgradeInfo upgradeInfo, WsSession wsSession, Transformation transformation, ClassLoader applicationClassLoader)

Method Detail

doOnDataAvailableback to summary
private AbstractEndpoint.Handler.SocketState doOnDataAvailable() throws IOException
getLogback to summary
protected Log getLog()

Implements abstract org.apache.tomcat.websocket.WsFrameBase.getLog.

Annotations
@Override
getTransformationback to summary
protected Transformation getTransformation()

Overrides org.apache.tomcat.websocket.WsFrameBase.getTransformation.

Annotations
@Override
isMaskedback to summary
protected boolean isMasked()

Implements abstract org.apache.tomcat.websocket.WsFrameBase.isMasked.

Annotations
@Override
isOpenback to summary
protected boolean isOpen()

Overrides org.apache.tomcat.websocket.WsFrameBase.isOpen.

Annotations
@Override
notifyDataAvailableback to summary
pack-priv AbstractEndpoint.Handler.SocketState notifyDataAvailable() throws IOException
onDataAvailableback to summary
private void onDataAvailable() throws IOException

Called when there is data in the ServletInputStream to process.

Exceptions
IOException:
if an I/O error occurs while processing the available data
resumeProcessingback to summary
protected void resumeProcessing()

Implements abstract org.apache.tomcat.websocket.WsFrameBase.resumeProcessing.

Doc from org.apache.tomcat.websocket.WsFrameBase.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.

Annotations
@Override
sendMessageBinaryback to summary
protected void sendMessageBinary(ByteBuffer msg, boolean last) throws WsIOException

Overrides org.apache.tomcat.websocket.WsFrameBase.sendMessageBinary.

Annotations
@Override
sendMessageTextback to summary
protected void sendMessageText(boolean last) throws WsIOException

Overrides org.apache.tomcat.websocket.WsFrameBase.sendMessageText.

Annotations
@Override
updateStatsback to summary
protected void updateStats(long payloadLength)

Overrides org.apache.tomcat.websocket.WsFrameBase.updateStats.

Doc from org.apache.tomcat.websocket.WsFrameBase.updateStats.

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

Parameters
payloadLength:long

Size of message payload

Annotations
@Override