Tomcat 10.1.19 · org.apache.tomcat.websocket.WsRemoteEndpointImplBase

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	WsRemoteEndpointImplBase.BlockingSendHandler
private static class	WsRemoteEndpointImplBase.EncoderEntry
private static class	WsRemoteEndpointImplBase.EndMessageHandler Wraps the user provided handler so that the end point is notified when the message is complete.
private static class	WsRemoteEndpointImplBase.IntermediateMessageHandler If a transformation needs to split a `MessagePart` into multiple `MessagePart`s, it uses this handler as the end handler for each of the additional `MessagePart`s.
private static class	WsRemoteEndpointImplBase.OutputBufferFlushSendHandler Ensures that the output buffer is cleared after it has been flushed.
private static class	WsRemoteEndpointImplBase.OutputBufferSendHandler Used to write data to the output buffer, flushing the buffer if it fills up.
private static enum	WsRemoteEndpointImplBase.State
private static class	WsRemoteEndpointImplBase.StateMachine
private static class	WsRemoteEndpointImplBase.StateUpdateSendHandler
private class	WsRemoteEndpointImplBase.TextMessageSendHandler
private static class	WsRemoteEndpointImplBase.WsOutputStream
private static class	WsRemoteEndpointImplBase.WsWriter

Modifier and Type	Field and Description
private final AtomicBoolean	batchingAllowed
private volatile boolean	closed
private final CharsetEncoder	encoder
private final ByteBuffer	encoderBuffer
private List<WsRemoteEndpointImplBase.EncoderEntry>	encoderEntries
private boolean	fragmented
private final ByteBuffer	headerBuffer
private final WsRemoteEndpointImplBase.IntermediateMessageHandler	intermediateMessageHandler
private final Log	log
protected final Semaphore	messagePartInProgress
private final Object	messagePartLock
private final Queue<MessagePart>	messagePartQueue
private boolean	nextFragmented
private boolean	nextText
private final ByteBuffer	outputBuffer
protected static final SendResult	SENDRESULT_OK
private volatile long	sendTimeout
protected static final StringManager	sm
private final WsRemoteEndpointImplBase.StateMachine	stateMachine
private boolean	text
private Transformation	transformation
private WsSession	wsSession

Access	Constructor and Description
public	WsRemoteEndpointImplBase()

Method Summary

Modifier and Type	Method and Description
protected boolean	Returns: `true` if the semaphore is obtained, otherwise `false`. acquireMessagePartInProgressSemaphore(byte The OPCODE for the message to be written opCode, long The time when the attempt to acquire the semaphore should expire timeoutExpiry) Acquire the semaphore that allows a message part to be written.
public final void	close()
protected abstract void	doClose()
protected abstract void	doWrite(SendHandler handler, long blockingWriteTimeoutExpiry, ByteBuffer... data)
pack-priv void	endMessage(SendHandler handler, SendResult result)
private Encoder	findEncoder(Object obj)
public void	flushBatch() Implements jakarta.websocket.RemoteEndpoint.flushBatch. Flush any currently batched messages to the remote endpoint.
public boolean	getBatchingAllowed() Implements jakarta.websocket.RemoteEndpoint.getBatchingAllowed. Obtains the current batching status of the endpoint.
private long	getBlockingSendTimeout()
protected abstract Lock	getLock()
public OutputStream	getSendStream()
public long	getSendTimeout()
public Writer	getSendWriter()
private long	getTimeoutExpiry()
protected abstract boolean	isMasked()
public void	sendBytes(ByteBuffer data)
public void	sendBytesByCompletion(ByteBuffer data, SendHandler handler)
public Future<Void>	sendBytesByFuture(ByteBuffer data)
pack-priv void	sendMessageBlock(CharBuffer part, boolean last)
pack-priv void	sendMessageBlock(byte opCode, ByteBuffer payload, boolean last)
private void	sendMessageBlock(byte opCode, ByteBuffer payload, boolean last, long timeoutExpiry)
public void	sendObject(Object obj)
public void	sendObjectByCompletion(Object obj, SendHandler completion)
public Future<Void>	sendObjectByFuture(Object obj)
public void	sendPartialBytes(ByteBuffer partialByte, boolean last)
public void	sendPartialString(String fragment, boolean isLast)
public void	sendPing(ByteBuffer The payload for the ping message applicationData) Implements jakarta.websocket.RemoteEndpoint.sendPing. Send a ping message blocking until the message has been sent.
public void	sendPong(ByteBuffer The payload for the pong message applicationData) Implements jakarta.websocket.RemoteEndpoint.sendPong. Send a pong message blocking until the message has been sent.
public void	sendString(String text)
public void	sendStringByCompletion(String text, SendHandler handler)
public Future<Void>	sendStringByFuture(String text)
public void	setBatchingAllowed(boolean New setting batchingAllowed) Implements jakarta.websocket.RemoteEndpoint.setBatchingAllowed. Enable or disable the batching of outgoing messages for this endpoint.
protected void	setEncoders(EndpointConfig endpointConfig)
public void	setSendTimeout(long timeout)
protected void	setSession(WsSession wsSession)
protected void	setTransformation(Transformation transformation)
pack-priv void	startMessage(byte opCode, ByteBuffer payload, boolean last, SendHandler handler)
protected void	updateStats(long Size of message payload payloadLength) Hook for updating server side statistics.
private static void	writeHeader(ByteBuffer headerBuffer, boolean fin, int rsv, byte opCode, boolean masked, ByteBuffer payload, byte[] mask, boolean first)
pack-priv void	writeMessagePart(MessagePart mp)

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

public abstract Class WsRemoteEndpointImplBase

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary