Port (Kompics Core 1.2.1 API)

All Known Subinterfaces:: Negative<E>, Positive<E>

All Known Implementing Classes:: JavaPort, PortCore

public interface Port<P extends PortType>

The Port class.

Version:: $Id$
Author:: Cosmin Arad <[email protected]>, Jim Dowling <[email protected]>, Lars Kroll <[email protected]>

Method Summary

Modifier and Type	Method	Description
`void`	`addChannel(ChannelCore<P> channel)`
`void`	`addChannel(ChannelCore<P> channel, ChannelSelector<?,?> filter)`
`<E extends KompicsEvent> void`	`doSubscribe(Handler<E> handler)`
`void`	`doSubscribe(MatchedHandler<?,?,?> handler)`
`void`	`doTrigger(KompicsEvent event, int wid, ChannelCore<?> channel)`	trigger event on this port
`void`	`doTrigger(KompicsEvent event, int wid, ComponentCore component)`	trigger event on this port
`void`	`enqueue(KompicsEvent event)`
`ComponentCore`	`getOwner()`
`PortCore<P>`	`getPair()`
`P`	`getPortType()`	Gets the port type.
`void`	`removeChannel(ChannelCore<P> remotePort)`
`void`	`setPair(PortCore<P> port)`

Method Details
- getPortType
  
  P getPortType()
  
  Gets the port type.
  
  Returns:
  
  the port type
- doTrigger
  
  void doTrigger(KompicsEvent event, int wid, ChannelCore<?> channel)
  
  trigger event on this port
  
  Parameters:
  
  event - to be triggered
  
  wid - ?
  
  channel - that triggered the event
- doTrigger
  
  void doTrigger(KompicsEvent event, int wid, ComponentCore component)
  
  trigger event on this port
  
  Parameters:
  
  event - to be triggered
  
  wid - ?
  
  component - that triggered the event
- getOwner
  
  ComponentCore getOwner()
  
  Returns:
  
  the component the port is part of
- getPair
  
  PortCore<P> getPair()
  
  Returns:
  
  complement port this one is connected to (if any)
- setPair
  
  void setPair(PortCore<P> port)
  
  Parameters:
  
  port - complement port
- doSubscribe
  
  <E extends KompicsEvent> void doSubscribe(Handler<E> handler)
- doSubscribe
  
  void doSubscribe(MatchedHandler<?,?,?> handler)
- addChannel
  
  void addChannel(ChannelCore<P> channel)
- addChannel
  
  void addChannel(ChannelCore<P> channel, ChannelSelector<?,?> filter)
- removeChannel
  
  void removeChannel(ChannelCore<P> remotePort)
- enqueue
  
  void enqueue(KompicsEvent event)