net.sf.jrtps.rtps

Class Endpoint

java.lang.Object

net.sf.jrtps.rtps.Endpoint

Direct Known Subclasses:

RTPSReader, RTPSWriter

public class Endpoint
extends Object

Base class for RTPSReader and RTPSWriter.

Author:

mcr70

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Endpoint(RTPSParticipant participant, EntityId entityId, String topicName, QualityOfService qos, Configuration configuration) Constructor

Method Summary

Modifier and Type	Method and Description
EntityId	getEntityId() Gets the EntityId of this Endpoint.
Guid	getGuid() Gets the Guid of this Endpoint.
protected RTPSParticipant	getParticipant() Get the RTPSParticipant, that created this entity.
QualityOfService	getQualityOfService() Gets the QualityOfService associated with this entity.
String	getTopicName() Gets the name of the topic associated with this Endpoint.
boolean	isSecure() Checks, if this endpoint is secure or not.
protected boolean	sendMessage(Message m, RemoteProxy proxy) Sends a message.

Methods inherited from class java.lang.Object

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

Constructor Detail

Endpoint

protected Endpoint(RTPSParticipant participant,
                   EntityId entityId,
                   String topicName,
                   QualityOfService qos,
                   Configuration configuration)

Constructor

Parameters:

participant - RTPSParticipant

entityId - EntityId

topicName - Name of the topic

qos - QualityOfService

configuration - Configuration

Method Detail

getTopicName

public String getTopicName()

Gets the name of the topic associated with this Endpoint.

Returns:

name of the topic

getGuid

public Guid getGuid()

Gets the Guid of this Endpoint.

Returns:

Guid

getEntityId

public EntityId getEntityId()

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

Returns:

EntityId

getQualityOfService

public QualityOfService getQualityOfService()

Gets the QualityOfService associated with this entity.

Returns:

QualityOfService

sendMessage

protected boolean sendMessage(Message m,
                              RemoteProxy proxy)

Sends a message. If an overflow occurs during marshaling of Message, only submessages before the overflow will get sent.

Parameters:

m - Message to send

proxy - proxy of the remote entity

Returns:

true, if an overflow occurred during send.

getParticipant

protected RTPSParticipant getParticipant()

Get the RTPSParticipant, that created this entity.

Returns:

RTPSParticipant

isSecure

public boolean isSecure()

Checks, if this endpoint is secure or not. If an endpoint is secure, every message that is being sent, will be encoded by Transformer.

Returns:

true or false