akka.contrib.pattern
Class ClusterReceptionistExtension

java.lang.Object
  extended by akka.contrib.pattern.ClusterReceptionistExtension
All Implemented Interfaces:
Extension

public class ClusterReceptionistExtension
extends java.lang.Object
implements Extension


Constructor Summary
ClusterReceptionistExtension(ExtendedActorSystem system)
           
 
Method Summary
static ClusterReceptionistExtension createExtension(ExtendedActorSystem system)
           
static ClusterReceptionistExtension get(ActorSystem system)
           
 boolean isTerminated()
          Returns true if this member is not tagged with the role configured for the receptionist.
static ClusterReceptionistExtension$ lookup()
           
 void registerService(ActorRef actor)
          Register an actor that should be reachable for the clients.
 void registerSubscriber(java.lang.String topic, ActorRef actor)
          Register an actor that should be reachable for the clients to a named topic.
 void unregisterService(ActorRef actor)
          A registered actor will be automatically unregistered when terminated, but it can also be explicitly unregistered before termination.
 void unregisterSubscriber(java.lang.String topic, ActorRef actor)
          A registered subscriber will be automatically unregistered when terminated, but it can also be explicitly unregistered before termination.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ClusterReceptionistExtension

public ClusterReceptionistExtension(ExtendedActorSystem system)
Method Detail

get

public static ClusterReceptionistExtension get(ActorSystem system)

lookup

public static ClusterReceptionistExtension$ lookup()

createExtension

public static ClusterReceptionistExtension createExtension(ExtendedActorSystem system)

isTerminated

public boolean isTerminated()
Returns true if this member is not tagged with the role configured for the receptionist.

Returns:
(undocumented)

registerService

public void registerService(ActorRef actor)
Register an actor that should be reachable for the clients. The clients can send messages to this actor with Send or SendToAll using the path elements of the ActorRef, e.g. "/user/myservice".

Parameters:
actor - (undocumented)

unregisterService

public void unregisterService(ActorRef actor)
A registered actor will be automatically unregistered when terminated, but it can also be explicitly unregistered before termination.

Parameters:
actor - (undocumented)

registerSubscriber

public void registerSubscriber(java.lang.String topic,
                               ActorRef actor)
Register an actor that should be reachable for the clients to a named topic. Several actors can be registered to the same topic name, and all will receive published messages. The client can publish messages to this topic with Publish.

Parameters:
topic - (undocumented)
actor - (undocumented)

unregisterSubscriber

public void unregisterSubscriber(java.lang.String topic,
                                 ActorRef actor)
A registered subscriber will be automatically unregistered when terminated, but it can also be explicitly unregistered before termination.

Parameters:
topic - (undocumented)
actor - (undocumented)