This is the class that allows for any object to be a DDS producer or consumer. More...

Collaboration diagram for DDSParticipant:

Static Public Member Functions
static synchronized DataWriter	getWriterForTopic (Copyable c, String topicName, String participantName, DomainParticipantListener dpListener)
static void	writeMessage (String participantName, int domainId, Copyable copyable, String dstAgentName, String topicName)
	Use the default values for QoS and sample count.
static void	writeMessage (String participantName, int domainId, Copyable copyable, String dstAgentName, String topicName, DomainParticipantListener dpListener, int sampleCount)
static void	writeMessage (DomainParticipant participant, Copyable copyable, String dstAgentName, String topicName, DomainParticipantListener dpListener, int sampleCount)
static synchronized void	writeMessage (DomainParticipant participant, Copyable copyable, String dstAgentName, String topicName, DomainParticipantListener dpListener, PublisherQos publisherQos, PublisherListener publisherListener, int sampleCount)
static synchronized void	writeMessage (DomainParticipant participant, Copyable copyable, String dstAgentName, String topicName, DomainParticipantListener dpListener, PublisherQos publisherQos, PublisherListener publisherListener, DataWriterQos writerQos, int sampleCount)
	This does not handle the case where the PublisherQos contains a list of partitions, then you only want to send to a particular partition.
static synchronized void	writeMessageWithXMLQos (DomainParticipant participant, Copyable copyable, String dstAgentName, String topicName, DomainParticipantListener dpListener, PublisherQos publisherQos, PublisherListener publisherListener, String dataWriterQosLibName, String dataWriterQosProfileName, int sampleCount)
	XXX JT this needs to change after field trial.
static synchronized DataReader	getReaderForTopic (Copyable c, String topicName, String participantName, DomainParticipantListener dpListener, SubscriberQos sqos, DataReaderQos rqos)
static synchronized DataReader	getReaderForTopic (DomainParticipant participant, Copyable copyable, String topicName, String sourcePartitionName, DomainParticipantListener dpListener, SubscriberQos subscriberQos, DataReaderQos readerQos)
static synchronized DataReader	getReaderForTopic (DomainParticipant participant, Copyable copyable, String topicName, String sourcePartitionName, DomainParticipantListener participantListener, SubscriberListener subscriberListener, DataReaderListener dataReaderListener, SubscriberQos subscriberQos, DataReaderQos readerQos)
	XXX the algorithm here uses the Topic as the basis of creating the subscriber.
static synchronized DataReader	getReaderForTopicWithQosXML (DomainParticipant participant, Copyable copyable, String topicName, String sourcePartitionName, DomainParticipantListener participantListener, SubscriberListener subscriberListener, DataReaderListener dataReaderListener, SubscriberQos subscriberQos, String dataReaderQosLibraryName, String dataReaderQosProfileName)
static synchronized void	registerForMessages (Copyable c, String topic, String participantName, DomainParticipantListener dpListener)
static synchronized void	registerForMessages (Copyable c, String topic, String participantName, DomainParticipantListener dpListener, int sampleCount)
static synchronized void	registerForMessages (DomainParticipant participant, Copyable c, String topic, String sourcePartitionName, DomainParticipantListener dpListener, int sampleCount)
static synchronized void	registerForMessages (DomainParticipant participant, Copyable c, String topic, String sourcePartitionName, DomainParticipantListener dpListener, int sampleCount, SubscriberQos subscriberQos, DataReaderQos readerQos)
static synchronized void	registerForMessages (DomainParticipant participant, Copyable c, String topic, String sourcePartitionName, DomainParticipantListener dpListener, SubscriberListener sListener, DataReaderListener drListener, int sampleCount, SubscriberQos subscriberQos, DataReaderQos readerQos)
static synchronized void	registerForMessages (DomainParticipant participant, Copyable c, String topic, String sourcePartitionName, DomainParticipantListener dpListener, SubscriberListener sListener, DataReaderListener drListener, int sampleCount, SubscriberQos subscriberQos, String dataReaderQosLibName, String dataReaderQosProfileName)
static synchronized DomainParticipant	createDomainParticipant (String participantName, int domainId)
static synchronized DomainParticipant	createDomainParticipant (String participantName, int domainId, DomainParticipantListener dpListener)
static synchronized DomainParticipant	createDomainParticipant (String participantName, int domainId, DomainParticipantListener dpListener, DomainParticipantQos qos)
static synchronized DomainParticipantQos	getDomainParticipantQos (String participantName)
static String	getDomainParticipantInfo (DomainParticipant p)
static void	setDomainId (int domainId)
static int	getDomainId ()
static void	cleanupAndShutdown (DomainParticipant p)
	cleanup and delete provided participant
