dds_c_domain.h File Reference

DDS Domain Module definitions. More...

#include "dds_c/dds_c_dll.h"
#include "reda/reda_string.h"
#include "rt/rt_rt.h"
#include "dds_c/dds_c_infrastructure.h"
#include "dds_c_sequence.h"
#include "dds_c/dds_c_type.h"
#include "dds_c/dds_c_topic.h"
#include "dds_c/dds_c_publication.h"
#include "dds_c/dds_c_subscription.h"

Go to the source code of this file.

Data Structures
struct	NDDS_Discovery_Property
	Specifies internal information used to store discovery information about a DDS_DomainParticipant in the registry. More...
struct	DDS_DiscoveryComponent
	Specifies the name that will be used to identify a DDS_DomainParticipant in the discovery process. More...
struct	DDS_DiscoveryQosPolicy
	<<cert>> Specifies the attributes required to discover participants in the domain. More...
struct	DDS_UserTrafficQosPolicy
	A QosPolicy to configure properties of network traffic caused by the exchange of user data. More...
struct	DDS_DomainParticipantListener
	<<interface>> <<cert>> Listener for participant status. More...
struct	DDS_DomainParticipantQos
	<<cert>> QoS policies supported by a DDS_DomainParticipant entity.Certain members must be set in a consistent manner: More...
struct	DDS_DomainParticipantFactoryQos
	<<cert>> QoS policies supported by a DDS_DomainParticipantFactory. More...

Macros
#define	DDS_DiscoveryComponent_INITIALIZER
	Initializer for new DDS_DiscoveryComponent instances.
#define	DDS_DomainParticipantListener_INITIALIZER
	<<cert>> Initializer for new DDS_DomainParticipantListener.No memory is allocated. New DDS_DomainParticipantListener instances stored in the stack should be initialized with this value before they are passed to any methods .
#define	DDS_DomainParticipantQos_INITIALIZER
	<<cert>> Initializer for new QoS instances.
#define	DDS_DomainParticipantFactoryQos_INITIALIZER
	<<cert>> Initializer for new QoS instances.
#define	DDS_TheParticipantFactory   DDS_DomainParticipantFactory_get_instance()
	<<cert>> Alias for singleton participant factory.

Typedefs
typedef DDS_DOMAINID_TYPE_NATIVE	DDS_DomainId_t
	<<cert>> An integer that indicates in which domain a DDS_DomainParticipant communicates.Participants with the same DDS_DomainId_t are said to be in the same domain, and can thus communicate with one another.
typedef struct DDS_DomainParticipantFactoryImpl	DDS_DomainParticipantFactory
	<<singleton>> <<interface>> <<cert>> Allows creation and destruction of DDS_DomainParticipant objects.The sole purpose of this class is to allow the creation and destruction of DDS_DomainParticipant objects. This class itself is a <<singleton>>, and accessed via the get_instance() method , and destroyed with finalize_instance() method .

Functions
DDS_ReturnCode_t	DDS_DomainParticipantQos_initialize (struct DDS_DomainParticipantQos *self)
	Initializer for new QoS instances.
DDS_ReturnCode_t	DDS_DomainParticipantQos_copy (struct DDS_DomainParticipantQos *self, const struct DDS_DomainParticipantQos *source)
	Copy the contents of the given QoS into this QoS.DDS_DomainParticipantQos instances can use dynamic memory because of the sequences contained in some QoS policies. A shallow copy by assignment is therefore unsafe. This method performs a deep-copy, allocating memory if necessary.
DDS_ReturnCode_t	DDS_DomainParticipantQos_finalize (struct DDS_DomainParticipantQos *self)
	Free any dynamic memory allocated by the policies in this DDS_DomainParticipantQos.Some QoS policies may use dynamic memory (regardless of whether the QoS itself is in dynamic memory). This method frees that memory but otherwise leaves this QoS unchanged. It should be called on all instances before they are freed (or, in the case of stack-based instances, before they go out of scope).
DDS_Entity *	DDS_DomainParticipant_as_entity (DDS_DomainParticipant *domain)
	<<cert>> Access a DDS_DomainParticipant's supertype instance.
