OpenDDS  Snapshot(2023/04/28-20:55)
ParameterListConverter.h
Go to the documentation of this file.
1 /*
2  *
3  * Distributed under the OpenDDS License.
4  * See: http://www.opendds.org/license.html
5  */
6 
7 #ifndef OPENDDS_DCPS_RTPS_PARAMETERLISTCONVERTER_H
8 #define OPENDDS_DCPS_RTPS_PARAMETERLISTCONVERTER_H
9 
10 #include "rtps_export.h"
11 #include "RtpsCoreC.h"
12 
13 #ifdef OPENDDS_SECURITY
14 #include "RtpsSecurityC.h"
15 #endif
16 
17 #include "ICE/Ice.h"
18 
19 #include "dds/DCPS/XTypes/TypeObject.h"
20 #include "dds/DCPS/BuiltInTopicUtils.h"
21 
22 OPENDDS_BEGIN_VERSIONED_NAMESPACE_DECL
23 
24 namespace OpenDDS {
25 namespace RTPS {
26 namespace ParameterListConverter {
27 
28 #ifdef OPENDDS_SECURITY
29 struct DiscoveredPublication_SecurityWrapper {
30  DCPS::DiscoveredWriterData data;
31  DDS::Security::EndpointSecurityInfo security_info;
32  DDS::Security::DataTags data_tags;
33  bool have_ice_agent_info;
34  ICE::AgentInfo ice_agent_info;
35  XTypes::TypeInformation type_info;
36 
37  DiscoveredPublication_SecurityWrapper()
38  : have_ice_agent_info(false)
39  {
40  data.ddsPublicationData.key = DCPS::BUILTIN_TOPIC_KEY_UNKNOWN;
41  data.ddsPublicationData.participant_key = DCPS::BUILTIN_TOPIC_KEY_UNKNOWN;
42  security_info.endpoint_security_attributes = 0;
43  security_info.plugin_endpoint_security_attributes = 0;
44  }
45 };
46 
47 struct DiscoveredSubscription_SecurityWrapper {
48  DCPS::DiscoveredReaderData data;
49  DDS::Security::EndpointSecurityInfo security_info;
50  DDS::Security::DataTags data_tags;
51  bool have_ice_agent_info;
52  ICE::AgentInfo ice_agent_info;
53  XTypes::TypeInformation type_info;
54 
55  DiscoveredSubscription_SecurityWrapper()
56  : have_ice_agent_info(false)
57  {
58  data.ddsSubscriptionData.key = DCPS::BUILTIN_TOPIC_KEY_UNKNOWN;
59  data.ddsSubscriptionData.participant_key = DCPS::BUILTIN_TOPIC_KEY_UNKNOWN;
60  security_info.endpoint_security_attributes = 0;
61  security_info.plugin_endpoint_security_attributes = 0;
62  }
63 };
64 #endif
65 
66 // DDS::ParticipantBuiltinTopicData
67 
68 OpenDDS_Rtps_Export
69 bool to_param_list(const DDS::ParticipantBuiltinTopicData& pbtd,
70  ParameterList& param_list);
71 
72 OpenDDS_Rtps_Export
73 bool from_param_list(const ParameterList& param_list,
74  DDS::ParticipantBuiltinTopicData& pbtd);
75 
76 #ifdef OPENDDS_SECURITY
77 // DDS::Security::ParticipantBuiltinTopicData
78 
79 OpenDDS_Rtps_Export
80 bool to_param_list(const DDS::Security::ParticipantBuiltinTopicData& pbtd,
81  ParameterList& param_list);
82 
83 OpenDDS_Rtps_Export
84 bool from_param_list(const ParameterList& param_list,
85  DDS::Security::ParticipantBuiltinTopicData& pbtd);
86 
87 // DDS::Security::ParticipantBuiltinTopicDataSecure
88 
89 OpenDDS_Rtps_Export
90 bool to_param_list(const DDS::Security::ParticipantBuiltinTopicDataSecure& pbtds,
91  ParameterList& param_list);
92 
93 OpenDDS_Rtps_Export
94 bool from_param_list(const ParameterList& param_list,
95  DDS::Security::ParticipantBuiltinTopicDataSecure& pbtds);
96 #endif
97 
98 // OpenDDS::RTPS::ParticipantProxy_t
99 
100 OpenDDS_Rtps_Export
101 bool to_param_list(const ParticipantProxy_t& proxy,
102  ParameterList& param_list);
103 
104 OpenDDS_Rtps_Export
105 bool from_param_list(const ParameterList& param_list,
106  ParticipantProxy_t& proxy);
107 
108 // OpenDDS::RTPS::Duration_t
109 
110 OpenDDS_Rtps_Export
111 bool to_param_list(const Duration_t& duration,
112  ParameterList& param_list);
113 
114 OpenDDS_Rtps_Export
115 bool from_param_list(const ParameterList& param_list,
116  Duration_t& duration);
117 
118 // OpenDDS::RTPS::SPDPdiscoveredParticipantData
119 
120 OpenDDS_Rtps_Export
121 bool to_param_list(const SPDPdiscoveredParticipantData& participant_data,
122  ParameterList& param_list);
123 
124 OpenDDS_Rtps_Export
125 bool from_param_list(const ParameterList& param_list,
126  SPDPdiscoveredParticipantData& participant_data);
127 
128 #ifdef OPENDDS_SECURITY
129 // OpenDDS::Security::SPDPdiscoveredParticipantData
130 
131 OpenDDS_Rtps_Export
132 bool to_param_list(const OpenDDS::Security::SPDPdiscoveredParticipantData& participant_data,
133  ParameterList& param_list);
134 
135 OpenDDS_Rtps_Export
136 bool from_param_list(const ParameterList& param_list,
137  OpenDDS::Security::SPDPdiscoveredParticipantData& participant_data);
138 #endif
139 
140 // OpenDDS::DCPS::DiscoveredWriterData
141 
142 OpenDDS_Rtps_Export
143 void add_DataRepresentationQos(ParameterList& param_list, const DDS::DataRepresentationIdSeq& ids);
144 
145 OpenDDS_Rtps_Export
146 bool to_param_list(const DCPS::DiscoveredWriterData& writer_data,
147  ParameterList& param_list,
148  bool use_xtypes,
149  const XTypes::TypeInformation& type_info,
150  bool map = false /*map IPV4 to IPV6 addr*/);
151 
152 OpenDDS_Rtps_Export
153 bool from_param_list(const ParameterList& param_list,
154  DCPS::DiscoveredWriterData& writer_data,
155  bool use_xtypes,
156  XTypes::TypeInformation& type_info);
157 
158 // OpenDDS::DCPS::DiscoveredReaderData
159 
160 OpenDDS_Rtps_Export
161 bool to_param_list(const DCPS::DiscoveredReaderData& reader_data,
162  ParameterList& param_list,
163  bool use_xtypes,
164  const XTypes::TypeInformation& type_info,
165  bool map = false /*map IPV4 to IPV6 addr*/);
166 
167 OpenDDS_Rtps_Export
168 bool from_param_list(const ParameterList& param_list,
169  DCPS::DiscoveredReaderData& reader_data,
170  bool use_xtypes,
171  XTypes::TypeInformation& type_info);
172 
173 #ifdef OPENDDS_SECURITY
174 // DDS::Security::EndpointSecurityInfo
175 
176 OpenDDS_Rtps_Export
177 bool to_param_list(const DDS::Security::EndpointSecurityInfo& info,
178  ParameterList& param_list);
179 
180 OpenDDS_Rtps_Export
181 bool from_param_list(const ParameterList& param_list,
182  DDS::Security::EndpointSecurityInfo& info);
183 
184 // DDS::Security::DataTags data_tags
185 
186 OpenDDS_Rtps_Export
187 bool to_param_list(const DDS::Security::DataTags& tags,
188  ParameterList& param_list);
189 
190 OpenDDS_Rtps_Export
191 bool from_param_list(const ParameterList& param_list,
192  DDS::Security::DataTags& tags);
193 
194 // DiscoveredPublication_SecurityWrapper
195 
196 OpenDDS_Rtps_Export
197 bool to_param_list(const DiscoveredPublication_SecurityWrapper& wrapper,
198  ParameterList& param_list,
199  bool use_xtypes,
200  const XTypes::TypeInformation& type_info,
201  bool map = false /*map IPV4 to IPV6 addr*/);
202 
203 OpenDDS_Rtps_Export
204 bool from_param_list(const ParameterList& param_list,
205  DiscoveredPublication_SecurityWrapper& wrapper,
206  bool use_xtypes,
207  XTypes::TypeInformation& type_info);
208 
209 // DiscoveredSubscription_SecurityWrapper
210 
211 OpenDDS_Rtps_Export
212 bool to_param_list(const DiscoveredSubscription_SecurityWrapper& wrapper,
213  ParameterList& param_list,
214  bool use_xtypes,
215  const XTypes::TypeInformation& type_info,
216  bool map = false /*map IPV4 to IPV6 addr*/);
217 
218 OpenDDS_Rtps_Export
219 bool from_param_list(const ParameterList& param_list,
220  DiscoveredSubscription_SecurityWrapper& wrapper,
221  bool use_xtypes,
222  XTypes::TypeInformation& type_info);
223 
224 // Extensions for ICE
225 
226 OpenDDS_Rtps_Export
227 bool to_param_list(const ICE::AgentInfoMap& ai_map,
228  ParameterList& param_list);
229 
230 OpenDDS_Rtps_Export
231 bool from_param_list(const ParameterList& param_list,
232  ICE::AgentInfoMap& ai_map);
233 #endif
234 
235 }
236 }
237 }
238 
239 OPENDDS_END_VERSIONED_NAMESPACE_DECL
240 
241 #endif
OpenDDS::RTPS::ParameterListConverter::from_param_list
bool from_param_list(const ParameterList &param_list, DDS::ParticipantBuiltinTopicData &pbtd)
Definition: ParameterListConverter.cpp:344
OpenDDS::DCPS::BUILTIN_TOPIC_KEY_UNKNOWN
const DDS::BuiltinTopicKey_t BUILTIN_TOPIC_KEY_UNKNOWN
Definition: BuiltInTopicUtils.h:85
DDS::Security::EndpointSecurityInfo::plugin_endpoint_security_attributes
PluginEndpointSecurityAttributesMask plugin_endpoint_security_attributes
Definition: DdsSecurityParams.idl:100
DDS::DataRepresentationIdSeq
sequence< DataRepresentationId_t > DataRepresentationIdSeq
Definition: DdsDcpsCore.idl:280
OpenDDS::RTPS::ParameterListConverter::add_DataRepresentationQos
void add_DataRepresentationQos(ParameterList &param_list, const DDS::DataRepresentationIdSeq &ids)
Definition: ParameterListConverter.cpp:789
OpenDDS::DCPS::DiscoveredWriterData::ddsPublicationData
DDS::PublicationBuiltinTopicData ddsPublicationData
Definition: DdsDcpsInfoUtils.idl:122
OpenDDS::DCPS::DiscoveredReaderData::ddsSubscriptionData
DDS::SubscriptionBuiltinTopicData ddsSubscriptionData
Definition: DdsDcpsInfoUtils.idl:110
DDS::Security::EndpointSecurityInfo::endpoint_security_attributes
EndpointSecurityAttributesMask endpoint_security_attributes
Definition: DdsSecurityParams.idl:99
OpenDDS_Rtps_Export
#define OpenDDS_Rtps_Export
Definition: rtps_export.h:23
ParameterList
sequence< Parameter > ParameterList
OPENDDS_END_VERSIONED_NAMESPACE_DECL
#define OPENDDS_END_VERSIONED_NAMESPACE_DECL
Definition: Versioned_Namespace.h:48
OpenDDS::RTPS::ParameterListConverter::to_param_list
bool to_param_list(const DDS::ParticipantBuiltinTopicData &pbtd, ParameterList &param_list)
Definition: ParameterListConverter.cpp:332
OpenDDS
The Internal API and Implementation of OpenDDS.
Definition: AddressCache.h:28
Generated by   doxygen 1.8.13