dds_c_publication.h File Reference

DDS publication module. More...

#include "dds_c_config.h"
#include "dds_c_sequence.h"
#include "db/db_api.h"
#include "dds_c/dds_c_topic.h"
#include "dds_c/dds_c_wh_plugin.h"

Go to the source code of this file.

Data Structures
struct	DDS_OfferedDeadlineMissedStatus
	<<cert>> DDS_OFFERED_DEADLINE_MISSED_STATUS More...
struct	DDS_LivelinessLostStatus
	<<cert>> DDS_LIVELINESS_LOST_STATUS More...
struct	DDS_OfferedIncompatibleQosStatus
	<<cert>> DDS_OFFERED_INCOMPATIBLE_QOS_STATUS More...
struct	DDS_PublicationMatchedStatus
	<<cert>> DDS_PUBLICATION_MATCHED_STATUS More...
struct	DDS_ReliableReaderActivityChangedStatus
	<<eXtension>> <<cert>> Describes the activity (i.e. are acknowledgements forthcoming) of reliable readers matched to a reliable writer. More...
struct	DDS_DataWriterQos
	<<cert>> QoS policies supported by a DDS_DataWriter entity. More...
struct	DDS_PublisherQos
	<<cert>> QoS policies supported by a DDS_Publisher entity. More...
struct	DDS_DataWriterListener
	<<interface>> <<cert>> DDS_Listener for writer status. More...
struct	DDS_PublisherListener
	<<interface>> <<cert>> DDS_Listener for DDS_Publisher status. More...

Macros
#define	DDS_OfferedDeadlineMissedStatus_INITIALIZER
	<<cert>> Initializer for new status instances.
#define	DDS_LivelinessLostStatus_INITIALIZER
	<<cert>> Initializer for new status instances.
#define	DDS_OfferedIncompatibleQosStatus_INITIALIZER
	<<cert>> Initializer for new status instances.
#define	DDS_PublicationMatchedStatus_INITIALIZER
	<<cert>> Initializer for new status instances.
#define	DDS_ReliableReaderActivityChangedStatus_INITIALIZER
	<<cert>> Initializer for new status instances.
#define	DDS_DataWriterQos_INITIALIZER
	<<cert>> Initializer for new QoS instances.
#define	DDS_PublisherQos_INITIALIZER
	<<cert>> Initializer for new QoS instances.
#define	DDS_DataWriterListener_INITIALIZER
	<<cert>> Initializer for new DDS_DataWriterListener.
#define	DDS_PublisherListener_INITIALIZER
	<<cert>> Initializer for new DDS_PublisherListener.

Typedefs
typedef struct DDS_DataWriterImpl	DDS_DataWriter
	<<interface>> <<cert>> Allows an application to set the value of the data to be published under a given DDS_Topic.
typedef struct DDS_PublisherImpl	DDS_Publisher
	<<interface>> <<cert>> A publisher is the object responsible for the actual dissemination of publications.
typedef void(*	DDS_DataWriterListener_OfferedDeadlineMissedCallback )(void *listener_data, DDS_DataWriter *writer, const struct DDS_OfferedDeadlineMissedStatus *status)
	<<cert>> Prototype of a DDS_DataWriterListener on_offered_deadline_missed function.
typedef void(*	DDS_DataWriterListener_LivelinessLostCallback )(void *listener_data, DDS_DataWriter *writer, const struct DDS_LivelinessLostStatus *status)
	<<cert>> Prototype of a DDS_DataWriterListener on_liveliness_lost function.
typedef void(*	DDS_DataWriterListener_OfferedIncompatibleQosCallback )(void *listener_data, DDS_DataWriter *writer, const struct DDS_OfferedIncompatibleQosStatus *status)
	<<cert>> Prototype of a DDS_DataWriterListener on_offered_incompatible_qos function.
typedef void(*	DDS_DataWriterListener_PublicationMatchedCallback )(void *listener_data, DDS_DataWriter *writer, const struct DDS_PublicationMatchedStatus *status)
	<<cert>> Prototype of a DDS_DataWriterListener on_publication_matched function.
typedef void(*	DDS_DataWriterListener_ReliableReaderActivityChangedCallback )(void *listener_data, DDS_DataWriter *writer, const struct DDS_ReliableReaderActivityChangedStatus *status)
	<<eXtension>> <<cert>> A matched reliable reader has become active or become inactive.

Functions
DDS_ReturnCode_t	DDS_DataWriterQos_initialize (struct DDS_DataWriterQos *self)
	Initializer for new QoS instances.
DDS_ReturnCode_t	DDS_DataWriterQos_copy (struct DDS_DataWriterQos *self, const struct DDS_DataWriterQos *source)
	Copy the contents of the given QoS into this QoS.
