Jetty 12.0.6 · org.eclipse.jetty.ee10.websocket.jakarta.common.JakartaWebSocketFrameHandler

Modifier and Type	Field and Description
private MessageSink	activeMessageSink
private JakartaWebSocketMessageMetadata	binaryMetadata
private MessageSink	binarySink
private MethodHandle	closeHandle
private final AtomicBoolean	closeNotified
private final JakartaWebSocketContainer	container
private CoreSession	coreSession
protected byte	dataType
private EndpointConfig	endpointConfig
private final Object	endpointInstance
private MethodHandle	errorHandle
private final AutoLock	lock
private final Logger	logger
private final Map<Byte, RegisteredMessageHandler>	messageHandlerMap
private MethodHandle	openHandle
private MethodHandle	pongHandle
private JakartaWebSocketSession	session
private JakartaWebSocketMessageMetadata	textMetadata
private MessageSink	textSink
private final UpgradeRequest	upgradeRequest

Access	Constructor and Description
public	JakartaWebSocketFrameHandler(JakartaWebSocketContainer container, UpgradeRequest upgradeRequest, Object endpointInstance, MethodHandle openHandle, MethodHandle closeHandle, MethodHandle errorHandle, JakartaWebSocketMessageMetadata textMetadata, JakartaWebSocketMessageMetadata binaryMetadata, MethodHandle pongHandle, EndpointConfig endpointConfig)

Method Summary

Modifier and Type	Method and Description
private void	acceptMessage(Frame frame, Callback callback)
public <T> void	addMessageHandler(Class<T> clazz, MessageHandler.Partial<T> handler)
public <T> void	addMessageHandler(Class<T> clazz, MessageHandler.Whole<T> handler)
private void	assertBasicTypeNotRegistered(byte basicWebSocketType, MessageHandler replacement)
private void	configListener(String key, Object value)
public JakartaWebSocketMessageMetadata	getBinaryMetadata()
public Object	getEndpoint()
public EndpointConfig	getEndpointConfig()
public Map<Byte, RegisteredMessageHandler>	getMessageHandlerMap()
public Set<MessageHandler>	getMessageHandlers()
public JakartaWebSocketSession	getSession()
public JakartaWebSocketMessageMetadata	getTextMetadata()
public UpgradeRequest	getUpgradeRequest()
private EndpointConfig	getWrappedEndpointConfig()
private void	notifyOnClose(CloseStatus closeStatus, Callback callback)
public void	onBinary(Frame frame, Callback callback)
public void	onClose(Frame frame, Callback callback)
public void	onClosed(CloseStatus the close status received from the remote peer, or generated locally in the case of abnormal closures. closeStatus, Callback the callback to indicate success or failure of the processing of this event. callback) Implements org.eclipse.jetty.websocket.core.FrameHandler.onClosed. Invoked when a WebSocket close event happened.
public void	onContinuation(Frame frame, Callback callback)
public void	onError(Throwable the error cause cause, Callback the callback to indicate success or failure of the processing of this event. callback) Implements org.eclipse.jetty.websocket.core.FrameHandler.onError. Invoked when an error has occurred or has been detected.
public void	onFrame(Frame the WebSocket frame. frame, Callback the callback to indicate success or failure of the processing of this event. callback) Implements org.eclipse.jetty.websocket.core.FrameHandler.onFrame. Invoked when a WebSocket frame is received.
public void	onOpen(CoreSession the session associated with this connection. coreSession, Callback the callback to indicate success or failure of the processing of this event. callback) Implements org.eclipse.jetty.websocket.core.FrameHandler.onOpen. Invoked when the WebSocket connection is opened.
public void	onPing(Frame frame, Callback callback)
public void	onPong(Frame frame, Callback callback)
public void	onText(Frame frame, Callback callback)
private void	registerMessageHandler(Class<?> clazz, MessageHandler handler, byte basicMessageType, JakartaWebSocketMessageMetadata metadata)
private <T> MessageSink	registerMessageHandler(byte basicWebSocketMessageType, Class<T> handlerType, MessageHandler handler, MessageSink messageSink)
public void	removeMessageHandler(MessageHandler handler)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

activeMessageSink	back to summary
private MessageSink activeMessageSink

binarySink	back to summary
private MessageSink binarySink

closeHandle	back to summary
private MethodHandle closeHandle

closeNotified	back to summary
private final AtomicBoolean closeNotified

container	back to summary
private final JakartaWebSocketContainer container

