disc_dpse_dpsediscovery.h File Reference

DPSE API Dynamic Participant/Static Endpoint Discovery Plugin. More...

#include "disc_dpse/disc_dpse_dll.h"
#include "dds_c/dds_c_discovery_plugin.h"

Go to the source code of this file.

Data Structures
struct	DPSE_DiscoveryPluginProperty
	<<eXtension>> <<cert>> Properties for the Dynamic Participant/Static Endpoint (DPSE) discovery plugin. This includes all discovery timing properties for participant discovery. More...

Macros
#define	DPSE_DiscoveryPluginProperty_INITIALIZER

Functions
DDS_ReturnCode_t	DPSE_RemoteParticipant_assert_builtin (DDS_DomainParticipant *const participant, struct DDS_ParticipantBuiltinTopicData *const data)
	Assert remote participant by passing in the builtin data.
DDS_ReturnCode_t	DPSE_RemoteParticipant_assert (DDS_DomainParticipant *const participant, const char *rem_participant_name)
	Assert remote participant by passing in the name of that participant.
DDS_ReturnCode_t	DPSE_RemotePublication_assert (DDS_DomainParticipant *const participant, const char *const rem_participant_name, const struct DDS_PublicationBuiltinTopicData *const data, NDDS_TypePluginKeyKind key_kind)
	Assert remote publication by passing in the builtin data that describes the type, topic, and QoS of that remote publication.DPSE discovery requires that you pre-configure your application with information about any remote publications that you intend to discover and receive data from. The ::DDS_PublicationBuiltinTopicData field must include the topic name, type name, and QoS of the remote DDS_DataWriter that you intend to receive communications from.
DDS_ReturnCode_t	DPSE_RemoteSubscription_assert (DDS_DomainParticipant *const participant, const char *const rem_participant_name, const struct DDS_SubscriptionBuiltinTopicData *const data, NDDS_TypePluginKeyKind key_kind)
	Assert remote subscription by passing in the builtin data that describes the type, topic, and QoS of that remote subscription.DPSE discovery requires that you pre-configure your application with information about any remote subscriptions that you intend to discover and send data to. The ::DDS_SubscriptionBuiltinTopicData parameter must include the topic name, type name, and QoS of the remote DDS_DataReader that your application intends to send data to. Additionally, if the remote DDS_DataReader is listening on a non-default port, you must set the remote locator (including the non-default port) in the ::DDS_SubscriptionBuiltinTopicData that you intend to use to contact the remote DDS_DataReader.
struct RT_ComponentFactoryI *	DPSE_DiscoveryFactory_get_interface (void)
	Gets the component factory necessary when registering a DPSE component with RTI Connext Micro.

---

Detailed Description

DPSE API Dynamic Participant/Static Endpoint Discovery Plugin.

The Plugin APIs are used to configure and instantiate the RTI Connext Micro Dynamic Participant/Static Endpoint Discovery Plugin.

---

Macro Definition Documentation

#define DPSE_DiscoveryPluginProperty_INITIALIZER

Value:

{ \
    RT_ComponentFactoryProperty_INITIALIZER,\
    {30,0},  \
    {100,0}, \
    5,       \
    {1,0},   \
    }

---

Function Documentation

DDS_ReturnCode_t DPSE_RemoteParticipant_assert_builtin	(	DDS_DomainParticipant *const	participant,
		struct DDS_ParticipantBuiltinTopicData *const	data
	)

Assert remote participant by passing in the builtin data.

DDS_ReturnCode_t DPSE_RemoteParticipant_assert	(	DDS_DomainParticipant *const	participant,
		const char *	rem_participant_name
	)

Assert remote participant by passing in the name of that participant.

DPSE discovery requires that you pre-configure your application with information about any remote participants that you intend to discover. The only information that needs to be pre-configured is the name of the remote DDS_DomainParticipant that your application intends to discover.

DDS_ReturnCode_t DPSE_RemotePublication_assert	(	DDS_DomainParticipant *const	participant,
		const char *const	rem_participant_name,
		const struct DDS_PublicationBuiltinTopicData *const	data,
		NDDS_TypePluginKeyKind	key_kind
	)

Assert remote publication by passing in the builtin data that describes the type, topic, and QoS of that remote publication.DPSE discovery requires that you pre-configure your application with information about any remote publications that you intend to discover and receive data from. The ::DDS_PublicationBuiltinTopicData field must include the topic name, type name, and QoS of the remote DDS_DataWriter that you intend to receive communications from.

Additionally, this method takes a key_kind argument that must match the key kind returned by the type plugin.

DDS_ReturnCode_t DPSE_RemoteSubscription_assert	(	DDS_DomainParticipant *const	participant,
		const char *const	rem_participant_name,
		const struct DDS_SubscriptionBuiltinTopicData *const	data,
		NDDS_TypePluginKeyKind	key_kind
	)

Assert remote subscription by passing in the builtin data that describes the type, topic, and QoS of that remote subscription.DPSE discovery requires that you pre-configure your application with information about any remote subscriptions that you intend to discover and send data to. The ::DDS_SubscriptionBuiltinTopicData parameter must include the topic name, type name, and QoS of the remote DDS_DataReader that your application intends to send data to. Additionally, if the remote DDS_DataReader is listening on a non-default port, you must set the remote locator (including the non-default port) in the ::DDS_SubscriptionBuiltinTopicData that you intend to use to contact the remote DDS_DataReader.

Additionally, this method takes a key_kind argument that must match the key kind returned by the type plugin.

struct RT_ComponentFactoryI* DPSE_DiscoveryFactory_get_interface ( void  )

read

Gets the component factory necessary when registering a DPSE component with RTI Connext Micro.