ConnectionRegistry (Kontraktor 4.27 API)

java.lang.Object
- org.nustaq.kontraktor.remoting.base.ConnectionRegistry

```
public abstract class ConnectionRegistry
extends Object
```
Created by moelrue on 5/7/15. Manages mapping of remote refs and callbacks of a single connection. E.g. if an actor ref or callback or spore is sent to a remote actor, during serialization ConnectionRegistry 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 AtomicLong`	`actorIdCount`
`protected org.nustaq.serialization.FSTConfiguration`	`conf`
`protected Consumer<Actor>`	`disconnectHandler`
`protected boolean`	`isObsolete`
`protected long`	`lastRoutingClientPing`
`static int`	`MAX_BATCH_CALLS`
`static Object`	`OUT_OF_ORDER_SEQ`
`protected ConcurrentHashMap<Long,Object>`	`publishedActorMap`
`protected ConcurrentHashMap<Object,Long>`	`publishedActorMappingReverse`
`protected ConcurrentHashMap<Long,Actor>`	`remoteActorMap`
`protected ConcurrentLinkedQueue<Actor>`	`remoteActors`
`protected BiFunction<Actor,String,Boolean>`	`remoteCallInterceptor`
`static BiFunction`	`remoteCallMapper`
`protected RemoteScheduler`	`scheduler`
`protected boolean`	`terminated`
`AtomicReference<Object>`	`userData`

Constructor Summary

Constructors
Constructor and Description

ConnectionRegistry(Coding code)

ConnectionRegistry(org.nustaq.serialization.FSTConfiguration conf, Coding coding)

Constructors
Constructor and Description
`ConnectionRegistry(Coding code)`
`ConnectionRegistry(org.nustaq.serialization.FSTConfiguration conf, Coding coding)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cleanUp()` cleanup after (virtual) connection close
`void`	`close(Actor closedOne)`
`IPromise`	`closeNetwork()`
`protected void`	`closeRef(CallEntry ce, ObjectSocket chan)`
`protected void`	`configureSerialization(Coding code)`
`void`	`disconnect()` called from ObjectSocket in case of disconnect (decoding errors or network issues)
`void`	`forwardRemoteMessage(RemoteCallEntry rce)`
`org.nustaq.serialization.FSTConfiguration`	`getConf()`
`String`	`getConnectionIdentifier()`
`Consumer<Actor>`	`getDisconnectHandler()`
`Actor`	`getFacadeActor()`
`abstract Actor`	`getFacadeProxy()`
`long`	`getLastRoutingClientPing()`
`int`	`getOpenRemoteMappingsCount()`
`Actor`	`getPublishedActor(long id)`
`long[]`	`getPublishedActorIds()`
`Callback`	`getPublishedCallback(long id)`
`ConcurrentHashMap<Long,Actor>`	`getRemoteActorMap()`
`ConcurrentLinkedQueue<Actor>`	`getRemoteActors()`
`int`	`getRemoteActorSize()`
`BiFunction<Actor,String,Boolean>`	`getRemoteCallInterceptor()`
`long[]`	`getRemotedActorIds()`
`long`	`getRemoteId(Actor act)`
`RemoteScheduler`	`getScheduler()`
`ActorServer`	`getServer()`
`ObjectSocket`	`getSocketRef()`
`abstract AtomicReference<ObjectSocket>`	`getWriteObjectSocket()`
`void`	`inFacadeThread(Runnable toRun)`
`boolean`	`isObsolete()`
`boolean`	`isTerminated()`
`void`	`pingFromRoutingClient()`
`boolean`	`pollAndSend2Remote(AtomicReference<ObjectSocket> chanHolder)` poll remote actor proxies and send. return true if there was at least one message
`protected boolean`	`processRemoteCallEntry(ObjectSocket objSocket, RemoteCallEntry response, List<IPromise> createdFutures, Object authContext)`
`long`	`publishActor(Actor act)`
`void`	`receiveCBResult(ObjectSocket chan, long id, Object result, Object error)`
`boolean`	`receiveObject(ObjectSocket responseChannel, ObjectSink receiver, Object response, List<IPromise> createdFutures, Object authContext)` process a remote call entry or an array of remote call entries.
`static void`	`registerDefaultClassMappings(org.nustaq.serialization.FSTConfiguration conf)`
`long`	`registerPublishedCallback(Callback cb)`
`Actor`	`registerRemoteActorRef(Class actorClazz, long remoteId, Object client)`
`void`	`registerRemoteRefDirect(Actor act)`
`protected void`	`remoteRefStopped(Actor actor)` warning: MThreaded
`void`	`removePublishedObject(long receiverKey)`
`protected void`	`removeRemoteActor(Actor act)`
`void`	`setClassLoader(ClassLoader l)`
`void`	`setDisconnectHandler(Consumer<Actor> disconnectHandler)`
`void`	`setFacadeActor(Actor facadeActor)`
`void`	`setIsObsolete(boolean isObsolete)` give the application a way to explecitely flag a connection as obsolete
`void`	`setServer(ActorServer server)`
`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
```

remoteCallMapper

public static BiFunction remoteCallMapper

userData

public AtomicReference<Object> userData

lastRoutingClientPing
```
protected long lastRoutingClientPing
```

conf

protected org.nustaq.serialization.FSTConfiguration conf

scheduler
```
protected RemoteScheduler scheduler
```

actorIdCount
```
protected AtomicLong actorIdCount
```

publishedActorMap

protected ConcurrentHashMap<Long,Object> publishedActorMap

publishedActorMappingReverse

protected ConcurrentHashMap<Object,Long> publishedActorMappingReverse

remoteActors

protected ConcurrentLinkedQueue<Actor> remoteActors

remoteActorMap

protected ConcurrentHashMap<Long,Actor> remoteActorMap

terminated
```
protected volatile boolean terminated
```

remoteCallInterceptor

protected BiFunction<Actor,String,Boolean> remoteCallInterceptor

disconnectHandler

protected Consumer<Actor> disconnectHandler

isObsolete
```
protected boolean isObsolete
```

Constructor Detail

ConnectionRegistry

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

ConnectionRegistry

public ConnectionRegistry(Coding code)

Method Detail

registerDefaultClassMappings

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

getRemoteCallInterceptor

public BiFunction<Actor,String,Boolean> getRemoteCallInterceptor()

configureSerialization

protected void configureSerialization(Coding code)

getOpenRemoteMappingsCount

public int getOpenRemoteMappingsCount()

getPublishedActor

public Actor getPublishedActor(long id)

getPublishedCallback

public Callback getPublishedCallback(long id)

getScheduler
```
public RemoteScheduler getScheduler()
```

getRemoteActors

public ConcurrentLinkedQueue<Actor> getRemoteActors()

getRemoteActorMap

public ConcurrentHashMap<Long,Actor> getRemoteActorMap()

isTerminated
```
public boolean isTerminated()
```

setTerminated

public void setTerminated(boolean terminated)

publishActor
```
public long publishActor(Actor act)
```

unpublishActor
```
public void unpublishActor(Actor act)
```
remove current mappings if present. return map containing removed mappings (for reconnection)

Parameters:

act -

registerPublishedCallback

public long registerPublishedCallback(Callback cb)

removePublishedObject

public void removePublishedObject(long receiverKey)

registerRemoteRefDirect

public void registerRemoteRefDirect(Actor act)

registerRemoteActorRef

public Actor registerRemoteActorRef(Class actorClazz,
                                    long 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,
                             Object authContext)
                      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; authContext -
Returns:
Throws:: Exception

processRemoteCallEntry

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

Throws:: Exception

cleanUp
```
public void cleanUp()
```
cleanup after (virtual) connection close

disconnect
```
public void disconnect()
```
called from ObjectSocket in case of disconnect (decoding errors or network issues)

closeRef

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

Throws:: IOException

writeObject

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

Throws:: Exception

inFacadeThread

public void inFacadeThread(Runnable toRun)

forwardRemoteMessage

public void forwardRemoteMessage(RemoteCallEntry rce)

receiveCBResult

public void receiveCBResult(ObjectSocket chan,
                            long id,
                            Object result,
                            Object error)

close
```
public void close(Actor closedOne)
```

getConf

public org.nustaq.serialization.FSTConfiguration getConf()

getFacadeProxy

public abstract Actor getFacadeProxy()

setDisconnectHandler

public void setDisconnectHandler(Consumer<Actor> disconnectHandler)

getDisconnectHandler

public Consumer<Actor> getDisconnectHandler()

setClassLoader

public void setClassLoader(ClassLoader l)

getRemoteId
```
public long getRemoteId(Actor act)
```

pollAndSend2Remote
```
public boolean pollAndSend2Remote(AtomicReference<ObjectSocket> chanHolder)
                           throws Exception
