public interface Services
Modifier and Type | Method and Description |
---|---|
void |
addProvidesPort(Port inPort,
PortInfo name_type_and_props)
Exports a Port implemented by this component to the framework.
|
PortInfo |
createPortInfo(java.lang.String name,
java.lang.String type,
java.lang.String[] properties)
Creates a PortInfo to be used in subsequent calls to describe a Port.
|
ComponentID |
getComponentID()
Get a reference interface for the component to which this Services object belongs.
|
Port |
getPort(java.lang.String name)
Fetch a previously registered Port (defined by either addProvide or registerUses).
|
Port |
getPortNonblocking(java.lang.String name)
Fetch a previously registered Port (defined by
either addProvide or registerUses) and return that
Port if it is available immediately or return null
otherwise.
|
PortInfo[] |
getProvidedPorts()
UNADOPTED: Return the Ports this component currently provides.
|
PortInfo[] |
getRegisteredPorts()
UNADOPTED: Return the Ports this component currently wants.
|
void |
registerUsesPort(PortInfo name_and_type)
Register a request for a Port that will be retrieved subsequently
with a call to getPort().
|
void |
releasePort(java.lang.String name)
Notifies the framework that this component is finished using this previously
fetched Port.
|
void |
removeProvidesPort(java.lang.String name)
Notifies the framework that a previously exported Port is no longer
available for use.
|
void |
unregisterUsesPort(java.lang.String name)
Notify the framework that a Port, previously registered by this component,
is no longer desired.
|
Port getPort(java.lang.String name) throws java.lang.Exception
java.lang.Exception
- if named port is not known.Port getPortNonblocking(java.lang.String name) throws java.lang.Exception
java.lang.Exception
void releasePort(java.lang.String name)
PortInfo createPortInfo(java.lang.String name, java.lang.String type, java.lang.String[] properties)
PortInfo
void registerUsesPort(PortInfo name_and_type) throws java.lang.Exception
java.lang.Exception
- Registering the same name twice is an error,
regardless of the associated type or properties in the PortInfo.void unregisterUsesPort(java.lang.String name) throws java.lang.Exception
java.lang.Exception
- Unregistering a port which is currently in use (i.e.
an unreleased getPort() being outstanding) is an error.void addProvidesPort(Port inPort, PortInfo name_type_and_props) throws java.lang.Exception
java.lang.Exception
- Adding an already defined port name (registered or provided)
is an error.void removeProvidesPort(java.lang.String name)
PortInfo[] getProvidedPorts()
PortInfo[] getRegisteredPorts()
ComponentID getComponentID()