com.toc.coredx.DDS
Class Publisher

java.lang.Object
  com.toc.coredx.DDS.Entity
      com.toc.coredx.DDS.DomainEntity
          com.toc.coredx.DDS.Publisher

public class Publisher
extends DomainEntity

The Publisher configures, creates, manages and destroys DataWriters.

Method Summary

ReturnCode_t	begin_coherent_changes() This method is not yet implemented.
ReturnCode_t	copy_from_topic_qos(DataWriterQos qos, TopicQos topic_qos) This operation copies the QoS settings in a_topic_qos to the corresponding settings in a_datawriter_qos. The a_datawriter_qos parameter is populated with a copy of the QoS policies from the a_topic_qos structure.
DataWriter	create_datawriter(Topic topic, DataWriterQos qos, DataWriterListener listener, long mask) This operation creates a DataWriter.
ReturnCode_t	delete_contained_entities() This operation deletes all the DataWriters created by means of the Publisher.create_datawriter() operation on the Publisher p. This routine will recursively call the corresponding delete_contained_entities() operation on each of the contained DataWriter objects.
ReturnCode_t	delete_datawriter(DataWriter datawriter) This operation deletes a DataWriter.
ReturnCode_t	enable() Enables the Publisher.
ReturnCode_t	end_coherent_changes() This method is not yet implemented.
ReturnCode_t	get_default_datawriter_qos(DataWriterQos qos) Provides access to the default DataWriterQos settings held in the Publisher p. The provided qos argument is populated with the current default qos settings.
PublisherListener	get_listener() This operation returns the currently installed PublisherListener.
DomainParticipant	get_participant() This operation returns the DomainParticipant this Publisher belongs to.
ReturnCode_t	get_qos(PublisherQos qos) Returns the current PublisherQos settings held in the Publisher p. The qos parameter is populated with a copy of the current Publisher QoS properties.
DataWriter	lookup_datawriter(java.lang.String topic_name) This operation retrieves a previously-created DataWriter contained in the Publisher, attached to a Topic named topic_name. If multiple DataWriters are found, one of them will be returned.
ReturnCode_t	resume_publications() This method is not yet implemented.
ReturnCode_t	set_default_datawriter_qos(DataWriterQos qos) Sets the default DataWriterQos held in the Publisher.
ReturnCode_t	set_listener(PublisherListener new_listener, long mask) Installs a PublisherListener on Publisher p. Only one listener may be attached to a Publisher at a time.
ReturnCode_t	set_qos(PublisherQos qos) Sets the PublisherQos values.
ReturnCode_t	suspend_publications() This method is not yet implemented.
ReturnCode_t	wait_for_acknowledgments(Duration_t max_wait) This method is not yet implemented.

Methods inherited from class com.toc.coredx.DDS.Entity

get_instance_handle, get_status_changes, get_statuscondition

Methods inherited from class java.lang.Object

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

Method Detail

enable

public ReturnCode_t enable()

Enables the Publisher. A Publisher is created either enabled or not based on the DomainParticipantQos setting entity_factory. When a Publisher is not enabled, only the following sub-set of all Publisher operations are legal:

• operations to get and set QoS policies,
• factory operations (create, delete),
• get_statuscondition(),
• get_status_changes(),
• lookup operations

Any other operation may return the ReturnCode_t.RETCODE_NOT_ENABLED error. Publisher_enable() may be called on an already enabled Subscriber [it will have no effect].

Overrides:

enable in class Entity

get_participant

public DomainParticipant get_participant()

This operation returns the DomainParticipant this Publisher belongs to.

create_datawriter

public DataWriter create_datawriter(Topic topic,
                                    DataWriterQos qos,
                                    DataWriterListener listener,
                                    long mask)

This operation creates a DataWriter. The created DataWriter is contained within the Publisher p. It is associated with the Topic, ContentFilteredTopic, or MultiTopic indicated by a_topic, and has the DataWriterQos indicated by qos. The qos argument may be passed DDS.DATAWRITER_QOS_DEFAULT, which indicates that the Publisher should use its currently configured default data writer QoS values. The DataWriterListener a_listener, is installed at creation time.

