|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||

Provides collaborative access to the remote sessions that are connected to the same
repository as the local session. A CDORemoteSessionManager can be subscribed or
unsubscribed to changes in the set of remote sessions. It is subscribed if at least one is true:
listener is registered with this remote session manager.
Force subscription is true.
events to
registered listeners:
IContainerEvent with CDORemoteSession as generic type argument to reflect opened or closed remote
sessions.
CDORemoteSessionEvent.SubscriptionChanged to reflect the ability of the remote session to receive and
possibly handle remote messages from other sessions.
CDORemoteSessionEvent.MessageReceived to deliver custom data
sent from other sessions .
| Nested Class Summary | |
|---|---|
static class |
CDORemoteSessionManager.EventAdapter
A default adapter for all kinds of remote session related events. |
static interface |
CDORemoteSessionManager.LocalSubscriptionChangedEvent
An event that is fired by a remote session manager after the
subscription mode of the
local session changed. |
| Nested classes/interfaces inherited from interface org.eclipse.net4j.util.container.IContainer |
|---|
IContainer.Modifiable<E> |
| Method Summary | |
|---|---|
CDOSession |
getLocalSession()
Returns the local session this CDORemoteSessionManager belongs to. |
CDORemoteSession[] |
getRemoteSessions()
Returns the set of remote sessions that are connected to the same repository as the
local session. |
boolean |
isForceSubscription()
Returns true if this CDORemoteSessionManager shall be subscribed to changes in the set of remote
sessions and delivers custom data events even if no listener is
registered, false otherwise. |
boolean |
isSubscribed()
Returns true if this CDORemoteSessionManager is subscribed to changes in the set of remote sessions
and delivers custom data events, false otherwise. |
Set<CDORemoteSession> |
sendMessage(CDORemoteSessionMessage message,
CDORemoteSession... recipients)
Sends a multicast message to the subscribed recipients. |
Set<CDORemoteSession> |
sendMessage(CDORemoteSessionMessage message,
Collection<CDORemoteSession> recipients)
Same as sendMessage(CDORemoteSessionMessage, CDORemoteSession...) but with a recipients collection. |
void |
setForceSubscription(boolean forceSubscription)
Enables or disables subscription to changes in the set of remote sessions even if no listener is
registered. |
| Methods inherited from interface org.eclipse.net4j.util.container.IContainer |
|---|
getElements, isEmpty |
| Methods inherited from interface org.eclipse.net4j.util.event.INotifier |
|---|
addListener, getListeners, hasListeners, removeListener |
| Method Detail |
|---|
CDOSession getLocalSession()
local session this CDORemoteSessionManager belongs to.
CDORemoteSession[] getRemoteSessions()
remote sessions that are connected to the same repository as the
local session. If this CDORemoteSessionManager itself is subscribed the result is returned from a local cache for remote sessions, otherwise it is requested from the
server each time this method is called.
boolean isSubscribed()
true if this CDORemoteSessionManager is subscribed to changes in the set of remote sessions
and delivers custom data events, false otherwise. It is subscribed if at least
one is true:
listener is registered with this remote session manager.
Force subscription is true.
INotifier.addListener(IListener),
setForceSubscription(boolean)boolean isForceSubscription()
true if this CDORemoteSessionManager shall be subscribed to changes in the set of remote
sessions and delivers custom data events even if no listener is
registered, false otherwise.
INotifier.addListener(IListener),
setForceSubscription(boolean)void setForceSubscription(boolean forceSubscription)
listener is
registered.
INotifier.addListener(IListener),
setForceSubscription(boolean)
Set<CDORemoteSession> sendMessage(CDORemoteSessionMessage message,
CDORemoteSession... recipients)
recipients that the message has been forwarded to by the server.
Note: No assumption must be made on whether a recipient session received the message and was able to
handle it adequately!
Set<CDORemoteSession> sendMessage(CDORemoteSessionMessage message,
Collection<CDORemoteSession> recipients)
sendMessage(CDORemoteSessionMessage, CDORemoteSession...) but with a recipients collection.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||