org.atmosphere.vibe.server

Class ClusteredServer

java.lang.Object

org.atmosphere.vibe.server.DefaultServer

org.atmosphere.vibe.server.ClusteredServer

All Implemented Interfaces:

Server

public class ClusteredServer
extends DefaultServer

Server implementation for clustering.

This implementation follows the publish and subscribe model from Java Message Service (JMS) to support clustering. Here, the message represents invocation of socket action and is created when one of selector actions is called. The publisher should publish the message passed from publishAction(Action) to all nodes in cluster and the subscriber should propagate a message sent from one of node in cluster to messageAction().

An invocation of the following socket finder actions will propagate to all the server in cluster:

• all(Action)
• ClusteredServer#byId(Action)
• ClusteredServer#byTag(Action)

That means server.all(action) executes a given action with not only all the sockets in this server but also all the sockets in all the other servers in the cluster.

Accordingly, most of Message Oriented Middlware requires message to be serialized and you may have to have pass Action implementing Serializable on method call. See the provided link, serialization of inner classes including local and anonymous classes, is discouraged and doesn't work in some cases. Therefore, always use Sentence instead of action if possible.

Author:

Donghwan Kim

See Also:

Sentence, Note of the Serializable Interface

Constructor Summary

Constructors

Constructor and Description
ClusteredServer()

Method Summary

Methods

Modifier and Type	Method and Description
Server	all(org.atmosphere.vibe.platform.Action<ServerSocket> action) Executes the given action retrieving all of the socket in this server or all of the server if it's in a clustered environment .
Server	byId(String id, org.atmosphere.vibe.platform.Action<ServerSocket> action) Executes the given action retrieving the socket of the given id in this server or all of the server if it's in a clustered environment.
Server	byTag(String[] names, org.atmosphere.vibe.platform.Action<ServerSocket> action) Executes the given action retrieving the socket tagged with all of the given names in this server or all of the server if it's in a clustered environment.
org.atmosphere.vibe.platform.Action<Map<String,Object>>	messageAction() This action receives a map fired from one of node in cluster and invokes socket action in this server.
Server	publishAction(org.atmosphere.vibe.platform.Action<Map<String,Object>> action) Attaches an action to be called with a map containing method name and arguments of socket action when it's called.

Methods inherited from class org.atmosphere.vibe.server.DefaultServer

all, byId, byTag, byTag, httpAction, set_heartbeat, setHeartbeat, setTransports, socketAction, websocketAction

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusteredServer

public ClusteredServer()

Method Detail

all

public Server all(org.atmosphere.vibe.platform.Action<ServerSocket> action)

Description copied from interface: Server

Executes the given action retrieving all of the socket in this server or all of the server if it's in a clustered environment .

Specified by:

all in interface Server

Overrides:

all in class DefaultServer

byId

public Server byId(String id,
          org.atmosphere.vibe.platform.Action<ServerSocket> action)

Description copied from interface: Server

Executes the given action retrieving the socket of the given id in this server or all of the server if it's in a clustered environment. The given action will be executed only once if socket is found and won't be executed if not found.

Specified by:

byId in interface Server

Overrides:

byId in class DefaultServer

byTag

public Server byTag(String[] names,
           org.atmosphere.vibe.platform.Action<ServerSocket> action)

Description copied from interface: Server

Executes the given action retrieving the socket tagged with all of the given names in this server or all of the server if it's in a clustered environment. The given action will be executed multiple times if sockets are found and won't be executed if not found.

Specified by:

byTag in interface Server

Overrides:

byTag in class DefaultServer

publishAction

public Server publishAction(org.atmosphere.vibe.platform.Action<Map<String,Object>> action)

Attaches an action to be called with a map containing method name and arguments of socket action when it's called.

messageAction

public org.atmosphere.vibe.platform.Action<Map<String,Object>> messageAction()

This action receives a map fired from one of node in cluster and invokes socket action in this server.