The created DataWriter (if not NULL) must be destroyed by a call to Publisher.delete_datawriter().

This routine will fail if the provided QoS settings are internally inconsistent. In this case, the routine will return NULL.

delete_datawriter

public ReturnCode_t delete_datawriter(DataWriter datawriter)

This operation deletes a DataWriter. If the provided DataWriter a_datawriter was not created by Publisher p, the routine will fail and will return ReturnCode_t.RETCODE_PRECONDITION_NOT_MET.

delete_contained_entities

public ReturnCode_t delete_contained_entities()

This operation deletes all the DataWriters created by means of the Publisher.create_datawriter() operation on the Publisher p. This routine will recursively call the corresponding delete_contained_entities() operation on each of the contained DataWriter objects. After successful execution, the application may delete the Publisher by calling DomainParticipant.delete_publisher().

If any of the objects cannot be deleted, this routine will return ReturnCode_t.RETCODE_PRECONDITION_NOT_MET.

lookup_datawriter

public DataWriter lookup_datawriter(java.lang.String topic_name)

This operation retrieves a previously-created DataWriter contained in the Publisher, attached to a Topic named topic_name. If multiple DataWriters are found, one of them will be returned. If no matching DataWriter is found, this routine will return NULL.

set_qos

public ReturnCode_t set_qos(PublisherQos qos)

Sets the PublisherQos values. These QoS values affect the behavior of the Publisher. This routine may fail if the provided qos argument is not internally consistent. In this case, ReturnCode_t.RETCODE_INCONSISTENT_POLICY will be returned, and no changes will be made to the Publisher QoS.

get_qos

public ReturnCode_t get_qos(PublisherQos qos)

Returns the current PublisherQos settings held in the Publisher p. The qos parameter is populated with a copy of the current Publisher QoS properties.

set_listener

public ReturnCode_t set_listener(PublisherListener new_listener,
                                 long mask)

Installs a PublisherListener on Publisher p. Only one listener may be attached to a Publisher at a time. A call to set_listener() will replace any current listener with a_listener.

a_listener can be NULL, which indicates a listener that does nothing.

get_listener

public PublisherListener get_listener()

This operation returns the currently installed PublisherListener.

suspend_publications

public ReturnCode_t suspend_publications()

This method is not yet implemented.

resume_publications

public ReturnCode_t resume_publications()

This method is not yet implemented.

begin_coherent_changes

public ReturnCode_t begin_coherent_changes()

This method is not yet implemented.

end_coherent_changes

public ReturnCode_t end_coherent_changes()

This method is not yet implemented.

wait_for_acknowledgments

public ReturnCode_t wait_for_acknowledgments(Duration_t max_wait)

This method is not yet implemented.

set_default_datawriter_qos

public ReturnCode_t set_default_datawriter_qos(DataWriterQos qos)

Sets the default DataWriterQos held in the Publisher. This default qos will be used during subsequent calls to Publisher.create_datawriter() if the special DDS.DATAWRITER_QOS_DEFAULT value is provided for qos. This routine may fail if the provided qos argument is not internally consistent. In this case, ReturnCode_t.RETCODE_INCONSISTENT_POLICY will be returned, and no changes will be made to the Publisher.

get_default_datawriter_qos

public ReturnCode_t get_default_datawriter_qos(DataWriterQos qos)

Provides access to the default DataWriterQos settings held in the Publisher p. The provided qos argument is populated with the current default qos settings.

copy_from_topic_qos

public ReturnCode_t copy_from_topic_qos(DataWriterQos qos,
                                        TopicQos topic_qos)

This operation copies the QoS settings in a_topic_qos to the corresponding settings in a_datawriter_qos. The a_datawriter_qos parameter is populated with a copy of the QoS policies from the a_topic_qos structure. QoS entries in the datawriter qos structure will be overwritten with the values from the topic.