public final class NetBarrierLocation extends NetLocation
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.
Constructor and description |
---|
NetBarrierLocation
(NodeID aNodeID, int aVBN) Constructor to create a new NetBarrierLocation |
Type | Name and description |
---|---|
NodeAddress |
getNodeAddress() Gets the NodeAddress part of the location |
NodeID |
getNodeID() Gets the NodeID part of the location |
int |
getVBN() Gets the index part of the location |
static NetBarrierLocation |
parse(String str) Takes the string representation of a NetBarrierLocation and converts it back into an object for usage by JCSP. |
String |
toString() Returns the string representation of the NetBarrierLocation. |
Methods inherited from class | Name |
---|---|
class NetLocation |
getNodeAddress, getNodeID |
Constructor to create a new NetBarrierLocation
aNodeID
- The NodeID portion of the NetBarrierLocationaVBN
- The index part of the NetBarrierLocationGets the NodeAddress part of the location
Gets the NodeID part of the location
Gets the index part of the location
Takes the string representation of a NetBarrierLocation and converts it back into an object for usage by JCSP.
str
- The string representation of the NetBarrierLocationReturns 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.
JCSP for Java 1.8 generated 14-10-2016 by Jon Kerridge, Edinburgh Napier University - j dot kerridge at napier dot ac dot uk