Interface ServerSession.DeQueueListener

All Superinterfaces:

Bayeux.BayeuxListener, EventListener, ServerSession.ServerSessionListener

All Known Implementing Classes:

AcknowledgedMessagesSessionExtension

Enclosing interface:

ServerSession

public static interface ServerSession.DeQueueListener
extends ServerSession.ServerSessionListener

Listeners objects that implement this interface will be notified when the session queue is being drained to actually deliver the messages.

This is a restricted listener interface, see ServerSession.QueueMaxedListener.

Method Summary

Modifier and Type	Method	Description
void	deQueue(ServerSession session, Queue<ServerMessage> queue)	Callback invoked to notify that the queue of messages is about to be sent to the remote client.
default void	deQueue(ServerSession session, Queue<ServerMessage> queue, List<ServerMessage.Mutable> replies)	Callback invoked to notify that the queue of messages and the message replies are about to be sent to the remote client.

Method Details

deQueue

default void deQueue(ServerSession session,
 Queue<ServerMessage> queue,
 List<ServerMessage.Mutable> replies)

Callback invoked to notify that the queue of messages and the message replies are about to be sent to the remote client.

This is the last chance to process the queue, to remove duplicates or merge messages, and to process the replies.

Parameters:

session - the session whose messages are being sent

queue - the queue of messages to send

replies - the message replies to send

deQueue

void deQueue(ServerSession session,
 Queue<ServerMessage> queue)

Callback invoked to notify that the queue of messages is about to be sent to the remote client.

This is the last chance to process the queue and remove duplicates or merge messages.

Parameters:

session - the session whose messages are being sent

queue - the queue of messages to send