org.nustaq.kontraktor.remoting.base

Class RemoteRegistry

java.lang.Object

org.nustaq.kontraktor.remoting.base.RemoteRegistry

All Implemented Interfaces:

RemoteConnection

public abstract class RemoteRegistry
extends Object
implements RemoteConnection

Created by moelrue on 5/7/15. Manages mapping of remote refs and callbacks. E.g. if an actor ref or callback or spore is sent to a remote actor, during serialization RemoteRegistry generates and maps the callback id's required to later on route incoming messages from remote to the appropriate local instances

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicInteger	actorIdCount
protected org.nustaq.serialization.FSTConfiguration	conf
protected java.util.function.Consumer<Actor>	disconnectHandler
protected boolean	isObsolete
static int	MAX_BATCH_CALLS
static Object	OUT_OF_ORDER_SEQ
protected ConcurrentHashMap<Integer,Object>	publishedActorMapping
protected ConcurrentHashMap<Object,Integer>	publishedActorMappingReverse
protected ConcurrentLinkedQueue<Actor>	remoteActors
protected ConcurrentHashMap<Integer,Actor>	remoteActorSet
protected java.util.function.BiFunction<Actor,String,Boolean>	remoteCallInterceptor
protected RemoteScheduler	scheduler
protected boolean	terminated

Constructor Summary

Constructors

Constructor and Description
RemoteRegistry(Coding code)
RemoteRegistry(org.nustaq.serialization.FSTConfiguration conf, Coding coding)

Method Summary

Modifier and Type	Method and Description
void	cleanUp() cleanup after connection close
void	close() closes the underlying connection (Warning: may side effect to other actors published on this connection)
protected void	closeRef(CallEntry ce, ObjectSocket chan)
protected void	configureSerialization(Coding code)
org.nustaq.serialization.FSTConfiguration	getConf()
java.util.function.Consumer<Actor>	getDisconnectHandler()
Actor	getFacadeActor()
abstract Actor	getFacadeProxy()
Actor	getPublishedActor(int id)
Callback	getPublishedCallback(int id)
ConcurrentLinkedQueue<Actor>	getRemoteActors()
int	getRemoteActorSize()
java.util.function.BiFunction<Actor,String,Boolean>	getRemoteCallInterceptor()
int	getRemoteId(Actor act)
RemoteScheduler	getScheduler()
abstract AtomicReference<ObjectSocket>	getWriteObjectSocket()
boolean	isObsolete()
boolean	isTerminated()
boolean	pollAndSend2Remote(ObjectSocket chan) poll remote actor proxies and send.
protected boolean	processRemoteCallEntry(ObjectSocket objSocket, RemoteCallEntry response, List<IPromise> createdFutures)
int	publishActor(Actor act)
void	receiveCBResult(ObjectSocket chan, int id, Object result, Object error)
boolean	receiveObject(ObjectSocket responseChannel, ObjectSink receiver, Object response, List<IPromise> createdFutures) process a remote call entry or an array of remote call entries.
static void	registerDefaultClassMappings(org.nustaq.serialization.FSTConfiguration conf)
int	registerPublishedCallback(Callback cb)
Actor	registerRemoteActorRef(Class actorClazz, int remoteId, Object client)
void	registerRemoteRefDirect(Actor act)
protected void	remoteRefStopped(Actor actor) warning: MThreaded
void	removePublishedObject(int receiverKey)
protected void	removeRemoteActor(Actor act)
void	setClassLoader(ClassLoader l)
void	setDisconnectHandler(java.util.function.Consumer<Actor> disconnectHandler)
void	setFacadeActor(Actor facadeActor)
void	setIsObsolete(boolean isObsolete) give the application a way to explecitely flag a connection as obsolete
void	setRemoteCallInterceptor(java.util.function.BiFunction<Actor,String,Boolean> remoteCallInterceptor)
void	setTerminated(boolean terminated)
void	stopRemoteRefs()
void	unpublishActor(Actor act) remove current mappings if present.
protected void	writeObject(ObjectSocket chan, RemoteCallEntry rce)

Methods inherited from class java.lang.Object

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

Field Detail

OUT_OF_ORDER_SEQ

public static final Object OUT_OF_ORDER_SEQ

MAX_BATCH_CALLS

public static int MAX_BATCH_CALLS

conf

protected org.nustaq.serialization.FSTConfiguration conf

scheduler

protected RemoteScheduler scheduler

actorIdCount

protected AtomicInteger actorIdCount

publishedActorMapping

protected ConcurrentHashMap<Integer,Object> publishedActorMapping

publishedActorMappingReverse

protected ConcurrentHashMap<Object,Integer> publishedActorMappingReverse

remoteActors

protected ConcurrentLinkedQueue<Actor> remoteActors

remoteActorSet