Static Package Attributes
static final long	DEFAULT_SEND_PERIOD_MILLI_SEC = 1
	Send period, in seconds.

Detailed Description

To obtain messages, just override the on_data_available() method.

Member Function Documentation

static void cleanupAndShutdown ( DomainParticipant p ) [static]

Parameters:

p

static synchronized DomainParticipant createDomainParticipant	(	String	participantName,
		int	domainId,
		DomainParticipantListener	dpListener
	)		`[static]`

Here is the call graph for this function:

static synchronized DomainParticipant createDomainParticipant	(	String	participantName,
		int	domainId,
		DomainParticipantListener	dpListener,
		DomainParticipantQos	qos
	)		`[static]`

Here is the call graph for this function:

static synchronized DomainParticipant createDomainParticipant	(	String	participantName,
		int	domainId
	)		`[static]`

static int getDomainId ( ) [static]

static String getDomainParticipantInfo ( DomainParticipant p ) [static]

static synchronized DomainParticipantQos getDomainParticipantQos ( String participantName ) [static]

Here is the call graph for this function:

static synchronized DataReader getReaderForTopic	(	Copyable	c,
		String	topicName,
		String	participantName,
		DomainParticipantListener	dpListener,
		SubscriberQos	sqos,
		DataReaderQos	rqos
	)		`[static]`

Here is the call graph for this function:

static synchronized DataReader getReaderForTopic	(	DomainParticipant	participant,
		Copyable	copyable,
		String	topicName,
		String	sourcePartitionName,
		DomainParticipantListener	dpListener,
		SubscriberQos	subscriberQos,
		DataReaderQos	readerQos
	)		`[static]`

Here is the call graph for this function:

static synchronized DataReader getReaderForTopic	(	DomainParticipant	participant,
		Copyable	copyable,
		String	topicName,
		String	sourcePartitionName,
		DomainParticipantListener	participantListener,
		SubscriberListener	subscriberListener,
		DataReaderListener	dataReaderListener,
		SubscriberQos	subscriberQos,
		DataReaderQos	readerQos
	)		`[static]`

. need to change that back

Parameters:

participant
copyable
topicName
sourcePartitionName
participantListener
subscriberListener
dataReaderListener
subscriberQos
readerQos

Returns:

static synchronized DataReader getReaderForTopicWithQosXML	(	DomainParticipant	participant,
		Copyable	copyable,
		String	topicName,
		String	sourcePartitionName,
		DomainParticipantListener	participantListener,
		SubscriberListener	subscriberListener,
		DataReaderListener	dataReaderListener,
		SubscriberQos	subscriberQos,
		String	dataReaderQosLibraryName,
		String	dataReaderQosProfileName
	)		`[static]`

static synchronized DataWriter getWriterForTopic	(	Copyable	c,
		String	topicName,
		String	participantName,
		DomainParticipantListener	dpListener
	)		`[static]`

Here is the call graph for this function:

static synchronized void registerForMessages	(	DomainParticipant	participant,
		Copyable	c,
		String	topic,
		String	sourcePartitionName,
		DomainParticipantListener	dpListener,
		int	sampleCount,
		SubscriberQos	subscriberQos,
		DataReaderQos	readerQos
	)		`[static]`

Here is the call graph for this function:

static synchronized void registerForMessages	(	DomainParticipant	participant,
		Copyable	c,
		String	topic,
		String	sourcePartitionName,
		DomainParticipantListener	dpListener,
		SubscriberListener	sListener,
		DataReaderListener	drListener,
		int	sampleCount,
		SubscriberQos	subscriberQos,
		DataReaderQos	readerQos
	)		`[static]`

Here is the call graph for this function:

