Package org.apache.tomcat.websocket
Class WsRemoteEndpointImplBase
- java.lang.Object
-
- org.apache.tomcat.websocket.WsRemoteEndpointImplBase
-
- All Implemented Interfaces:
RemoteEndpoint
- Direct Known Subclasses:
WsRemoteEndpointImplClient,WsRemoteEndpointImplServer
public abstract class WsRemoteEndpointImplBase extends java.lang.Object implements RemoteEndpoint
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface jakarta.websocket.RemoteEndpoint
RemoteEndpoint.Async, RemoteEndpoint.Basic
-
-
Field Summary
Fields Modifier and Type Field Description protected static SendResultSENDRESULT_OKprotected static StringManagersm
-
Constructor Summary
Constructors Constructor Description WsRemoteEndpointImplBase()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voidclose()protected abstract voiddoClose()protected abstract voiddoWrite(SendHandler handler, long blockingWriteTimeoutExpiry, java.nio.ByteBuffer... data)voidflushBatch()Flush any currently batched messages to the remote endpoint.booleangetBatchingAllowed()Obtains the current batching status of the endpoint.java.io.OutputStreamgetSendStream()longgetSendTimeout()java.io.WritergetSendWriter()protected abstract booleanisMasked()voidsendBytes(java.nio.ByteBuffer data)voidsendBytesByCompletion(java.nio.ByteBuffer data, SendHandler handler)java.util.concurrent.Future<java.lang.Void>sendBytesByFuture(java.nio.ByteBuffer data)voidsendObject(java.lang.Object obj)voidsendObjectByCompletion(java.lang.Object obj, SendHandler completion)java.util.concurrent.Future<java.lang.Void>sendObjectByFuture(java.lang.Object obj)voidsendPartialBytes(java.nio.ByteBuffer partialByte, boolean last)voidsendPartialString(java.lang.String fragment, boolean isLast)voidsendPing(java.nio.ByteBuffer applicationData)Send a ping message blocking until the message has been sent.voidsendPong(java.nio.ByteBuffer applicationData)Send a pong message blocking until the message has been sent.voidsendString(java.lang.String text)voidsendStringByCompletion(java.lang.String text, SendHandler handler)java.util.concurrent.Future<java.lang.Void>sendStringByFuture(java.lang.String text)voidsetBatchingAllowed(boolean batchingAllowed)Enable or disable the batching of outgoing messages for this endpoint.protected voidsetEncoders(EndpointConfig endpointConfig)voidsetSendTimeout(long timeout)protected voidsetSession(WsSession wsSession)protected voidsetTransformation(Transformation transformation)protected voidupdateStats(long payloadLength)Hook for updating server side statistics.
-
-
-
Field Detail
-
sm
protected static final StringManager sm
-
SENDRESULT_OK
protected static final SendResult SENDRESULT_OK
-
-
Method Detail
-
setTransformation
protected void setTransformation(Transformation transformation)
-
getSendTimeout
public long getSendTimeout()
-
setSendTimeout
public void setSendTimeout(long timeout)
-
setBatchingAllowed
public void setBatchingAllowed(boolean batchingAllowed) throws java.io.IOExceptionDescription copied from interface:jakarta.websocket.RemoteEndpointEnable or disable the batching of outgoing messages for this endpoint. If batching is disabled when it was previously enabled then this method will block until any currently batched messages have been written.- Specified by:
setBatchingAllowedin interfaceRemoteEndpoint- Parameters:
batchingAllowed- New setting- Throws:
java.io.IOException- If changing the value resulted in a call toRemoteEndpoint.flushBatch()and that call threw anIOException.
-
getBatchingAllowed
public boolean getBatchingAllowed()
Description copied from interface:jakarta.websocket.RemoteEndpointObtains the current batching status of the endpoint.- Specified by:
getBatchingAllowedin interfaceRemoteEndpoint- Returns:
trueif batching is enabled, otherwisefalse.
-
flushBatch
public void flushBatch() throws java.io.IOExceptionDescription copied from interface:jakarta.websocket.RemoteEndpointFlush any currently batched messages to the remote endpoint. This method will block until the flush completes.- Specified by:
flushBatchin interfaceRemoteEndpoint- Throws:
java.io.IOException- If an I/O error occurs while flushing
-
sendBytes
public void sendBytes(java.nio.ByteBuffer data) throws java.io.IOException- Throws:
java.io.IOException
-
sendBytesByFuture
public java.util.concurrent.Future<java.lang.Void> sendBytesByFuture(java.nio.ByteBuffer data)
-
sendBytesByCompletion
public void sendBytesByCompletion(java.nio.ByteBuffer data, SendHandler handler)
-
sendPartialBytes
public void sendPartialBytes(java.nio.ByteBuffer partialByte, boolean last) throws java.io.IOException- Throws:
java.io.IOException
-
sendPing
public void sendPing(java.nio.ByteBuffer applicationData) throws java.io.IOException, java.lang.IllegalArgumentExceptionDescription copied from interface:jakarta.websocket.RemoteEndpointSend a ping message blocking until the message has been sent. Note that if a message is in the process of being sent asynchronously, this method will block until that message and this ping has been sent.- Specified by:
sendPingin interfaceRemoteEndpoint- Parameters:
applicationData- The payload for the ping message- Throws:
java.io.IOException- If an I/O error occurs while sending the pingjava.lang.IllegalArgumentException- if the applicationData is too large for a control message (max 125 bytes)
-
sendPong
public void sendPong(java.nio.ByteBuffer applicationData) throws java.io.IOException, java.lang.IllegalArgumentExceptionDescription copied from interface:jakarta.websocket.RemoteEndpointSend a pong message blocking until the message has been sent. Note that if a message is in the process of being sent asynchronously, this method will block until that message and this pong has been sent.- Specified by:
sendPongin interfaceRemoteEndpoint- Parameters:
applicationData- The payload for the pong message- Throws:
java.io.IOException- If an I/O error occurs while sending the pongjava.lang.IllegalArgumentException- if the applicationData is too large for a control message (max 125 bytes)
-
sendString
public void sendString(java.lang.String text) throws java.io.IOException- Throws:
java.io.IOException
-
sendStringByFuture
public java.util.concurrent.Future<java.lang.Void> sendStringByFuture(java.lang.String text)
-
sendStringByCompletion
public void sendStringByCompletion(java.lang.String text, SendHandler handler)
-
sendPartialString
public void sendPartialString(java.lang.String fragment, boolean isLast) throws java.io.IOException- Throws:
java.io.IOException
-
getSendStream
public java.io.OutputStream getSendStream()
-
getSendWriter
public java.io.Writer getSendWriter()
-
updateStats
protected void updateStats(long payloadLength)
Hook 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).- Parameters:
payloadLength- Size of message payload
-
sendObject
public void sendObject(java.lang.Object obj) throws java.io.IOException, EncodeException- Throws:
java.io.IOExceptionEncodeException
-
sendObjectByFuture
public java.util.concurrent.Future<java.lang.Void> sendObjectByFuture(java.lang.Object obj)
-
sendObjectByCompletion
public void sendObjectByCompletion(java.lang.Object obj, SendHandler completion)
-
setSession
protected void setSession(WsSession wsSession)
-
setEncoders
protected void setEncoders(EndpointConfig endpointConfig) throws DeploymentException
- Throws:
DeploymentException
-
close
public final void close()
-
doWrite
protected abstract void doWrite(SendHandler handler, long blockingWriteTimeoutExpiry, java.nio.ByteBuffer... data)
-
isMasked
protected abstract boolean isMasked()
-
doClose
protected abstract void doClose()
-
-