TCPControlMessage.h 59 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755
  1. // Copyright 2019 Proyectos y Sistemas de Mantenimiento SL (eProsima).
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. /*!
  15. * @file TCPControlMessage.h
  16. * This header file contains the declaration of the described types in the IDL file.
  17. *
  18. * This file was generated by the tool gen.
  19. */
  20. #ifndef _FASTDDS_TCP_CONTROL_MESSAGE_H_
  21. #define _FASTDDS_TCP_CONTROL_MESSAGE_H_
  22. #include <fastdds/rtps/common/Locator.h>
  23. #include <fastdds/rtps/common/SerializedPayload.h>
  24. #if defined(_WIN32)
  25. #if defined(EPROSIMA_USER_DLL_EXPORT)
  26. #define eProsima_user_DllExport __declspec( dllexport )
  27. #else
  28. #define eProsima_user_DllExport
  29. #endif
  30. #else
  31. #define eProsima_user_DllExport
  32. #endif
  33. #if defined(_WIN32)
  34. #if defined(EPROSIMA_USER_DLL_EXPORT)
  35. #if defined(tcp_idl_SOURCE)
  36. #define tcp_idl_DllAPI __declspec( dllexport )
  37. #else
  38. #define tcp_idl_DllAPI __declspec( dllimport )
  39. #endif // tcp_idl_SOURCE
  40. #else
  41. #define tcp_idl_DllAPI
  42. #endif
  43. #else
  44. #define tcp_idl_DllAPI
  45. #endif // _WIN32
  46. namespace eprosima
  47. {
  48. namespace fastcdr
  49. {
  50. class Cdr;
  51. }
  52. }
  53. namespace eprosima{
  54. namespace fastdds{
  55. namespace rtps{
  56. /*!
  57. * @brief This class represents the enumeration TCPCommonKind defined by the user in the IDL file.
  58. * @ingroup TCP_IDL.1
  59. */
  60. enum TCPCommonKind : uint32_t
  61. {
  62. BIND_CONNECTION,
  63. OPEN_LOGICAL_PORT,
  64. CHECK_LOGICAL_PORT,
  65. KEEP_ALIVE,
  66. UNBIND_CONNECTION,
  67. LOGICAL_PORT_IS_CLOSED
  68. };
  69. /*!
  70. * @brief This class represents the structure ConnectionRequest_t defined by the user in the IDL file.
  71. * @ingroup TCP_IDL.1
  72. */
  73. class ConnectionRequest_t
  74. {
  75. public:
  76. /*!
  77. * @brief Default constructor.
  78. */
  79. eProsima_user_DllExport ConnectionRequest_t();
  80. /*!
  81. * @brief Default destructor.
  82. */
  83. eProsima_user_DllExport ~ConnectionRequest_t();
  84. /*!
  85. * @brief Copy constructor.
  86. * @param x Reference to the object ConnectionRequest_t that will be copied.
  87. */
  88. eProsima_user_DllExport ConnectionRequest_t(const ConnectionRequest_t &x);
  89. /*!
  90. * @brief Move constructor.
  91. * @param x Reference to the object ConnectionRequest_t that will be copied.
  92. */
  93. eProsima_user_DllExport ConnectionRequest_t(ConnectionRequest_t &&x);
  94. /*!
  95. * @brief Copy assignment.
  96. * @param x Reference to the object ConnectionRequest_t that will be copied.
  97. */
  98. eProsima_user_DllExport ConnectionRequest_t& operator=(const ConnectionRequest_t &x);
  99. /*!
  100. * @brief Move assignment.
  101. * @param x Reference to the object ConnectionRequest_t that will be copied.
  102. */
  103. eProsima_user_DllExport ConnectionRequest_t& operator=(ConnectionRequest_t &&x);
  104. /*!
  105. * @brief This function sets a value in member protocolVersion
  106. * @param _protocolVersion New value for member protocolVersion
  107. */
  108. inline eProsima_user_DllExport void protocolVersion(const fastrtps::rtps::ProtocolVersion_t& _protocolVersion)
  109. {
  110. m_protocolVersion = _protocolVersion;
  111. }
  112. /*!
  113. * @brief This function returns the value of member protocolVersion
  114. * @return Value of member protocolVersion
  115. */
  116. inline eProsima_user_DllExport fastrtps::rtps::ProtocolVersion_t protocolVersion() const
  117. {
  118. return m_protocolVersion;
  119. }
  120. /*!
  121. * @brief This function returns a reference to member protocolVersion
  122. * @return Reference to member protocolVersion
  123. */
  124. inline eProsima_user_DllExport fastrtps::rtps::ProtocolVersion_t& protocolVersion()
  125. {
  126. return m_protocolVersion;
  127. }
  128. /*!
  129. * @brief This function sets a value in member vendorId
  130. * @param _vendorId New value for member vendorId
  131. */
  132. inline eProsima_user_DllExport void vendorId(const fastrtps::rtps::VendorId_t& _vendorId)
  133. {
  134. m_vendorId = _vendorId;
  135. }
  136. /*!
  137. * @brief This function returns the value of member vendorId
  138. * @return Value of member vendorId
  139. */
  140. inline eProsima_user_DllExport fastrtps::rtps::VendorId_t vendorId() const
  141. {
  142. return m_vendorId;
  143. }
  144. /*!
  145. * @brief This function returns a reference to member vendorId
  146. * @return Reference to member vendorId
  147. */
  148. inline eProsima_user_DllExport fastrtps::rtps::VendorId_t& vendorId()
  149. {
  150. return m_vendorId;
  151. }
  152. /*!
  153. * @brief This function sets a value in member transportLocator
  154. * @param _transportLocator New value for member transportLocator
  155. */
  156. inline eProsima_user_DllExport void transportLocator(const fastrtps::rtps::Locator_t& _transportLocator)
  157. {
  158. m_transportLocator = _transportLocator;
  159. }
  160. /*!
  161. * @brief This function returns the value of member transportLocator
  162. * @return Value of member transportLocator
  163. */
  164. inline eProsima_user_DllExport fastrtps::rtps::Locator_t transportLocator() const
  165. {
  166. return m_transportLocator;
  167. }
  168. /*!
  169. * @brief This function returns a reference to member transportLocator
  170. * @return Reference to member transportLocator
  171. */
  172. inline eProsima_user_DllExport fastrtps::rtps::Locator_t& transportLocator()
  173. {
  174. return m_transportLocator;
  175. }
  176. /*!
  177. * @brief This function returns the maximum serialized size of an object
  178. * depending on the buffer alignment.
  179. * @param data Data which is calculated its serialized size.
  180. * @param current_alignment Buffer alignment.
  181. * @return Maximum serialized size.
  182. */
  183. eProsima_user_DllExport static size_t getBufferCdrSerializedSize(
  184. const ConnectionRequest_t& data,
  185. size_t current_alignment = 0);
  186. /*!
  187. * @brief This function returns the serialized size of a data depending on the buffer alignment.
  188. * @param data Data which is calculated its serialized size.
  189. * @param current_alignment Buffer alignment.
  190. * @return Serialized size.
  191. */
  192. eProsima_user_DllExport static size_t getCdrSerializedSize(const ConnectionRequest_t& data, size_t current_alignment = 0);
  193. /*!
  194. * @brief This function serializes an object using CDR serialization.
  195. * @param cdr CDR serialization object.
  196. */
  197. eProsima_user_DllExport void serialize(eprosima::fastcdr::Cdr &cdr) const;
  198. /*!
  199. * @brief This function deserializes an object using CDR serialization.
  200. * @param cdr CDR serialization object.
  201. */
  202. eProsima_user_DllExport void deserialize(eprosima::fastcdr::Cdr &cdr);
  203. /*!
  204. * @brief This function returns the maximum serialized size of the Key of an object
  205. * depending on the buffer alignment.
  206. * @param current_alignment Buffer alignment.
  207. * @return Maximum serialized size.
  208. */
  209. eProsima_user_DllExport static size_t getKeyMaxCdrSerializedSize(size_t current_alignment = 0);
  210. /*!
  211. * @brief This function tells you if the Key has been defined for this type
  212. */
  213. eProsima_user_DllExport static bool isKeyDefined();
  214. /*!
  215. * @brief This function serializes the key members of an object using CDR serialization.
  216. * @param cdr CDR serialization object.
  217. */
  218. eProsima_user_DllExport void serializeKey(eprosima::fastcdr::Cdr &cdr) const;
  219. bool serialize(fastrtps::rtps::SerializedPayload_t *payload);
  220. bool deserialize(fastrtps::rtps::SerializedPayload_t *payload);
  221. private:
  222. fastrtps::rtps::ProtocolVersion_t m_protocolVersion;
  223. fastrtps::rtps::VendorId_t m_vendorId;
  224. fastrtps::rtps::Locator_t m_transportLocator;
  225. };
  226. /*!
  227. * @brief This class represents the structure OpenLogicalPortRequest_t defined by the user in the IDL file.
  228. * @ingroup TCP_IDL.1
  229. */
  230. class OpenLogicalPortRequest_t
  231. {
  232. public:
  233. /*!
  234. * @brief Default constructor.
  235. */
  236. eProsima_user_DllExport OpenLogicalPortRequest_t();
  237. /*!
  238. * @brief Default destructor.
  239. */
  240. eProsima_user_DllExport ~OpenLogicalPortRequest_t();
  241. /*!
  242. * @brief Copy constructor.
  243. * @param x Reference to the object OpenLogicalPortRequest_t that will be copied.
  244. */
  245. eProsima_user_DllExport OpenLogicalPortRequest_t(const OpenLogicalPortRequest_t &x);
  246. /*!
  247. * @brief Move constructor.
  248. * @param x Reference to the object OpenLogicalPortRequest_t that will be copied.
  249. */
  250. eProsima_user_DllExport OpenLogicalPortRequest_t(OpenLogicalPortRequest_t &&x);
  251. /*!
  252. * @brief Copy assignment.
  253. * @param x Reference to the object OpenLogicalPortRequest_t that will be copied.
  254. */
  255. eProsima_user_DllExport OpenLogicalPortRequest_t& operator=(const OpenLogicalPortRequest_t &x);
  256. /*!
  257. * @brief Move assignment.
  258. * @param x Reference to the object OpenLogicalPortRequest_t that will be copied.
  259. */
  260. eProsima_user_DllExport OpenLogicalPortRequest_t& operator=(OpenLogicalPortRequest_t &&x);
  261. /*!
  262. * @brief This function sets a value in member logicalPort
  263. * @param _logicalPort New value for member logicalPort
  264. */
  265. inline eProsima_user_DllExport void logicalPort(uint16_t _logicalPort)
  266. {
  267. m_logicalPort = _logicalPort;
  268. }
  269. /*!
  270. * @brief This function returns the value of member logicalPort
  271. * @return Value of member logicalPort
  272. */
  273. inline eProsima_user_DllExport uint16_t logicalPort() const
  274. {
  275. return m_logicalPort;
  276. }
  277. /*!
  278. * @brief This function returns a reference to member logicalPort
  279. * @return Reference to member logicalPort
  280. */
  281. inline eProsima_user_DllExport uint16_t& logicalPort()
  282. {
  283. return m_logicalPort;
  284. }
  285. /*!
  286. * @brief This function returns the maximum serialized size of an object
  287. * depending on the buffer alignment.
  288. * @param data Data which is calculated its serialized size.
  289. * @param current_alignment Buffer alignment.
  290. * @return Maximum serialized size.
  291. */
  292. eProsima_user_DllExport static size_t getBufferCdrSerializedSize(
  293. const OpenLogicalPortRequest_t& data,
  294. size_t current_alignment = 0);
  295. /*!
  296. * @brief This function returns the serialized size of a data depending on the buffer alignment.
  297. * @param data Data which is calculated its serialized size.
  298. * @param current_alignment Buffer alignment.
  299. * @return Serialized size.
  300. */
  301. eProsima_user_DllExport static size_t getCdrSerializedSize(const OpenLogicalPortRequest_t& data, size_t current_alignment = 0);
  302. /*!
  303. * @brief This function serializes an object using CDR serialization.
  304. * @param cdr CDR serialization object.
  305. */
  306. eProsima_user_DllExport void serialize(eprosima::fastcdr::Cdr &cdr) const;
  307. /*!
  308. * @brief This function deserializes an object using CDR serialization.
  309. * @param cdr CDR serialization object.
  310. */
  311. eProsima_user_DllExport void deserialize(eprosima::fastcdr::Cdr &cdr);
  312. /*!
  313. * @brief This function returns the maximum serialized size of the Key of an object
  314. * depending on the buffer alignment.
  315. * @param current_alignment Buffer alignment.
  316. * @return Maximum serialized size.
  317. */
  318. eProsima_user_DllExport static size_t getKeyMaxCdrSerializedSize(size_t current_alignment = 0);
  319. /*!
  320. * @brief This function tells you if the Key has been defined for this type
  321. */
  322. eProsima_user_DllExport static bool isKeyDefined();
  323. /*!
  324. * @brief This function serializes the key members of an object using CDR serialization.
  325. * @param cdr CDR serialization object.
  326. */
  327. eProsima_user_DllExport void serializeKey(eprosima::fastcdr::Cdr &cdr) const;
  328. bool serialize(fastrtps::rtps::SerializedPayload_t *payload);
  329. bool deserialize(fastrtps::rtps::SerializedPayload_t *payload);
  330. private:
  331. uint16_t m_logicalPort;
  332. };
  333. /*!
  334. * @brief This class represents the structure CheckLogicalPortsRequest_t defined by the user in the IDL file.
  335. * @ingroup TCP_IDL.1
  336. */
  337. class CheckLogicalPortsRequest_t
  338. {
  339. public:
  340. /*!
  341. * @brief Default constructor.
  342. */
  343. eProsima_user_DllExport CheckLogicalPortsRequest_t();
  344. /*!
  345. * @brief Default destructor.
  346. */
  347. eProsima_user_DllExport ~CheckLogicalPortsRequest_t();
  348. /*!
  349. * @brief Copy constructor.
  350. * @param x Reference to the object CheckLogicalPortsRequest_t that will be copied.
  351. */
  352. eProsima_user_DllExport CheckLogicalPortsRequest_t(const CheckLogicalPortsRequest_t &x);
  353. /*!
  354. * @brief Move constructor.
  355. * @param x Reference to the object CheckLogicalPortsRequest_t that will be copied.
  356. */
  357. eProsima_user_DllExport CheckLogicalPortsRequest_t(CheckLogicalPortsRequest_t &&x);
  358. /*!
  359. * @brief Copy assignment.
  360. * @param x Reference to the object CheckLogicalPortsRequest_t that will be copied.
  361. */
  362. eProsima_user_DllExport CheckLogicalPortsRequest_t& operator=(const CheckLogicalPortsRequest_t &x);
  363. /*!
  364. * @brief Move assignment.
  365. * @param x Reference to the object CheckLogicalPortsRequest_t that will be copied.
  366. */
  367. eProsima_user_DllExport CheckLogicalPortsRequest_t& operator=(CheckLogicalPortsRequest_t &&x);
  368. /*!
  369. * @brief This function copies the value in member logicalPortsRange
  370. * @param _logicalPortsRange New value to be copied in member logicalPortsRange
  371. */
  372. inline eProsima_user_DllExport void logicalPortsRange(const std::vector<uint16_t> &_logicalPortsRange)
  373. {
  374. m_logicalPortsRange = _logicalPortsRange;
  375. }
  376. /*!
  377. * @brief This function moves the value in member logicalPortsRange
  378. * @param _logicalPortsRange New value to be moved in member logicalPortsRange
  379. */
  380. inline eProsima_user_DllExport void logicalPortsRange(std::vector<uint16_t> &&_logicalPortsRange)
  381. {
  382. m_logicalPortsRange = std::move(_logicalPortsRange);
  383. }
  384. /*!
  385. * @brief This function returns a constant reference to member logicalPortsRange
  386. * @return Constant reference to member logicalPortsRange
  387. */
  388. inline eProsima_user_DllExport const std::vector<uint16_t>& logicalPortsRange() const
  389. {
  390. return m_logicalPortsRange;
  391. }
  392. /*!
  393. * @brief This function returns a reference to member logicalPortsRange
  394. * @return Reference to member logicalPortsRange
  395. */
  396. inline eProsima_user_DllExport std::vector<uint16_t>& logicalPortsRange()
  397. {
  398. return m_logicalPortsRange;
  399. }
  400. /*!
  401. * @brief This function returns the maximum serialized size of an object
  402. * depending on the buffer alignment.
  403. * @param data Data which is calculated its serialized size.
  404. * @param current_alignment Buffer alignment.
  405. * @return Maximum serialized size.
  406. */
  407. eProsima_user_DllExport static size_t getBufferCdrSerializedSize(
  408. const CheckLogicalPortsRequest_t& data,
  409. size_t current_alignment = 0);
  410. /*!
  411. * @brief This function returns the serialized size of a data depending on the buffer alignment.
  412. * @param data Data which is calculated its serialized size.
  413. * @param current_alignment Buffer alignment.
  414. * @return Serialized size.
  415. */
  416. eProsima_user_DllExport static size_t getCdrSerializedSize(const CheckLogicalPortsRequest_t& data, size_t current_alignment = 0);
  417. /*!
  418. * @brief This function serializes an object using CDR serialization.
  419. * @param cdr CDR serialization object.
  420. */
  421. eProsima_user_DllExport void serialize(eprosima::fastcdr::Cdr &cdr) const;
  422. /*!
  423. * @brief This function deserializes an object using CDR serialization.
  424. * @param cdr CDR serialization object.
  425. */
  426. eProsima_user_DllExport void deserialize(eprosima::fastcdr::Cdr &cdr);
  427. /*!
  428. * @brief This function returns the maximum serialized size of the Key of an object
  429. * depending on the buffer alignment.
  430. * @param current_alignment Buffer alignment.
  431. * @return Maximum serialized size.
  432. */
  433. eProsima_user_DllExport static size_t getKeyMaxCdrSerializedSize(size_t current_alignment = 0);
  434. /*!
  435. * @brief This function tells you if the Key has been defined for this type
  436. */
  437. eProsima_user_DllExport static bool isKeyDefined();
  438. /*!
  439. * @brief This function serializes the key members of an object using CDR serialization.
  440. * @param cdr CDR serialization object.
  441. */
  442. eProsima_user_DllExport void serializeKey(eprosima::fastcdr::Cdr &cdr) const;
  443. bool serialize(fastrtps::rtps::SerializedPayload_t *payload);
  444. bool deserialize(fastrtps::rtps::SerializedPayload_t *payload);
  445. private:
  446. std::vector<uint16_t> m_logicalPortsRange;
  447. };
  448. /*!
  449. * @brief This class represents the structure KeepAliveRequest_t defined by the user in the IDL file.
  450. * @ingroup TCP_IDL.1
  451. */
  452. class KeepAliveRequest_t
  453. {
  454. public:
  455. /*!
  456. * @brief Default constructor.
  457. */
  458. eProsima_user_DllExport KeepAliveRequest_t();
  459. /*!
  460. * @brief Default destructor.
  461. */
  462. eProsima_user_DllExport ~KeepAliveRequest_t();
  463. /*!
  464. * @brief Copy constructor.
  465. * @param x Reference to the object KeepAliveRequest_t that will be copied.
  466. */
  467. eProsima_user_DllExport KeepAliveRequest_t(const KeepAliveRequest_t &x);
  468. /*!
  469. * @brief Move constructor.
  470. * @param x Reference to the object KeepAliveRequest_t that will be copied.
  471. */
  472. eProsima_user_DllExport KeepAliveRequest_t(KeepAliveRequest_t &&x);
  473. /*!
  474. * @brief Copy assignment.
  475. * @param x Reference to the object KeepAliveRequest_t that will be copied.
  476. */
  477. eProsima_user_DllExport KeepAliveRequest_t& operator=(const KeepAliveRequest_t &x);
  478. /*!
  479. * @brief Move assignment.
  480. * @param x Reference to the object KeepAliveRequest_t that will be copied.
  481. */
  482. eProsima_user_DllExport KeepAliveRequest_t& operator=(KeepAliveRequest_t &&x);
  483. /*!
  484. * @brief This function sets a value in member locator
  485. * @param _locator New value for member locator
  486. */
  487. inline eProsima_user_DllExport void locator(const fastrtps::rtps::Locator_t& _locator)
  488. {
  489. m_locator = _locator;
  490. }
  491. /*!
  492. * @brief This function returns the value of member locator
  493. * @return Value of member locator
  494. */
  495. inline eProsima_user_DllExport fastrtps::rtps::Locator_t locator() const
  496. {
  497. return m_locator;
  498. }
  499. /*!
  500. * @brief This function returns a reference to member locator
  501. * @return Reference to member locator
  502. */
  503. inline eProsima_user_DllExport fastrtps::rtps::Locator_t& locator()
  504. {
  505. return m_locator;
  506. }
  507. /*!
  508. * @brief This function returns the maximum serialized size of an object
  509. * depending on the buffer alignment.
  510. * @param data Data which is calculated its serialized size.
  511. * @param current_alignment Buffer alignment.
  512. * @return Maximum serialized size.
  513. */
  514. eProsima_user_DllExport static size_t getBufferCdrSerializedSize(
  515. const KeepAliveRequest_t& data,
  516. size_t current_alignment = 0);
  517. /*!
  518. * @brief This function returns the serialized size of a data depending on the buffer alignment.
  519. * @param data Data which is calculated its serialized size.
  520. * @param current_alignment Buffer alignment.
  521. * @return Serialized size.
  522. */
  523. eProsima_user_DllExport static size_t getCdrSerializedSize(const KeepAliveRequest_t& data, size_t current_alignment = 0);
  524. /*!
  525. * @brief This function serializes an object using CDR serialization.
  526. * @param cdr CDR serialization object.
  527. */
  528. eProsima_user_DllExport void serialize(eprosima::fastcdr::Cdr &cdr) const;
  529. /*!
  530. * @brief This function deserializes an object using CDR serialization.
  531. * @param cdr CDR serialization object.
  532. */
  533. eProsima_user_DllExport void deserialize(eprosima::fastcdr::Cdr &cdr);
  534. /*!
  535. * @brief This function returns the maximum serialized size of the Key of an object
  536. * depending on the buffer alignment.
  537. * @param current_alignment Buffer alignment.
  538. * @return Maximum serialized size.
  539. */
  540. eProsima_user_DllExport static size_t getKeyMaxCdrSerializedSize(size_t current_alignment = 0);
  541. /*!
  542. * @brief This function tells you if the Key has been defined for this type
  543. */
  544. eProsima_user_DllExport static bool isKeyDefined();
  545. /*!
  546. * @brief This function serializes the key members of an object using CDR serialization.
  547. * @param cdr CDR serialization object.
  548. */
  549. eProsima_user_DllExport void serializeKey(eprosima::fastcdr::Cdr &cdr) const;
  550. bool serialize(fastrtps::rtps::SerializedPayload_t *payload);
  551. bool deserialize(fastrtps::rtps::SerializedPayload_t *payload);
  552. private:
  553. fastrtps::rtps::Locator_t m_locator;
  554. };
  555. /*!
  556. * @brief This class represents the structure LogicalPortIsClosedRequest_t defined by the user in the IDL file.
  557. * @ingroup TCP_IDL.1
  558. */
  559. class LogicalPortIsClosedRequest_t
  560. {
  561. public:
  562. /*!
  563. * @brief Default constructor.
  564. */
  565. eProsima_user_DllExport LogicalPortIsClosedRequest_t();
  566. /*!
  567. * @brief Default destructor.
  568. */
  569. eProsima_user_DllExport ~LogicalPortIsClosedRequest_t();
  570. /*!
  571. * @brief Copy constructor.
  572. * @param x Reference to the object LogicalPortIsClosedRequest_t that will be copied.
  573. */
  574. eProsima_user_DllExport LogicalPortIsClosedRequest_t(const LogicalPortIsClosedRequest_t &x);
  575. /*!
  576. * @brief Move constructor.
  577. * @param x Reference to the object LogicalPortIsClosedRequest_t that will be copied.
  578. */
  579. eProsima_user_DllExport LogicalPortIsClosedRequest_t(LogicalPortIsClosedRequest_t &&x);
  580. /*!
  581. * @brief Copy assignment.
  582. * @param x Reference to the object LogicalPortIsClosedRequest_t that will be copied.
  583. */
  584. eProsima_user_DllExport LogicalPortIsClosedRequest_t& operator=(const LogicalPortIsClosedRequest_t &x);
  585. /*!
  586. * @brief Move assignment.
  587. * @param x Reference to the object LogicalPortIsClosedRequest_t that will be copied.
  588. */
  589. eProsima_user_DllExport LogicalPortIsClosedRequest_t& operator=(LogicalPortIsClosedRequest_t &&x);
  590. /*!
  591. * @brief This function sets a value in member logicalPort
  592. * @param _logicalPort New value for member logicalPort
  593. */
  594. inline eProsima_user_DllExport void logicalPort(uint16_t _logicalPort)
  595. {
  596. m_logicalPort = _logicalPort;
  597. }
  598. /*!
  599. * @brief This function returns the value of member logicalPort
  600. * @return Value of member logicalPort
  601. */
  602. inline eProsima_user_DllExport uint16_t logicalPort() const
  603. {
  604. return m_logicalPort;
  605. }
  606. /*!
  607. * @brief This function returns a reference to member logicalPort
  608. * @return Reference to member logicalPort
  609. */
  610. inline eProsima_user_DllExport uint16_t& logicalPort()
  611. {
  612. return m_logicalPort;
  613. }
  614. /*!
  615. * @brief This function returns the maximum serialized size of an object
  616. * depending on the buffer alignment.
  617. * @param data Data which is calculated its serialized size.
  618. * @param current_alignment Buffer alignment.
  619. * @return Maximum serialized size.
  620. */
  621. eProsima_user_DllExport static size_t getBufferCdrSerializedSize(
  622. const LogicalPortIsClosedRequest_t& data,
  623. size_t current_alignment = 0);
  624. /*!
  625. * @brief This function returns the serialized size of a data depending on the buffer alignment.
  626. * @param data Data which is calculated its serialized size.
  627. * @param current_alignment Buffer alignment.
  628. * @return Serialized size.
  629. */
  630. eProsima_user_DllExport static size_t getCdrSerializedSize(const LogicalPortIsClosedRequest_t& data, size_t current_alignment = 0);
  631. /*!
  632. * @brief This function serializes an object using CDR serialization.
  633. * @param cdr CDR serialization object.
  634. */
  635. eProsima_user_DllExport void serialize(eprosima::fastcdr::Cdr &cdr) const;
  636. /*!
  637. * @brief This function deserializes an object using CDR serialization.
  638. * @param cdr CDR serialization object.
  639. */
  640. eProsima_user_DllExport void deserialize(eprosima::fastcdr::Cdr &cdr);
  641. /*!
  642. * @brief This function returns the maximum serialized size of the Key of an object
  643. * depending on the buffer alignment.
  644. * @param current_alignment Buffer alignment.
  645. * @return Maximum serialized size.
  646. */
  647. eProsima_user_DllExport static size_t getKeyMaxCdrSerializedSize(size_t current_alignment = 0);
  648. /*!
  649. * @brief This function tells you if the Key has been defined for this type
  650. */
  651. eProsima_user_DllExport static bool isKeyDefined();
  652. /*!
  653. * @brief This function serializes the key members of an object using CDR serialization.
  654. * @param cdr CDR serialization object.
  655. */
  656. eProsima_user_DllExport void serializeKey(eprosima::fastcdr::Cdr &cdr) const;
  657. bool serialize(fastrtps::rtps::SerializedPayload_t *payload);
  658. bool deserialize(fastrtps::rtps::SerializedPayload_t *payload);
  659. private:
  660. uint16_t m_logicalPort;
  661. };
  662. /*!
  663. * @brief This class represents the union RequestData defined by the user in the IDL file.
  664. * @ingroup TCP_IDL.1
  665. */
  666. class RequestData
  667. {
  668. public:
  669. /*!
  670. * @brief Default constructor.
  671. */
  672. eProsima_user_DllExport RequestData();
  673. /*!
  674. * @brief Default destructor.
  675. */
  676. eProsima_user_DllExport ~RequestData();
  677. /*!
  678. * @brief Copy constructor.
  679. * @param x Reference to the object RequestData that will be copied.
  680. */
  681. eProsima_user_DllExport RequestData(const RequestData &x);
  682. /*!
  683. * @brief Move constructor.
  684. * @param x Reference to the object RequestData that will be copied.
  685. */
  686. eProsima_user_DllExport RequestData(RequestData &&x);
  687. /*!
  688. * @brief Copy assignment.
  689. * @param x Reference to the object RequestData that will be copied.
  690. */
  691. eProsima_user_DllExport RequestData& operator=(const RequestData &x);
  692. /*!
  693. * @brief Move assignment.
  694. * @param x Reference to the object RequestData that will be copied.
  695. */
  696. eProsima_user_DllExport RequestData& operator=(RequestData &&x);
  697. /*!
  698. * @brief This function sets the discriminator value.
  699. * @param __d New value for the discriminator.
  700. * @exception eprosima::fastcdr::BadParamException This exception is thrown if the new value doesn't correspond to the selected union member.
  701. */
  702. eProsima_user_DllExport void _d(TCPCommonKind __d);
  703. /*!
  704. * @brief This function returns the value of the discriminator.
  705. * @return Value of the discriminator
  706. */
  707. eProsima_user_DllExport TCPCommonKind _d() const;
  708. /*!
  709. * @brief This function returns a reference to the discriminator.
  710. * @return Reference to the discriminator.
  711. */
  712. eProsima_user_DllExport TCPCommonKind& _d();
  713. /*!
  714. * @brief This function copies the value in member connectionRequest
  715. * @param _connectionRequest New value to be copied in member connectionRequest
  716. */
  717. eProsima_user_DllExport void connectionRequest(const ConnectionRequest_t &_connectionRequest);
  718. /*!
  719. * @brief This function moves the value in member connectionRequest
  720. * @param _connectionRequest New value to be moved in member connectionRequest
  721. */
  722. eProsima_user_DllExport void connectionRequest(ConnectionRequest_t &&_connectionRequest);
  723. /*!
  724. * @brief This function returns a constant reference to member connectionRequest
  725. * @return Constant reference to member connectionRequest
  726. * @exception eprosima::fastcdr::BadParamException This exception is thrown if the requested union member is not the current selection.
  727. */
  728. eProsima_user_DllExport const ConnectionRequest_t& connectionRequest() const;
  729. /*!
  730. * @brief This function returns a reference to member connectionRequest
  731. * @return Reference to member connectionRequest
  732. * @exception eprosima::fastcdr::BadParamException This exception is thrown if the requested union member is not the current selection.
  733. */
  734. eProsima_user_DllExport ConnectionRequest_t& connectionRequest();
  735. /*!
  736. * @brief This function copies the value in member openLogicalPortRequest
  737. * @param _openLogicalPortRequest New value to be copied in member openLogicalPortRequest
  738. */
  739. eProsima_user_DllExport void openLogicalPortRequest(const OpenLogicalPortRequest_t &_openLogicalPortRequest);
  740. /*!
  741. * @brief This function moves the value in member openLogicalPortRequest
  742. * @param _openLogicalPortRequest New value to be moved in member openLogicalPortRequest
  743. */
  744. eProsima_user_DllExport void openLogicalPortRequest(OpenLogicalPortRequest_t &&_openLogicalPortRequest);
  745. /*!
  746. * @brief This function returns a constant reference to member openLogicalPortRequest
  747. * @return Constant reference to member openLogicalPortRequest
  748. * @exception eprosima::fastcdr::BadParamException This exception is thrown if the requested union member is not the current selection.
  749. */
  750. eProsima_user_DllExport const OpenLogicalPortRequest_t& openLogicalPortRequest() const;
  751. /*!
  752. * @brief This function returns a reference to member openLogicalPortRequest
  753. * @return Reference to member openLogicalPortRequest
  754. * @exception eprosima::fastcdr::BadParamException This exception is thrown if the requested union member is not the current selection.
  755. */
  756. eProsima_user_DllExport OpenLogicalPortRequest_t& openLogicalPortRequest();
  757. /*!
  758. * @brief This function copies the value in member checkLogicalPortsRequest
  759. * @param _checkLogicalPortsRequest New value to be copied in member checkLogicalPortsRequest
  760. */
  761. eProsima_user_DllExport void checkLogicalPortsRequest(const CheckLogicalPortsRequest_t &_checkLogicalPortsRequest);
  762. /*!
  763. * @brief This function moves the value in member checkLogicalPortsRequest
  764. * @param _checkLogicalPortsRequest New value to be moved in member checkLogicalPortsRequest
  765. */
  766. eProsima_user_DllExport void checkLogicalPortsRequest(CheckLogicalPortsRequest_t &&_checkLogicalPortsRequest);
  767. /*!
  768. * @brief This function returns a constant reference to member checkLogicalPortsRequest
  769. * @return Constant reference to member checkLogicalPortsRequest
  770. * @exception eprosima::fastcdr::BadParamException This exception is thrown if the requested union member is not the current selection.
  771. */
  772. eProsima_user_DllExport const CheckLogicalPortsRequest_t& checkLogicalPortsRequest() const;
  773. /*!
  774. * @brief This function returns a reference to member checkLogicalPortsRequest
  775. * @return Reference to member checkLogicalPortsRequest
  776. * @exception eprosima::fastcdr::BadParamException This exception is thrown if the requested union member is not the current selection.
  777. */
  778. eProsima_user_DllExport CheckLogicalPortsRequest_t& checkLogicalPortsRequest();
  779. /*!
  780. * @brief This function copies the value in member keepAliveRequest
  781. * @param _keepAliveRequest New value to be copied in member keepAliveRequest
  782. */
  783. eProsima_user_DllExport void keepAliveRequest(const KeepAliveRequest_t &_keepAliveRequest);
  784. /*!
  785. * @brief This function moves the value in member keepAliveRequest
  786. * @param _keepAliveRequest New value to be moved in member keepAliveRequest
  787. */
  788. eProsima_user_DllExport void keepAliveRequest(KeepAliveRequest_t &&_keepAliveRequest);
  789. /*!
  790. * @brief This function returns a constant reference to member keepAliveRequest
  791. * @return Constant reference to member keepAliveRequest
  792. * @exception eprosima::fastcdr::BadParamException This exception is thrown if the requested union member is not the current selection.
  793. */
  794. eProsima_user_DllExport const KeepAliveRequest_t& keepAliveRequest() const;
  795. /*!
  796. * @brief This function returns a reference to member keepAliveRequest
  797. * @return Reference to member keepAliveRequest
  798. * @exception eprosima::fastcdr::BadParamException This exception is thrown if the requested union member is not the current selection.
  799. */
  800. eProsima_user_DllExport KeepAliveRequest_t& keepAliveRequest();
  801. /*!
  802. * @brief This function copies the value in member logicalPortIsClosedRequest
  803. * @param _logicalPortIsClosedRequest New value to be copied in member logicalPortIsClosedRequest
  804. */
  805. eProsima_user_DllExport void logicalPortIsClosedRequest(const LogicalPortIsClosedRequest_t &_logicalPortIsClosedRequest);
  806. /*!
  807. * @brief This function moves the value in member logicalPortIsClosedRequest
  808. * @param _logicalPortIsClosedRequest New value to be moved in member logicalPortIsClosedRequest
  809. */
  810. eProsima_user_DllExport void logicalPortIsClosedRequest(LogicalPortIsClosedRequest_t &&_logicalPortIsClosedRequest);
  811. /*!
  812. * @brief This function returns a constant reference to member logicalPortIsClosedRequest
  813. * @return Constant reference to member logicalPortIsClosedRequest
  814. * @exception eprosima::fastcdr::BadParamException This exception is thrown if the requested union member is not the current selection.
  815. */
  816. eProsima_user_DllExport const LogicalPortIsClosedRequest_t& logicalPortIsClosedRequest() const;
  817. /*!
  818. * @brief This function returns a reference to member logicalPortIsClosedRequest
  819. * @return Reference to member logicalPortIsClosedRequest
  820. * @exception eprosima::fastcdr::BadParamException This exception is thrown if the requested union member is not the current selection.
  821. */
  822. eProsima_user_DllExport LogicalPortIsClosedRequest_t& logicalPortIsClosedRequest();
  823. /*!
  824. * @brief This function returns the maximum serialized size of an object
  825. * depending on the buffer alignment.
  826. * @param data Data which is calculated its serialized size.
  827. * @param current_alignment Buffer alignment.
  828. * @return Maximum serialized size.
  829. */
  830. eProsima_user_DllExport static size_t getBufferCdrSerializedSize(
  831. const RequestData& data,
  832. size_t current_alignment = 0);
  833. /*!
  834. * @brief This function returns the serialized size of a data depending on the buffer alignment.
  835. * @param data Data which is calculated its serialized size.
  836. * @param current_alignment Buffer alignment.
  837. * @return Serialized size.
  838. */
  839. eProsima_user_DllExport static size_t getCdrSerializedSize(const RequestData& data, size_t current_alignment = 0);
  840. /*!
  841. * @brief This function serializes an object using CDR serialization.
  842. * @param cdr CDR serialization object.
  843. */
  844. eProsima_user_DllExport void serialize(eprosima::fastcdr::Cdr &cdr) const;
  845. /*!
  846. * @brief This function deserializes an object using CDR serialization.
  847. * @param cdr CDR serialization object.
  848. */
  849. eProsima_user_DllExport void deserialize(eprosima::fastcdr::Cdr &cdr);
  850. /*!
  851. * @brief This function returns the maximum serialized size of the Key of an object
  852. * depending on the buffer alignment.
  853. * @param current_alignment Buffer alignment.
  854. * @return Maximum serialized size.
  855. */
  856. eProsima_user_DllExport static size_t getKeyMaxCdrSerializedSize(size_t current_alignment = 0);
  857. /*!
  858. * @brief This function tells you if the Key has been defined for this type
  859. */
  860. eProsima_user_DllExport static bool isKeyDefined();
  861. /*!
  862. * @brief This function serializes the key members of an object using CDR serialization.
  863. * @param cdr CDR serialization object.
  864. */
  865. eProsima_user_DllExport void serializeKey(eprosima::fastcdr::Cdr &cdr) const;
  866. private:
  867. TCPCommonKind m__d;
  868. ConnectionRequest_t m_connectionRequest;
  869. OpenLogicalPortRequest_t m_openLogicalPortRequest;
  870. CheckLogicalPortsRequest_t m_checkLogicalPortsRequest;
  871. KeepAliveRequest_t m_keepAliveRequest;
  872. LogicalPortIsClosedRequest_t m_logicalPortIsClosedRequest;
  873. };
  874. /*!
  875. * @brief This class represents the structure ControlProtocolRequestData defined by the user in the IDL file.
  876. * @ingroup TCP_IDL.1
  877. */
  878. class ControlProtocolRequestData
  879. {
  880. public:
  881. /*!
  882. * @brief Default constructor.
  883. */
  884. eProsima_user_DllExport ControlProtocolRequestData();
  885. /*!
  886. * @brief Default destructor.
  887. */
  888. eProsima_user_DllExport ~ControlProtocolRequestData();
  889. /*!
  890. * @brief Copy constructor.
  891. * @param x Reference to the object ControlProtocolRequestData that will be copied.
  892. */
  893. eProsima_user_DllExport ControlProtocolRequestData(const ControlProtocolRequestData &x);
  894. /*!
  895. * @brief Move constructor.
  896. * @param x Reference to the object ControlProtocolRequestData that will be copied.
  897. */
  898. eProsima_user_DllExport ControlProtocolRequestData(ControlProtocolRequestData &&x);
  899. /*!
  900. * @brief Copy assignment.
  901. * @param x Reference to the object ControlProtocolRequestData that will be copied.
  902. */
  903. eProsima_user_DllExport ControlProtocolRequestData& operator=(const ControlProtocolRequestData &x);
  904. /*!
  905. * @brief Move assignment.
  906. * @param x Reference to the object ControlProtocolRequestData that will be copied.
  907. */
  908. eProsima_user_DllExport ControlProtocolRequestData& operator=(ControlProtocolRequestData &&x);
  909. /*!
  910. * @brief This function copies the value in member requestData
  911. * @param _requestData New value to be copied in member requestData
  912. */
  913. inline eProsima_user_DllExport void requestData(const RequestData &_requestData)
  914. {
  915. m_requestData = _requestData;
  916. }
  917. /*!
  918. * @brief This function moves the value in member requestData
  919. * @param _requestData New value to be moved in member requestData
  920. */
  921. inline eProsima_user_DllExport void requestData(RequestData &&_requestData)
  922. {
  923. m_requestData = std::move(_requestData);
  924. }
  925. /*!
  926. * @brief This function returns a constant reference to member requestData
  927. * @return Constant reference to member requestData
  928. */
  929. inline eProsima_user_DllExport const RequestData& requestData() const
  930. {
  931. return m_requestData;
  932. }
  933. /*!
  934. * @brief This function returns a reference to member requestData
  935. * @return Reference to member requestData
  936. */
  937. inline eProsima_user_DllExport RequestData& requestData()
  938. {
  939. return m_requestData;
  940. }
  941. /*!
  942. * @brief This function returns the maximum serialized size of an object
  943. * depending on the buffer alignment.
  944. * @param data Data which is calculated its serialized size.
  945. * @param current_alignment Buffer alignment.
  946. * @return Maximum serialized size.
  947. */
  948. eProsima_user_DllExport static size_t getBufferCdrSerializedSize(
  949. const ControlProtocolRequestData& data,
  950. size_t current_alignment = 0);
  951. /*!
  952. * @brief This function returns the serialized size of a data depending on the buffer alignment.
  953. * @param data Data which is calculated its serialized size.
  954. * @param current_alignment Buffer alignment.
  955. * @return Serialized size.
  956. */
  957. eProsima_user_DllExport static size_t getCdrSerializedSize(const ControlProtocolRequestData& data, size_t current_alignment = 0);
  958. /*!
  959. * @brief This function serializes an object using CDR serialization.
  960. * @param cdr CDR serialization object.
  961. */
  962. eProsima_user_DllExport void serialize(eprosima::fastcdr::Cdr &cdr) const;
  963. /*!
  964. * @brief This function deserializes an object using CDR serialization.
  965. * @param cdr CDR serialization object.
  966. */
  967. eProsima_user_DllExport void deserialize(eprosima::fastcdr::Cdr &cdr);
  968. /*!
  969. * @brief This function returns the maximum serialized size of the Key of an object
  970. * depending on the buffer alignment.
  971. * @param current_alignment Buffer alignment.
  972. * @return Maximum serialized size.
  973. */
  974. eProsima_user_DllExport static size_t getKeyMaxCdrSerializedSize(size_t current_alignment = 0);
  975. /*!
  976. * @brief This function tells you if the Key has been defined for this type
  977. */
  978. eProsima_user_DllExport static bool isKeyDefined();
  979. /*!
  980. * @brief This function serializes the key members of an object using CDR serialization.
  981. * @param cdr CDR serialization object.
  982. */
  983. eProsima_user_DllExport void serializeKey(eprosima::fastcdr::Cdr &cdr) const;
  984. private:
  985. RequestData m_requestData;
  986. };
  987. /*!
  988. * @brief This class represents the enumeration ResponseCode defined by the user in the IDL file.
  989. * @ingroup TCP_IDL.1
  990. */
  991. enum ResponseCode : uint32_t
  992. {
  993. RETCODE_VOID = (uint32_t)(-1),
  994. RETCODE_OK = 0,
  995. RETCODE_BAD_REQUEST,
  996. RETCODE_EXISTING_CONNECTION,
  997. RETCODE_INVALID_PORT,
  998. RETCODE_UNKNOWN_LOCATOR,
  999. RETCODE_INCOMPATIBLE_VERSION,
  1000. RETCODE_SERVER_ERROR
  1001. };
  1002. /*!
  1003. * @brief This class represents the structure BindConnectionResponse_t defined by the user in the IDL file.
  1004. * @ingroup TCP_IDL.1
  1005. */
  1006. class BindConnectionResponse_t
  1007. {
  1008. public:
  1009. /*!
  1010. * @brief Default constructor.
  1011. */
  1012. eProsima_user_DllExport BindConnectionResponse_t();
  1013. /*!
  1014. * @brief Default destructor.
  1015. */
  1016. eProsima_user_DllExport ~BindConnectionResponse_t();
  1017. /*!
  1018. * @brief Copy constructor.
  1019. * @param x Reference to the object BindConnectionResponse_t that will be copied.
  1020. */
  1021. eProsima_user_DllExport BindConnectionResponse_t(const BindConnectionResponse_t &x);
  1022. /*!
  1023. * @brief Move constructor.
  1024. * @param x Reference to the object BindConnectionResponse_t that will be copied.
  1025. */
  1026. eProsima_user_DllExport BindConnectionResponse_t(BindConnectionResponse_t &&x);
  1027. /*!
  1028. * @brief Copy assignment.
  1029. * @param x Reference to the object BindConnectionResponse_t that will be copied.
  1030. */
  1031. eProsima_user_DllExport BindConnectionResponse_t& operator=(const BindConnectionResponse_t &x);
  1032. /*!
  1033. * @brief Move assignment.
  1034. * @param x Reference to the object BindConnectionResponse_t that will be copied.
  1035. */
  1036. eProsima_user_DllExport BindConnectionResponse_t& operator=(BindConnectionResponse_t &&x);
  1037. /*!
  1038. * @brief This function sets a value in member locator
  1039. * @param _locator New value for member locator
  1040. */
  1041. inline eProsima_user_DllExport void locator(const fastrtps::rtps::Locator_t& _locator)
  1042. {
  1043. m_locator = _locator;
  1044. }
  1045. /*!
  1046. * @brief This function returns the value of member locator
  1047. * @return Value of member locator
  1048. */
  1049. inline eProsima_user_DllExport fastrtps::rtps::Locator_t locator() const
  1050. {
  1051. return m_locator;
  1052. }
  1053. /*!
  1054. * @brief This function returns a reference to member locator
  1055. * @return Reference to member locator
  1056. */
  1057. inline eProsima_user_DllExport fastrtps::rtps::Locator_t& locator()
  1058. {
  1059. return m_locator;
  1060. }
  1061. /*!
  1062. * @brief This function returns the maximum serialized size of an object
  1063. * depending on the buffer alignment.
  1064. * @param data Data which is calculated its serialized size.
  1065. * @param current_alignment Buffer alignment.
  1066. * @return Maximum serialized size.
  1067. */
  1068. eProsima_user_DllExport static size_t getBufferCdrSerializedSize(
  1069. const BindConnectionResponse_t& data,
  1070. size_t current_alignment = 0);
  1071. /*!
  1072. * @brief This function returns the serialized size of a data depending on the buffer alignment.
  1073. * @param data Data which is calculated its serialized size.
  1074. * @param current_alignment Buffer alignment.
  1075. * @return Serialized size.
  1076. */
  1077. eProsima_user_DllExport static size_t getCdrSerializedSize(const BindConnectionResponse_t& data, size_t current_alignment = 0);
  1078. /*!
  1079. * @brief This function serializes an object using CDR serialization.
  1080. * @param cdr CDR serialization object.
  1081. */
  1082. eProsima_user_DllExport void serialize(eprosima::fastcdr::Cdr &cdr) const;
  1083. /*!
  1084. * @brief This function deserializes an object using CDR serialization.
  1085. * @param cdr CDR serialization object.
  1086. */
  1087. eProsima_user_DllExport void deserialize(eprosima::fastcdr::Cdr &cdr);
  1088. /*!
  1089. * @brief This function returns the maximum serialized size of the Key of an object
  1090. * depending on the buffer alignment.
  1091. * @param current_alignment Buffer alignment.
  1092. * @return Maximum serialized size.
  1093. */
  1094. eProsima_user_DllExport static size_t getKeyMaxCdrSerializedSize(size_t current_alignment = 0);
  1095. /*!
  1096. * @brief This function tells you if the Key has been defined for this type
  1097. */
  1098. eProsima_user_DllExport static bool isKeyDefined();
  1099. /*!
  1100. * @brief This function serializes the key members of an object using CDR serialization.
  1101. * @param cdr CDR serialization object.
  1102. */
  1103. eProsima_user_DllExport void serializeKey(eprosima::fastcdr::Cdr &cdr) const;
  1104. bool serialize(fastrtps::rtps::SerializedPayload_t *payload);
  1105. bool deserialize(fastrtps::rtps::SerializedPayload_t *payload);
  1106. private:
  1107. fastrtps::rtps::Locator_t m_locator;
  1108. };
  1109. /*!
  1110. * @brief This class represents the structure CheckLogicalPortsResponse_t defined by the user in the IDL file.
  1111. * @ingroup TCP_IDL.1
  1112. */
  1113. class CheckLogicalPortsResponse_t
  1114. {
  1115. public:
  1116. /*!
  1117. * @brief Default constructor.
  1118. */
  1119. eProsima_user_DllExport CheckLogicalPortsResponse_t();
  1120. /*!
  1121. * @brief Default destructor.
  1122. */
  1123. eProsima_user_DllExport ~CheckLogicalPortsResponse_t();
  1124. /*!
  1125. * @brief Copy constructor.
  1126. * @param x Reference to the object CheckLogicalPortsResponse_t that will be copied.
  1127. */
  1128. eProsima_user_DllExport CheckLogicalPortsResponse_t(const CheckLogicalPortsResponse_t &x);
  1129. /*!
  1130. * @brief Move constructor.
  1131. * @param x Reference to the object CheckLogicalPortsResponse_t that will be copied.
  1132. */
  1133. eProsima_user_DllExport CheckLogicalPortsResponse_t(CheckLogicalPortsResponse_t &&x);
  1134. /*!
  1135. * @brief Copy assignment.
  1136. * @param x Reference to the object CheckLogicalPortsResponse_t that will be copied.
  1137. */
  1138. eProsima_user_DllExport CheckLogicalPortsResponse_t& operator=(const CheckLogicalPortsResponse_t &x);
  1139. /*!
  1140. * @brief Move assignment.
  1141. * @param x Reference to the object CheckLogicalPortsResponse_t that will be copied.
  1142. */
  1143. eProsima_user_DllExport CheckLogicalPortsResponse_t& operator=(CheckLogicalPortsResponse_t &&x);
  1144. /*!
  1145. * @brief This function copies the value in member availableLogicalPorts
  1146. * @param _availableLogicalPorts New value to be copied in member availableLogicalPorts
  1147. */
  1148. inline eProsima_user_DllExport void availableLogicalPorts(const std::vector<uint16_t> &_availableLogicalPorts)
  1149. {
  1150. m_availableLogicalPorts = _availableLogicalPorts;
  1151. }
  1152. /*!
  1153. * @brief This function moves the value in member availableLogicalPorts
  1154. * @param _availableLogicalPorts New value to be moved in member availableLogicalPorts
  1155. */
  1156. inline eProsima_user_DllExport void availableLogicalPorts(std::vector<uint16_t> &&_availableLogicalPorts)
  1157. {
  1158. m_availableLogicalPorts = std::move(_availableLogicalPorts);
  1159. }
  1160. /*!
  1161. * @brief This function returns a constant reference to member availableLogicalPorts
  1162. * @return Constant reference to member availableLogicalPorts
  1163. */
  1164. inline eProsima_user_DllExport const std::vector<uint16_t>& availableLogicalPorts() const
  1165. {
  1166. return m_availableLogicalPorts;
  1167. }
  1168. /*!
  1169. * @brief This function returns a reference to member availableLogicalPorts
  1170. * @return Reference to member availableLogicalPorts
  1171. */
  1172. inline eProsima_user_DllExport std::vector<uint16_t>& availableLogicalPorts()
  1173. {
  1174. return m_availableLogicalPorts;
  1175. }
  1176. /*!
  1177. * @brief This function returns the maximum serialized size of an object
  1178. * depending on the buffer alignment.
  1179. * @param data Data which is calculated its serialized size.
  1180. * @param current_alignment Buffer alignment.
  1181. * @return Maximum serialized size.
  1182. */
  1183. eProsima_user_DllExport static size_t getBufferCdrSerializedSize(
  1184. const CheckLogicalPortsResponse_t& data,
  1185. size_t current_alignment = 0);
  1186. /*!
  1187. * @brief This function returns the serialized size of a data depending on the buffer alignment.
  1188. * @param data Data which is calculated its serialized size.
  1189. * @param current_alignment Buffer alignment.
  1190. * @return Serialized size.
  1191. */
  1192. eProsima_user_DllExport static size_t getCdrSerializedSize(const CheckLogicalPortsResponse_t& data, size_t current_alignment = 0);
  1193. /*!
  1194. * @brief This function serializes an object using CDR serialization.
  1195. * @param cdr CDR serialization object.
  1196. */
  1197. eProsima_user_DllExport void serialize(eprosima::fastcdr::Cdr &cdr) const;
  1198. /*!
  1199. * @brief This function deserializes an object using CDR serialization.
  1200. * @param cdr CDR serialization object.
  1201. */
  1202. eProsima_user_DllExport void deserialize(eprosima::fastcdr::Cdr &cdr);
  1203. /*!
  1204. * @brief This function returns the maximum serialized size of the Key of an object
  1205. * depending on the buffer alignment.
  1206. * @param current_alignment Buffer alignment.
  1207. * @return Maximum serialized size.
  1208. */
  1209. eProsima_user_DllExport static size_t getKeyMaxCdrSerializedSize(size_t current_alignment = 0);
  1210. /*!
  1211. * @brief This function tells you if the Key has been defined for this type
  1212. */
  1213. eProsima_user_DllExport static bool isKeyDefined();
  1214. /*!
  1215. * @brief This function serializes the key members of an object using CDR serialization.
  1216. * @param cdr CDR serialization object.
  1217. */
  1218. eProsima_user_DllExport void serializeKey(eprosima::fastcdr::Cdr &cdr) const;
  1219. bool serialize(fastrtps::rtps::SerializedPayload_t *payload);
  1220. bool deserialize(fastrtps::rtps::SerializedPayload_t *payload);
  1221. private:
  1222. std::vector<uint16_t> m_availableLogicalPorts;
  1223. };
  1224. /*!
  1225. * @brief This class represents the union ResponseData defined by the user in the IDL file.
  1226. * @ingroup TCP_IDL.1
  1227. */
  1228. class ResponseData
  1229. {
  1230. public:
  1231. /*!
  1232. * @brief Default constructor.
  1233. */
  1234. eProsima_user_DllExport ResponseData();
  1235. /*!
  1236. * @brief Default destructor.
  1237. */
  1238. eProsima_user_DllExport ~ResponseData();
  1239. /*!
  1240. * @brief Copy constructor.
  1241. * @param x Reference to the object ResponseData that will be copied.
  1242. */
  1243. eProsima_user_DllExport ResponseData(const ResponseData &x);
  1244. /*!
  1245. * @brief Move constructor.
  1246. * @param x Reference to the object ResponseData that will be copied.
  1247. */
  1248. eProsima_user_DllExport ResponseData(ResponseData &&x);
  1249. /*!
  1250. * @brief Copy assignment.
  1251. * @param x Reference to the object ResponseData that will be copied.
  1252. */
  1253. eProsima_user_DllExport ResponseData& operator=(const ResponseData &x);
  1254. /*!
  1255. * @brief Move assignment.
  1256. * @param x Reference to the object ResponseData that will be copied.
  1257. */
  1258. eProsima_user_DllExport ResponseData& operator=(ResponseData &&x);
  1259. /*!
  1260. * @brief This function sets the discriminator value.
  1261. * @param __d New value for the discriminator.
  1262. * @exception eprosima::fastcdr::BadParamException This exception is thrown if the new value doesn't correspond to the selected union member.
  1263. */
  1264. eProsima_user_DllExport void _d(TCPCommonKind __d);
  1265. /*!
  1266. * @brief This function returns the value of the discriminator.
  1267. * @return Value of the discriminator
  1268. */
  1269. eProsima_user_DllExport TCPCommonKind _d() const;
  1270. /*!
  1271. * @brief This function returns a reference to the discriminator.
  1272. * @return Reference to the discriminator.
  1273. */
  1274. eProsima_user_DllExport TCPCommonKind& _d();
  1275. /*!
  1276. * @brief This function copies the value in member bindConnectionResponse
  1277. * @param _bindConnectionResponse New value to be copied in member bindConnectionResponse
  1278. */
  1279. eProsima_user_DllExport void bindConnectionResponse(const BindConnectionResponse_t &_bindConnectionResponse);
  1280. /*!
  1281. * @brief This function moves the value in member bindConnectionResponse
  1282. * @param _bindConnectionResponse New value to be moved in member bindConnectionResponse
  1283. */
  1284. eProsima_user_DllExport void bindConnectionResponse(BindConnectionResponse_t &&_bindConnectionResponse);
  1285. /*!
  1286. * @brief This function returns a constant reference to member bindConnectionResponse
  1287. * @return Constant reference to member bindConnectionResponse
  1288. * @exception eprosima::fastcdr::BadParamException This exception is thrown if the requested union member is not the current selection.
  1289. */
  1290. eProsima_user_DllExport const BindConnectionResponse_t& bindConnectionResponse() const;
  1291. /*!
  1292. * @brief This function returns a reference to member bindConnectionResponse
  1293. * @return Reference to member bindConnectionResponse
  1294. * @exception eprosima::fastcdr::BadParamException This exception is thrown if the requested union member is not the current selection.
  1295. */
  1296. eProsima_user_DllExport BindConnectionResponse_t& bindConnectionResponse();
  1297. /*!
  1298. * @brief This function returns the maximum serialized size of an object
  1299. * depending on the buffer alignment.
  1300. * @param data Data which is calculated its serialized size.
  1301. * @param current_alignment Buffer alignment.
  1302. * @return Maximum serialized size.
  1303. */
  1304. eProsima_user_DllExport static size_t getBufferCdrSerializedSize(
  1305. const ResponseData& data,
  1306. size_t current_alignment = 0);
  1307. /*!
  1308. * @brief This function returns the serialized size of a data depending on the buffer alignment.
  1309. * @param data Data which is calculated its serialized size.
  1310. * @param current_alignment Buffer alignment.
  1311. * @return Serialized size.
  1312. */
  1313. eProsima_user_DllExport static size_t getCdrSerializedSize(const ResponseData& data, size_t current_alignment = 0);
  1314. /*!
  1315. * @brief This function serializes an object using CDR serialization.
  1316. * @param cdr CDR serialization object.
  1317. */
  1318. eProsima_user_DllExport void serialize(eprosima::fastcdr::Cdr &cdr) const;
  1319. /*!
  1320. * @brief This function deserializes an object using CDR serialization.
  1321. * @param cdr CDR serialization object.
  1322. */
  1323. eProsima_user_DllExport void deserialize(eprosima::fastcdr::Cdr &cdr);
  1324. /*!
  1325. * @brief This function returns the maximum serialized size of the Key of an object
  1326. * depending on the buffer alignment.
  1327. * @param current_alignment Buffer alignment.
  1328. * @return Maximum serialized size.
  1329. */
  1330. eProsima_user_DllExport static size_t getKeyMaxCdrSerializedSize(size_t current_alignment = 0);
  1331. /*!
  1332. * @brief This function tells you if the Key has been defined for this type
  1333. */
  1334. eProsima_user_DllExport static bool isKeyDefined();
  1335. /*!
  1336. * @brief This function serializes the key members of an object using CDR serialization.
  1337. * @param cdr CDR serialization object.
  1338. */
  1339. eProsima_user_DllExport void serializeKey(eprosima::fastcdr::Cdr &cdr) const;
  1340. private:
  1341. TCPCommonKind m__d;
  1342. BindConnectionResponse_t m_bindConnectionResponse;
  1343. };
  1344. /*!
  1345. * @brief This class represents the structure ControlProtocolResponseData defined by the user in the IDL file.
  1346. * @ingroup TCP_IDL.1
  1347. */
  1348. class ControlProtocolResponseData
  1349. {
  1350. public:
  1351. /*!
  1352. * @brief Default constructor.
  1353. */
  1354. eProsima_user_DllExport ControlProtocolResponseData();
  1355. /*!
  1356. * @brief Default destructor.
  1357. */
  1358. eProsima_user_DllExport ~ControlProtocolResponseData();
  1359. /*!
  1360. * @brief Copy constructor.
  1361. * @param x Reference to the object ControlProtocolResponseData that will be copied.
  1362. */
  1363. eProsima_user_DllExport ControlProtocolResponseData(const ControlProtocolResponseData &x);
  1364. /*!
  1365. * @brief Move constructor.
  1366. * @param x Reference to the object ControlProtocolResponseData that will be copied.
  1367. */
  1368. eProsima_user_DllExport ControlProtocolResponseData(ControlProtocolResponseData &&x);
  1369. /*!
  1370. * @brief Copy assignment.
  1371. * @param x Reference to the object ControlProtocolResponseData that will be copied.
  1372. */
  1373. eProsima_user_DllExport ControlProtocolResponseData& operator=(const ControlProtocolResponseData &x);
  1374. /*!
  1375. * @brief Move assignment.
  1376. * @param x Reference to the object ControlProtocolResponseData that will be copied.
  1377. */
  1378. eProsima_user_DllExport ControlProtocolResponseData& operator=(ControlProtocolResponseData &&x);
  1379. /*!
  1380. * @brief This function sets a value in member responseCode
  1381. * @param _responseCode New value for member responseCode
  1382. */
  1383. inline eProsima_user_DllExport void responseCode(ResponseCode _responseCode)
  1384. {
  1385. m_responseCode = _responseCode;
  1386. }
  1387. /*!
  1388. * @brief This function returns the value of member responseCode
  1389. * @return Value of member responseCode
  1390. */
  1391. inline eProsima_user_DllExport ResponseCode responseCode() const
  1392. {
  1393. return m_responseCode;
  1394. }
  1395. /*!
  1396. * @brief This function returns a reference to member responseCode
  1397. * @return Reference to member responseCode
  1398. */
  1399. inline eProsima_user_DllExport ResponseCode& responseCode()
  1400. {
  1401. return m_responseCode;
  1402. }
  1403. /*!
  1404. * @brief This function copies the value in member responseData
  1405. * @param _responseData New value to be copied in member responseData
  1406. */
  1407. inline eProsima_user_DllExport void responseData(const ResponseData &_responseData)
  1408. {
  1409. m_responseData = _responseData;
  1410. }
  1411. /*!
  1412. * @brief This function moves the value in member responseData
  1413. * @param _responseData New value to be moved in member responseData
  1414. */
  1415. inline eProsima_user_DllExport void responseData(ResponseData &&_responseData)
  1416. {
  1417. m_responseData = std::move(_responseData);
  1418. }
  1419. /*!
  1420. * @brief This function returns a constant reference to member responseData
  1421. * @return Constant reference to member responseData
  1422. */
  1423. inline eProsima_user_DllExport const ResponseData& responseData() const
  1424. {
  1425. return m_responseData;
  1426. }
  1427. /*!
  1428. * @brief This function returns a reference to member responseData
  1429. * @return Reference to member responseData
  1430. */
  1431. inline eProsima_user_DllExport ResponseData& responseData()
  1432. {
  1433. return m_responseData;
  1434. }
  1435. /*!
  1436. * @brief This function returns the maximum serialized size of an object
  1437. * depending on the buffer alignment.
  1438. * @param data Data which is calculated its serialized size.
  1439. * @param current_alignment Buffer alignment.
  1440. * @return Maximum serialized size.
  1441. */
  1442. eProsima_user_DllExport static size_t getBufferCdrSerializedSize(
  1443. const ControlProtocolResponseData& data,
  1444. size_t current_alignment = 0);
  1445. /*!
  1446. * @brief This function returns the serialized size of a data depending on the buffer alignment.
  1447. * @param data Data which is calculated its serialized size.
  1448. * @param current_alignment Buffer alignment.
  1449. * @return Serialized size.
  1450. */
  1451. eProsima_user_DllExport static size_t getCdrSerializedSize(const ControlProtocolResponseData& data, size_t current_alignment = 0);
  1452. /*!
  1453. * @brief This function serializes an object using CDR serialization.
  1454. * @param cdr CDR serialization object.
  1455. */
  1456. eProsima_user_DllExport void serialize(eprosima::fastcdr::Cdr &cdr) const;
  1457. /*!
  1458. * @brief This function deserializes an object using CDR serialization.
  1459. * @param cdr CDR serialization object.
  1460. */
  1461. eProsima_user_DllExport void deserialize(eprosima::fastcdr::Cdr &cdr);
  1462. /*!
  1463. * @brief This function returns the maximum serialized size of the Key of an object
  1464. * depending on the buffer alignment.
  1465. * @param current_alignment Buffer alignment.
  1466. * @return Maximum serialized size.
  1467. */
  1468. eProsima_user_DllExport static size_t getKeyMaxCdrSerializedSize(size_t current_alignment = 0);
  1469. /*!
  1470. * @brief This function tells you if the Key has been defined for this type
  1471. */
  1472. eProsima_user_DllExport static bool isKeyDefined();
  1473. /*!
  1474. * @brief This function serializes the key members of an object using CDR serialization.
  1475. * @param cdr CDR serialization object.
  1476. */
  1477. eProsima_user_DllExport void serializeKey(eprosima::fastcdr::Cdr &cdr) const;
  1478. private:
  1479. ResponseCode m_responseCode;
  1480. ResponseData m_responseData;
  1481. };
  1482. }
  1483. }
  1484. } // Namespaces
  1485. #endif // _FASTDDS_TCP_CONTROL_MESSAGE_H_