org.nustaq.kontraktor.impl

Class DispatcherThread

java.lang.Object

java.lang.Thread

org.nustaq.kontraktor.impl.DispatcherThread

All Implemented Interfaces:

Runnable, Monitorable

public class DispatcherThread
extends Thread
implements Monitorable

Implements the default dispatcher/scheduling of actors. For each actor created from "outside" (not from within another actor). A new DispatcherThread is created automatically. An actor created from within another actor inherits the dispatcher of the enclosing actor by default. Calls from actors sharing the same dispatcher are done directly (no queueing). Calls across actors in different dispatchers are put to the Channel of the receiving dispatcher. Note that cross-dispatcher calls are like 1000 times slower than inbound calls. Each dispatcher owns exactly one single thread. Note that dispatchers must be terminated if not needed any longer, as a thread is associated with them. For more sophisticated applications it might be appropriate to manually set up dispatchers (Actors.assignDispatcher()). The Actors.Channel method allows to specifiy a dedicated dispatcher on which to run the actor. This way it is possible to exactly balance and control the number of threads created and which thread operates a set of actors.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DispatcherThread.DispatcherReport

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
static int	MILLIS_AFTER_CREATION_BEFORE_REBALANCING
static int	QUEUE_PERCENTAGE_TRIGGERING_REBALANCE
static int	SCHEDULE_TICK_NANOS
protected boolean	shutDown

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
DispatcherThread(Scheduler scheduler)

Method Summary

Modifier and Type	Method and Description
Future	$getReport()
Future<Monitorable[]>	$getSubMonitorables()
void	addActor(Actor act)
int	getAccumulatedQSizes() accumulated queue sizes of all actors
Actor[]	getActors()
int	getLoad()
int	getQSize()
Scheduler	getScheduler()
boolean	isEmpty()
boolean	isIsolated()
boolean	isShutDown()
boolean	pollQs()
boolean	pollQs(Actor[] actors)
protected CallEntry	pollQueues(Actor[] actors)
void	run()
void	schedulePendingAdds() add actors which have been marked to be scheduled on this
boolean	schedules(Object receiverRef) can be called from the dispacther thread itself only
void	setIsolated(boolean isIsolated)
void	shutDown() terminate operation after emptying Q
void	shutDownImmediate() terminate operation immediately.
String	toString()
void	waitEmpty(long nanos) blocking method, use for debugging only.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, yield

Methods inherited from class java.lang.Object

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

Field Detail

SCHEDULE_TICK_NANOS

public static int SCHEDULE_TICK_NANOS

QUEUE_PERCENTAGE_TRIGGERING_REBALANCE

public static int QUEUE_PERCENTAGE_TRIGGERING_REBALANCE

MILLIS_AFTER_CREATION_BEFORE_REBALANCING

public static int MILLIS_AFTER_CREATION_BEFORE_REBALANCING

shutDown

protected boolean shutDown

Constructor Detail

DispatcherThread

public DispatcherThread(Scheduler scheduler)

Method Detail

toString

public String toString()

Overrides:

toString in class Thread

isIsolated

public boolean isIsolated()

setIsolated

public void setIsolated(boolean isIsolated)

addActor

public void addActor(Actor act)

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

schedulePendingAdds

public void schedulePendingAdds()

add actors which have been marked to be scheduled on this

pollQueues

protected CallEntry pollQueues(Actor[] actors)

pollQs

public boolean pollQs()

pollQs

public boolean pollQs(Actor[] actors)

Returns:

false if no message could be polled

getLoad

public int getLoad()

Returns:

percentage of queue fill of max actor

getAccumulatedQSizes

public int getAccumulatedQSizes()

accumulated queue sizes of all actors

Returns:

getQSize

public int getQSize()

Returns:

accumulated q size of all dispatched actors

isShutDown

public boolean isShutDown()

Returns:

true if DispatcherThread is not shut down

shutDown

public void shutDown()

terminate operation after emptying Q

shutDownImmediate

public void shutDownImmediate()

terminate operation immediately. Pending messages in Q are lost

isEmpty

public boolean isEmpty()

waitEmpty

public void waitEmpty(long nanos)

blocking method, use for debugging only.

getScheduler

public Scheduler getScheduler()

getActors

public Actor[] getActors()

Returns:

a copy of actors used

schedules

public boolean schedules(Object receiverRef)

can be called from the dispacther thread itself only

Parameters:

receiverRef -

Returns:

$getReport

public Future $getReport()

Specified by:

$getReport in interface Monitorable

$getSubMonitorables

public Future<Monitorable[]> $getSubMonitorables()

Specified by:

$getSubMonitorables in interface Monitorable