Package org.red5.net.websocket.server

Class WsRemoteEndpointImplServer

java.lang.Object

org.apache.tomcat.websocket.WsRemoteEndpointImplBase

org.red5.net.websocket.server.WsRemoteEndpointImplServer

All Implemented Interfaces:

jakarta.websocket.RemoteEndpoint

public class WsRemoteEndpointImplServer
extends org.apache.tomcat.websocket.WsRemoteEndpointImplBase

This is the server side RemoteEndpoint implementation - i.e. what the server uses to send data to the client.

Author:

mondain

Nested Class Summary

Nested classes/interfaces inherited from interface jakarta.websocket.RemoteEndpoint

jakarta.websocket.RemoteEndpoint.Async, jakarta.websocket.RemoteEndpoint.Basic

Field Summary

Fields

Modifier and Type	Field	Description
protected static final jakarta.websocket.SendResult	SENDRESULT_OK	Constant SENDRESULT_OK

Fields inherited from class org.apache.tomcat.websocket.WsRemoteEndpointImplBase

messagePartInProgress, sm

Constructor Summary

Constructors

Constructor	Description
WsRemoteEndpointImplServer(org.apache.tomcat.util.net.SocketWrapperBase<?> socketWrapper, org.apache.coyote.http11.upgrade.UpgradeInfo upgradeInfo)	Constructor for WsRemoteEndpointImplServer.

Method Summary

Modifier and Type	Method	Description
protected void	doClose()
protected void	doWrite(jakarta.websocket.SendHandler handler, long blockingWriteTimeoutExpiry, ByteBuffer... buffers)
protected ReentrantLock	getLock()
protected long	getTimeoutExpiry()	Getter for the field timeoutExpiry.
protected final boolean	isMasked()
protected void	onTimeout(boolean useDispatch)	onTimeout.
void	onWritePossible(boolean useDispatch)	onWritePossible.
protected void	setTransformation(org.apache.tomcat.websocket.Transformation transformation)
protected void	updateStats(long payloadLength)

Methods inherited from class org.apache.tomcat.websocket.WsRemoteEndpointImplBase

acquireMessagePartInProgressSemaphore, close, flushBatch, getBatchingAllowed, getSendStream, getSendTimeout, getSendWriter, getSession, sendBytes, sendBytesByCompletion, sendBytesByFuture, sendObject, sendObjectByCompletion, sendObjectByFuture, sendPartialBytes, sendPartialString, sendPing, sendPong, sendString, sendStringByCompletion, sendStringByFuture, setBatchingAllowed, setEncoders, setSendTimeout, setSession

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SENDRESULT_OK

protected static final jakarta.websocket.SendResult SENDRESULT_OK

Constant SENDRESULT_OK

Constructor Details

WsRemoteEndpointImplServer

public WsRemoteEndpointImplServer(org.apache.tomcat.util.net.SocketWrapperBase<?> socketWrapper,
 org.apache.coyote.http11.upgrade.UpgradeInfo upgradeInfo)

Constructor for WsRemoteEndpointImplServer.

Parameters:

socketWrapper - a SocketWrapperBase object

upgradeInfo - a UpgradeInfo object

Method Details

isMasked

protected final boolean isMasked()

Specified by:

isMasked in class org.apache.tomcat.websocket.WsRemoteEndpointImplBase

doWrite

protected void doWrite(jakarta.websocket.SendHandler handler,
 long blockingWriteTimeoutExpiry,
 ByteBuffer... buffers)

Specified by:

doWrite in class org.apache.tomcat.websocket.WsRemoteEndpointImplBase

updateStats

protected void updateStats(long payloadLength)

Overrides:

updateStats in class org.apache.tomcat.websocket.WsRemoteEndpointImplBase

onWritePossible

public void onWritePossible(boolean useDispatch)

onWritePossible.

Parameters:

useDispatch - a boolean

doClose

protected void doClose()

Specified by:

doClose in class org.apache.tomcat.websocket.WsRemoteEndpointImplBase

getLock

protected ReentrantLock getLock()

Specified by:

getLock in class org.apache.tomcat.websocket.WsRemoteEndpointImplBase

getTimeoutExpiry

protected long getTimeoutExpiry()

Getter for the field timeoutExpiry.

Returns:

a long

onTimeout

protected void onTimeout(boolean useDispatch)

onTimeout.

Parameters:

useDispatch - a boolean

setTransformation

protected void setTransformation(org.apache.tomcat.websocket.Transformation transformation)

Overrides:

setTransformation in class org.apache.tomcat.websocket.WsRemoteEndpointImplBase