Module org.tentackle.session

Package org.tentackle.session

Class DefaultSessionTaskDispatcher

java.lang.Object

java.lang.Thread

org.tentackle.task.DefaultTaskDispatcher

org.tentackle.session.DefaultSessionTaskDispatcher

All Implemented Interfaces:

Runnable, Killable, Supervisable, Terminatable, SessionTaskDispatcher, TaskDispatcher

public class DefaultSessionTaskDispatcher
extends DefaultTaskDispatcher
implements SessionTaskDispatcher

A thread executing tasks in a serialized manner on an exclusive connection.

Author:

harald

Nested Class Summary

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

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class org.tentackle.task.DefaultTaskDispatcher

INSTANCE_COUNTER

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor	Description
DefaultSessionTaskDispatcher(String name)	Creates a dispatcher to be configured later.
DefaultSessionTaskDispatcher(String name, Session session, boolean useMutexLocking, long keepAliveMillis, long deadInterval)	Creates an execution thread for a given session. The session must not be used by any other thread!

Method Summary

Modifier and Type	Method	Description
boolean	addTask(Task task)	Adds a task to the queue.
protected void	cleanup()
protected SessionTaskDispatcherLock	createLock(Object key)
Session	getSession()	Gets the session.
boolean	isSessionClosedOnTermination()	Returns whether the session should be closed on termination.
boolean	isSessionKeptAlive()	Gets the keepalive flag.
void	run()
void	setSession(Session session)	Sets the session.
void	setSessionClosedOnTermination(boolean closeSessionOnTermination)	Sets whether the session should be closed on termination.
void	setSessionKeptAlive(boolean sessionKeptAlive)	Sets the keepalive flag. If set, setAlive() will be invoked periodically to keep the session alive.
protected void	unlockInternal(long sleepMs)

Methods inherited from class org.tentackle.task.DefaultTaskDispatcher

addTaskAndWait, addTaskListener, assertAlive, assertIntervalsInRange, assertNotAlive, assertNotKilled, executeTask, fireCompleted, fireStarted, getAllTasks, getDeadInterval, getQueueSize, getShutdownIdleTimeout, getSleepInterval, getTask, getTerminationCause, getWaitInterval, interrupt, isDead, isInstanceOfTaskPending, isKilled, isQueueEmpty, isTaskDispatcherThread, isTaskPending, isTerminationRequested, isUsingMutexLocking, kill, lock, lockInternal, nextTask, removeTask, removeTaskListener, requestTermination, setDead, setDeadInterval, setShutdownIdleTimeout, setSleepInterval, setUsingMutexLocking, setWaitInterval, sleepForInterval, startedAt, terminate, terminatedAt, toDiagnosticString, unlock, waitForTask

Methods inherited from class java.lang.Thread

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tentackle.daemon.Supervisable

getName

Methods inherited from interface org.tentackle.task.TaskDispatcher

addTaskAndWait, addTaskListener, getAllTasks, getDeadInterval, getQueueSize, getShutdownIdleTimeout, getSleepInterval, getTask, getWaitInterval, isAlive, isInstanceOfTaskPending, isQueueEmpty, isTaskPending, isUsingMutexLocking, lock, removeTask, removeTaskListener, setDeadInterval, setShutdownIdleTimeout, setSleepInterval, setUsingMutexLocking, setWaitInterval, start, toDiagnosticString, unlock, waitForTask

Methods inherited from interface org.tentackle.daemon.Terminatable

isTerminationRequested, requestTermination, terminate

Constructor Details

DefaultSessionTaskDispatcher

public DefaultSessionTaskDispatcher(String name,
 Session session,
 boolean useMutexLocking,
 long keepAliveMillis,
 long deadInterval)

Creates an execution thread for a given session.
The session must not be used by any other thread!

Parameters:

name - the dispatcher's name

session - the open session

useMutexLocking - true use a mutex for locking, else just a counter

keepAliveMillis - keep alive in milliseconds

deadInterval - interval in milliseconds to detect a dead dispatcher, 0 to disable detection

DefaultSessionTaskDispatcher

public DefaultSessionTaskDispatcher(String name)

Creates a dispatcher to be configured later.

Parameters:

name - the dispatcher's name

Method Details

setSessionKeptAlive

public void setSessionKeptAlive(boolean sessionKeptAlive)

Description copied from interface: SessionTaskDispatcher

Sets the keepalive flag.
If set, setAlive() will be invoked periodically to keep the session alive.

Specified by:

setSessionKeptAlive in interface SessionTaskDispatcher

Parameters:

sessionKeptAlive - true if ping enabled

isSessionKeptAlive

public boolean isSessionKeptAlive()

Description copied from interface: SessionTaskDispatcher

Gets the keepalive flag.

Specified by:

isSessionKeptAlive in interface SessionTaskDispatcher

Returns:

true if ping enabled

getSession

public Session getSession()

Description copied from interface: SessionTaskDispatcher

Gets the session.

Specified by:

getSession in interface SessionTaskDispatcher

Returns:

the session

setSession

public void setSession(Session session)

Description copied from interface: SessionTaskDispatcher

Sets the session.

Specified by:

setSession in interface SessionTaskDispatcher

Parameters:

session - the session

isSessionClosedOnTermination

public boolean isSessionClosedOnTermination()

Description copied from interface: SessionTaskDispatcher

Returns whether the session should be closed on termination.

Specified by:

isSessionClosedOnTermination in interface SessionTaskDispatcher

Returns:

true to close, false to leave it open

setSessionClosedOnTermination

public void setSessionClosedOnTermination(boolean closeSessionOnTermination)

Description copied from interface: SessionTaskDispatcher

Sets whether the session should be closed on termination.

Specified by:

setSessionClosedOnTermination in interface SessionTaskDispatcher

Parameters:

closeSessionOnTermination - true to close, false to leave it open

createLock

protected SessionTaskDispatcherLock createLock(Object key)

Overrides:

createLock in class DefaultTaskDispatcher

addTask

public boolean addTask(Task task)

Adds a task to the queue.

Specified by:

addTask in interface TaskDispatcher

Overrides:

addTask in class DefaultTaskDispatcher

Parameters:

task - the task to add

Returns:

true if added, false if already in queue

unlockInternal

protected void unlockInternal(long sleepMs)

Overridden to run Session.setAlive(boolean) when sleeping for a while.

Overrides:

unlockInternal in class DefaultTaskDispatcher

run

public void run()

Overridden to set the thread-local session.

Specified by:

run in interface Runnable

Overrides:

run in class DefaultTaskDispatcher

cleanup

protected void cleanup()

Overridden to close the session.

Overrides:

cleanup in class DefaultTaskDispatcher