DDS_ReturnCode_t	DDS_DomainParticipant_get_default_publisher_qos (DDS_DomainParticipant *self, struct DDS_PublisherQos *qos)
	Copy the default DDS_PublisherQos values into the provided DDS_PublisherQos instance.The retrieved qos will match the set of values specified on the last successful call to DDS_DomainParticipant_set_default_publisher_qos, or else, if the call was never made, the default values listed in DDS_PublisherQos.
DDS_ReturnCode_t	DDS_DomainParticipant_set_default_publisher_qos (DDS_DomainParticipant *self, const struct DDS_PublisherQos *qos)
	Set the default DDS_PublisherQos values for this domain participant.This default value will be used for newly created DDS_Publisher if DDS_PUBLISHER_QOS_DEFAULT is specified as the qos parameter when DDS_DomainParticipant_create_publisher is called.
DDS_ReturnCode_t	DDS_DomainParticipant_get_default_subscriber_qos (DDS_DomainParticipant *self, struct DDS_SubscriberQos *qos)
	Copy the default DDS_SubscriberQos values into the provided DDS_SubscriberQos instance.The retrieved qos will match the set of values specified on the last successful call to DDS_DomainParticipant_set_default_subscriber_qos, or else, if the call was never made, the default values listed in DDS_SubscriberQos.
DDS_ReturnCode_t	DDS_DomainParticipant_set_default_subscriber_qos (DDS_DomainParticipant *self, const struct DDS_SubscriberQos *qos)
	Set the default DDS_SubscriberQos values for this domain participant.This default value will be used for newly created DDS_Subscriber if DDS_SUBSCRIBER_QOS_DEFAULT is specified as the qos parameter when DDS_DomainParticipant_create_subscriber is called.
DDS_ReturnCode_t	DDS_DomainParticipant_get_default_topic_qos (DDS_DomainParticipant *self, struct DDS_TopicQos *qos)
	Copies the default DDS_TopicQos values for this domain participant into the given DDS_TopicQos instance.The retrieved qos will match the set of values specified on the last successful call to DDS_DomainParticipant_set_default_topic_qos, or else, if the call was never made, the default values listed in DDS_TopicQos.
DDS_ReturnCode_t	DDS_DomainParticipant_set_default_topic_qos (DDS_DomainParticipant *self, const struct DDS_TopicQos *qos)
	Set the default DDS_TopicQos values for this domain participant.This default value will be used for newly created DDS_Topic if DDS_TOPIC_QOS_DEFAULT is specified as the qos parameter when DDS_DomainParticipant_create_topic is called.
DDS_Publisher *	DDS_DomainParticipant_create_publisher (DDS_DomainParticipant *self, const struct DDS_PublisherQos *qos, const struct DDS_PublisherListener *listener, DDS_StatusMask mask)
	<<cert>> Creates a DDS_Publisher with the desired QoS policies and attaches to it the specified DDS_PublisherListener.
DDS_ReturnCode_t	DDS_DomainParticipant_delete_publisher (DDS_DomainParticipant *self, DDS_Publisher *p)
	Deletes an existing DDS_Publisher.
DDS_Subscriber *	DDS_DomainParticipant_create_subscriber (DDS_DomainParticipant *self, const struct DDS_SubscriberQos *qos, const struct DDS_SubscriberListener *listener, DDS_StatusMask mask)
	<<cert>> Creates a DDS_Subscriber with the desired QoS policies and attaches to it the specified DDS_SubscriberListener.
DDS_ReturnCode_t	DDS_DomainParticipant_delete_subscriber (DDS_DomainParticipant *self, DDS_Subscriber *s)
	Deletes an existing DDS_Subscriber.
DDS_Topic *	DDS_DomainParticipant_create_topic (DDS_DomainParticipant *self, const char *topic_name, const char *type_name, const struct DDS_TopicQos *qos, const struct DDS_TopicListener *listener, DDS_StatusMask mask)
	<<cert>> Creates a DDS_Topic with the desired QoS policies
DDS_ReturnCode_t	DDS_DomainParticipant_delete_topic (DDS_DomainParticipant *self, DDS_Topic *topic)
	Deletes a DDS_Topic.
DDS_Topic *	DDS_DomainParticipant_find_topic (DDS_DomainParticipant *self, const char *topic_name, const struct DDS_Duration_t *timeout)
	Finds an existing (or ready to exist) DDS_Topic, based on its name.
