Class WsRemoteEndpointImplServer
- java.lang.Object
-
- org.apache.tomcat.websocket.WsRemoteEndpointImplBase
-
- org.apache.tomcat.websocket.server.WsRemoteEndpointImplServer
-
- All Implemented Interfaces:
RemoteEndpoint
public class WsRemoteEndpointImplServer extends WsRemoteEndpointImplBase
This is the server sideRemoteEndpointimplementation - i.e. what the server uses to send data to the client.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface javax.websocket.RemoteEndpoint
RemoteEndpoint.Async, RemoteEndpoint.Basic
-
-
Field Summary
-
Fields inherited from class org.apache.tomcat.websocket.WsRemoteEndpointImplBase
SENDRESULT_OK
-
-
Constructor Summary
Constructors Constructor Description WsRemoteEndpointImplServer(SocketWrapperBase<?> socketWrapper, UpgradeInfo upgradeInfo, WsServerContainer serverContainer)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voiddoClose()protected voiddoWrite(SendHandler handler, long blockingWriteTimeoutExpiry, ByteBuffer... buffers)protected longgetTimeoutExpiry()protected booleanisMasked()protected voidonTimeout(boolean useDispatch)voidonWritePossible(boolean useDispatch)protected voidsetTransformation(Transformation transformation)protected voidupdateStats(long payloadLength)Hook for updating server side statistics.-
Methods inherited from class org.apache.tomcat.websocket.WsRemoteEndpointImplBase
close, flushBatch, getBatchingAllowed, getSendStream, getSendTimeout, getSendWriter, sendBytes, sendBytesByCompletion, sendBytesByFuture, sendObject, sendObjectByCompletion, sendObjectByFuture, sendPartialBytes, sendPartialString, sendPing, sendPong, sendString, sendStringByCompletion, sendStringByFuture, setBatchingAllowed, setEncoders, setSendTimeout, setSession
-
-
-
-
Constructor Detail
-
WsRemoteEndpointImplServer
public WsRemoteEndpointImplServer(SocketWrapperBase<?> socketWrapper, UpgradeInfo upgradeInfo, WsServerContainer serverContainer)
-
-
Method Detail
-
isMasked
protected final boolean isMasked()
- Specified by:
isMaskedin classWsRemoteEndpointImplBase
-
doWrite
protected void doWrite(SendHandler handler, long blockingWriteTimeoutExpiry, ByteBuffer... buffers)
- Specified by:
doWritein classWsRemoteEndpointImplBase
-
updateStats
protected void updateStats(long payloadLength)
Description copied from class:WsRemoteEndpointImplBaseHook for updating server side statistics. Called on every frame written (including when batching is enabled and the frames are buffered locally until the buffer is full or is flushed).- Overrides:
updateStatsin classWsRemoteEndpointImplBase- Parameters:
payloadLength- Size of message payload
-
onWritePossible
public void onWritePossible(boolean useDispatch)
-
doClose
protected void doClose()
- Specified by:
doClosein classWsRemoteEndpointImplBase
-
getTimeoutExpiry
protected long getTimeoutExpiry()
-
onTimeout
protected void onTimeout(boolean useDispatch)
-
setTransformation
protected void setTransformation(Transformation transformation)
- Overrides:
setTransformationin classWsRemoteEndpointImplBase
-
-