Jetty 12.0.6 · org.eclipse.jetty.websocket.core.internal.MessageHandler

Modifier and Type	Field and Description
private ByteArrayOutputStream	binaryMessageBuffer
private CoreSession	coreSession
private byte	dataType
private static final Logger	LOG
private Utf8StringBuilder	textMessageBuffer

Access	Constructor and Description
public	MessageHandler()

Method Summary

Modifier and Type	Method and Description
public static MessageHandler	from(Consumer<String> onText, Consumer<ByteBuffer> onBinary)
private ByteArrayOutputStream	getBinaryMessageBuffer()
public CoreSession	getCoreSession()
private Utf8StringBuilder	getTextMessageBuffer()
protected void	onBinary(ByteBuffer The binary payload message, Callback The callback to signal completion of handling. callback) Method called when a complete binary message is received.
protected 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.
protected void	onCloseFrame(Frame frame, Callback callback)
protected 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. 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.
protected void	onPingFrame(Frame frame, Callback callback)
protected void	onPongFrame(Frame frame, Callback callback)
protected void	onText(String the received text payload message, Callback The callback to signal completion of handling. callback) Method called when a complete text message is received.
protected void	onTextFrame(Frame frame, Callback callback)
public void	sendBinary(ByteBuffer The message to send message, Callback The callback to call when the send is complete callback, boolean The batch mode to send the frames in. batch) Send a ByteBuffer as a single binary frame.
public void	sendBinary(Callback The callback to call when the send is complete callback, boolean The batch mode to send the frames in. batch, final ByteBuffer... The parts of the message. parts) Send a sequence of ByteBuffers as a sequences for fragmented text frame.
public void	sendText(String The message to send message, Callback The callback to call when the send is complete callback, boolean The batch mode to send the frames in. batch) Send a String as a single text frame.
public void	sendText(Callback The callback to call when the send is complete callback, boolean The batch mode to send the frames in. batch, final String... The parts of the message. parts) Send a sequence of Strings as a sequences for fragmented text frame.

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

binaryMessageBuffer	back to summary
private ByteArrayOutputStream binaryMessageBuffer

coreSession	back to summary
private CoreSession coreSession

dataType	back to summary
private byte dataType

LOG	back to summary
private static final Logger LOG

textMessageBuffer	back to summary
private Utf8StringBuilder textMessageBuffer

MessageHandler	back to summary
public MessageHandler()

Method Detail

from	back to summary
public static MessageHandler from(Consumer<String> onText, Consumer<ByteBuffer> onBinary)

getBinaryMessageBuffer	back to summary
private ByteArrayOutputStream getBinaryMessageBuffer()

getCoreSession	back to summary
public CoreSession getCoreSession()

getTextMessageBuffer	back to summary
private Utf8StringBuilder getTextMessageBuffer()

onBinary	back to summary
protected void onBinary(ByteBuffer message, Callback callback) Method called when a complete binary message is received. Parameters message:ByteBuffer The binary payload callback:Callback The callback to signal completion of handling.

onBinary

back to summary

protected void onBinary(ByteBuffer message, Callback callback)

Method called when a complete binary message is received.

Parameters

message:ByteBuffer: The binary payload
callback:Callback: The callback to signal completion of handling.

onBinaryFrame	back to summary
protected 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
protected void onCloseFrame(Frame frame, Callback callback)

onContinuationFrame	back to summary
protected 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 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

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

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

onText	back to summary
protected void onText(String message, Callback callback) Method called when a complete text message is received. Parameters message:String the received text payload callback:Callback The callback to signal completion of handling.

onText

back to summary

protected void onText(String message, Callback callback)

Method called when a complete text message is received.

Parameters

message:String: the received text payload
callback:Callback: The callback to signal completion of handling.

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

sendBinary	back to summary
public void sendBinary(ByteBuffer message, Callback callback, boolean batch) Send a ByteBuffer as a single binary frame. Parameters message:ByteBuffer The message to send callback:Callback The callback to call when the send is complete batch:boolean The batch mode to send the frames in.

sendBinary

back to summary

public void sendBinary(ByteBuffer message, Callback callback, boolean batch)

Send a ByteBuffer as a single binary frame.

Parameters

message:ByteBuffer: The message to send
callback:Callback: The callback to call when the send is complete
batch:boolean: The batch mode to send the frames in.

sendBinary	back to summary
public void sendBinary(Callback callback, boolean batch, final ByteBuffer... parts) Send a sequence of ByteBuffers as a sequences for fragmented text frame. Parameters callback:Callback The callback to call when the send is complete batch:boolean The batch mode to send the frames in. parts:ByteBuffer[] The parts of the message.

sendBinary

back to summary

public void sendBinary(Callback callback, boolean batch, final ByteBuffer... parts)

Send a sequence of ByteBuffers as a sequences for fragmented text frame.

Parameters

callback:Callback: The callback to call when the send is complete
batch:boolean: The batch mode to send the frames in.
parts:ByteBuffer[]: The parts of the message.

sendText	back to summary
public void sendText(String message, Callback callback, boolean batch) Send a String as a single text frame. Parameters message:String The message to send callback:Callback The callback to call when the send is complete batch:boolean The batch mode to send the frames in.

sendText

back to summary

public void sendText(String message, Callback callback, boolean batch)

Send a String as a single text frame.

Parameters

message:String: The message to send
callback:Callback: The callback to call when the send is complete
batch:boolean: The batch mode to send the frames in.

sendText	back to summary
public void sendText(Callback callback, boolean batch, final String... parts) Send a sequence of Strings as a sequences for fragmented text frame. Sending a large message in fragments can reduce memory overheads as only a single fragment need be converted to bytes Parameters callback:Callback The callback to call when the send is complete batch:boolean The batch mode to send the frames in. parts:String[] The parts of the message.

sendText

back to summary

public void sendText(Callback callback, boolean batch, final String... parts)

Send a sequence of Strings as a sequences for fragmented text frame. Sending a large message in fragments can reduce memory overheads as only a single fragment need be converted to bytes

Parameters

callback:Callback: The callback to call when the send is complete
batch:boolean: The batch mode to send the frames in.
parts:String[]: The parts of the message.

public Class MessageHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail