nl.tudelft.simulation.messaging.devices.components
Interface ReceivingDeviceInterface

All Superinterfaces:

DeviceInterface, nl.tudelft.simulation.event.EventProducerInterface

All Known Implementing Classes:

ReceivingDevice, SendingReceivingDevice

public interface ReceivingDeviceInterface

extends DeviceInterface

The ReceivingDeviceInterface, which extends the standard functionality of a device by adding a method to receive a message, and a method to retrieve the queue of messages that have already been received.

Copyright (c) 2003-2005 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information www.simulation.tudelft.nl . The source code and binary code of this software is proprietary information of Delft University of Technology.

Version:

$$Revision: 1.2 $$ $$Date: 2005/04/08 10:56:35 $$

Author:

Peter Jacobs , Stijn-Pieter van Houten , Alexander Verbraeck

Field Summary

static nl.tudelft.simulation.event.EventType

RECEIVED_NEW_MESSAGE_EVENT The event to indicate we received a message

Fields inherited from interface nl.tudelft.simulation.messaging.devices.components.DeviceInterface

STATE_CHANGE_EVENT

Fields inherited from interface nl.tudelft.simulation.event.EventProducerInterface

FIRST_POSITION, LAST_POSITION

Method Summary

MessageQueueInterface	getQueue() get the queue of messages that have already been received.
java.lang.Object	receive(Message message) receives a message

Methods inherited from interface nl.tudelft.simulation.messaging.devices.components.DeviceInterface

getDeviceType, getName, getState, getTransmissionDelay, getTransmissionFrequency

Methods inherited from interface nl.tudelft.simulation.event.EventProducerInterface

addListener, addListener, addListener, addListener, getEventTypes, removeListener

Field Detail

RECEIVED_NEW_MESSAGE_EVENT

public static final nl.tudelft.simulation.event.EventType RECEIVED_NEW_MESSAGE_EVENT

The event to indicate we received a message

Method Detail

receive

public java.lang.Object receive(Message message)

receives a message

Parameters:

message - the message

Returns:

acknowledgement

getQueue

public MessageQueueInterface getQueue()

get the queue of messages that have already been received.

Returns:

Returns the message queue.