RTI Connext Micro  Version 2.4.1.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
disc_dpse_dpsediscovery.h
Go to the documentation of this file.
1 /*
2  * FILE: disc_dpse_discovery.h - DPSE API
3  *
4  * (c) Copyright 2011-2014 Real-Time Innovations,
5  *
6  * All rights reserved.
7  *
8  * No duplications, whole or partial, manual or electronic, may be made
9  * without express written permission. Any such copies, or
10  * revisions thereof, must display this notice unaltered.
11  * This code contains trade secrets of Real-Time Innovations, Inc.
12  *
13  * Modification History
14  * --------------------
15  * 09sep2008,tk Refactored
16  * 08aug2011,yy Copied the loopback string so that it could be freed later
17  * 04aug2011,yy Fixed 14066
18  * 09sep2008,rmw Created
19  */
20 /*ce
21  * \file
22  * \brief DPSE API Dynamic Participant/Static Endpoint Discovery Plugin.
23  * \details
24  * The Plugin APIs are used to configure and instantiate the RTI
25  * Connext Micro Dynamic Participant/Static Endpoint
26  * Discovery Plugin.
27  */
28 #ifndef disc_dpse_dpsediscovery_h
29 #define disc_dpse_dpsediscovery_h
30 
31 #ifndef disc_dpse_dll_h
33 #endif
34 #ifndef dds_c_discovery_plugin_h
36 #endif
37 
38 #ifdef __cplusplus
39 extern "C"
40 {
41 #endif
42 
44 DISC_DPSEDllExport DDS_ReturnCode_t
45 DPSE_DiscoveryPluginProperty_initialize(
46  struct DPSE_DiscoveryPluginProperty *dst);
47 
48 #ifdef __cplusplus
49 }
50 #endif
51 
52 /*e \dref_DPSE_DiscoveryPluginProperty
53 */
55 {
56  /*ci
57  * \brief Inherit from base-class
58  */
59  struct RT_ComponentFactoryProperty _parent;
60 
61  /*e \dref_DPSE_DiscoveryPluginProperty_participant_liveliness_assert_period
62  */
64 
65  /*e \dref_DPSE_DiscoveryPluginProperty_participant_liveliness_lease_duration
66  */
68 
69  /*e \dref_DPSE_DiscoveryPluginProperty_initial_participant_announcements
70  */
72 
73  /*e \dref_DPSE_DiscoveryPluginProperty_initial_participant_announcement_period
74  */
76 
77 #ifdef RTI_CPP
78  public:\
80  {
81  DPSE_DiscoveryPluginProperty_initialize(this);
82  }
84  private:\
86  const struct DPSE_DiscoveryPluginProperty& from )
87  {
88  UNUSED_ARG(from);
89  }
90  struct DPSE_DiscoveryPluginProperty& operator=(
91  const struct DPSE_DiscoveryPluginProperty& from )
92  {
93  UNUSED_ARG(from);
94  return *this;
95  }
96  bool operator==(
97  const struct DPSE_DiscoveryPluginProperty& other)
98  {
99  UNUSED_ARG(other);
100  return false;
101  }
102  bool operator!=(
103  const struct DPSE_DiscoveryPluginProperty& other)
104  {
105  UNUSED_ARG(other);
106  return false;
107  }
108 #endif
109 };
110 
111 #ifdef __cplusplus
112 extern "C"
113 {
114 #endif
115 
116 #define RTI_DPSEDISCOVERY_INTERFACE_ID \
117  RT_MKINTERFACEID(RT_COMPONENT_CLASS_DISCOVERY,\
118  RT_COMPONENT_INSTANCE_DISCOVERY_DPSE)
119 
120 /*e \dref_DPSE_DiscoveryPluginProperty_INITIALIZER
121  */
122 #define DPSE_DiscoveryPluginProperty_INITIALIZER { \
123  RT_ComponentFactoryProperty_INITIALIZER,\
124  {30,0}, \
125  {100,0}, \
126  5, \
127  {1,0}, \
128  }
129 
130 /*ce \dref_DPSE_RemoteParticipant_assert_builtin
131  */
132 MUST_CHECK_RETURN DISC_DPSEDllExport DDS_ReturnCode_t
134  struct DDS_ParticipantBuiltinTopicData *const data);
135 
136 
137 
138 /*ce \dref_DPSE_RemoteParticipant_assert
139  */
140 MUST_CHECK_RETURN DISC_DPSEDllExport DDS_ReturnCode_t
142  const char *rem_participant_name);
143 
144 /*ce \dref_DPSE_RemotePublication_assert
145  */
146 MUST_CHECK_RETURN DISC_DPSEDllExport DDS_ReturnCode_t
148  const char *const rem_participant_name,
149  const struct DDS_PublicationBuiltinTopicData *const data,
150  NDDS_TypePluginKeyKind key_kind);
151 
152 /*ce \dref_DPSE_RemoteSubscription_assert
153  */
154 MUST_CHECK_RETURN DISC_DPSEDllExport DDS_ReturnCode_t
156  const char *const rem_participant_name,
157  const struct DDS_SubscriptionBuiltinTopicData *const data,
158  NDDS_TypePluginKeyKind key_kind);
159 
160 /* -------------------------------------------------------------------------- */
161 /* Plugin factory
162  */
163 /*ce \dref_DPSE_DiscoveryFactory_get_interface
164  */
165 MUST_CHECK_RETURN DISC_DPSEDllExport struct RT_ComponentFactoryI*
167 
168 #ifdef __cplusplus
169 } /* extern "C" */
170 #endif
171 
172 #endif /* disc_dpse_dpsediscovery_h */

RTI Connext Micro Version 2.4.1.0 Copyright © Thu Nov 20 2014 Real-Time Innovations, Inc