Jetty 12.0.6 · org.eclipse.jetty.websocket.common.JettyWebSocketFrameHandler

Field Summary

Modifier and Type	Field and Description
private MessageSink	activeMessageSink
private MethodHandle	binaryHandle
private MessageSink	binarySink
private final Class<? extends MessageSink>	binarySinkClass
private MethodHandle	closeHandle
private final AtomicBoolean	closeNotified
private final WebSocketContainer	container
private final Object	endpointInstance
private MethodHandle	errorHandle
private MethodHandle	frameHandle
private final Logger	log
private final JettyWebSocketFrameHandlerMetadata	metadata
private MethodHandle	openHandle
private MethodHandle	pingHandle
private MethodHandle	pongHandle
private WebSocketSession	session
private MethodHandle	textHandle
private MessageSink	textSink
private final Class<? extends MessageSink>	textSinkClass
private UpgradeRequest	upgradeRequest
private UpgradeResponse	upgradeResponse

Constructor Summary

Access	Constructor and Description
public	JettyWebSocketFrameHandler(WebSocketContainer container, Object endpointInstance, JettyWebSocketFrameHandlerMetadata metadata)

Method Summary

Modifier and Type	Method and Description
private void	acceptFrame(Frame frame, Callback callback)
private void	autoDemand()
public static Throwable	convertCause(Throwable cause)
private static MessageSink	createMessageSink(Class<? extends MessageSink> sinkClass, WebSocketSession session, MethodHandle msgHandle, boolean autoDemanding)
public WebSocketSession	getSession()
public UpgradeRequest	getUpgradeRequest()
public UpgradeResponse	getUpgradeResponse()
private void	internalDemand()
pack-priv boolean	isAutoDemand()
private void	notifyOnClose(CloseStatus closeStatus, Callback callback)
private void	onBinaryFrame(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.
private void	onCloseFrame(Frame frame, Callback callback)
private void	onContinuationFrame(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. coreCallback) 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.
private void	onPingFrame(Frame frame, Callback callback)
private void	onPongFrame(Frame frame, Callback callback)
private void	onTextFrame(Frame frame, Callback callback)
public void	setUpgradeRequest(UpgradeRequest upgradeRequest)
public void	setUpgradeResponse(UpgradeResponse upgradeResponse)
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

Field Detail

activeMessageSink	back to summary
private MessageSink activeMessageSink

binaryHandle	back to summary
private MethodHandle binaryHandle

binarySink	back to summary
private MessageSink binarySink

binarySinkClass	back to summary
private final Class<? extends MessageSink> binarySinkClass

closeHandle	back to summary
private MethodHandle closeHandle

closeNotified	back to summary
private final AtomicBoolean closeNotified

container	back to summary
private final WebSocketContainer container

container

back to summary

private final WebSocketContainer container

endpointInstance	back to summary
private final Object endpointInstance

errorHandle	back to summary
private MethodHandle errorHandle

frameHandle	back to summary
private MethodHandle frameHandle

log	back to summary
private final Logger log

metadata	back to summary
private final JettyWebSocketFrameHandlerMetadata metadata

openHandle	back to summary
private MethodHandle openHandle

pingHandle	back to summary
private MethodHandle pingHandle

pongHandle	back to summary
private MethodHandle pongHandle

session	back to summary
private WebSocketSession session

textHandle	back to summary
private MethodHandle textHandle

textSink	back to summary
private MessageSink textSink

textSinkClass	back to summary
private final Class<? extends MessageSink> textSinkClass

upgradeRequest	back to summary
private UpgradeRequest upgradeRequest

upgradeResponse	back to summary
private UpgradeResponse upgradeResponse

Constructor Detail

JettyWebSocketFrameHandler	back to summary
public JettyWebSocketFrameHandler(WebSocketContainer container, Object endpointInstance, JettyWebSocketFrameHandlerMetadata metadata)

Method Detail

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

autoDemand	back to summary
private void autoDemand()

convertCause	back to summary
public static Throwable convertCause(Throwable cause)

createMessageSink	back to summary
private static MessageSink createMessageSink(Class<? extends MessageSink> sinkClass, WebSocketSession session, MethodHandle msgHandle, boolean autoDemanding)

getSession	back to summary
public WebSocketSession getSession()

getUpgradeRequest	back to summary
public UpgradeRequest getUpgradeRequest()

getUpgradeResponse	back to summary
public UpgradeResponse getUpgradeResponse()

internalDemand	back to summary
private void internalDemand()

isAutoDemand	back to summary
pack-priv boolean isAutoDemand()

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

onBinaryFrame	back to summary
private void onBinaryFrame(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

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

onContinuationFrame	back to summary
private void onContinuationFrame(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 coreCallback) 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. coreCallback:Callback the callback to indicate success or failure of the processing of this event. Annotations @Override

public void onFrame(Frame frame, Callback coreCallback)

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.
coreCallback: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

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

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

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

setUpgradeRequest	back to summary
public void setUpgradeRequest(UpgradeRequest upgradeRequest)

setUpgradeResponse	back to summary
public void setUpgradeResponse(UpgradeResponse upgradeResponse)

toString back to summary

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 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 JettyWebSocketFrameHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail