Class QueuedSocketWriter

java.lang.Object

java.lang.Thread

net.sf.colossus.webserver.QueuedSocketWriter

All Implemented Interfaces:

Runnable

class QueuedSocketWriter
extends Thread

Nested Class Summary

Nested classes/interfaces inherited from class Thread

Thread.Builder, Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	done
private boolean	flushed	Set to true when flushing is completed.
private final Object	flushMutex	Sending thread that requests the flushing, waits on this mutex until notified that the flush was completed (boolean 'flushed' below set to true).
private final int	instanceId
private static int	instanceIdCounter
(package private) static final Logger	LOGGER
private static final String	MSG_EXIT_LOOP
private static final String	MSG_FLUSH_MSGS
(package private) PrintWriter	out	The actual writer object which will send printed data over the socket.
private final LinkedBlockingQueue<String>	queue	The actual queue holding all messages that need to be sent.

Fields inherited from class Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor	Description
QueuedSocketWriter(Socket socket)

Method Summary

Modifier and Type	Method	Description
void	flushMessages()	Enqueues a flush marker and waits on the mutex until the flushing of all messages enqueued prior to the marker have been sent.
private String	readNextFromQueue()	We use no timeout while waiting for next message in the queue.
void	run()
void	sendMessage(String message)
void	stopWriter()

Methods inherited from class Thread

activeCount, checkAccess, clone, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, isVirtual, join, join, join, join, ofPlatform, ofVirtual, onSpinWait, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, sleep, start, startVirtualThread, stop, threadId, toString, yield

Methods inherited from class Object

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

Field Details

LOGGER

static final Logger LOGGER

MSG_EXIT_LOOP

private static final String MSG_EXIT_LOOP

See Also:

• Constant Field Values

MSG_FLUSH_MSGS

private static final String MSG_FLUSH_MSGS

See Also:

• Constant Field Values

queue

private final LinkedBlockingQueue<String> queue

The actual queue holding all messages that need to be sent. This is a concurrent-safe queue.

out

PrintWriter out

The actual writer object which will send printed data over the socket.

flushMutex

private final Object flushMutex

Sending thread that requests the flushing, waits on this mutex until notified that the flush was completed (boolean 'flushed' below set to true).

flushed

private boolean flushed

Set to true when flushing is completed.

done

private boolean done

instanceIdCounter

private static int instanceIdCounter

instanceId

private final int instanceId

Constructor Details

QueuedSocketWriter

public QueuedSocketWriter(Socket socket)
                   throws IOException

Throws:

IOException

Method Details

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

flushMessages

public void flushMessages()

Enqueues a flush marker and waits on the mutex until the flushing of all messages enqueued prior to the marker have been sent. (this does at the moment not imply that the client has received them (not to mention even has processed them).

stopWriter

public void stopWriter()

sendMessage

public void sendMessage(String message)

readNextFromQueue

private String readNextFromQueue()

We use no timeout while waiting for next message in the queue. To get it out of the loop, we enqueue a special marker (MSG_EXIT_LOOP).

Returns:

String containing the next message to write.