com.goldencode.p2j.ui.client.driver.web

Class PushMessagesWorker

java.lang.Object

java.lang.Thread

com.goldencode.p2j.ui.client.driver.web.PushMessagesWorker

All Implemented Interfaces:

java.lang.Runnable

public class PushMessagesWorker
extends java.lang.Thread

For performance reasons the sending of messages to the remote end point via web sockets should be done asynchronously. A queue is used to store the messages. Messages are extracted from the queue in a FIFO order and are then pushed down to the remote end point.

IMPORTANT: Do not use logging anywhere inside this class. When an authentication plugin is running during session establishment with the P2J server using logging no messages are written into the log and the application becomes deadlocked.

Nested Class Summary

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

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
private static CentralLogger	LOG Logger
private java.util.Deque<java.lang.Object>	messages Messages queue
private boolean	running Running flag.
private org.eclipse.jetty.websocket.api.Session	session Remote session.
private java.lang.Object	sessionGuard The session guard object
private boolean	sessionInvalid The session state
private static long	WAIT_TO_DIE Time in milliseconds to wait for the thread exit.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
PushMessagesWorker() The default constructor.

Method Summary

Modifier and Type	Method and Description
org.eclipse.jetty.websocket.api.Session	getCurrentSession() Get the current session.
void	pushMessage(java.lang.Object message) Add a new message at the end of the FIFO queue and notify the push thread.
void	run() Get messages from queue and send.
private void	sendMessage(org.eclipse.jetty.websocket.api.Session session) Send a message.
void	setCurrentSession(org.eclipse.jetty.websocket.api.Session session) Set the current session.
void	stopPushing() Kill thread and wait to die.
private void	waitForMessages() Block if the queue is empty.

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, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final CentralLogger LOG

Logger

WAIT_TO_DIE

private static final long WAIT_TO_DIE

Time in milliseconds to wait for the thread exit.

See Also:

Constant Field Values

messages

private final java.util.Deque<java.lang.Object> messages

Messages queue

session

private org.eclipse.jetty.websocket.api.Session session

Remote session.

running

private boolean running

Running flag.

sessionGuard

private final java.lang.Object sessionGuard

The session guard object

sessionInvalid

private boolean sessionInvalid

The session state

Constructor Detail

PushMessagesWorker

public PushMessagesWorker()

The default constructor.

Method Detail

setCurrentSession

public void setCurrentSession(org.eclipse.jetty.websocket.api.Session session)

Set the current session.

Parameters:

session - The current websocket session

getCurrentSession

public org.eclipse.jetty.websocket.api.Session getCurrentSession()

Get the current session.

Returns:

The current websocket session

pushMessage

public void pushMessage(java.lang.Object message)

Add a new message at the end of the FIFO queue and notify the push thread.

Parameters:

message - A binary or a text message.

run

public void run()

Get messages from queue and send. Wait if no messages on queue.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

stopPushing

public void stopPushing()

Kill thread and wait to die.

waitForMessages

private void waitForMessages()

Block if the queue is empty. This will return when there are messages available in the queue OR in the case where the thread has been interrupted (this should be because the thread has been shutdown but it could also happen spuriously). For this reason, the caller must place this in a loop and check the running flag.

sendMessage

private void sendMessage(org.eclipse.jetty.websocket.api.Session session)

Send a message.

Parameters:

session - The current websocket session