protected ConcurrentHashMap<Integer,Actor> remoteActorSet

terminated

protected volatile boolean terminated

remoteCallInterceptor

protected java.util.function.BiFunction<Actor,String,Boolean> remoteCallInterceptor

disconnectHandler

protected java.util.function.Consumer<Actor> disconnectHandler

isObsolete

protected boolean isObsolete

Constructor Detail

RemoteRegistry

public RemoteRegistry(org.nustaq.serialization.FSTConfiguration conf,
                      Coding coding)

RemoteRegistry

public RemoteRegistry(Coding code)

Method Detail

registerDefaultClassMappings

public static void registerDefaultClassMappings(org.nustaq.serialization.FSTConfiguration conf)

getRemoteCallInterceptor

public java.util.function.BiFunction<Actor,String,Boolean> getRemoteCallInterceptor()

setRemoteCallInterceptor

public void setRemoteCallInterceptor(java.util.function.BiFunction<Actor,String,Boolean> remoteCallInterceptor)

configureSerialization

protected void configureSerialization(Coding code)

getPublishedActor

public Actor getPublishedActor(int id)

getPublishedCallback

public Callback getPublishedCallback(int id)

getScheduler

public RemoteScheduler getScheduler()

getRemoteActors

public ConcurrentLinkedQueue<Actor> getRemoteActors()

isTerminated

public boolean isTerminated()

setTerminated

public void setTerminated(boolean terminated)

publishActor

public int publishActor(Actor act)

unpublishActor

public void unpublishActor(Actor act)

remove current mappings if present. return map containing removed mappings (for reconnection)

Specified by:

unpublishActor in interface RemoteConnection

Parameters:

act -

registerPublishedCallback

public int registerPublishedCallback(Callback cb)

removePublishedObject

public void removePublishedObject(int receiverKey)

registerRemoteRefDirect

public void registerRemoteRefDirect(Actor act)

registerRemoteActorRef

public Actor registerRemoteActorRef(Class actorClazz,
                                    int remoteId,
                                    Object client)

remoteRefStopped

protected void remoteRefStopped(Actor actor)

warning: MThreaded

Parameters:

actor -

stopRemoteRefs

public void stopRemoteRefs()

removeRemoteActor

protected void removeRemoteActor(Actor act)

receiveObject

public boolean receiveObject(ObjectSocket responseChannel,
                             ObjectSink receiver,
                             Object response,
                             List<IPromise> createdFutures)
                      throws Exception

process a remote call entry or an array of remote call entries.

Parameters:

responseChannel - - writer required to route callback messages

response -

createdFutures - - can be null. Contains futures created by the submitted callsequence

Returns:

Throws:

Exception

processRemoteCallEntry

protected boolean processRemoteCallEntry(ObjectSocket objSocket,
                                         RemoteCallEntry response,
                                         List<IPromise> createdFutures)
                                  throws Exception

Throws:

Exception

cleanUp

public void cleanUp()

cleanup after connection close

closeRef

protected void closeRef(CallEntry ce,
                        ObjectSocket chan)
                 throws IOException

Throws:

IOException

writeObject

protected void writeObject(ObjectSocket chan,
                           RemoteCallEntry rce)
                    throws Exception

Throws:

Exception

receiveCBResult

public void receiveCBResult(ObjectSocket chan,
                            int id,
                            Object result,
                            Object error)
                     throws Exception

Throws:

Exception

close

public void close()

Description copied from interface: RemoteConnection

closes the underlying connection (Warning: may side effect to other actors published on this connection)

Specified by:

close in interface RemoteConnection

getConf

public org.nustaq.serialization.FSTConfiguration getConf()

getFacadeProxy

public abstract Actor getFacadeProxy()

setDisconnectHandler

public void setDisconnectHandler(java.util.function.Consumer<Actor> disconnectHandler)

getDisconnectHandler

public java.util.function.Consumer<Actor> getDisconnectHandler()

setClassLoader

public void setClassLoader(ClassLoader l)

Specified by:

setClassLoader in interface RemoteConnection

getRemoteId

public int getRemoteId(Actor act)

Specified by:

getRemoteId in interface RemoteConnection

pollAndSend2Remote

public boolean pollAndSend2Remote(ObjectSocket chan)
                           throws Exception

poll remote actor proxies and send. return true if there was at least one message

Parameters:

chan -

Throws:

Exception

getWriteObjectSocket

public abstract AtomicReference<ObjectSocket> getWriteObjectSocket()

isObsolete

public boolean isObsolete()

setIsObsolete

public void setIsObsolete(boolean isObsolete)

give the application a way to explecitely flag a connection as obsolete

getRemoteActorSize

public int getRemoteActorSize()

setFacadeActor

public void setFacadeActor(Actor facadeActor)

getFacadeActor

public Actor getFacadeActor()