DDS_TopicDescription *	DDS_DomainParticipant_lookup_topicdescription (DDS_DomainParticipant *self, const char *topic_name)
	<<cert>> Lookup an existing locally-created DDS_TopicDescription, based on its name.The returned topic can either be enabled or disabled.
DDS_ReturnCode_t	DDS_DomainParticipant_add_peer (DDS_DomainParticipant *self, const char *peer)
	<<eXtension>> Attempt to contact one or more additional peer participants.Add the given peer description to the list of peers with which this DDS_DomainParticipant will try to communicate.
DDS_DomainId_t	DDS_DomainParticipant_get_domain_id (DDS_DomainParticipant *self)
	Get the unique domain identifier.This operation retrieves the domain_id used to create the DDS_DomainParticipant. The domain_id identifies the DDS domain to which the DDS_DomainParticipant belongs. Each DDS domain represents a separate data 'communication plane' isolated from other domains.
DDS_ReturnCode_t	DDS_DomainParticipant_delete_contained_entities (DDS_DomainParticipant *self)
	Delete all the entities that were created by means of the "create" operations on the DDS_DomainParticipant.This operation deletes all contained DDS_Publisher, DDS_Subscriber, and DDS_Topic.
DDS_ReturnCode_t	DDS_DomainParticipant_get_current_time (DDS_DomainParticipant *self, struct DDS_Time_t *current_time)
	<<cert>> Returns the current value of the time.The current value of the time that RTI Connext Micro uses to time-stamp DDS_DataWriter and to set the reception-timestamp for the data updates that it receives.
DDS_ReturnCode_t	DDS_DomainParticipant_set_qos (DDS_DomainParticipant *self, const struct DDS_DomainParticipantQos *qos)
	Returns a sequence containing DDS_InstanceHandle_t for all the remote DDS_DomainParticipant that have been discovered by the DDS_DomainParticipant.
DDS_ReturnCode_t	DDS_DomainParticipant_get_qos (DDS_DomainParticipant *self, struct DDS_DomainParticipantQos *qos)
	Get the participant QoS.This method may potentially allocate memory depending on the sequences contained in some QoS policies.
DDS_ReturnCode_t	DDS_DomainParticipant_set_listener (DDS_DomainParticipant *self, const struct DDS_DomainParticipantListener *l, DDS_StatusMask mask)
	Sets the participant listener.
struct DDS_DomainParticipantListener	DDS_DomainParticipant_get_listener (DDS_DomainParticipant *self)
	Get the participant listener.
DDS_ReturnCode_t	DDS_DomainParticipant_register_type (DDS_DomainParticipant *participant, const char *type_name, struct NDDS_Type_Plugin *plugin)
	<<eXtension>> <<cert>> Allows an application to communicate to RTI Connext Micro the existence of a data type.The generated implementation of the operation embeds all the knowledge that has to be communicated to the middleware in order to make it able to manage the contents of data of that type. This includes in particular the key definition that will allow RTI Connext Micro to distinguish different instances of the same type.
struct NDDS_Type_Plugin *	DDS_DomainParticipant_unregister_type (DDS_DomainParticipant *participant, const char *type_name)
	Allows an application to unregister a data type from RTI Connext Micro. After calling unregister_type, no further communication using that type is possible.The generated implementation of the operation removes all the information about a type from RTI Connext Micro. No further communication using that type is possible.
DDS_DomainParticipantFactory *	DDS_DomainParticipantFactory_get_instance (void)
	<<cert>> Gets the singleton instance of this class.
DDS_ReturnCode_t	DDS_DomainParticipantFactory_finalize_instance (void)
	<<eXtension>> Destroys the singleton instance of this class.Only necessary to explicitly reclaim resources used by the participant factory singleton. Note that on many OSes, these resources are automatically reclaimed by the OS when the program terminates. Some memory checker tools still flag these as unreclaimed however. So this method provides a way to clean up memory used by the participant factory.
DDS_ReturnCode_t	DDS_DomainParticipantFactory_set_default_participant_qos (DDS_DomainParticipantFactory *self, const struct DDS_DomainParticipantQos *qos)
	Sets the default DDS_DomainParticipantQos values for this domain participant factory.This method may potentially allocate memory depending on the sequences contained in some QoS policies.
