org.nustaq.kontraktor.routers

Class AbstractKrouter<T extends AbstractKrouter>

java.lang.Object

org.nustaq.kontraktor.Actors

org.nustaq.kontraktor.Actor<T>

org.nustaq.kontraktor.routers.AbstractKrouter<T>

All Implemented Interfaces:

Serializable, Executor, Monitorable, RemotedActor, ServingActor

Direct Known Subclasses:

HotHotFailoverKrouter, Krouter, SingleActiveServiceKrouter

public abstract class AbstractKrouter<T extends AbstractKrouter>
extends Actor<T>
implements RemotedActor, ServingActor

base class for load balancers and failover proxies. Krouters are designed to run as standalone processes (similar e.g. nginx). ServiceActors connect and register actively to be available. Clients connect to the Krouter which then forwards/dispatches remote messages and results depending on implemented strategy. This way services are protected against any malicious attacks as they don't even accept connections from the network (they are clients of the Krouter, the Krouter has no prior knowledge of address of the krouter's address. E.g. its possible to have a public Krouter running in the cloud and run the service behind a firewall (or even http proxy).

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.nustaq.kontraktor.Actor

Actor.ActorReport

Field Summary

Fields

Modifier and Type	Field and Description
static long	CLIENT_PING_INTERVAL_MS client connection loss detection can be slow (just needed for resource cleanup)
protected HashMap<String,ConnectionRegistry>	clients
protected long	lastSwitch
protected Set<Long>	nextAliveRemoteActors
static String	SERVICE_UNAVAILABLE
protected HashMap<Object,Long>	timeoutMap

Fields inherited from class org.nustaq.kontraktor.Actor

__cbQueue, __clientConnection, __connections, __currentDispatcher, __mailbox, __mailboxCapacity, __mbCapacity, __publishTarget, __remoteId, __scheduler, __self, __stopped, __ticketMachine, connection, sender, userData, zzRoutingGCEnabled, zzServerMsgCallback

Fields inherited from class org.nustaq.kontraktor.Actors

CONT, DEFAULT_TIMOUT, defaultScheduler, delayedCalls, exec, instance, MAX_EXTERNAL_THREADS_POOL_SIZE, version

Constructor Summary

Constructors

Constructor and Description
AbstractKrouter()

Method Summary

Modifier and Type	Method and Description
boolean	__dispatchRemoteCall(ObjectSocket objSocket, RemoteCallEntry rce, ConnectionRegistry clientRemoteRegistry, List<IPromise> createdFutures, Object authContext, BiFunction<Actor,String,Boolean> callInterceptor) called if a message invokation from remote is received
void	checkPingOnClients()
void	clientConnected(ConnectionRegistry connectionRegistry, String connectionIdentifier)
void	clientDisconnected(ConnectionRegistry connectionRegistry, String connectionIdentifier)
protected RemoteCallEntry	createErrorPromiseResponse(RemoteCallEntry rce, ConnectionRegistry clientRemoteRegistry)
protected abstract boolean	dispatchRemoteCall(RemoteCallEntry rce, ConnectionRegistry clientRemoteRegistry) dispatch call to a service.
protected void	forwardCall(RemoteCallEntry rce, Actor remoteRef, ConnectionRegistry clientRemoteRegistry)
protected void	forwardCallInternal(RemoteCallEntry rce, Actor remoteRef, ConnectionRegistry clientRemoteRegistry)
protected void	forwardMultiCall(RemoteCallEntry rce, Actor remoteRef, ConnectionRegistry clientRemoteRegistry, boolean[] done, Callback[] selected)
protected void	forwardMultiCallInternal(RemoteCallEntry rceIn, Actor remoteRef, ConnectionRegistry clientRemoteRegistry, boolean[] done, Callback[] selected)
protected long	getClientPingTimeout()
protected long	getServicePingTimeout()
protected abstract List<Actor>	getServices()
protected void	handleServiceDiscon(Actor remoteRef)
void	hasBeenUnpublished(String connectionIdentifier) notification method called once an actor has been unpublished.
void	init()
protected boolean	isStateful()
void	pingServices()
IPromise<Long>	router$clientPing(long tim, long[] publishedActorIds) a krouter client should ping using this method.
abstract void	router$handleServiceDisconnect(Actor disconnected)
IPromise	router$RegisterService(Actor remoteRef, boolean stateful)
protected void	sendFailoverNotification(ConnectionRegistry clientRemoteRegistry)
protected void	sendFailoverNotificationInternal(ConnectionRegistry registry)

Methods inherited from class org.nustaq.kontraktor.Actor

__addDeadLetter, __addRemoteConnection, __addStopHandler, __enqueueCall, __getCachedMethod, __removeRemoteConnection, __stop, __stopImpl, __submit, ask, askMsg, asyncstop, checkThread, close, closeCurrentClient, current, cyclic, debounce, delayed, execInThreadPool, execute, getActor, getActorRef, getCallbackSize, getConnections, getCurrentDispatcher, getFactory, getMailboxSize, getQSizes, getReport, getScheduler, getSubMonitorables, getUntypedRef, hasStopped, inside, inThread, isCallbackQPressured, isEmpty, isMailboxPressured, isProxy, isPublished, isRemote, isStopped, ping, self, serialOn, setServerMsgCallback, stop, stopSafeClose, tell, tellMsg, unpublish, zzkrouterLostClient, zzRoutingRefGC

