net.sf.jrtps.udds

Class Participant

java.lang.Object

net.sf.jrtps.udds.Participant

public class Participant
extends Object

Participant acts as a communication endpoint of different data.

Author:

mcr70

Constructor Summary

Constructors

Constructor and Description
Participant() Create a Participant with domainId 0 and participantId -1.
Participant(int domainId) Create a Participant with given domainId and participantId -1.
Participant(int domainId, int participantId) Create a Participant with given domainId and participantId.
Participant(int domainId, int participantId, EntityFactory ef, Configuration cfg) Create a Participant with given domainId and participantId.

Method Summary

Modifier and Type	Method and Description
void	addEntityListener(EntityListener el) Adds a new EntityListener
void	assertLiveliness() Asserts liveliness of writers, whose QosLiveliness kind is MANUAL_BY_PARTICIPANT.
void	close() Close this participant.
<T> DataReader<T>	createDataReader(Class<T> type) Create a new DataReader for given type T.
<T> DataReader<T>	createDataReader(Class<T> type, QualityOfService qos) Create a new DataReader for given type T.
<T> DataReader<T>	createDataReader(String topicName, Class<T> type, String typeName, QualityOfService qos) Create a DataReader.
<T> DataWriter<T>	createDataWriter(Class<T> type) Creates a new DataWriter of given type.
<T> DataWriter<T>	createDataWriter(Class<T> type, QualityOfService qos) Creates a new DataWriter of given type.
<T> DataWriter<T>	createDataWriter(String topicName, Class<T> type, String typeName, QualityOfService qos) Create a DataWriter.
List<EntityListener>	getEntityListeners() Gets EntityListeners
Guid	getGuid() Gets the Guid of this Participant.
DataReader<?>	getReader(EntityId readerId) Finds a Reader with given entity id.
List<DataReader<?>>	getReaders() Gets DataReaders created by this Participant.
DataWriter<?>	getWriter(EntityId writerId) Finds a Writer with given entity id.
List<DataWriter<?>>	getWriters() Gets DataWriters created by this Participant.
void	setEntityFactory(EntityFactory ef) Sets the EntityFactory of this Participant to given one.
<T> void	setMarshaller(Class<T> type, Marshaller<T> m) Sets a type specific Marshaller.

Methods inherited from class java.lang.Object

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

Constructor Detail

Participant

public Participant()

Create a Participant with domainId 0 and participantId -1.

Participant

public Participant(int domainId)

Create a Participant with given domainId and participantId -1.

Parameters:

domainId - domainId

Participant

public Participant(int domainId,
                   int participantId)

Create a Participant with given domainId and participantId.

Parameters:

domainId - Domain ID

participantId - Participant ID

Participant

public Participant(int domainId,
                   int participantId,
                   EntityFactory ef,
                   Configuration cfg)

Create a Participant with given domainId and participantId. Participants with same domainId are able to communicate with each other. participantId is used to distinguish participants within this domain(and JVM). More specifically, domainId and participantId are used to select networking ports used by participant. If participantId is set to -1, participantId will be determined during starting of network receivers. First participantId (based on available port number) available will be used.

Participant delegates creation of DataWriters and DataReaders to EntityFactory. By providing a custom EntityFactory, application can provide customized DataReaders and DataWriters, including entities for builtin topics.

Parameters:

domainId - Domain Id of this participant.

participantId - Participant Id of this participant.

ef - EntityFactory to be used. If ef is null, a default EntityFactory will be used.

cfg - Configuration used. If config is null, default Configuration is used.

Method Detail

getGuid

public Guid getGuid()

Gets the Guid of this Participant.

Returns:

guid

createDataReader

public <T> DataReader<T> createDataReader(Class<T> type)

Create a new DataReader for given type T. DataReader is bound to a topic named c.getSimpleName(), which corresponds to class name of the argument. If Class type has a TypeName annotation set, it will be used to set the value of TypeName to be announced to remote entities. Otherwise TypeName is set to fully qualified class name.

Type Parameters:

T - Type of DataReader

Parameters:

type - Type of the DataReader to create

Returns:

a DataReader

createDataReader

public <T> DataReader<T> createDataReader(Class<T> type,
                                          QualityOfService qos)

Create a new DataReader for given type T. DataReader is bound to a topic named type.getSimpleName(), which corresponds to class name of the argument. If Class type has a TypeName annotation set, it will be used to set the value of TypeName to be announced to remote entities. Otherwise TypeName is set to fully qualified class name.

Type Parameters:

T - Type of DataReader

Parameters:

type - Type of the DataReader to create

qos - QualityOfService used

Returns:

a DataReader

createDataReader

public <T> DataReader<T> createDataReader(String topicName,
                                          Class<T> type,
                                          String typeName,
                                          QualityOfService qos)

Create a DataReader. All the properties(topicName, type, typeName, qos) of the DataReader is given in parameters.

Type Parameters:

T - Type of the reader

Parameters:

topicName - name of the topic

type - type of the DataReader

typeName - name of the type

qos - QualityOfService

Returns:

a DataReader

createDataWriter

public <T> DataWriter<T> createDataWriter(Class<T> type)

Creates a new DataWriter of given type. DataWriter is bound to a topic named c.getSimpleName(), which corresponds to class name of the argument. If Class type has a TypeName annotation set, it will be used to set the value of TypeName to be announced to remote entities. Otherwise TypeName is set to fully qualified class name.

Type Parameters:

T - Type of DataWriter

Parameters:

type - A class, that is used with created DataWriter.

Returns:

a DataWriter

createDataWriter

public <T> DataWriter<T> createDataWriter(Class<T> type,
                                          QualityOfService qos)

Creates a new DataWriter of given type. DataWriter is bound to a topic named c.getSimpleName(), which corresponds to class name of the argument. If Class type has a Topic annotation set, it will be used to set the value of TypeName to be announced to remote entities. Otherwise TypeName is set to fully qualified class name.

Type Parameters:

T - Type of DataWriter

Parameters:

type - A class, that is used with created DataWriter.

qos - QualityOfService

Returns:

a DataWriter

createDataWriter

public <T> DataWriter<T> createDataWriter(String topicName,
                                          Class<T> type,
                                          String typeName,
                                          QualityOfService qos)

Create a DataWriter. All the properties(topicName, type, typeName, qos) of the DataWriter is given in parameters.

Type Parameters:

T - Type of DataWriter

Parameters:

topicName - name of the topic

type - type of the DataWriter

typeName - name of the type. typeName gets sent to remote readers.

qos - QualityOfService

Returns:

a DataWriter

setMarshaller

public <T> void setMarshaller(Class<T> type,
                              Marshaller<T> m)

Sets a type specific Marshaller. When creating entities, a type specific Marshaller is preferred over other matching Marshallers.

Type Parameters:

T - Type of Marshaller

Parameters:

type - a Class, that will be associated with given Marshaller

m - Marshaller associated with given typ

setEntityFactory

public void setEntityFactory(EntityFactory ef)

Sets the EntityFactory of this Participant to given one. All the entities created after setting of EntityFactory will be created by that EntityFactory. Previously created entities remain as before.

This method provides means to create entities by different EntityFactories. For example, one might want to create builtin entities with default EntityFactory, and application entities with customized EntityFactory.

Parameters:

ef - EntityFactory to set

assertLiveliness

public void assertLiveliness()

Asserts liveliness of writers, whose QosLiveliness kind is MANUAL_BY_PARTICIPANT.

See Also:

QosLiveliness

close

public void close()

Close this participant. Closing a participant shuts down all the threads allocated.

getReader

public DataReader<?> getReader(EntityId readerId)

Finds a Reader with given entity id.

Parameters:

readerId - EntityId of the Reader

Returns:

DataReader, or null if not found

getWriter

public DataWriter<?> getWriter(EntityId writerId)

Finds a Writer with given entity id.

Parameters:

writerId - EntityId of the Writer

Returns:

DataWriter, or null if not found

addEntityListener

public void addEntityListener(EntityListener el)

Adds a new EntityListener

Parameters:

el - EntityListener to add

getEntityListeners

public List<EntityListener> getEntityListeners()

Gets EntityListeners

Returns:

a List of EntityListeners

getReaders

public List<DataReader<?>> getReaders()

Gets DataReaders created by this Participant.

Returns:

a List of DataReaders

getWriters

public List<DataWriter<?>> getWriters()

Gets DataWriters created by this Participant.

Returns:

a List of DataWriters