Package org.apache.tomcat.websocket.pojo

Class PojoMessageHandlerPartialBase<T>

java.lang.Object

org.apache.tomcat.websocket.pojo.PojoMessageHandlerBase<T>

org.apache.tomcat.websocket.pojo.PojoMessageHandlerPartialBase<T>

Type Parameters:

T - The type of message to handle

All Implemented Interfaces:

MessageHandler, MessageHandler.Partial<T>, WrappedMessageHandler

Direct Known Subclasses:

PojoMessageHandlerPartialBinary, PojoMessageHandlerPartialText

public abstract class PojoMessageHandlerPartialBase<T>
extends PojoMessageHandlerBase<T>
implements MessageHandler.Partial<T>

Common implementation code for the POJO partial message handlers. All the real work is done in this class and in the superclass.

Nested Class Summary

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

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

Field Summary

Fields inherited from class org.apache.tomcat.websocket.pojo.PojoMessageHandlerBase

convert, indexPayload, indexSession, maxMessageSize, method, params, pojo, session

Constructor Summary

Constructors

Constructor	Description
PojoMessageHandlerPartialBase(java.lang.Object pojo, java.lang.reflect.Method method, Session session, java.lang.Object[] params, int indexPayload, boolean convert, int indexBoolean, int indexSession, long maxMessageSize)	Create a partial message handler.

Method Summary

Modifier and Type	Method	Description
void	onMessage(T message, boolean last)	Called when part of a message is available to be processed.

Methods inherited from class org.apache.tomcat.websocket.pojo.PojoMessageHandlerBase

getMaxMessageSize, getWrappedHandler, handlePojoMethodException, processResult

Methods inherited from class java.lang.Object

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

Constructor Detail

PojoMessageHandlerPartialBase

public PojoMessageHandlerPartialBase(java.lang.Object pojo,
                                     java.lang.reflect.Method method,
                                     Session session,
                                     java.lang.Object[] params,
                                     int indexPayload,
                                     boolean convert,
                                     int indexBoolean,
                                     int indexSession,
                                     long maxMessageSize)

Create a partial message handler.

Parameters:

pojo - POJO instance

method - Method to invoke

session - WebSocket session

params - Pre-populated parameter array

indexPayload - Index of the payload parameter

convert - Convert the message before passing to the method

indexBoolean - Index of the last flag parameter

indexSession - Index of the session parameter

maxMessageSize - Maximum message size

Method Detail

onMessage

public final void onMessage(T message,
                            boolean last)

Description copied from interface: jakarta.websocket.MessageHandler.Partial

Called when part of a message is available to be processed.

Specified by:

onMessage in interface MessageHandler.Partial<T>

Parameters:

message - The message part

last - true if this is the last part of this message, else false