DDS_ReturnCode_t	DDS_DataWriterQos_finalize (struct DDS_DataWriterQos *self)
	Free any dynamic memory allocated by the policies in this DDS_DataWriterQos.
DDS_ReturnCode_t	DDS_PublisherQos_initialize (struct DDS_PublisherQos *self)
	Initializer for new QoS instances.
DDS_ReturnCode_t	DDS_PublisherQos_copy (struct DDS_PublisherQos *self, const struct DDS_PublisherQos *source)
	Copy the contents of the given QoS into this QoS.
DDS_ReturnCode_t	DDS_PublisherQos_finalize (struct DDS_PublisherQos *self)
	Free any dynamic memory allocated by the policies in this DDS_PublisherQos.
DDS_Entity *	DDS_Publisher_as_entity (DDS_Publisher *publisher)
	<<cert>> Access a DDS_Publisher's supertype instance.
DDS_ReturnCode_t	DDS_Publisher_get_default_datawriter_qos (DDS_Publisher *self, struct DDS_DataWriterQos *qos)
	Copies the default DDS_DataWriterQos values into the provided DDS_DataWriterQos instance.
DDS_ReturnCode_t	DDS_Publisher_set_default_datawriter_qos (DDS_Publisher *self, const struct DDS_DataWriterQos *qos)
	Sets the default DDS_DataWriterQos values for this publisher.
DDS_DataWriter *	DDS_Publisher_create_datawriter (DDS_Publisher *self, DDS_Topic *topic, const struct DDS_DataWriterQos *qos, const struct DDS_DataWriterListener *listener, DDS_StatusMask mask)
	<<cert>> Creates a DDS_DataWriter that will be attached and belong to the DDS_Publisher.
DDS_ReturnCode_t	DDS_Publisher_enable (DDS_Entity *self)
	Enables a DDS_Publisher instance.
DDS_ReturnCode_t	DDS_Publisher_delete_datawriter (DDS_Publisher *self, DDS_DataWriter *a_datawriter)
	Deletes a DDS_DataWriter that belongs to the DDS_Publisher.
DDS_DataWriter *	DDS_Publisher_lookup_datawriter (DDS_Publisher *self, const char *topic_name)
	<<cert>> Retrieves the DDS_DataWriter for a specific DDS_Topic.
DDS_DomainParticipant *	DDS_Publisher_get_participant (DDS_Publisher *self)
	<<cert>> Returns the DDS_DomainParticipant to which the DDS_Publisher belongs.
DDS_ReturnCode_t	DDS_Publisher_delete_contained_entities (DDS_Publisher *self)
	Deletes all the entities that were created by means of the "create" operation on the DDS_Publisher.
DDS_ReturnCode_t	DDS_Publisher_set_qos (DDS_Publisher *self, const struct DDS_PublisherQos *qos)
	Sets the publisher QoS.
DDS_ReturnCode_t	DDS_Publisher_get_qos (DDS_Publisher *self, struct DDS_PublisherQos *qos)
	Gets the publisher QoS.
DDS_ReturnCode_t	DDS_Publisher_set_listener (DDS_Publisher *self, const struct DDS_PublisherListener *l, DDS_StatusMask mask)
	Sets the publisher listener.
struct DDS_PublisherListener	DDS_Publisher_get_listener (DDS_Publisher *self)
	Get the publisher listener.
DDS_Entity *	DDS_DataWriter_as_entity (DDS_DataWriter *dataWriter)
	<<cert>> Access a DDS_DataWriter's supertype instance.
DDS_ReturnCode_t	DDS_DataWriter_enable (DDS_Entity *self)
	Enables a DDS_DataWriter instance.
DDS_ReturnCode_t	DDS_DataWriter_assert_liveliness (DDS_DataWriter *self)
	<<cert>> This operation manually asserts the liveliness of this DDS_DataWriter.
DDS_ReturnCode_t	DDS_DataWriter_get_matched_subscriptions (DDS_DataWriter *self, struct DDS_InstanceHandleSeq *subscription_handles)
	Retrieve the list of subscriptions currently "associated" with this DDS_DataWriter.
DDS_ReturnCode_t	DDS_DataWriter_get_matched_subscription_data (DDS_DataWriter *self, struct DDS_SubscriptionBuiltinTopicData *subscription_data, const DDS_InstanceHandle_t *subscription_handle)
	This operation retrieves the information on a subscription that is currently "associated" with the DDS_DataWriter.
DDS_Topic *	DDS_DataWriter_get_topic (DDS_DataWriter *self)
	<<cert>> This operation returns the DDS_Topic associated with the DDS_DataWriter.
DDS_Publisher *	DDS_DataWriter_get_publisher (DDS_DataWriter *self)
	<<cert>> This operation returns the DDS_Publisher to which the DDS_DataWriter belongs.
