org.atmosphere.vibe

Class ClusteredServer

java.lang.Object

org.atmosphere.vibe.DefaultServer

org.atmosphere.vibe.ClusteredServer

All Implemented Interfaces:

Action<ServerTransport>, Server

public class ClusteredServer
extends DefaultServer

Server implementation for clustering.

With this implementation, server.all(action) have action be executed with every socket in every server in the cluster.

This implementation adopts the publish and subscribe model from Java Message Service to support clustering. Here, the exchanged message represents method invocation to be executed by every server in the cluster. The following methods create such messages.

• Server.all()
• Server.all(Action)
• Server.byTag(String...)
• Server.byTag(String, Action)
• Server.byTag(String[], Action)

A message created by this server is passed to publishAction(Action) and a message created by other servers is expected to be passed to messageAction(). Therefore, what you need to do is to publish a message given through publishAction(Action) to every server in the cluster and to subscribe a published message by other servers to delegate it to messageAction().

Accordingly, such message must be able to be serialized and you have to pass Action implementing Serializable. However, serialization of inner classes doesn't work in some cases as expected so that always use Sentence instead of action if possible unless you use lambda expressions.

Author:

Donghwan Kim

See Also:

Note of the Serializable Interface

Constructor Summary

Constructors

Constructor and Description
ClusteredServer()

Method Summary

Methods

Modifier and Type	Method and Description
Server	all(Action<ServerSocket> action) Executes the given action retrieving every socket in this server.
Server	byTag(String[] names, Action<ServerSocket> action) Executes the given action retrieving the socket tagged with the given tags in this server.
Action<Map<String,Object>>	messageAction() An action to receive a message published from one of nodes in the cluster.
Server	publishAction(Action<Map<String,Object>> action) Adds an action to be called with a message to be published to every node in the cluster.

Methods inherited from class org.atmosphere.vibe.DefaultServer

all, byTag, byTag, on, set_heartbeat, setHeartbeat, socketAction

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(Action<ServerSocket> action)

Description copied from interface: Server

Executes the given action retrieving every socket in this server.

Specified by:

all in interface Server

Overrides:

all in class DefaultServer

byTag

public Server byTag(String[] names,
           Action<ServerSocket> action)

Description copied from interface: Server

Executes the given action retrieving the socket tagged with the given tags in this server. The given action will be executed multiple times per socket 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(Action<Map<String,Object>> action)

Adds an action to be called with a message to be published to every node in the cluster.

messageAction

public Action<Map<String,Object>> messageAction()

An action to receive a message published from one of nodes in the cluster.