ikr.simlib.ports.input

Class CallbackInputPort

java.lang.Object

ikr.simlib.ports.Port

ikr.simlib.ports.input.InputPort

ikr.simlib.ports.input.CallbackInputPort

public class CallbackInputPort
extends InputPort

Convenience class to use instead of manually deriving from InputPort.

Allows to specify a callback function which is executed whenever message indication is signalled from the connected output port. Three interfaces support different method signatures to make usage with java 1.8 closure syntax more convenient.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CallbackInputPort.MessageIndicationHandler callback interface with port and message arguments
static interface	CallbackInputPort.MessageIndicationHandlerMessage callback interface with message argument
static interface	CallbackInputPort.MessageIndicationHandlerNoArgs callback interface with no arguments

Field Summary

Fields inherited from class ikr.simlib.ports.input.InputPort

INPUT_PORT_NAME, prev

Fields inherited from class ikr.simlib.ports.Port

LOG, owner, portName

Constructor Summary

Constructors

Constructor and Description
CallbackInputPort(Entity owner, CallbackInputPort.MessageIndicationHandler msgIndicationhandler)
CallbackInputPort(Entity owner, CallbackInputPort.MessageIndicationHandlerMessage msgIndicationhandler)
CallbackInputPort(Entity owner, CallbackInputPort.MessageIndicationHandlerNoArgs msgIndicationhandler)
CallbackInputPort(Entity owner, java.lang.String portName, CallbackInputPort.MessageIndicationHandler msgIndicationhandler)
CallbackInputPort(Entity owner, java.lang.String portName, CallbackInputPort.MessageIndicationHandlerMessage msgIndicationhandler)
CallbackInputPort(Entity owner, java.lang.String portName, CallbackInputPort.MessageIndicationHandlerNoArgs msgIndicationhandler)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	handleMessageIndication(Message msg)

Methods inherited from class ikr.simlib.ports.input.InputPort

getConnectedOutputPort, getConnectedPort, handleGetMessage, handleIsMessageAvailable, setConnectedOutputPort

Methods inherited from class ikr.simlib.ports.Port

addPortMonitor, getDelimiter, getLocalName, getMessage, getName, getOwner, isConnected, isMessageAvailable, messageIndication, removePortMonitor

Methods inherited from class java.lang.Object

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

Constructor Detail

CallbackInputPort

public CallbackInputPort(Entity owner,
                 java.lang.String portName,
                 CallbackInputPort.MessageIndicationHandler msgIndicationhandler)

CallbackInputPort

public CallbackInputPort(Entity owner,
                 CallbackInputPort.MessageIndicationHandler msgIndicationhandler)

CallbackInputPort

public CallbackInputPort(Entity owner,
                 java.lang.String portName,
                 CallbackInputPort.MessageIndicationHandlerMessage msgIndicationhandler)

CallbackInputPort

public CallbackInputPort(Entity owner,
                 CallbackInputPort.MessageIndicationHandlerMessage msgIndicationhandler)

CallbackInputPort

public CallbackInputPort(Entity owner,
                 java.lang.String portName,
                 CallbackInputPort.MessageIndicationHandlerNoArgs msgIndicationhandler)

CallbackInputPort

public CallbackInputPort(Entity owner,
                 CallbackInputPort.MessageIndicationHandlerNoArgs msgIndicationhandler)

Method Detail

handleMessageIndication

protected void handleMessageIndication(Message msg)

Specified by:

handleMessageIndication in class Port