net.sf.jrtps.rtps

Class RemoteProxy

java.lang.Object

net.sf.jrtps.rtps.RemoteProxy

Direct Known Subclasses:

ReaderProxy, WriterProxy

public class RemoteProxy
extends Object

A base class used to represent a remote entity.

Author:

mcr70

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RemoteProxy(DiscoveredData dd, List<Locator> locators) Constructor for RemoteProxy.

Method Summary

Modifier and Type	Method and Description
DiscoveredData	getDiscoveredData() Gets the DiscoveredData associated with this Proxy.
EntityId	getEntityId() Gets the EntityId of remote entity.
Guid	getGuid() Gets the Guid of remote entity.
Locator	getLocator() Gets the Locator for the remote entity.
List<Locator>	getLocators() Gets all the locators for this RemoteProxy
boolean	isReliable() Return true, if remote entity represented by this RemoteProxy is configured to be reliable.
void	preferMulticast(boolean preferMulticast) Sets whether or not to prefer multicast.
String	toString()
void	update(DiscoveredData dd) Updates DiscoveredData of this RemoteProxy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RemoteProxy

protected RemoteProxy(DiscoveredData dd,
                      List<Locator> locators)

Constructor for RemoteProxy.

Parameters:

dd - DiscoveredData

locators - a List of Locators

Method Detail

update

public void update(DiscoveredData dd)

Updates DiscoveredData of this RemoteProxy

Parameters:

dd - DiscoveredData

getLocator

public Locator getLocator()

Gets the Locator for the remote entity. Tries to return preferred locator (unicast or multicast). If the preferred locator is null, return non preferred locator. By default, unicast is preferred.

Returns:

Locator

getLocators

public List<Locator> getLocators()

Gets all the locators for this RemoteProxy

Returns:

All the locators that can be handled by TransportProviders

getDiscoveredData

public DiscoveredData getDiscoveredData()

Gets the DiscoveredData associated with this Proxy.

Returns:

DiscoveredData

isReliable

public boolean isReliable()

Return true, if remote entity represented by this RemoteProxy is configured to be reliable.

Returns:

true, if this RemoteProxy represents a reliable entity

getGuid

public Guid getGuid()

Gets the Guid of remote entity.

Returns:

Guid

getEntityId

public EntityId getEntityId()

Gets the EntityId of remote entity. This is method behaves the same as calling getGuid().getEntityId().

Returns:

EntityId

preferMulticast

public void preferMulticast(boolean preferMulticast)

Sets whether or not to prefer multicast. Default is not to prefer multicast.

Parameters:

preferMulticast - Whether or not proxy prefers multicast

toString

public String toString()

Overrides:

toString in class Object