Class JettyWebSocketFrameHandler

java.lang.Object

org.eclipse.jetty.ee9.websocket.common.JettyWebSocketFrameHandler

All Implemented Interfaces:

FrameHandler, IncomingFrames

public class JettyWebSocketFrameHandler
extends Object
implements FrameHandler

Constructor Summary

Constructors

Constructor

Description

JettyWebSocketFrameHandler(WebSocketContainer container, Object endpointInstance, MethodHandle openHandle, MethodHandle closeHandle, MethodHandle errorHandle, MethodHandle textHandle, MethodHandle binaryHandle, Class<? extends MessageSink> textSinkClass, Class<? extends MessageSink> binarySinkClass, MethodHandle frameHandle, MethodHandle pingHandle, MethodHandle pongHandle, BatchMode batchMode, Configuration.Customizer customizer)

Method Summary

Modifier and Type	Method	Description
static Throwable	convertCause(Throwable cause)
BatchMode	getBatchMode()
WebSocketSession	getSession()
UpgradeRequest	getUpgradeRequest()
UpgradeResponse	getUpgradeResponse()
void	onClosed(CloseStatus closeStatus, Callback callback)	Invoked when a WebSocket close event happened.
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	resume()
void	setUpgradeRequest(UpgradeRequest upgradeRequest)
void	setUpgradeResponse(UpgradeResponse upgradeResponse)
void	suspend()
String	toString()

Methods inherited from class Object

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

Constructor Details

JettyWebSocketFrameHandler

public JettyWebSocketFrameHandler(WebSocketContainer container,
 Object endpointInstance,
 MethodHandle openHandle,
 MethodHandle closeHandle,
 MethodHandle errorHandle,
 MethodHandle textHandle,
 MethodHandle binaryHandle,
 Class<? extends MessageSink> textSinkClass,
 Class<? extends MessageSink> binarySinkClass,
 MethodHandle frameHandle,
 MethodHandle pingHandle,
 MethodHandle pongHandle,
 BatchMode batchMode,
 Configuration.Customizer customizer)

Method Details

setUpgradeRequest

public void setUpgradeRequest(UpgradeRequest upgradeRequest)

setUpgradeResponse

public void setUpgradeResponse(UpgradeResponse upgradeResponse)

getUpgradeRequest

public UpgradeRequest getUpgradeRequest()

getUpgradeResponse

public UpgradeResponse getUpgradeResponse()

getBatchMode

public BatchMode getBatchMode()

getSession

public WebSocketSession 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.

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.

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.

toString

public String toString()

Overrides:

toString in class Object

suspend

public void suspend()

resume

public void resume()

convertCause

public static Throwable convertCause(Throwable cause)