DPSEDiscoveryPlugin Class Reference

<<eXtension>> <<cert>> Discovery plug-in used for asserting remote entities. More...

List of all members.

Static Public Member Functions
static DDS_ReturnCode_t	RemoteParticipant_assert (DDSDomainParticipant *const participant, const char *rem_participant_name)
	<<cert>> Assert remote participant by passing in the name of that participant.
static DDS_ReturnCode_t	RemotePublication_assert (DDSDomainParticipant *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.
static DDS_ReturnCode_t	RemoteSubscription_assert (DDSDomainParticipant *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.

---

Detailed Description

<<eXtension>> <<cert>> Discovery plug-in used for asserting remote entities.

---

Member Function Documentation

static DDS_ReturnCode_t DPSEDiscoveryPlugin::RemoteParticipant_assert ( DDSDomainParticipant *const  participant, const char *  rem_participant_name  )

static

<<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 DDSDomainParticipant that your application intends to discover.

Parameters:

participant	<<in>> The DDSDomainParticipant 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.

static DDS_ReturnCode_t DPSEDiscoveryPlugin::RemotePublication_assert ( DDSDomainParticipant *const  participant, const char *const  rem_participant_name, const struct DDS_PublicationBuiltinTopicData *const  data, NDDS_TypePluginKeyKind  key_kind  )

static

<<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 DDSDataWriter 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 DDSDomainParticipant 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.

static DDS_ReturnCode_t DPSEDiscoveryPlugin::RemoteSubscription_assert ( DDSDomainParticipant *const  participant, const char *const  rem_participant_name, const struct DDS_SubscriptionBuiltinTopicData *const  data, NDDS_TypePluginKeyKind  key_kind  )

static

<<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 DDSDataReader that your application intends to send data to. Additionally, if the remote DDSDataReader 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 DDSDataReader.

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

Parameters:

participant	<<in>> The DDSDomainParticipant 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.