Class AcknowledgedMessagesExtension

java.lang.Object

org.cometd.server.ext.AcknowledgedMessagesExtension

All Implemented Interfaces:

BayeuxServer.Extension

public class AcknowledgedMessagesExtension
extends Object
implements BayeuxServer.Extension

Installing this extension in a BayeuxServer provides support for server-to-client message acknowledgement if a client also supports it.

The main role of this extension is to install the AcknowledgedMessagesSessionExtension on the ServerSession instances created during successful handshakes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AcknowledgedMessagesExtension.Listener	A listener for acknowledgement events.

Constructor Summary

Constructors

Constructor	Description
AcknowledgedMessagesExtension()

Method Summary

Modifier and Type	Method	Description
void	addListener(AcknowledgedMessagesExtension.Listener listener)
int	getMaxQueueSize()
protected AcknowledgedMessagesSessionExtension	newSessionExtension(ServerSession session)
boolean	rcvMeta(ServerSession remote, ServerMessage.Mutable message)	Blocking version of BayeuxServer.Extension.incoming(ServerSession, ServerMessage.Mutable, Promise) for meta messages.
void	removeListener(AcknowledgedMessagesExtension.Listener listener)
void	setMaxQueueSize(int maxQueueSize)

Methods inherited from class Object

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

Methods inherited from interface BayeuxServer.Extension

incoming, outgoing, rcv, send, sendMeta

Constructor Details

AcknowledgedMessagesExtension

public AcknowledgedMessagesExtension()

Method Details

addListener

public void addListener(AcknowledgedMessagesExtension.Listener listener)

removeListener

public void removeListener(AcknowledgedMessagesExtension.Listener listener)

getMaxQueueSize

public int getMaxQueueSize()

setMaxQueueSize

public void setMaxQueueSize(int maxQueueSize)

rcvMeta

public boolean rcvMeta(ServerSession remote,
 ServerMessage.Mutable message)

Description copied from interface: BayeuxServer.Extension

Blocking version of BayeuxServer.Extension.incoming(ServerSession, ServerMessage.Mutable, Promise) for meta messages.

Specified by:

rcvMeta in interface BayeuxServer.Extension

Parameters:

remote - the session that sent the message

message - the incoming message

Returns:

whether message processing should continue

newSessionExtension

protected AcknowledgedMessagesSessionExtension newSessionExtension(ServerSession session)