Package org.jcsp.net2
Class NetBarrierLocation
java.lang.Object
org.jcsp.net2.NetLocation
org.jcsp.net2.NetBarrierLocation
- All Implemented Interfaces:
Serializable
This class is a data structure representing the location of a NetBarrier in a network. The NetBarrierLocation
consists of the NodeID of the Node on which the NetBarrier resides, and its Virtual Barrier Number, which is the
number uniquely identifying the NetBarrier on said node.
To acquire the NetBarrierLocation of a NetBarrier, use the getLocation method:
NetBarrierLocation location = (NetBarrierLocation)bar.getLocation();
The location returned depends on whether the NetBarrier is a client or a server end. A server end of a NetBarrier will return its own location. A client end of a NetBarrier will return the location of the server end it is connected to. This is because we consider the NetBarrier to be a single, virtual construct, with only one location. That location is where the server end of the NetBarrier is located.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final NodeID
The NodeID portion of the location structureprivate static final long
The SUID of this object.private final int
The index portion of the location structure -
Constructor Summary
ConstructorsConstructorDescriptionNetBarrierLocation
(NodeID aNodeID, int aVBN) Constructor to create a new NetBarrierLocation -
Method Summary
Modifier and TypeMethodDescriptionGets the NodeAddress part of the locationGets the NodeID part of the locationint
getVBN()
Gets the index part of the locationstatic NetBarrierLocation
Takes the string representation of a NetBarrierLocation and converts it back into an object for usage by JCSP.toString()
Returns the string representation of the NetBarrierLocation.
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDThe SUID of this object. Required for Serialization.- See Also:
-
nodeID
The NodeID portion of the location structure -
vbn
private final int vbnThe index portion of the location structure
-
-
Constructor Details
-
NetBarrierLocation
Constructor to create a new NetBarrierLocation- Parameters:
aNodeID
- The NodeID portion of the NetBarrierLocationaVBN
- The index part of the NetBarrierLocation
-
-
Method Details
-
getNodeID
Gets the NodeID part of the location- Specified by:
getNodeID
in classNetLocation
- Returns:
- The NodeID part of the NetBarrierLocation
-
getNodeAddress
Gets the NodeAddress part of the location- Specified by:
getNodeAddress
in classNetLocation
- Returns:
- The NodeAddress part of the NetBarrierLocation
-
getVBN
public int getVBN()Gets the index part of the location- Returns:
- The VBN part of the NetBarrierLocation
-
toString
Returns the string representation of the NetBarrierLocation. This takes the form of nbl://[NodeID]/[VBN]. This string representation has been created to allow other frameworks to interpret the NetBarrierLocation. -
parse
Takes the string representation of a NetBarrierLocation and converts it back into an object for usage by JCSP.- Parameters:
str
- The string representation of the NetBarrierLocation- Returns:
- A NetBarrierLocation produced from a String representation
- Throws:
IllegalArgumentException
- Thrown if a non NetBarrierLocation is attempted to be parsed
-