All Packages This Package Class Hierarchy Class Search Index
java.lang.Object | +----utah.npm.core.Lockable | +----utah.npm.core.NPMObject | +----utah.npm.core.Refable | +----utah.npm.core.Port
Summary |
public class Port extends utah.npm.core.Refable { // Fields 2 private Object alias_; private final Link pset_; // Constructors 2 public Port(Object, Reference); public Port(Object, Reference, int); // Methods 8 static String typeName(); public void destroy(); Object s_getAlias(); Link s_getPSetLink(); protected void s_init(Object, Reference, int); int s_type(); public void setAlias(Object); public String toString(); }
A Port is a server-side IPC connection point. Ports are aggregated into a single PortSet for server threads to service. Clients connect to a Port through a Port Reference.
Fields |
· alias_ | Summary | Top |
private Object alias_
The server alias for this port. The alias is used to distinguish which port a client connected to when a server blocks on a PortSet with more than one item.
· pset_ | Summary | Top |
private final Link pset_
A link to the PortSet this Port is associated with.
See Also: PortSet
Constructors |
· Port | Summary | Top |
public Port(Object alias, Reference portSet)
Create a new Port object. The provided alias will be returned to server threads that service client threads which connnect through this port. See IPC.serverWaitReceive()
Parameter Description alias the object alias to associate with this Port portSet the PortSet to associate this object with.
See Also: IPC.serverWaitReceive
· Port | Summary | Top |
public Port(Object alias, Reference portSet, int hashCode)
Create a new Port object. The provided alias will be returned to server threads that service client threads which connnect through this port. See IPC.serverWaitReceive()
Parameter Description alias the object alias to associate with this Port portSet the PortSet to associate this object with. hashCode the hashcode to use for this object.
See Also: IPC.serverWaitReceive
Methods |
· s_init | Summary | Top |
protected void s_init(Object alias, Reference portSet, int hashCode)
Performs internal initalization of this Port.
Parameter Description alias the object alias to associate with this Port portSet the PortSet to associate this object with. hashCode the hashcode to use for this object.
· setAlias | Summary | Top |
public void setAlias(Object alias)
Set the alias object associated with this Port.
Parameter Description alias the object alias to associate with this Port
· destroy | Summary | Top |
public void destroy()
Destroy this Port object.
- Overrides:
- destroy in class Refable
· toString | Summary | Top |
public String toString()
Generate a string representation of this Port (includes the alias and PortSet)
- Returns:
- a string describing this Port.
- Overrides:
- toString in class NPMObject
· typeName | Summary | Top |
static String typeName()
- Overrides:
- typeName in class NPMObject
· s_getAlias | Summary | Top |
Object s_getAlias()
Package interface for retreving this Port's alias object. The Port must be locked by the caller.
- Returns:
- the alias object associated with this Port.
· s_getPSetLink | Summary | Top |
Link s_getPSetLink()
Package interface for retreving this Port's PortSet link. The Port must be locked by the caller.
- Returns:
- the alias object associated with this Port.
· s_type | Summary | Top |
int s_type()
Package interface for retreiving the type of this object.
- Returns:
- NPMObject.PortType
- Overrides:
- s_type in class NPMObject
See Also: NPMObject.s_type, NPMObject.PortType
All Packages This Package Class Hierarchy Class Search IndexFreshly brewed Java API Documentation automatically generated with polardoc Version 1.0.7