RTI Connext DDS Micro  Version 2.4.6
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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-2015 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 
45 /*ce \dref_DPSE_DiscoveryPluginProperty_initialize
46 */
47 DISC_DPSEDllExport DDS_ReturnCode_t
49  struct DPSE_DiscoveryPluginProperty *dst);
50 
51 #ifdef __cplusplus
52 }
53 #endif
54 
55 /*e \dref_DPSE_DiscoveryPluginProperty
56 */
58 {
59  /*ci
60  * \brief Inherit from base-class
61  */
62  struct RT_ComponentFactoryProperty _parent;
63 
64  /*e \dref_DPSE_DiscoveryPluginProperty_participant_liveliness_assert_period
65  */
67 
68  /*e \dref_DPSE_DiscoveryPluginProperty_participant_liveliness_lease_duration
69  */
71 
72  /*e \dref_DPSE_DiscoveryPluginProperty_initial_participant_announcements
73  */
75 
76  /*e \dref_DPSE_DiscoveryPluginProperty_initial_participant_announcement_period
77  */
79 
80  /*e \dref_DPSE_DiscoveryPluginProperty_max_participant_locators;
81  */
83 
84  /*e \dref_DPSE_DiscoveryPluginProperty_max_locators_per_discovered_participant;
85  */
87 
88 #ifdef RTI_CPP
89  public:\
91  {
93  }
95  private:\
97  const struct DPSE_DiscoveryPluginProperty& from )
98  {
100  UNUSED_ARG(from);
101  }
102  struct DPSE_DiscoveryPluginProperty& operator=(
103  const struct DPSE_DiscoveryPluginProperty& from )
104  {
105  UNUSED_ARG(from);
106  return *this;
107  }
108  bool operator==(
109  const struct DPSE_DiscoveryPluginProperty& other)
110  {
111  UNUSED_ARG(other);
112  return false;
113  }
114  bool operator!=(
115  const struct DPSE_DiscoveryPluginProperty& other)
116  {
117  UNUSED_ARG(other);
118  return false;
119  }
120 #endif
121 };
122 
123 #ifdef __cplusplus
124 extern "C"
125 {
126 #endif
127 
128 #define RTI_DPSEDISCOVERY_INTERFACE_ID \
129  RT_MKINTERFACEID(RT_COMPONENT_CLASS_DISCOVERY,\
130  RT_COMPONENT_INSTANCE_DISCOVERY_DPSE)
131 
132 /*e \dref_DPSE_DiscoveryPluginProperty_INITIALIZER
133  */
134 #define DPSE_DiscoveryPluginProperty_INITIALIZER \
135 { \
136  RT_ComponentFactoryProperty_INITIALIZER,\
137  {30,0}, \
138  {100,0}, \
139  5, \
140  {1,0}, \
141  DDS_LENGTH_AUTO,\
142  4 \
143 }
144 
145 /*ce \dref_DPSE_RemoteParticipant_assert
146  */
147 MUST_CHECK_RETURN DISC_DPSEDllExport DDS_ReturnCode_t
149  const char *rem_participant_name);
150 
151 /*ce \dref_DPSE_RemotePublication_assert
152  */
153 MUST_CHECK_RETURN DISC_DPSEDllExport DDS_ReturnCode_t
155  const char *const rem_participant_name,
156  const struct DDS_PublicationBuiltinTopicData *const data,
157  NDDS_TypePluginKeyKind key_kind);
158 
159 /*ce \dref_DPSE_RemoteSubscription_assert
160  */
161 MUST_CHECK_RETURN DISC_DPSEDllExport DDS_ReturnCode_t
163  const char *const rem_participant_name,
164  const struct DDS_SubscriptionBuiltinTopicData *const data,
165  NDDS_TypePluginKeyKind key_kind);
166 
167 /* -------------------------------------------------------------------------- */
168 /* Plugin factory
169  */
170 /*ce \dref_DPSE_DiscoveryFactory_get_interface
171  */
172 MUST_CHECK_RETURN DISC_DPSEDllExport struct RT_ComponentFactoryI*
174 
175 #ifdef __cplusplus
176 } /* extern "C" */
177 #endif
178 
179 #endif /* disc_dpse_dpsediscovery_h */

RTI Connext DDS Micro Version 2.4.6 Copyright © Mon Jan 25 2016 Real-Time Innovations, Inc