Interface ClientSessionChannel
- All Superinterfaces:
Channel
A client side channel representation.
A ClientSessionChannel is scoped to a particular ClientSession
that is obtained by a call to ClientSession.getChannel(String).
Typical usage examples are:
clientSession.getChannel("/foo/bar").subscribe(mySubscriptionListener);
clientSession.getChannel("/foo/bar").publish("Hello");
clientSession.getChannel("/meta/*").addListener(myMetaChannelListener);
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceRepresents a listener on aClientSessionChannel.static interfaceA listener for messages on aClientSessionChannel. -
Field Summary
Fields inherited from interface org.cometd.bayeux.Channel
META, META_CONNECT, META_DISCONNECT, META_HANDSHAKE, META_SUBSCRIBE, META_UNSUBSCRIBE, SERVICE -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds a listener to this channel.booleandefault voidPublishes the givendataonto this channel.voidpublish(Object data, ClientSession.MessageListener callback) Publishes the givendataonto this channel, notifying the givencallbackof the publish result, whether successful or unsuccessful.voidpublish(Message.Mutable message, ClientSession.MessageListener callback) Publishes the givenmessageonto this channel, notifying the givencallbackof the publish result.booleanrelease()Releases this channel from itsClientSession.voidRemoves the givenlistenerfrom this channel.default booleanEquivalent tosubscribe(listener, null).default booleansubscribe(ClientSessionChannel.MessageListener listener, ClientSession.MessageListener callback) Equivalent tosubscribe(null, listener, callback).booleansubscribe(Message.Mutable message, ClientSessionChannel.MessageListener listener, ClientSession.MessageListener callback) Subscribes the givenlistenerto receive messages sent to this channel.voidUnsubscribes all subscribers registered on this channel.default booleanEquivalent tounsubscribe(listener, null).default booleanunsubscribe(ClientSessionChannel.MessageListener listener, ClientSession.MessageListener callback) Equivalent tounsubscribe(null, listener, callback).booleanunsubscribe(Message.Mutable message, ClientSessionChannel.MessageListener listener, ClientSession.MessageListener callback) Unsubscribes the givenlistenerfrom receiving messages sent to this channel.Methods inherited from interface org.cometd.bayeux.Channel
getAttribute, getAttributeNames, getChannelId, getId, isBroadcast, isDeepWild, isMeta, isService, isWild, removeAttribute, setAttribute
-
Method Details
-
addListener
Adds a listener to this channel.
If the listener is a
ClientSessionChannel.MessageListener, it will be invoked if a message arrives to this channel.Adding a listener never involves communication with the server, differently from
subscribe(MessageListener).Listeners are best suited to receive messages from
meta channels.- Parameters:
listener- the listener to add- See Also:
-
removeListener
Removes the given
listenerfrom this channel.Removing a listener never involves communication with the server, differently from
unsubscribe(MessageListener).- Parameters:
listener- the listener to remove- See Also:
-
getListeners
List<ClientSessionChannel.ClientSessionChannelListener> getListeners()- Returns:
- an immutable snapshot of the listeners
- See Also:
-
getSession
ClientSession getSession()- Returns:
- the client session associated with this channel
-
publish
Publishes the given
dataonto this channel.The
datapublished must not be null and can be any object that can be natively converted to JSON (numbers, strings, arrays, lists, maps), or objects for which a JSON converter has been registered with the infrastructure responsible of the JSON conversion.- Parameters:
data- the data to publish- See Also:
-
publish
Publishes the given
dataonto this channel, notifying the givencallbackof the publish result, whether successful or unsuccessful.- Parameters:
data- the data to publishcallback- the message callback to notify of the publish result- See Also:
-
publish
Publishes the given
messageonto this channel, notifying the givencallbackof the publish result.- Parameters:
message- the message to publishcallback- the message callback to notify of the publish result- See Also:
-
subscribe
Equivalent to
subscribe(listener, null).- Parameters:
listener- the listener to register and invoke when a message arrives on this channel.- Returns:
- whether the subscribe message has been sent
-
subscribe
default boolean subscribe(ClientSessionChannel.MessageListener listener, ClientSession.MessageListener callback) Equivalent to
subscribe(null, listener, callback).- Parameters:
listener- the listener to register and invoke when a message arrives on this channelcallback- the callback to notify of the subscribe result- Returns:
- whether the subscribe message has been sent
-
subscribe
boolean subscribe(Message.Mutable message, ClientSessionChannel.MessageListener listener, ClientSession.MessageListener callback) Subscribes the given
listenerto receive messages sent to this channel.Subscription involves communication with the server only for the first listener subscribed to this channel. Listeners registered after the first will not cause a message being sent to the server.
The callback parameter will be invoked upon acknowledgment of the subscription by the server, and therefore only for the first subscription to this channel.
- Parameters:
message- the subscription messagelistener- the listener to register and invoke when a message arrives on this channelcallback- the callback to notify of the subscribe result- Returns:
- whether the subscribe message has been sent
- See Also:
-
unsubscribe
Equivalent to
unsubscribe(listener, null).- Parameters:
listener- the listener to unsubscribe- Returns:
- whether the unsubscribe message has been sent
-
unsubscribe
default boolean unsubscribe(ClientSessionChannel.MessageListener listener, ClientSession.MessageListener callback) Equivalent to
unsubscribe(null, listener, callback).- Parameters:
listener- the listener to unsubscribecallback- the callback to notify of the unsubscribe result- Returns:
- whether the unsubscribe message has been sent
-
unsubscribe
boolean unsubscribe(Message.Mutable message, ClientSessionChannel.MessageListener listener, ClientSession.MessageListener callback) Unsubscribes the given
listenerfrom receiving messages sent to this channel.Unsubscription involves communication with the server only for the last listener unsubscribed from this channel.
The callback parameter will be invoked upon acknowledgment of the unsubscription by the server, and therefore only for the last unsubscription from this channel.
- Parameters:
message- the unsubscription messagelistener- the listener to unsubscribecallback- the callback to notify of the unsubscribe result- Returns:
- whether the unsubscribe message has been sent
- See Also:
-
unsubscribe
void unsubscribe()Unsubscribes all subscribers registered on this channel.
- See Also:
-
getSubscribers
List<ClientSessionChannel.MessageListener> getSubscribers()- Returns:
- an immutable snapshot of the subscribers
- See Also:
-
release
boolean release()Releases this channel from its
ClientSession.If the release is successful, subsequent invocations of
ClientSession.getChannel(String)will return a new, different, instance of a ClientSessionChannel.The release of a ClientSessionChannel is successful only if no listeners and no subscribers are present at the moment of the release.
- Returns:
- true if the release was successful, false otherwise
- See Also:
-
isReleased
boolean isReleased()- Returns:
- whether this channel has been released
- See Also:
-