Methods inherited from class org.nustaq.kontraktor.Actors

AddDeadLetter, all, all, all, allMapped, AsActor, AsActor, AsActor, AsActor, AsUntypedActor, awaitAll, awaitAll, awaitAll, awaitAll, complete, complete, DeadLetters, flow, InThread, isComplete, isCont, isError, isErrorOrComplete, isResult, isTimeout, promise, race, race, reject, resolve, resolve, stream, SubmitDelayed, yield, yield, yieldCallbacks

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nustaq.kontraktor.remoting.base.RemotedActor

hasBeenPublished

Field Detail

SERVICE_UNAVAILABLE

public static final String SERVICE_UNAVAILABLE

See Also:

Constant Field Values

CLIENT_PING_INTERVAL_MS

public static long CLIENT_PING_INTERVAL_MS

client connection loss detection can be slow (just needed for resource cleanup)

timeoutMap

protected HashMap<Object,Long> timeoutMap

clients

protected HashMap<String,ConnectionRegistry> clients

nextAliveRemoteActors

protected Set<Long> nextAliveRemoteActors

lastSwitch

protected long lastSwitch

Constructor Detail

AbstractKrouter

public AbstractKrouter()

Method Detail

router$RegisterService

public IPromise router$RegisterService(Actor remoteRef,
                                       boolean stateful)

isStateful

protected boolean isStateful()

router$handleServiceDisconnect

public abstract void router$handleServiceDisconnect(Actor disconnected)

router$clientPing

public IPromise<Long> router$clientPing(long tim,
                                        long[] publishedActorIds)

Description copied from class: Actor

a krouter client should ping using this method.

Overrides:

router$clientPing in class Actor<T extends AbstractKrouter>

publishedActorIds - - published actors of sender

Returns:

init

public void init()

__dispatchRemoteCall

public boolean __dispatchRemoteCall(ObjectSocket objSocket,
                                    RemoteCallEntry rce,
                                    ConnectionRegistry clientRemoteRegistry,
                                    List<IPromise> createdFutures,
                                    Object authContext,
                                    BiFunction<Actor,String,Boolean> callInterceptor)

Description copied from class: Actor

called if a message invokation from remote is received

Overrides:

__dispatchRemoteCall in class Actor<T extends AbstractKrouter>

Returns:

true if a new promise has been created

pingServices

public void pingServices()

checkPingOnClients

public void checkPingOnClients()

getServicePingTimeout

protected long getServicePingTimeout()

getClientPingTimeout

protected long getClientPingTimeout()

sendFailoverNotification

protected void sendFailoverNotification(ConnectionRegistry clientRemoteRegistry)

sendFailoverNotificationInternal

protected void sendFailoverNotificationInternal(ConnectionRegistry registry)

getServices

protected abstract List<Actor> getServices()

createErrorPromiseResponse

protected RemoteCallEntry createErrorPromiseResponse(RemoteCallEntry rce,
                                                     ConnectionRegistry clientRemoteRegistry)

forwardMultiCall

protected void forwardMultiCall(RemoteCallEntry rce,
                                Actor remoteRef,
                                ConnectionRegistry clientRemoteRegistry,
                                boolean[] done,
                                Callback[] selected)

forwardMultiCallInternal

protected void forwardMultiCallInternal(RemoteCallEntry rceIn,
                                        Actor remoteRef,
                                        ConnectionRegistry clientRemoteRegistry,
                                        boolean[] done,
                                        Callback[] selected)

dispatchRemoteCall

protected abstract boolean dispatchRemoteCall(RemoteCallEntry rce,
                                              ConnectionRegistry clientRemoteRegistry)

dispatch call to a service. (use forwardXX to send)

Parameters:

rce -

clientRemoteRegistry -

Returns:

return false in case call could not be dispatched

forwardCall

protected void forwardCall(RemoteCallEntry rce,
                           Actor remoteRef,
                           ConnectionRegistry clientRemoteRegistry)

forwardCallInternal

protected void forwardCallInternal(RemoteCallEntry rce,
                                   Actor remoteRef,
                                   ConnectionRegistry clientRemoteRegistry)

handleServiceDiscon

protected void handleServiceDiscon(Actor remoteRef)

hasBeenUnpublished

public void hasBeenUnpublished(String connectionIdentifier)

Description copied from interface: RemotedActor

notification method called once an actor has been unpublished. E.g. in case of a ClientSession role actor, this will be called once the client disconnects or times out

Specified by:

hasBeenUnpublished in interface RemotedActor

clientConnected

public void clientConnected(ConnectionRegistry connectionRegistry,
                            String connectionIdentifier)

Specified by:

clientConnected in interface ServingActor

clientDisconnected

public void clientDisconnected(ConnectionRegistry connectionRegistry,
                               String connectionIdentifier)

Specified by:

clientDisconnected in interface ServingActor