public class NetChannelLocation
Instances of this class hold location information for a networked
ChannelInput
object. Instances of the class hold sufficient
information for a networked ChannelOutput
object to establish
a connection to the networked ChannelInput
object.
Instances of this class may either be constructed by the
jcsp.net
user or by the networking infrastructure.
Constructor and description |
---|
NetChannelLocation
(NodeID channelNode, String channelLabel) |
NetChannelLocation
(NodeAddressID channelAddress, String channelLabel) |
protected NetChannelLocation
(NetChannelLocation other) |
Type | Name and description |
---|---|
protected boolean |
checkEqual(NetChannelLocation other) |
Object |
clone() |
boolean |
equals(Object o) |
NodeAddressID |
getChannelAddress() |
String |
getChannelLabel() |
NodeID |
getChannelNodeID() |
String |
getStringID() |
int |
hashCode() Return a hashcode for this object. |
boolean |
refresh() |
protected void |
refreshFrom(NetChannelLocation other) |
Constructor which takes the NodeID
of the Node hosting
the networked ChannelInput
object and the label assigned
to the channel's Virtual Channel Number (VCN).
channelNode
- the NodeID
of the Node hosting the
read end of the channel.channelLabel
- the label assigned to the channel's Virtual
Channel Number (VCN).
Constructor which takes a NodeAddressID
on which the
channel's Node is listening and the label assigned to the channel's
Virtual Channel Number (VCN).
This constructor is intended to be used by code that wishes to connect
to a ChannelInput
running on a Node to which a
Link
has not yet been established. An address of the Node
must be known by some means. For example, with a JCSP network running
over TCP/IP, a program may prompt the user for an IP address to which
to connect.
channelAddress
- a NodeAddressID
on which the channel's
Node is listening.channelLabel
- the label assigned to the channel's VCN.
This is a protected constructor which takes another
NetChannelLocation
object and "clones" it into this one.
This allows sub-classes to adopt the field values of an instance of
this class by passing a reference of it to this constructor.
null
.other
- Another NetChannelLocation
to "clone"
into this one.
This method is used by the equals(Object)
method
to determine whether another object is equal to the one on which
it is invoked.
This should be used by sub-classes as they cannot override the equals method.
true
if the other object is equal to this one.other the
- NetChannelLocation
object to
compare with this object.
Returns a clone of the instance of this class. All mutable fields are also cloned.
Returns whether this object is equal to another object.
true
iff the supplied object is equal.
Public accessor for the channel's address, if held.
NodeAddressID
on which the channel's Node is
listening. If the channel's Node's NodeID
is
known, then this will return null
.
Public accessor for the channel label property.
null
.
Public accessor for the channel label property.
NodeID
of the channel's Node, if known,
else null
.
Returns a String ID for this
NetChannelLocation
object.
This method does not need to be used by normal JCSP users.
Return a hashcode for this object.
int
hash code.
This method requests that the instance of this class refresh its information. This class does not actually do anything when this method is called, however, instances of subclasses may take the opportunity to refresh their data.
An example, of when this might be useful is if this class were
extended as part of a name service that resolves names to
NetChannelLocation
objects. If a user of an instance
of this extended version wanted to check that the data were still
up to date, it would call this method which would then check the
information with a name service.
true
if any information has changed, otherwise
false
.
This method refreshes the fields in the instance of this object to
equal the fields in the supplied object. Only members of the
NetChannelLocation
class are copied and not members
added by sub-classes.
null
.other
- Another NetChannelLocation
to "clone"
into this one.JCSP for Java 1.8 generated 14-10-2016 by Jon Kerridge, Edinburgh Napier University - j dot kerridge at napier dot ac dot uk