Interface AcknowledgedMessagesExtension.Listener

Enclosing class:

AcknowledgedMessagesExtension

public static interface AcknowledgedMessagesExtension.Listener

A listener for acknowledgement events.

Implementation will be notified of these events:

• batchSend, when a batch of messages is sent to a client session
• onBatchReceive(ServerSession, long), when the client session confirms it has received a batch of messages

Stateful implementations may use Session.setAttribute(String, Object) to store per-session data, or a Map<ServerSession, ?>

Method Summary

Modifier and Type	Method	Description
default void	onBatchQueueMaxed(ServerSession session, Queue<ServerMessage> queue)	Callback method invoked when the unacknowledged message queue size exceeds the value returned by AcknowledgedMessagesExtension.getMaxQueueSize().
default void	onBatchReceive(ServerSession session, long batch)	Callback method invoked when a client session confirms it has received the given batch of messages.
default void	onBatchSend(ServerSession session, List<ServerMessage> messages, long batch)	Callback method invoked when a batch of messages is about to be sent to a client session.

Method Details

onBatchSend

default void onBatchSend(ServerSession session,
 List<ServerMessage> messages,
 long batch)

Callback method invoked when a batch of messages is about to be sent to a client session.

Parameters:

session - the session

messages - the messages to send, as an immutable list

batch - the batch number

onBatchReceive

default void onBatchReceive(ServerSession session,
 long batch)

Callback method invoked when a client session confirms it has received the given batch of messages.

Parameters:

session - the session

batch - the batch number

onBatchQueueMaxed

default void onBatchQueueMaxed(ServerSession session,
 Queue<ServerMessage> queue)

Callback method invoked when the unacknowledged message queue size exceeds the value returned by AcknowledgedMessagesExtension.getMaxQueueSize().

Parameters:

session - the session

queue - the unacknowledged message queue