DDS_ReturnCode_t	DDS_DataWriter_get_liveliness_lost_status (DDS_DataWriter *self, struct DDS_LivelinessLostStatus *status)
	<<cert>> Accesses the DDS_LIVELINESS_LOST_STATUS communication status.
DDS_ReturnCode_t	DDS_DataWriter_get_offered_deadline_missed_status (DDS_DataWriter *self, struct DDS_OfferedDeadlineMissedStatus *status)
	<<cert>> Accesses the DDS_OFFERED_DEADLINE_MISSED_STATUS communication status.
DDS_ReturnCode_t	DDS_DataWriter_get_offered_incompatible_qos_status (DDS_DataWriter *self, struct DDS_OfferedIncompatibleQosStatus *status)
	<<cert>> Accesses the DDS_OFFERED_INCOMPATIBLE_QOS_STATUS communication status.
DDS_ReturnCode_t	DDS_DataWriter_get_publication_matched_status (DDS_DataWriter *self, struct DDS_PublicationMatchedStatus *status)
	<<cert>> Accesses the DDS_PUBLICATION_MATCHED_STATUS communication status.
DDS_ReturnCode_t	DDS_DataWriter_get_reliable_reader_activity_changed_status (DDS_DataWriter *self, struct DDS_ReliableReaderActivityChangedStatus *status)
	<<cert>> Get the reliable reader activity changed status for this writer.
DDS_ReturnCode_t	DDS_DataWriter_set_qos (DDS_DataWriter *self, const struct DDS_DataWriterQos *qos)
	Sets the writer QoS.
DDS_ReturnCode_t	DDS_DataWriter_get_qos (DDS_DataWriter *self, struct DDS_DataWriterQos *qos)
	Gets the writer QoS.
DDS_ReturnCode_t	DDS_DataWriter_set_listener (DDS_DataWriter *self, const struct DDS_DataWriterListener *l, DDS_StatusMask mask)
	Sets the writer listener.
struct DDS_DataWriterListener	DDS_DataWriter_get_listener (DDS_DataWriter *self)
	Get the writer listener.
DDS_InstanceHandle_t	DDS_DataWriter_register_instance (DDS_DataWriter *self, const void *instance_data)
	<<cert>> Informs RTI Connext Micro that the application will be modifying a particular instance.
DDS_InstanceHandle_t	DDS_DataWriter_register_instance_w_timestamp (DDS_DataWriter *self, const void *instance_data, const struct DDS_Time_t *source_timestamp)
	<<cert>> Performs the same function as DDS_DataWriter_register_instance except that it also provides the value for the source_timestamp.
DDS_ReturnCode_t	DDS_DataWriter_unregister_instance (DDS_DataWriter *self, const void *instance_data, const DDS_InstanceHandle_t *handle)
	<<cert>> Reverses the action of DDS_DataWriter_register_instance.
DDS_ReturnCode_t	DDS_DataWriter_unregister_instance_w_timestamp (DDS_DataWriter *self, const void *instance_data, const DDS_InstanceHandle_t *handle, const struct DDS_Time_t *source_timestamp)
	<<cert>> Performs the same function as DDS_DataWriter_unregister_instance except that it also provides the value for the source_timestamp.
DDS_ReturnCode_t	DDS_DataWriter_dispose (DDS_DataWriter *self, const void *instance_data, const DDS_InstanceHandle_t *handle)
	<<cert>> Requests the middleware to delete the data.
DDS_ReturnCode_t	DDS_DataWriter_dispose_w_timestamp (DDS_DataWriter *self, const void *instance_data, const DDS_InstanceHandle_t *handle, const struct DDS_Time_t *source_timestamp)
	<<cert>> Performs the same function as DDS_DataWriter_dispose except that it also provides the value for the source_timestamp.
DDS_ReturnCode_t	DDS_DataWriter_write (DDS_DataWriter *self, const void *instance_data, const DDS_InstanceHandle_t *handle)
	<<cert>> Modifies the value of a data instance.
DDS_ReturnCode_t	DDS_DataWriter_write_w_timestamp (DDS_DataWriter *self, const void *instance_data, const DDS_InstanceHandle_t *handle, const struct DDS_Time_t *source_timestamp)
	<<cert>> Performs the same function as DDS_DataWriter_write except that it also provides the value for the source_timestamp.
DDS_ReturnCode_t	DDS_DataWriter_write_w_params (DDS_DataWriter *self, const void *instance_data, struct DDS_WriteParams_t *params)
	Publish a data sample using the given set of additional parameters.

Variables
struct DDS_DataWriterQos	DDS_DATAWRITER_QOS_DEFAULT
	<<cert>> Special value for creating DDS_DataWriter with default QoS

---

Detailed Description

DDS publication module.