DDS_ReturnCode_t	DDS_DomainParticipantFactory_get_default_participant_qos (DDS_DomainParticipantFactory *self, struct DDS_DomainParticipantQos *qos)
	Initializes the DDS_DomainParticipantQos instance with default values.The retrieved qos will match the set of values specified on the last successful call to DDS_DomainParticipantFactory_set_default_participant_qos, or else, if the call was never made, the default values listed in DDS_DomainParticipantQos.
DDS_DomainParticipant *	DDS_DomainParticipantFactory_create_participant (DDS_DomainParticipantFactory *self, DDS_DomainId_t domainId, const struct DDS_DomainParticipantQos *qos, const struct DDS_DomainParticipantListener *listener, DDS_StatusMask mask)
	<<cert>> Creates a new DDS_DomainParticipant object.
DDS_ReturnCode_t	DDS_DomainParticipantFactory_delete_participant (DDS_DomainParticipantFactory *self, DDS_DomainParticipant *a_participant)
	Deletes an existing DDS_DomainParticipant.
DDS_DomainParticipant *	DDS_DomainParticipantFactory_lookup_participant (DDS_DomainParticipantFactory *self, DDS_DomainId_t domainId)
	<<cert>> Locates an existing DDS_DomainParticipant.If no such DDS_DomainParticipant exists, the operation will return NULL value.
DDS_ReturnCode_t	DDS_DomainParticipantFactory_get_qos (DDS_DomainParticipantFactory *self, struct DDS_DomainParticipantFactoryQos *qos)
	Gets the value for participant factory QoS.
DDS_ReturnCode_t	DDS_DomainParticipantFactory_set_qos (DDS_DomainParticipantFactory *self, const struct DDS_DomainParticipantFactoryQos *qos)
	<<cert>> Sets the value for a participant factory QoS.The DDS_DomainParticipantFactoryQos::entity_factory can be changed. The other policies are immutable.
RT_Registry_T *	DDS_DomainParticipantFactory_get_registry (DDS_DomainParticipantFactory *self)
	Retrieves the singleton registry instance associated with the factory.

Variables
const char *const	DDS_DISCOVERY_QOS_POLICY_NAME
	Stringified human-readable name for DDS_DiscoveryQosPolicy.
struct DDS_TopicQos	DDS_TOPIC_QOS_DEFAULT
	<<cert>> Special value for creating a DDS_Topic with default QoS. Note that this is the only supported parameter in RTI Connext Micro when creating a topic.RTI Connext Micro does not support Topic QoS. This represents the a placeholder for Topic QoS values.This is the only valid paramater that can be passed into the DDS_DomainParticipant_create_topic function (no other values for QoS are supported).
struct DDS_PublisherQos	DDS_PUBLISHER_QOS_DEFAULT
	<<cert>> Special value for creating a DDS_Publisher with default QoS.When used in DDS_DomainParticipant_create_publisher, this special value is used to indicate that the DDS_Publisher should be created with the default DDS_Publisher QoS.
struct DDS_SubscriberQos	DDS_SUBSCRIBER_QOS_DEFAULT
	<<cert>> Special value for creating a DDS_Subscriber with default QoS.When used in DDS_DomainParticipant_create_subscriber, this special value is used to indicate that the DDS_Subscriber should be created with the default DDS_Subscriber QoS.
struct DDS_DomainParticipantFactoryQos	DDS_PARTICIPANT_FACTORY_QOS_DEFAULT
	<<cert>> Special value for creating domain participant with default QoS.When used in DDS_DomainParticipantFactory_create_participant, this special value is used to indicate that the DDS_DomainParticipant should be created with the default DDS_DomainParticipant QoS.
struct DDS_DomainParticipantQos	DDS_PARTICIPANT_QOS_DEFAULT
	<<cert>> Special value for creating domain participant with default QoS.When used in DDS_DomainParticipantFactory_create_participant, this special value is used to indicate that the DDS_DomainParticipant should be created with the default DDS_DomainParticipant QoS.

---

Detailed Description

DDS Domain Module definitions.

---

Macro Definition Documentation

#define DDS_DiscoveryComponent_INITIALIZER

Value:

{\
  {0},\
  NDDS_Discovery_Property_INITIALIZER\
}

Initializer for new DDS_DiscoveryComponent instances.