net.roboconf.messaging.processors

Class AbstractMessageProcessor<T extends IClient>

java.lang.Object

java.lang.Thread

net.roboconf.messaging.processors.AbstractMessageProcessor<T>

Type Parameters:

T - a sub-class of IClient

All Implemented Interfaces:

Runnable

public abstract class AbstractMessageProcessor<T extends IClient>
extends Thread

A message processor is in charge of (guess what) processing messages.

The DM is supposed to have only one message processor running.
Same thing for an agent. When the DM or an agent stops, the processor thread should be stopped.

This class is a thread that will process messages. The method stopProcessor() will stop processing messages after the current message is processed, or right after the next one is received. For an immediate stop, use the Thread.interrupt() method.

Author:

Vincent Zurczak - Linagora

Nested Class Summary

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

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected T	messagingClient

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
AbstractMessageProcessor(String threadName) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
LinkedBlockingQueue<Message>	getMessageQueue()
boolean	isRunning()
protected abstract void	processMessage(Message message) Processes a message.
void	run()
void	setMessagingClient(T messagingClient) This method must be invoked before Thread.start().
void	stopProcessor() Stops the processor.
void	storeMessage(Message message) Stores a message so that it can be processed later.

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

messagingClient

protected T extends IClient messagingClient

Constructor Detail

AbstractMessageProcessor

public AbstractMessageProcessor(String threadName)

Constructor.

Parameters:

threadName - the thread name

Method Detail

storeMessage

public final void storeMessage(Message message)

Stores a message so that it can be processed later.

Parameters:

message - a message to store

getMessageQueue

public LinkedBlockingQueue<Message> getMessageQueue()

Returns:

the messageQueue

setMessagingClient

public void setMessagingClient(T messagingClient)

This method must be invoked before Thread.start().

It is not recommended to change the messaging client once the thread has started. It is better to use a ReconfigurableClient to handle messaging reconfiguration.

Parameters:

messagingClient - the messaging client to set

run

public final void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

isRunning

public boolean isRunning()

Returns:

the running

stopProcessor

public void stopProcessor()

Stops the processor.

processMessage

protected abstract void processMessage(Message message)

Processes a message.

Parameters:

message - the message to process