```
poll remote actor proxies and send. return true if there was at least one message

Parameters:

chanHolder -

Throws:

Exception

getWriteObjectSocket

public abstract AtomicReference<ObjectSocket> getWriteObjectSocket()

getSocketRef
```
public ObjectSocket getSocketRef()
```

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()
```

setServer

public void setServer(ActorServer server)

getServer
```
public ActorServer getServer()
```

closeNetwork
```
public IPromise closeNetwork()
```

pingFromRoutingClient
```
public void pingFromRoutingClient()
```

getLastRoutingClientPing

public long getLastRoutingClientPing()

getRemotedActorIds
```
public long[] getRemotedActorIds()
```

getPublishedActorIds
```
public long[] getPublishedActorIds()
```

getConnectionIdentifier

public String getConnectionIdentifier()

Class ConnectionRegistry

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OUT_OF_ORDER_SEQ

MAX_BATCH_CALLS

remoteCallMapper

userData

lastRoutingClientPing

conf

scheduler

actorIdCount

publishedActorMap

publishedActorMappingReverse

remoteActors

remoteActorMap

terminated

remoteCallInterceptor

disconnectHandler

isObsolete

Constructor Detail

ConnectionRegistry

ConnectionRegistry

Method Detail

registerDefaultClassMappings

getRemoteCallInterceptor

configureSerialization

getOpenRemoteMappingsCount

getPublishedActor

getPublishedCallback

getScheduler

getRemoteActors

getRemoteActorMap

isTerminated

setTerminated

publishActor

unpublishActor

registerPublishedCallback

removePublishedObject

registerRemoteRefDirect

registerRemoteActorRef

remoteRefStopped

stopRemoteRefs

removeRemoteActor

receiveObject

processRemoteCallEntry

cleanUp

disconnect

closeRef

writeObject

inFacadeThread

forwardRemoteMessage

receiveCBResult

close

getConf

getFacadeProxy

setDisconnectHandler

getDisconnectHandler

setClassLoader

getRemoteId

pollAndSend2Remote

getWriteObjectSocket

getSocketRef

isObsolete

setIsObsolete

getRemoteActorSize

setFacadeActor

getFacadeActor

setServer

getServer

closeNetwork

pingFromRoutingClient

getLastRoutingClientPing

getRemotedActorIds

getPublishedActorIds

getConnectionIdentifier