Package org.cometd.server.ext
Interface AcknowledgedMessagesExtension.Listener
-
- Enclosing class:
- AcknowledgedMessagesExtension
public static interface AcknowledgedMessagesExtension.ListenerA listener for acknowledgement events.
Implementation will be notified of these events:
batchSend, when a batch of messages is sent to a client sessiononBatchReceive(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 aMap<ServerSession, ?>
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default voidonBatchQueueMaxed(ServerSession session, java.util.Queue<ServerMessage> queue)Callback method invoked when the unacknowledged message queue size exceeds the value returned byAcknowledgedMessagesExtension.getMaxQueueSize().default voidonBatchReceive(ServerSession session, long batch)Callback method invoked when a client session confirms it has received the given batch of messages.default voidonBatchSend(ServerSession session, java.util.List<ServerMessage> messages, long batch)Callback method invoked when a batch of message is about to be sent to a client session.
-
-
-
Method Detail
-
onBatchSend
default void onBatchSend(ServerSession session, java.util.List<ServerMessage> messages, long batch)
Callback method invoked when a batch of message is about to be sent to a client session.
- Parameters:
session- the sessionmessages- the messages to send, as an immutable listbatch- 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 sessionbatch- the batch number
-
onBatchQueueMaxed
default void onBatchQueueMaxed(ServerSession session, java.util.Queue<ServerMessage> queue)
Callback method invoked when the unacknowledged message queue size exceeds the value returned by
AcknowledgedMessagesExtension.getMaxQueueSize().- Parameters:
session- the sessionqueue- the unacknowledged message queue
-
-