org.universAAL.middleware.bus.model

Class BusStrategy

java.lang.Object

java.lang.Thread

org.universAAL.middleware.bus.model.BusStrategy

All Implemented Interfaces:

Runnable

public abstract class BusStrategy
extends Thread

A bus strategy for handling messages. Subclasses must implement their strategy within the handle(Message) method.

Author:

mtazari - Saied Tazari

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 AbstractBus	bus
protected ModuleContext	busModule
protected org.universAAL.middleware.modules.CommunicationModule	commModule

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BusStrategy(org.universAAL.middleware.modules.CommunicationModule commModule) Constructor receiving the CommunicationModule instance and creating queue for the messages.
protected	BusStrategy(org.universAAL.middleware.modules.CommunicationModule commModule, String name) Constructor receiving the CommunicationModule instance and creating queue for the messages.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.universAAL.middleware.connectors.util.ChannelMessage	buildChannelMessage(org.universAAL.middleware.bus.msg.BusMessage m)
protected BusMember	getBusMember(String memberID) Returns bus member instance based on the bus member ID.
protected AbstractBus	getLocalBusByName(String name) Returns bus based on the passed bus name.
protected abstract void	handle(org.universAAL.middleware.bus.msg.BusMessage m, String senderID) Handle the message.
void	handleMessage(org.universAAL.middleware.bus.msg.BusMessage m, String senderID) This method handles the message asynchronously, while trying to preserve the order of the messages from the same source, according to the counters of the messages.
void	run() Runs BusStrategy.
protected void	send(org.universAAL.middleware.bus.msg.BusMessage message)
void	setBus(AbstractBus bus) Joins the bus and the BusStrategy.
void	stopThread() Stops BusStrategy Thread.

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

bus

protected AbstractBus bus

busModule

protected ModuleContext busModule

commModule

protected org.universAAL.middleware.modules.CommunicationModule commModule

Constructor Detail

BusStrategy

protected BusStrategy(org.universAAL.middleware.modules.CommunicationModule commModule)

Constructor receiving the CommunicationModule instance and creating queue for the messages.

Parameters:

commModule - CommunicationModule instance

BusStrategy

protected BusStrategy(org.universAAL.middleware.modules.CommunicationModule commModule,
           String name)

Constructor receiving the CommunicationModule instance and creating queue for the messages.

Parameters:

commModule - CommunicationModule instance

name - Human-readable name of the Bus Strategy

Method Detail

getBusMember

protected BusMember getBusMember(String memberID)

Returns bus member instance based on the bus member ID.

Parameters:

memberID - bus member ID

Returns:

BusMember

handle

protected abstract void handle(org.universAAL.middleware.bus.msg.BusMessage m,
          String senderID)

Handle the message. This method is different from the handleMessage(), in that handeMessage() handle the message asynchronously, while queuing the messages to preserve the order of the messages. This method is executed synchronously, without any queuing.

Parameters:

m - message

senderID - sender (bus member) ID

getLocalBusByName

protected AbstractBus getLocalBusByName(String name)

Returns bus based on the passed bus name.

Parameters:

name - bus name

Returns:

bus

handleMessage

public final void handleMessage(org.universAAL.middleware.bus.msg.BusMessage m,
                 String senderID)

This method handles the message asynchronously, while trying to preserve the order of the messages from the same source, according to the counters of the messages. (The counters are part of the message ID). The messages are queued, and they are inserted into the queue according to their counter.

Parameters:

m - message to be handled

senderID - sender ID

run

public final void run()

Runs BusStrategy. Until stopping process messages (in separate Threads)

Specified by:

run in interface Runnable

Overrides:

run in class Thread

setBus

public void setBus(AbstractBus bus)

Joins the bus and the BusStrategy.

Parameters:

bus - bus

stopThread

public final void stopThread()

Stops BusStrategy Thread.

buildChannelMessage

protected org.universAAL.middleware.connectors.util.ChannelMessage buildChannelMessage(org.universAAL.middleware.bus.msg.BusMessage m)

send

protected void send(org.universAAL.middleware.bus.msg.BusMessage message)