DPSE Static Discovery API

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
	Initializer for the DPSE_DiscoveryPluginProperty.

Functions
DDS_ReturnCode_t	DPSE_DiscoveryPluginProperty_initialize (struct DPSE_DiscoveryPluginProperty *self)
	Initialize a DiscoveryPluginProperty structure.
DDS_ReturnCode_t	DPSE_RemoteParticipant_assert (DDS_DomainParticipant *const participant, const char *rem_participant_name)
	<<cert>> 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)
	<<cert>> Assert remote publication by passing in the builtin data that describes the type, topic, and QoS of that remote publication.
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)
	<<cert>> Assert remote subscription by passing in the builtin data that describes the type, topic, and QoS of that remote subscription.
struct RT_ComponentFactoryI *	DPSE_DiscoveryFactory_get_interface (void)
	Gets the singleton instance of the DPSE discovery plugin factory. The singleton instance of the factory is used when creating a domain participant.
const char *	DPSE_DiscoveryFactory_get_version (void)
	Returns the version string for the DPSE library.

---

Detailed Description

<<eXtension>> <<cert>> The RTI Connext Micro support for DPSE discovery of remote entities. Please refer to the Discovery chapter in the User's Manual, and the Getting Started Guide, for an example of how to register and use the DPSE plugin.

---

Macro Definition Documentation

#define DPSE_DiscoveryPluginProperty_INITIALIZER

Value:

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

Initializer for the DPSE_DiscoveryPluginProperty.

---

Function Documentation

DDS_ReturnCode_t DPSE_DiscoveryPluginProperty_initialize

(

struct DPSE_DiscoveryPluginProperty *

self

)

Initialize a DiscoveryPluginProperty structure.

Parameters:

self	<<in>> Cannot be NULL.

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

<<cert>> 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.

Parameters:

participant	<<in>> The DDS_DomainParticipant to assert the remote participant rem_participant_name into.
rem_participant_name	<<in>> The name of the remote participant as specified in DDS_ParticipantBuiltinTopicData::participant_name.

Returns:

One of the Standard Return Codes

MT Safety:

This operation is thread safe. However, note that the arguments are not protected from being modified by other threads and must not be modified until the call returns.

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
	)

<<cert>> 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.

Parameters:

participant	<<in>> The DDS_DomainParticipant to assert the remote publication defined by DDS_PublicationBuiltinTopicData into.
rem_participant_name	<<in>> The name of the remote participant as specified in DDS_ParticipantBuiltinTopicData::participant_name.
data	<<in>> The DDS_PublicationBuiltinTopicData defining the remote publication.
key_kind	<<in>> The IDL key type.

Returns:

One of the Standard Return Codes

MT Safety:

This operation is thread safe. However, note that the arguments are not protected from being modified by other threads and must not be modified until the call returns.

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
	)

<<cert>> 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.

Parameters:

participant	<<in>> The DDS_DomainParticipant to assert the remote subscription defined by DDS_SubscriptionBuiltinTopicData into.
rem_participant_name	<<in>> The name of the remote participant as specified in DDS_ParticipantBuiltinTopicData::participant_name.
data	<<in>> The DDS_SubscriptionBuiltinTopicData defining the remote subscription.
key_kind	<<in>> The IDL key type.

Returns:

One of the Standard Return Codes

MT Safety:

This operation is thread safe. However, note that the arguments are not protected from being modified by other threads and must not be modified until the call returns.

struct RT_ComponentFactoryI* DPSE_DiscoveryFactory_get_interface ( void  )

read

Gets the singleton instance of the DPSE discovery plugin factory. The singleton instance of the factory is used when creating a domain participant.

This function gets the single singleton instance of the DPSE discovery plugin factory that is used by the middleware to create a DPSE plugin. In the future, as more discovery plug-ins are supported, they will be registered with the middleware by installing different discovery factory instances with the DDS_DomainParticipantFactory. The singleton instance of the factory is registered with a name, and that name is specified in the DDS_DomainParticipant DDS_DiscoveryQosPolicy. This is used to create a discovery plug-in instance when creating a domain participant.

Returns:

Pointer to DPSE discovery plugin factory

MT Safety:

This operation is thread safe. However, note that the arguments are not protected from being modified by other threads and must not be modified until the call returns.

See also:

DDS_DiscoveryQosPolicy

const char* DPSE_DiscoveryFactory_get_version

(

void

)

Returns the version string for the DPSE library.