Package jakarta.websocket

Interface MessageHandler.Whole<T>

Type Parameters:

T - The type of the message object that this MessageHandler will consume.

All Superinterfaces:

MessageHandler

Enclosing interface:

MessageHandler

public static interface MessageHandler.Whole<T>
extends MessageHandler

This kind of handler is notified by the container on arrival of a complete message. If the message is received in parts, the container buffers it until it is has been fully received before this method is called.

For handling incoming text messages, the allowed types for T are

• String
• Reader
• any developer object for which there is a corresponding Decoder.Text or Decoder.TextStream configured

For handling incoming binary messages, the allowed types for T are

• ByteBuffer
• byte[]
• InputStream
• any developer object for which there is a corresponding Decoder.Binary or Decoder.BinaryStream configured

For handling incoming pong messages, the type of T is PongMessage

Developers should not continue to reference message objects of type Reader, ByteBuffer or InputStream after the completion of the onMessage() call, since they may be recycled by the implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface jakarta.websocket.MessageHandler

MessageHandler.Partial<T>, MessageHandler.Whole<T>

Method Summary

Modifier and Type	Method	Description
void	onMessage(T message)	Called when the message has been fully received.

Method Details

onMessage

void onMessage(T message)

Called when the message has been fully received.

Parameters:

message - the message data.