Package tools.refinery.interpreter.rete.network.mailbox.timeless

Class DefaultMailbox

java.lang.Object

tools.refinery.interpreter.rete.network.mailbox.timeless.DefaultMailbox

All Implemented Interfaces:

Clearable, IGroupable, AdaptableMailbox, Mailbox

public class DefaultMailbox
extends Object
implements AdaptableMailbox

Default mailbox implementation.

Usually, the mailbox performs counting of messages so that they can cancel each other out. However, if marked as a fall-through mailbox, than update messages are delivered directly to the receiver node to reduce overhead.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field	Description
protected Mailbox	adapter
protected Map<Tuple,Integer>	buffer
protected final ReteContainer	container
protected boolean	delivering
protected CommunicationGroup	group
protected Map<Tuple,Integer>	queue
protected final Receiver	receiver

Constructor Summary

Constructors

Constructor	Description
DefaultMailbox(Receiver receiver, ReteContainer container)

Method Summary

Modifier and Type	Method	Description
void	clear()
void	deliverAll(MessageSelector kind)	Delivers all messages according to the given selector from this mailbox.
protected Map<Tuple,Integer>	getActiveQueue()
Mailbox	getAdapter()
CommunicationGroup	getCurrentGroup()	Returns the CommunicationGroup of the receiver of this mailbox.
Receiver	getReceiver()	Returns the Receiver of this mailbox.
boolean	isEmpty()	Returns true if this mailbox is empty.
void	postMessage(Direction direction, Tuple update, Timestamp timestamp)	Posts a new message to this mailbox.
void	setAdapter(Mailbox adapter)
void	setCurrentGroup(CommunicationGroup group)	Sets the CommunicationGroup that the receiver of this mailbox is associated with.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

queue

protected Map<Tuple,Integer> queue

buffer

protected Map<Tuple,Integer> buffer

receiver

protected final Receiver receiver

container

protected final ReteContainer container

delivering

protected boolean delivering

adapter

protected Mailbox adapter

group

protected CommunicationGroup group

Constructor Details

DefaultMailbox

public DefaultMailbox(Receiver receiver,
 ReteContainer container)

Method Details

getActiveQueue

protected Map<Tuple,Integer> getActiveQueue()

getAdapter

public Mailbox getAdapter()

Specified by:

getAdapter in interface AdaptableMailbox

setAdapter

public void setAdapter(Mailbox adapter)

Specified by:

setAdapter in interface AdaptableMailbox

isEmpty

public boolean isEmpty()

Description copied from interface: Mailbox

Returns true if this mailbox is empty.

Specified by:

isEmpty in interface Mailbox

Returns:

postMessage

public void postMessage(Direction direction,
 Tuple update,
 Timestamp timestamp)

Description copied from interface: Mailbox

Posts a new message to this mailbox.

Specified by:

postMessage in interface Mailbox

Parameters:

direction - the direction of the update

update - the update element

deliverAll

public void deliverAll(MessageSelector kind)

Description copied from interface: Mailbox

Delivers all messages according to the given selector from this mailbox. The selector can also be null. In this case, no special separation is expected between the messages.

Specified by:

deliverAll in interface Mailbox

Parameters:

kind - the message selector

toString

public String toString()

Overrides:

toString in class Object

getReceiver

public Receiver getReceiver()

Description copied from interface: Mailbox

Returns the Receiver of this mailbox.

Specified by:

getReceiver in interface Mailbox

Returns:

the receiver

clear

public void clear()

Specified by:

clear in interface Clearable

getCurrentGroup

public CommunicationGroup getCurrentGroup()

Description copied from interface: Mailbox

Returns the CommunicationGroup of the receiver of this mailbox.

Specified by:

getCurrentGroup in interface IGroupable

Specified by:

getCurrentGroup in interface Mailbox

Returns:

the communication group

setCurrentGroup

public void setCurrentGroup(CommunicationGroup group)

Description copied from interface: Mailbox

Sets the CommunicationGroup that the receiver of this mailbox is associated with.

Specified by:

setCurrentGroup in interface IGroupable

Specified by:

setCurrentGroup in interface Mailbox

Parameters:

group - the communication group