coreSession	back to summary
private CoreSession coreSession

dataType	back to summary
protected byte dataType

endpointConfig	back to summary
private EndpointConfig endpointConfig

endpointInstance	back to summary
private final Object endpointInstance

errorHandle	back to summary
private MethodHandle errorHandle

lock	back to summary
private final AutoLock lock

logger	back to summary
private final Logger logger

messageHandlerMap	back to summary
private final Map<Byte, RegisteredMessageHandler> messageHandlerMap

openHandle	back to summary
private MethodHandle openHandle

pongHandle	back to summary
private MethodHandle pongHandle

session	back to summary
private JakartaWebSocketSession session

textSink	back to summary
private MessageSink textSink

upgradeRequest	back to summary
private final UpgradeRequest upgradeRequest

Method Detail

acceptMessage	back to summary
private void acceptMessage(Frame frame, Callback callback)

addMessageHandler	back to summary
public <T> void addMessageHandler(Class<T> clazz, MessageHandler.Partial<T> handler)

addMessageHandler	back to summary
public <T> void addMessageHandler(Class<T> clazz, MessageHandler.Whole<T> handler)

assertBasicTypeNotRegistered	back to summary
private void assertBasicTypeNotRegistered(byte basicWebSocketType, MessageHandler replacement)

configListener	back to summary
private void configListener(String key, Object value)

getBinaryMetadata	back to summary
public JakartaWebSocketMessageMetadata getBinaryMetadata()

getEndpoint	back to summary
public Object getEndpoint()

getEndpointConfig	back to summary
public EndpointConfig getEndpointConfig()

getMessageHandlerMap	back to summary
public Map<Byte, RegisteredMessageHandler> getMessageHandlerMap()

getMessageHandlers	back to summary
public Set<MessageHandler> getMessageHandlers()

getSession	back to summary
public JakartaWebSocketSession getSession()

getTextMetadata	back to summary
public JakartaWebSocketMessageMetadata getTextMetadata()

getUpgradeRequest	back to summary
public UpgradeRequest getUpgradeRequest()

getWrappedEndpointConfig	back to summary
private EndpointConfig getWrappedEndpointConfig()

notifyOnClose	back to summary
private void notifyOnClose(CloseStatus closeStatus, Callback callback)

onBinary	back to summary
public void onBinary(Frame frame, Callback callback)

onClose	back to summary
public void onClose(Frame frame, Callback callback)

onClosed	back to summary
public void onClosed(CloseStatus closeStatus, Callback callback) Implements org.eclipse.jetty.websocket.core.FrameHandler.onClosed. Doc from org.eclipse.jetty.websocket.core.FrameHandler.onClosed. Invoked when a WebSocket close event happened. The WebSocket connection is closed, no reading or writing is possible anymore. Implementations of this method may cleanup resources that have been allocated. This method will not be called more than once. Parameters closeStatus:CloseStatus the close status received from the remote peer, or generated locally in the case of abnormal closures. callback:Callback the callback to indicate success or failure of the processing of this event. Annotations @Override

onClosed

back to summary

public void onClosed(CloseStatus closeStatus, Callback callback)

Implements org.eclipse.jetty.websocket.core.FrameHandler.onClosed.

Doc from org.eclipse.jetty.websocket.core.FrameHandler.onClosed.

Invoked when a WebSocket close event happened.

The WebSocket connection is closed, no reading or writing is possible anymore.

Implementations of this method may cleanup resources that have been allocated.

This method will not be called more than once.

Parameters

closeStatus:CloseStatus: the close status received from the remote peer, or generated locally in the case of abnormal closures.
callback:Callback: the callback to indicate success or failure of the processing of this event.

Annotations

@Override

onContinuation	back to summary
public void onContinuation(Frame frame, Callback callback)

onError back to summary

onError	back to summary
public void onError(Throwable cause, Callback callback) Implements org.eclipse.jetty.websocket.core.FrameHandler.onError. Doc from org.eclipse.jetty.websocket.core.FrameHandler.onError. Invoked when an error has occurred or has been detected. A call to this method will be followed by a call to `onClosed(CloseStatus, Callback)` with the close status derived from the error. This method will not be called more than once, `onClosed(CloseStatus, Callback)` will be called on the callback completion. Parameters cause:Throwable the error cause callback:Callback the callback to indicate success or failure of the processing of this event. Annotations @Override

public void onError(Throwable cause, Callback callback)

Implements org.eclipse.jetty.websocket.core.FrameHandler.onError.

Doc from org.eclipse.jetty.websocket.core.FrameHandler.onError.

Invoked when an error has occurred or has been detected.

A call to this method will be followed by a call to onClosed(CloseStatus, Callback) with the close status derived from the error.

This method will not be called more than once, onClosed(CloseStatus, Callback) will be called on the callback completion.

Parameters

cause:Throwable: the error cause
callback:Callback: the callback to indicate success or failure of the processing of this event.

Annotations

@Override

onFrame back to summary

onFrame	back to summary
public void onFrame(Frame frame, Callback callback) Implements org.eclipse.jetty.websocket.core.FrameHandler.onFrame. Doc from org.eclipse.jetty.websocket.core.FrameHandler.onFrame. Invoked when a WebSocket frame is received. This method will never be called concurrently for the same session; will be called sequentially to satisfy the outstanding demand signaled by calls to `CoreSession#demand()`. Both control and data frames are passed to this method. CLOSE frames may be responded from this method, but if they are not responded, then the implementation will respond when the callback is completed. The callback argument must be completed to indicate that the buffers associated with the frame can be recycled. Additional WebSocket frames (of any type, including CLOSE frames) cannot be received until a call to `CoreSession#demand()` is made. Parameters frame:Frame the WebSocket frame. callback:Callback the callback to indicate success or failure of the processing of this event. Annotations @Override

public void onFrame(Frame frame, Callback callback)

Implements org.eclipse.jetty.websocket.core.FrameHandler.onFrame.

Doc from org.eclipse.jetty.websocket.core.FrameHandler.onFrame.

Invoked when a WebSocket frame is received.

This method will never be called concurrently for the same session; will be called sequentially to satisfy the outstanding demand signaled by calls to CoreSession#demand().

Both control and data frames are passed to this method.

CLOSE frames may be responded from this method, but if they are not responded, then the implementation will respond when the callback is completed.

The callback argument must be completed to indicate that the buffers associated with the frame can be recycled.

Additional WebSocket frames (of any type, including CLOSE frames) cannot be received until a call to CoreSession#demand() is made.

Parameters

frame:Frame: the WebSocket frame.
callback:Callback: the callback to indicate success or failure of the processing of this event.

Annotations

@Override

onOpen back to summary

onOpen	back to summary
public void onOpen(CoreSession coreSession, Callback callback) Implements org.eclipse.jetty.websocket.core.FrameHandler.onOpen. Doc from org.eclipse.jetty.websocket.core.FrameHandler.onOpen. Invoked when the WebSocket connection is opened. It is allowed to send WebSocket frames via `CoreSession#sendFrame(Frame, Callback, boolean)`. WebSocket frames cannot be received until a call to `CoreSession#demand()` is made. If the callback argument is failed, the implementation sends a CLOSE frame with `CloseStatus#SERVER_ERROR`, and the connection will be closed. Parameters coreSession:CoreSession the session associated with this connection. callback:Callback the callback to indicate success or failure of the processing of this event. Annotations @Override

public void onOpen(CoreSession coreSession, Callback callback)

Implements org.eclipse.jetty.websocket.core.FrameHandler.onOpen.

Doc from org.eclipse.jetty.websocket.core.FrameHandler.onOpen.

Invoked when the WebSocket connection is opened.

It is allowed to send WebSocket frames via CoreSession#sendFrame(Frame, Callback, boolean).

WebSocket frames cannot be received until a call to CoreSession#demand() is made.

If the callback argument is failed, the implementation sends a CLOSE frame with CloseStatus#SERVER_ERROR, and the connection will be closed.

Parameters

coreSession:CoreSession: the session associated with this connection.
callback:Callback: the callback to indicate success or failure of the processing of this event.

Annotations

@Override

onPing	back to summary
public void onPing(Frame frame, Callback callback)

onPong	back to summary
public void onPong(Frame frame, Callback callback)

onText	back to summary
public void onText(Frame frame, Callback callback)

registerMessageHandler	back to summary
private void registerMessageHandler(Class<?> clazz, MessageHandler handler, byte basicMessageType, JakartaWebSocketMessageMetadata metadata)

registerMessageHandler	back to summary
private <T> MessageSink registerMessageHandler(byte basicWebSocketMessageType, Class<T> handlerType, MessageHandler handler, MessageSink messageSink)

removeMessageHandler	back to summary
public void removeMessageHandler(MessageHandler handler)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object

public Class JakartaWebSocketFrameHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail