dds.h File Reference

CoreDX DDS C API Header File. More...

Go to the source code of this file.

Classes
struct	DDS_TopicListener
	The DDS_TopicListener provides asynchronous notification of DDS_Topic events. More...
struct	DDS_TopicListener_cd
	The DDS_TopicListener_cd provides asynchronous notification of DDS_Topic events with additional callback data. More...
struct	DDS_DataWriterListener
	The DDS_DataWriterListener provides asynchronous notification of DDS_DataWriter events. More...
struct	DDS_DataWriterListener_cd
	The DDS_DataWriterListener_cd provides asynchronous notification of DDS_DataWriter events with additional callback data. More...
struct	DDS_PublisherListener
	The DDS_PublisherListener provides asynchronous notification of DDS_Publisher events. More...
struct	DDS_PublisherListener_cd
	The DDS_PublisherListener_cd provides asynchronous notification of DDS_Publisher events with additionall callback data. More...
struct	DDS_DataReaderListener
	The DDS_DataReaderListener provides asynchronous notification of DDS_DataReader events. More...
struct	DDS_DataReaderListener_cd
	The DDS_DataReaderListener_cd provides asynchronous notification of DDS_DataReader events with additional callback data. More...
struct	DDS_SubscriberListener
	The DDS_SubscriberListener provides asynchronous notification of DDS_Subscriber events. More...
struct	DDS_SubscriberListener_cd
	The DDS_SubscriberListener_cd provides asynchronous notification of DDS_Subscriber events with additional callback data. More...
struct	DDS_DomainParticipantListener
	The DDS_DomainParticipantListener provides asynchronous notification of DDS_DomainParticipant events. More...
struct	DDS_DomainParticipantListener_cd
	The DDS_DomainParticipantListener_cd provides asynchronous notification of DDS_DomainParticipant events with additional callback data arguments. More...
struct	CoreDX_RTPSWriterQosPolicy
	QoS Policy for configuring aspects of the RTPS Writer Protocol. More...
struct	CoreDX_RTPSReaderQosPolicy
	QoS Policy for configuring aspects of the RTPS Reader Protocol. More...
struct	CoreDX_DiscoveryQosPolicy
	QoS Policy for configuring aspects of the Discovery and Builtin entities. More...
struct	DDS_DomainParticipantFactoryQos
	Structure that holds DDS_DomainParticipantFactory Quality of Service policies. More...
struct	DDS_DomainParticipantQos
	Structure that holds DDS_DomainParticipant Quality of Service policies. More...
struct	DDS_TopicQos
	Structure that holds DDS_Topic Quality of Service policies. More...
struct	DDS_DataWriterQos
	Structure that holds DDS_DataWriter Quality of Service policies. More...
struct	DDS_PublisherQos
	Structure that holds DDS_Publisher Quality of Service policies. More...
struct	DDS_DataReaderQos
	Structure that holds DDS_DataReader Quality of Service policies. More...
struct	DDS_SubscriberQos
	Structure that holds DDS_Subscriber Quality of Service policies. More...
Defines
#define	DDS_Publisher_wait_for_acknowledgements   DDS_Publisher_wait_for_acknowledgments
	Block until all writers contained by this publisher have received acknowledgements.
#define	DDS_DataWriter_wait_for_acknowledgements   DDS_DataWriter_wait_for_acknowledgments
	Block until this writer has received acknowledgements for all written data.
Typedefs
typedef struct _GuardCondition *	DDS_GuardCondition
	A DDS_GuardCondition is a condition where the trigger_value is under application control.

---

Detailed Description

CoreDX DDS C API Header File.

The include/dds.h file provides all of the CoreDX DDS declarations for DDS datatypes and functions. This file should be included by C application code that uses the C DDS Application Programming Interface.

---

Define Documentation

#define DDS_DataWriter_wait_for_acknowledgements   DDS_DataWriter_wait_for_acknowledgments [related]

Block until this writer has received acknowledgements for all written data.

This routine will block until all data written by the writer has been acknowledged, or until the 'max_wait' duration has passed. 'max_wait' can be set to INFINITE, in which case this routine may block indefinitely.

Return values:

	DDS_RETCODE_TIME_OUT	returned if 'max_wait' passes before all acks are received
	DDS_RETCODE_OK	returned if all acks have been received before 'max_wait'

#define DDS_Publisher_wait_for_acknowledgements   DDS_Publisher_wait_for_acknowledgments [related]

Block until all writers contained by this publisher have received acknowledgements.

This routine will block until all data written by contained writers has been acknowledged, or until the 'max_wait' duration has passed. 'max_wait' can be set to INFINITE, in which case this routine may block indefinitely.

Return values:

	DDS_RETCODE_TIME_OUT	returned if 'max_wait' passes before all acks are received
	DDS_RETCODE_OK	returned if all acks have been received before 'max_wait'