Package org.eclipse.jetty.ee10.websocket.jakarta.common

Class JakartaWebSocketFrameHandler

java.lang.Object

org.eclipse.jetty.ee10.websocket.jakarta.common.JakartaWebSocketFrameHandler

All Implemented Interfaces:

FrameHandler, IncomingFrames

public class JakartaWebSocketFrameHandler
extends Object
implements FrameHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected byte	dataType

Constructor Summary

Constructors

Constructor	Description
JakartaWebSocketFrameHandler(JakartaWebSocketContainer container, UpgradeRequest upgradeRequest, Object endpointInstance, MethodHandle openHandle, MethodHandle closeHandle, MethodHandle errorHandle, JakartaWebSocketMessageMetadata textMetadata, JakartaWebSocketMessageMetadata binaryMetadata, MethodHandle pongHandle, jakarta.websocket.EndpointConfig endpointConfig)

Method Summary

Modifier and Type	Method	Description
<T> void	addMessageHandler(Class<T> clazz, jakarta.websocket.MessageHandler.Partial<T> handler)
<T> void	addMessageHandler(Class<T> clazz, jakarta.websocket.MessageHandler.Whole<T> handler)
JakartaWebSocketMessageMetadata	getBinaryMetadata()
Object	getEndpoint()
jakarta.websocket.EndpointConfig	getEndpointConfig()
Map<Byte,RegisteredMessageHandler>	getMessageHandlerMap()
Set<jakarta.websocket.MessageHandler>	getMessageHandlers()
JakartaWebSocketSession	getSession()
JakartaWebSocketMessageMetadata	getTextMetadata()
UpgradeRequest	getUpgradeRequest()
void	onBinary(Frame frame, Callback callback)
void	onClose(Frame frame, Callback callback)
void	onClosed(CloseStatus closeStatus, Callback callback)	Invoked when a WebSocket close event happened.
void	onContinuation(Frame frame, Callback callback)
void	onError(Throwable cause, Callback callback)	Invoked when an error has occurred or has been detected.
void	onFrame(Frame frame, Callback callback)	Invoked when a WebSocket frame is received.
void	onOpen(CoreSession coreSession, Callback callback)	Invoked when the WebSocket connection is opened.
void	onPing(Frame frame, Callback callback)
void	onPong(Frame frame, Callback callback)
void	onText(Frame frame, Callback callback)
void	removeMessageHandler(jakarta.websocket.MessageHandler handler)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

dataType

protected byte dataType

Constructor Details

JakartaWebSocketFrameHandler

public JakartaWebSocketFrameHandler(JakartaWebSocketContainer container,
 UpgradeRequest upgradeRequest,
 Object endpointInstance,
 MethodHandle openHandle,
 MethodHandle closeHandle,
 MethodHandle errorHandle,
 JakartaWebSocketMessageMetadata textMetadata,
 JakartaWebSocketMessageMetadata binaryMetadata,
 MethodHandle pongHandle,
 jakarta.websocket.EndpointConfig endpointConfig)

Method Details

getEndpoint

public Object getEndpoint()

getEndpointConfig

public jakarta.websocket.EndpointConfig getEndpointConfig()

getSession

public JakartaWebSocketSession getSession()

onOpen

public void onOpen(CoreSession coreSession,
 Callback callback)

Description copied from interface: FrameHandler

Invoked when the WebSocket connection is opened.

It is allowed to send WebSocket frames via OutgoingFrames.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.

Specified by:

onOpen in interface FrameHandler

Parameters:

coreSession - the session associated with this connection.

callback - the callback to indicate success or failure of the processing of this event.

onFrame

public void onFrame(Frame frame,
 Callback callback)

Description copied from interface: FrameHandler

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.

Specified by:

onFrame in interface FrameHandler

Specified by:

onFrame in interface IncomingFrames

Parameters:

frame - the WebSocket frame.

callback - the callback to indicate success or failure of the processing of this event.

onClose

public void onClose(Frame frame,
 Callback callback)

onClosed

public void onClosed(CloseStatus closeStatus,
 Callback callback)

Description copied from interface: FrameHandler

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.

Specified by:

onClosed in interface FrameHandler

Parameters:

closeStatus - the close status received from the remote peer, or generated locally in the case of abnormal closures.

callback - the callback to indicate success or failure of the processing of this event.

onError

public void onError(Throwable cause,
 Callback callback)

Description copied from interface: FrameHandler

Invoked when an error has occurred or has been detected.

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

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

Specified by:

onError in interface FrameHandler

Parameters:

cause - the error cause

callback - the callback to indicate success or failure of the processing of this event.

getMessageHandlers

public Set<jakarta.websocket.MessageHandler> getMessageHandlers()

getMessageHandlerMap

public Map<Byte,RegisteredMessageHandler> getMessageHandlerMap()

getBinaryMetadata

public JakartaWebSocketMessageMetadata getBinaryMetadata()

getTextMetadata

public JakartaWebSocketMessageMetadata getTextMetadata()

addMessageHandler

public <T> void addMessageHandler(Class<T> clazz,
 jakarta.websocket.MessageHandler.Partial<T> handler)

addMessageHandler

public <T> void addMessageHandler(Class<T> clazz,
 jakarta.websocket.MessageHandler.Whole<T> handler)

removeMessageHandler

public void removeMessageHandler(jakarta.websocket.MessageHandler handler)

toString

public String toString()

Overrides:

toString in class Object

onPing

public void onPing(Frame frame,
 Callback callback)

onPong

public void onPong(Frame frame,
 Callback callback)

onText

public void onText(Frame frame,
 Callback callback)

onBinary

public void onBinary(Frame frame,
 Callback callback)

onContinuation

public void onContinuation(Frame frame,
 Callback callback)

getUpgradeRequest

public UpgradeRequest getUpgradeRequest()