Package org.cometd.bayeux.server
Interface BayeuxServer.Extension
-
- All Known Implementing Classes:
BayeuxServer.Extension.Adapter
- Enclosing interface:
- BayeuxServer
public static interface BayeuxServer.Extension
Extension API for
BayeuxServer
.Implementations of this interface allow to modify incoming and outgoing messages before any other processing performed by the implementation.
Multiple extensions can be registered; the extension receive methods are invoked in registration order, while the extension send methods are invoked in registration reverse order.
- See Also:
BayeuxServer.addExtension(Extension)
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
BayeuxServer.Extension.Adapter
Empty implementation ofBayeuxServer.Extension
.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
rcv(ServerSession from, ServerMessage.Mutable message)
Callback method invoked every time a normal message is incoming.boolean
rcvMeta(ServerSession from, ServerMessage.Mutable message)
Callback method invoked every time a meta message is incoming.boolean
send(ServerSession from, ServerSession to, ServerMessage.Mutable message)
Callback method invoked every time a normal message is outgoing.boolean
sendMeta(ServerSession to, ServerMessage.Mutable message)
Callback method invoked every time a meta message is outgoing.
-
-
-
Method Detail
-
rcv
boolean rcv(ServerSession from, ServerMessage.Mutable message)
Callback method invoked every time a normal message is incoming.
- Parameters:
from
- the session that sent the messagemessage
- the incoming message- Returns:
- true if message processing should continue, false if it should stop
-
rcvMeta
boolean rcvMeta(ServerSession from, ServerMessage.Mutable message)
Callback method invoked every time a meta message is incoming.
- Parameters:
from
- the session that sent the messagemessage
- the incoming meta message- Returns:
- true if message processing should continue, false if it should stop
-
send
boolean send(ServerSession from, ServerSession to, ServerMessage.Mutable message)
Callback method invoked every time a normal message is outgoing.
- Parameters:
from
- the session that sent the message or nullto
- the session the message is sent to, or null for a publish.message
- the outgoing message- Returns:
- true if message processing should continue, false if it should stop
-
sendMeta
boolean sendMeta(ServerSession to, ServerMessage.Mutable message)
Callback method invoked every time a meta message is outgoing.
- Parameters:
to
- the session the message is sent to, or null for a publish.message
- the outgoing meta message- Returns:
- true if message processing should continue, false if it should stop
-
-