edu.rice.hj.experimental.actors

Class Selector<MessageType>

java.lang.Object

edu.rice.hj.experimental.actors.Selector<MessageType>

Direct Known Subclasses:

DeclarativeSelector, ReaderWriterActor

public abstract class Selector<MessageType>
extends Object

A special actor which classifies messages based on an enum by storing the messages in different mailboxes (channels). The user has the option to enable/disable each of the mailboxes which affects which message is processed next. Enabling/disabling does not affect whether other actors can send messages to these mailboxes.

Details: Selectors: Actors with Multiple Guarded Mailboxes. Shams Imam, Vivek Sarkar. 4th International Workshop on Programming based on Actors, Agents, and Decentralized Control (AGERE! 2014), October 2014.

Author:

Shams Imam (shams@rice.edu), Vivek Sarkar (vsarkar@rice.edu)

Field Summary

Fields

Modifier and Type	Field and Description
protected int	numClassifiers

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Selector(Class<? extends Enum<?>> enumClass)
protected	Selector(Class<? extends Enum<?>> enumClass, boolean pAlwaysSequentialBody)
protected	Selector(int numMailboxes)
protected	Selector(int numMailboxes, boolean pAlwaysSequentialBody)
protected	Selector(int numMailboxes, boolean pAlwaysSequentialBody, boolean pPriorityPolicy)

Method Summary

Modifier and Type	Method and Description
protected void	disable(Enum<?> enumType) Disable the channel for enumType.
protected void	disable(int mailboxId) Disable the channel for enumType.
protected void	disableAllExcept(Enum<?> enumType) Disables all the channels except the one for enumType.
protected void	disableAllExcept(int mailboxId) Disables all the channels except the one at mailboxId.
protected void	enable(Enum<?> enumType) Enable the channel for enumType.
protected void	enable(int mailboxId) Enable the channel for enumType.
protected void	enableAll() Enables all the channels.
protected void	exit() Call this to signal intention for the selector to terminate
protected void	handleThrowable(Throwable th) handleThrowable.
boolean	hasStarted()
protected boolean	isEnabled(Enum<?> enumType) Returns whether the specified mailbox is currently enabled
protected boolean	isEnabled(int mailboxId) Returns whether the specified mailbox is currently enabled
protected void	onPostExit() Convenience: specify code to be executed after selector is terminated
protected void	onPostStart() Convenience: specify code to be executed after selector is started
protected void	onPreExit() Convenience: specify code to be executed before selector is terminated
protected void	onPreStart() Convenience: specify code to be executed before selector is started
protected abstract void	process(MessageType theMsg) Callback allowing user to have custom behavior while processing messages.
void	send(Enum<?> enumType, MessageType message)
void	send(int classifierId, MessageType message)
void	start() Causes the selector to start processing messages that have been sent to it. pause() messages before the selector was started are ignored.
void	start(HjPlace hjPlace) Causes the selector to start processing messages that have been sent to it. pause() messages before the selector was started are ignored.
protected void	tryProcessMessage(int localSearchStartIndex) Try and process message from an active mailbox.

Methods inherited from class java.lang.Object

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

Field Detail

numClassifiers

protected final int numClassifiers

Constructor Detail

Selector

protected Selector(Class<? extends Enum<?>> enumClass)

Parameters:

enumClass - The enum used to classify the different messages sent to this Actor

Throws:

NullPointerException - if enumClass is null

IllegalArgumentException - if enumClass does not represent an enum

Selector

protected Selector(int numMailboxes)

Parameters:

numMailboxes - The number of mailboxes to use

Selector

protected Selector(int numMailboxes,
                   boolean pAlwaysSequentialBody)

Parameters:

numMailboxes - The number of mailboxes to use

pAlwaysSequentialBody - (Optimization flag) Explicit notification from user for sequential message processing body

Selector

protected Selector(int numMailboxes,
                   boolean pAlwaysSequentialBody,
                   boolean pPriorityPolicy)

Selector

protected Selector(Class<? extends Enum<?>> enumClass,
                   boolean pAlwaysSequentialBody)

Parameters:

enumClass - The enum used to classify the different messages sent to this Actor

pAlwaysSequentialBody - (Optimization flag) Explicit notification from user for sequential message processing body

Throws:

NullPointerException - if enumClass is null

IllegalArgumentException - if enumClass does not represent an enum

Method Detail

hasStarted

public final boolean hasStarted()

start

public final void start()

Causes the selector to start processing messages that have been sent to it. pause() messages before the selector was started are ignored.

start

public final void start(HjPlace hjPlace)

Causes the selector to start processing messages that have been sent to it. pause() messages before the selector was started are ignored.

onPreStart

protected void onPreStart()

Convenience: specify code to be executed before selector is started

onPostStart

protected void onPostStart()

Convenience: specify code to be executed after selector is started

exit

protected final void exit()

Call this to signal intention for the selector to terminate

onPreExit

protected void onPreExit()

Convenience: specify code to be executed before selector is terminated

onPostExit

protected void onPostExit()

Convenience: specify code to be executed after selector is terminated

process

protected abstract void process(MessageType theMsg)

Callback allowing user to have custom behavior while processing messages.

Parameters:

theMsg - message to process

send

public final void send(Enum<?> enumType,
                       MessageType message)

Parameters:

enumType - The classifier for the mailbox this message goes into

message - The message to send to this selector

Throws:

NullPointerException - if enumType is null

send

public final void send(int classifierId,
                       MessageType message)

Parameters:

classifierId -

message -

enableAll

protected final void enableAll()

Enables all the channels.

disableAllExcept

protected final void disableAllExcept(Enum<?> enumType)

Disables all the channels except the one for enumType.

disableAllExcept

protected final void disableAllExcept(int mailboxId)

Disables all the channels except the one at mailboxId.

enable

protected final void enable(int mailboxId)

Enable the channel for enumType.

enable

protected final void enable(Enum<?> enumType)

Enable the channel for enumType.

disable

protected final void disable(Enum<?> enumType)

Disable the channel for enumType.

disable

protected final void disable(int mailboxId)

Disable the channel for enumType.

isEnabled

protected final boolean isEnabled(Enum<?> enumType)

Returns whether the specified mailbox is currently enabled

Parameters:

enumType - The mailbox to check

Returns:

whether the specified mailbox is currently enabled

isEnabled

protected final boolean isEnabled(int mailboxId)

Returns whether the specified mailbox is currently enabled

Parameters:

mailboxId - The mailbox to check

Returns:

whether the specified mailbox is currently enabled

tryProcessMessage

protected void tryProcessMessage(int localSearchStartIndex)

Try and process message from an active mailbox. Do nothing if no active message is found.

Parameters:

localSearchStartIndex - The index from which to start searching the mailboxes

handleThrowable

protected void handleThrowable(Throwable th)

handleThrowable.

Parameters:

th - The exception that occurred while processing a message.