static synchronized void registerForMessages	(	DomainParticipant	participant,
		Copyable	c,
		String	topic,
		String	sourcePartitionName,
		DomainParticipantListener	dpListener,
		SubscriberListener	sListener,
		DataReaderListener	drListener,
		int	sampleCount,
		SubscriberQos	subscriberQos,
		String	dataReaderQosLibName,
		String	dataReaderQosProfileName
	)		`[static]`

Here is the call graph for this function:

static synchronized void registerForMessages	(	Copyable	c,
		String	topic,
		String	participantName,
		DomainParticipantListener	dpListener,
		int	sampleCount
	)		`[static]`

Here is the call graph for this function:

static synchronized void registerForMessages	(	Copyable	c,
		String	topic,
		String	participantName,
		DomainParticipantListener	dpListener
	)		`[static]`

static synchronized void registerForMessages	(	DomainParticipant	participant,
		Copyable	c,
		String	topic,
		String	sourcePartitionName,
		DomainParticipantListener	dpListener,
		int	sampleCount
	)		`[static]`

Here is the call graph for this function:

static void setDomainId ( int domainId ) [static]

static synchronized void writeMessage	(	DomainParticipant	participant,
		Copyable	copyable,
		String	dstAgentName,
		String	topicName,
		DomainParticipantListener	dpListener,
		PublisherQos	publisherQos,
		PublisherListener	publisherListener,
		DataWriterQos	writerQos,
		int	sampleCount
	)		`[static]`

The writer will be created such that all partitions listed in the particular PublisherQos will be sent the message.

There will be another API when required that should take in a list of dstAgentNames to be able to match a String of partition names. Need to construct a equals method for checking full partition names.

Parameters:

participant
copyable
dstAgentName
topicName
dpListener
publisherQos
publisherListener
writerQos
sampleCount

static void writeMessage	(	String	participantName,
		int	domainId,
		Copyable	copyable,
		String	dstAgentName,
		String	topicName
	)		`[static]`

Sample count would be 1 meaning, just send the message once

Parameters:

participantName
domainId
copyable
dstAgentName
topicName

static void writeMessage	(	String	participantName,
		int	domainId,
		Copyable	copyable,
		String	dstAgentName,
		String	topicName,
		DomainParticipantListener	dpListener,
		int	sampleCount
	)		`[static]`

Here is the call graph for this function:

static void writeMessage	(	DomainParticipant	participant,
		Copyable	copyable,
		String	dstAgentName,
		String	topicName,
		DomainParticipantListener	dpListener,
		int	sampleCount
	)		`[static]`

Deprecated:

Here is the call graph for this function:

static synchronized void writeMessage	(	DomainParticipant	participant,
		Copyable	copyable,
		String	dstAgentName,
		String	topicName,
		DomainParticipantListener	dpListener,
		PublisherQos	publisherQos,
		PublisherListener	publisherListener,
		int	sampleCount
	)		`[static]`

Parameters:

participant
copyable
dstAgentName
topicName
dpListener
publisherQos
publisherListener
sampleCount

Here is the call graph for this function:

static synchronized void writeMessageWithXMLQos	(	DomainParticipant	participant,
		Copyable	copyable,
		String	dstAgentName,
		String	topicName,
		DomainParticipantListener	dpListener,
		PublisherQos	publisherQos,
		PublisherListener	publisherListener,
		String	dataWriterQosLibName,
		String	dataWriterQosProfileName,
		int	sampleCount
	)		`[static]`

See notes on what is being done and how this should change in the future. It would require the XML file to be more detailed and we need to bookeep which profile goes with what publisher.

It would just be that we would have to write a profile for each publisher.

This method should always be used in the API

Parameters:

participant
copyable
dstAgentName
topicName
dpListener
publisherQos
publisherListener
dataWriterQosLibName
dataWriterQosProfileName
sampleCount

Member Data Documentation

final long DEFAULT_SEND_PERIOD_MILLI_SEC = 1 [static, package]

The documentation for this class was generated from the following file:

DDSParticipant.java

DDSParticipant Class Reference

Static Public Member Functions

Static Package Attributes

Detailed Description

Member Function Documentation

Member Data Documentation