ua_pubsub_networkmessage.c 48 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294
  1. /* This Source Code Form is subject to the terms of the Mozilla Public
  2. * License, v. 2.0. If a copy of the MPL was not distributed with this
  3. * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  4. *
  5. * Copyright (c) 2017 - 2018 Fraunhofer IOSB (Author: Tino Bischoff)
  6. */
  7. #include "ua_types.h"
  8. #include "ua_types_encoding_binary.h"
  9. #include "ua_types_generated.h"
  10. #include "ua_types_generated_encoding_binary.h"
  11. #include "ua_types_generated_handling.h"
  12. #ifdef UA_ENABLE_PUBSUB /* conditional compilation */
  13. #include "ua_pubsub_networkmessage.h"
  14. const UA_Byte NM_VERSION_MASK = 15;
  15. const UA_Byte NM_PUBLISHER_ID_ENABLED_MASK = 16;
  16. const UA_Byte NM_GROUP_HEADER_ENABLED_MASK = 32;
  17. const UA_Byte NM_PAYLOAD_HEADER_ENABLED_MASK = 64;
  18. const UA_Byte NM_EXTENDEDFLAGS1_ENABLED_MASK = 128;
  19. const UA_Byte NM_PUBLISHER_ID_MASK = 7;
  20. const UA_Byte NM_DATASET_CLASSID_ENABLED_MASK = 8;
  21. const UA_Byte NM_SECURITY_ENABLED_MASK = 16;
  22. const UA_Byte NM_TIMESTAMP_ENABLED_MASK = 32;
  23. const UA_Byte NM_PICOSECONDS_ENABLED_MASK = 64;
  24. const UA_Byte NM_EXTENDEDFLAGS2_ENABLED_MASK = 128;
  25. const UA_Byte NM_NETWORK_MSG_TYPE_MASK = 28;
  26. const UA_Byte NM_CHUNK_MESSAGE_MASK = 1;
  27. const UA_Byte NM_PROMOTEDFIELDS_ENABLED_MASK = 2;
  28. const UA_Byte GROUP_HEADER_WRITER_GROUPID_ENABLED = 1;
  29. const UA_Byte GROUP_HEADER_GROUP_VERSION_ENABLED = 2;
  30. const UA_Byte GROUP_HEADER_NM_NUMBER_ENABLED = 4;
  31. const UA_Byte GROUP_HEADER_SEQUENCE_NUMBER_ENABLED = 8;
  32. const UA_Byte SECURITY_HEADER_NM_SIGNED = 1;
  33. const UA_Byte SECURITY_HEADER_NM_ENCRYPTED = 2;
  34. const UA_Byte SECURITY_HEADER_SEC_FOOTER_ENABLED = 4;
  35. const UA_Byte SECURITY_HEADER_FORCE_KEY_RESET = 8;
  36. const UA_Byte DS_MESSAGEHEADER_DS_MSG_VALID = 1;
  37. const UA_Byte DS_MESSAGEHEADER_FIELD_ENCODING_MASK = 6;
  38. const UA_Byte DS_MESSAGEHEADER_SEQ_NR_ENABLED_MASK = 8;
  39. const UA_Byte DS_MESSAGEHEADER_STATUS_ENABLED_MASK = 16;
  40. const UA_Byte DS_MESSAGEHEADER_CONFIGMAJORVERSION_ENABLED_MASK = 32;
  41. const UA_Byte DS_MESSAGEHEADER_CONFIGMINORVERSION_ENABLED_MASK = 64;
  42. const UA_Byte DS_MESSAGEHEADER_FLAGS2_ENABLED_MASK = 128;
  43. const UA_Byte DS_MESSAGEHEADER_DS_MESSAGE_TYPE_MASK = 15;
  44. const UA_Byte DS_MESSAGEHEADER_TIMESTAMP_ENABLED_MASK = 16;
  45. const UA_Byte DS_MESSAGEHEADER_PICOSECONDS_INCLUDED_MASK = 32;
  46. const UA_Byte NM_SHIFT_LEN = 2;
  47. const UA_Byte DS_MH_SHIFT_LEN = 1;
  48. static UA_Boolean UA_NetworkMessage_ExtendedFlags1Enabled(const UA_NetworkMessage* src);
  49. static UA_Boolean UA_NetworkMessage_ExtendedFlags2Enabled(const UA_NetworkMessage* src);
  50. static UA_Boolean UA_DataSetMessageHeader_DataSetFlags2Enabled(const UA_DataSetMessageHeader* src);
  51. UA_StatusCode
  52. UA_NetworkMessage_encodeBinary(const UA_NetworkMessage* src, UA_Byte **bufPos,
  53. const UA_Byte *bufEnd) {
  54. /* UADPVersion + UADP Flags */
  55. UA_Byte v = src->version;
  56. if(src->publisherIdEnabled)
  57. v |= NM_PUBLISHER_ID_ENABLED_MASK;
  58. if(src->groupHeaderEnabled)
  59. v |= NM_GROUP_HEADER_ENABLED_MASK;
  60. if(src->payloadHeaderEnabled)
  61. v |= NM_PAYLOAD_HEADER_ENABLED_MASK;
  62. if(UA_NetworkMessage_ExtendedFlags1Enabled(src))
  63. v |= NM_EXTENDEDFLAGS1_ENABLED_MASK;
  64. UA_StatusCode rv = UA_Byte_encodeBinary(&v, bufPos, bufEnd);
  65. if(rv != UA_STATUSCODE_GOOD)
  66. return rv;
  67. // ExtendedFlags1
  68. if(UA_NetworkMessage_ExtendedFlags1Enabled(src)) {
  69. v = (UA_Byte)src->publisherIdType;
  70. if(src->dataSetClassIdEnabled)
  71. v |= NM_DATASET_CLASSID_ENABLED_MASK;
  72. if(src->securityEnabled)
  73. v |= NM_SECURITY_ENABLED_MASK;
  74. if(src->timestampEnabled)
  75. v |= NM_TIMESTAMP_ENABLED_MASK;
  76. if(src->picosecondsEnabled)
  77. v |= NM_PICOSECONDS_ENABLED_MASK;
  78. if(UA_NetworkMessage_ExtendedFlags2Enabled(src))
  79. v |= NM_EXTENDEDFLAGS2_ENABLED_MASK;
  80. rv = UA_Byte_encodeBinary(&v, bufPos, bufEnd);
  81. if(rv != UA_STATUSCODE_GOOD)
  82. return rv;
  83. // ExtendedFlags2
  84. if(UA_NetworkMessage_ExtendedFlags2Enabled(src)) {
  85. v = (UA_Byte)src->networkMessageType;
  86. // shift left 2 bit
  87. v = (UA_Byte) (v << NM_SHIFT_LEN);
  88. if(src->chunkMessage)
  89. v |= NM_CHUNK_MESSAGE_MASK;
  90. if(src->promotedFieldsEnabled)
  91. v |= NM_PROMOTEDFIELDS_ENABLED_MASK;
  92. rv = UA_Byte_encodeBinary(&v, bufPos, bufEnd);
  93. if(rv != UA_STATUSCODE_GOOD)
  94. return rv;
  95. }
  96. }
  97. // PublisherId
  98. if(src->publisherIdEnabled) {
  99. switch (src->publisherIdType) {
  100. case UA_PUBLISHERDATATYPE_BYTE:
  101. rv = UA_Byte_encodeBinary(&(src->publisherId.publisherIdByte), bufPos, bufEnd);
  102. break;
  103. case UA_PUBLISHERDATATYPE_UINT16:
  104. rv = UA_UInt16_encodeBinary(&(src->publisherId.publisherIdUInt16), bufPos, bufEnd);
  105. break;
  106. case UA_PUBLISHERDATATYPE_UINT32:
  107. rv = UA_UInt32_encodeBinary(&(src->publisherId.publisherIdUInt32), bufPos, bufEnd);
  108. break;
  109. case UA_PUBLISHERDATATYPE_UINT64:
  110. rv = UA_UInt64_encodeBinary(&(src->publisherId.publisherIdUInt64), bufPos, bufEnd);
  111. break;
  112. case UA_PUBLISHERDATATYPE_STRING:
  113. rv = UA_String_encodeBinary(&(src->publisherId.publisherIdString), bufPos, bufEnd);
  114. break;
  115. default:
  116. rv = UA_STATUSCODE_BADINTERNALERROR;
  117. break;
  118. }
  119. if(rv != UA_STATUSCODE_GOOD)
  120. return rv;
  121. }
  122. // DataSetClassId
  123. if(src->dataSetClassIdEnabled) {
  124. rv = UA_Guid_encodeBinary(&(src->dataSetClassId), bufPos, bufEnd);
  125. if(rv != UA_STATUSCODE_GOOD)
  126. return rv;
  127. }
  128. // Group Header
  129. if(src->groupHeaderEnabled) {
  130. v = 0;
  131. if(src->groupHeader.writerGroupIdEnabled)
  132. v |= GROUP_HEADER_WRITER_GROUPID_ENABLED;
  133. if(src->groupHeader.groupVersionEnabled)
  134. v |= GROUP_HEADER_GROUP_VERSION_ENABLED;
  135. if(src->groupHeader.networkMessageNumberEnabled)
  136. v |= GROUP_HEADER_NM_NUMBER_ENABLED;
  137. if(src->groupHeader.sequenceNumberEnabled)
  138. v |= GROUP_HEADER_SEQUENCE_NUMBER_ENABLED;
  139. rv = UA_Byte_encodeBinary(&v, bufPos, bufEnd);
  140. if(rv != UA_STATUSCODE_GOOD)
  141. return rv;
  142. if(src->groupHeader.writerGroupIdEnabled) {
  143. rv = UA_UInt16_encodeBinary(&(src->groupHeader.writerGroupId), bufPos, bufEnd);
  144. if(rv != UA_STATUSCODE_GOOD)
  145. return rv;
  146. }
  147. if(src->groupHeader.groupVersionEnabled) {
  148. rv = UA_UInt32_encodeBinary(&(src->groupHeader.groupVersion), bufPos, bufEnd);
  149. if(rv != UA_STATUSCODE_GOOD)
  150. return rv;
  151. }
  152. if(src->groupHeader.networkMessageNumberEnabled) {
  153. rv = UA_UInt16_encodeBinary(&(src->groupHeader.networkMessageNumber), bufPos, bufEnd);
  154. if(rv != UA_STATUSCODE_GOOD)
  155. return rv;
  156. }
  157. if(src->groupHeader.sequenceNumberEnabled) {
  158. rv = UA_UInt16_encodeBinary(&(src->groupHeader.sequenceNumber), bufPos, bufEnd);
  159. if(rv != UA_STATUSCODE_GOOD)
  160. return rv;
  161. }
  162. }
  163. // Payload-Header
  164. if(src->payloadHeaderEnabled) {
  165. if(src->networkMessageType != UA_NETWORKMESSAGE_DATASET)
  166. return UA_STATUSCODE_BADNOTIMPLEMENTED;
  167. rv = UA_Byte_encodeBinary(&(src->payloadHeader.dataSetPayloadHeader.count), bufPos, bufEnd);
  168. if(src->payloadHeader.dataSetPayloadHeader.dataSetWriterIds == NULL)
  169. return UA_STATUSCODE_BADENCODINGERROR;
  170. for(UA_Byte i = 0; i < src->payloadHeader.dataSetPayloadHeader.count; i++) {
  171. rv = UA_UInt16_encodeBinary(&(src->payloadHeader.dataSetPayloadHeader.dataSetWriterIds[i]),
  172. bufPos, bufEnd);
  173. if(rv != UA_STATUSCODE_GOOD)
  174. return rv;
  175. }
  176. }
  177. // Timestamp
  178. if(src->timestampEnabled)
  179. rv = UA_DateTime_encodeBinary(&(src->timestamp), bufPos, bufEnd);
  180. // Picoseconds
  181. if(src->picosecondsEnabled)
  182. rv = UA_UInt16_encodeBinary(&(src->picoseconds), bufPos, bufEnd);
  183. // PromotedFields
  184. if(src->promotedFieldsEnabled) {
  185. /* Size (calculate & encode) */
  186. UA_UInt16 pfSize = 0;
  187. for(UA_UInt16 i = 0; i < src->promotedFieldsSize; i++)
  188. pfSize = (UA_UInt16) (pfSize + UA_Variant_calcSizeBinary(&src->promotedFields[i]));
  189. rv |= UA_UInt16_encodeBinary(&pfSize, bufPos, bufEnd);
  190. for (UA_UInt16 i = 0; i < src->promotedFieldsSize; i++)
  191. rv |= UA_Variant_encodeBinary(&(src->promotedFields[i]), bufPos, bufEnd);
  192. }
  193. // SecurityHeader
  194. if(src->securityEnabled) {
  195. // SecurityFlags
  196. v = 0;
  197. if(src->securityHeader.networkMessageSigned)
  198. v |= SECURITY_HEADER_NM_SIGNED;
  199. if(src->securityHeader.networkMessageEncrypted)
  200. v |= SECURITY_HEADER_NM_ENCRYPTED;
  201. if(src->securityHeader.securityFooterEnabled)
  202. v |= SECURITY_HEADER_SEC_FOOTER_ENABLED;
  203. if(src->securityHeader.forceKeyReset)
  204. v |= SECURITY_HEADER_FORCE_KEY_RESET;
  205. rv = UA_Byte_encodeBinary(&v, bufPos, bufEnd);
  206. if(rv != UA_STATUSCODE_GOOD)
  207. return rv;
  208. // SecurityTokenId
  209. rv = UA_UInt32_encodeBinary(&src->securityHeader.securityTokenId, bufPos, bufEnd);
  210. if(rv != UA_STATUSCODE_GOOD)
  211. return rv;
  212. // NonceLength
  213. rv = UA_Byte_encodeBinary(&src->securityHeader.nonceLength, bufPos, bufEnd);
  214. if(rv != UA_STATUSCODE_GOOD)
  215. return rv;
  216. // MessageNonce
  217. for (UA_Byte i = 0; i < src->securityHeader.nonceLength; i++) {
  218. rv = UA_Byte_encodeBinary(&(src->securityHeader.messageNonce.data[i]), bufPos, bufEnd);
  219. if(rv != UA_STATUSCODE_GOOD)
  220. return rv;
  221. }
  222. // SecurityFooterSize
  223. if(src->securityHeader.securityFooterEnabled) {
  224. rv = UA_UInt16_encodeBinary(&src->securityHeader.securityFooterSize, bufPos, bufEnd);
  225. if(rv != UA_STATUSCODE_GOOD)
  226. return rv;
  227. }
  228. }
  229. // Payload
  230. if(src->networkMessageType != UA_NETWORKMESSAGE_DATASET)
  231. return UA_STATUSCODE_BADNOTIMPLEMENTED;
  232. UA_Byte count = 1;
  233. if(src->payloadHeaderEnabled) {
  234. count = src->payloadHeader.dataSetPayloadHeader.count;
  235. if(count > 1) {
  236. for (UA_Byte i = 0; i < count; i++) {
  237. // initially calculate the size, if not specified
  238. UA_UInt16 sz = 0;
  239. if((src->payload.dataSetPayload.sizes != NULL) &&
  240. (src->payload.dataSetPayload.sizes[i] != 0)) {
  241. sz = src->payload.dataSetPayload.sizes[i];
  242. } else {
  243. sz = (UA_UInt16)UA_DataSetMessage_calcSizeBinary(&src->payload.dataSetPayload.dataSetMessages[i]);
  244. }
  245. rv = UA_UInt16_encodeBinary(&sz, bufPos, bufEnd);
  246. if(rv != UA_STATUSCODE_GOOD)
  247. return rv;
  248. }
  249. }
  250. }
  251. for(UA_Byte i = 0; i < count; i++) {
  252. rv = UA_DataSetMessage_encodeBinary(&(src->payload.dataSetPayload.dataSetMessages[i]), bufPos, bufEnd);
  253. if(rv != UA_STATUSCODE_GOOD)
  254. return rv;
  255. }
  256. if(src->securityEnabled) {
  257. // SecurityFooter
  258. if(src->securityHeader.securityFooterEnabled) {
  259. for(UA_Byte i = 0; i < src->securityHeader.securityFooterSize; i++) {
  260. rv = UA_Byte_encodeBinary(&(src->securityFooter.data[i]), bufPos, bufEnd);
  261. if(rv != UA_STATUSCODE_GOOD)
  262. return rv;
  263. }
  264. }
  265. // Signature
  266. if(src->securityHeader.networkMessageSigned) {
  267. rv = UA_ByteString_encodeBinary(&(src->signature), bufPos, bufEnd);
  268. if(rv != UA_STATUSCODE_GOOD)
  269. return rv;
  270. }
  271. }
  272. return UA_STATUSCODE_GOOD;
  273. }
  274. static UA_StatusCode
  275. UA_NetworkMessage_decodeBinaryInternal(const UA_ByteString *src, size_t *offset,
  276. UA_NetworkMessage* dst) {
  277. memset(dst, 0, sizeof(UA_NetworkMessage));
  278. UA_Byte v = 0;
  279. UA_StatusCode rv = UA_Byte_decodeBinary(src, offset, &v);
  280. if(rv != UA_STATUSCODE_GOOD)
  281. return rv;
  282. dst->version = v & NM_VERSION_MASK;
  283. if((v & NM_PUBLISHER_ID_ENABLED_MASK) != 0)
  284. dst->publisherIdEnabled = true;
  285. if((v & NM_GROUP_HEADER_ENABLED_MASK) != 0)
  286. dst->groupHeaderEnabled = true;
  287. if((v & NM_PAYLOAD_HEADER_ENABLED_MASK) != 0)
  288. dst->payloadHeaderEnabled = true;
  289. if((v & NM_EXTENDEDFLAGS1_ENABLED_MASK) != 0) {
  290. v = 0;
  291. rv = UA_Byte_decodeBinary(src, offset, &v);
  292. if(rv != UA_STATUSCODE_GOOD)
  293. return rv;
  294. dst->publisherIdType = (UA_PublisherIdDatatype)(v & NM_PUBLISHER_ID_MASK);
  295. if((v & NM_DATASET_CLASSID_ENABLED_MASK) != 0)
  296. dst->dataSetClassIdEnabled = true;
  297. if((v & NM_SECURITY_ENABLED_MASK) != 0)
  298. dst->securityEnabled = true;
  299. if((v & NM_TIMESTAMP_ENABLED_MASK) != 0)
  300. dst->timestampEnabled = true;
  301. if((v & NM_PICOSECONDS_ENABLED_MASK) != 0)
  302. dst->picosecondsEnabled = true;
  303. if((v & NM_EXTENDEDFLAGS2_ENABLED_MASK) != 0) {
  304. v = 0;
  305. rv = UA_Byte_decodeBinary(src, offset, &v);
  306. if(rv != UA_STATUSCODE_GOOD)
  307. return rv;
  308. if((v & NM_CHUNK_MESSAGE_MASK) != 0)
  309. dst->chunkMessage = true;
  310. if((v & NM_PROMOTEDFIELDS_ENABLED_MASK) != 0)
  311. dst->promotedFieldsEnabled = true;
  312. v = v & NM_NETWORK_MSG_TYPE_MASK;
  313. v = (UA_Byte) (v >> NM_SHIFT_LEN);
  314. dst->networkMessageType = (UA_NetworkMessageType)v;
  315. }
  316. }
  317. if(dst->publisherIdEnabled) {
  318. switch (dst->publisherIdType) {
  319. case UA_PUBLISHERDATATYPE_BYTE:
  320. rv = UA_Byte_decodeBinary(src, offset, &(dst->publisherId.publisherIdByte));
  321. break;
  322. case UA_PUBLISHERDATATYPE_UINT16:
  323. rv = UA_UInt16_decodeBinary(src, offset, &(dst->publisherId.publisherIdUInt16));
  324. break;
  325. case UA_PUBLISHERDATATYPE_UINT32:
  326. rv = UA_UInt32_decodeBinary(src, offset, &(dst->publisherId.publisherIdUInt32));
  327. break;
  328. case UA_PUBLISHERDATATYPE_UINT64:
  329. rv = UA_UInt64_decodeBinary(src, offset, &(dst->publisherId.publisherIdUInt64));
  330. break;
  331. case UA_PUBLISHERDATATYPE_STRING:
  332. rv = UA_String_decodeBinary(src, offset, &(dst->publisherId.publisherIdString));
  333. break;
  334. default:
  335. rv = UA_STATUSCODE_BADINTERNALERROR;
  336. break;
  337. }
  338. if(rv != UA_STATUSCODE_GOOD)
  339. return rv;
  340. }
  341. if(dst->dataSetClassIdEnabled) {
  342. rv = UA_Guid_decodeBinary(src, offset, &(dst->dataSetClassId));
  343. if(rv != UA_STATUSCODE_GOOD)
  344. return rv;
  345. }
  346. // GroupHeader
  347. if(dst->groupHeaderEnabled) {
  348. v = 0;
  349. rv = UA_Byte_decodeBinary(src, offset, &v);
  350. if(rv != UA_STATUSCODE_GOOD)
  351. return rv;
  352. if((v & GROUP_HEADER_WRITER_GROUPID_ENABLED) != 0)
  353. dst->groupHeader.writerGroupIdEnabled = true;
  354. if((v & GROUP_HEADER_GROUP_VERSION_ENABLED) != 0)
  355. dst->groupHeader.groupVersionEnabled = true;
  356. if((v & GROUP_HEADER_NM_NUMBER_ENABLED) != 0)
  357. dst->groupHeader.networkMessageNumberEnabled = true;
  358. if((v & GROUP_HEADER_SEQUENCE_NUMBER_ENABLED) != 0)
  359. dst->groupHeader.sequenceNumberEnabled = true;
  360. if(dst->groupHeader.writerGroupIdEnabled) {
  361. rv = UA_UInt16_decodeBinary(src, offset, &dst->groupHeader.writerGroupId);
  362. if(rv != UA_STATUSCODE_GOOD)
  363. return rv;
  364. }
  365. if(dst->groupHeader.groupVersionEnabled) {
  366. rv = UA_UInt32_decodeBinary(src, offset, &dst->groupHeader.groupVersion);
  367. if(rv != UA_STATUSCODE_GOOD)
  368. return rv;
  369. }
  370. if(dst->groupHeader.networkMessageNumberEnabled) {
  371. rv = UA_UInt16_decodeBinary(src, offset, &dst->groupHeader.networkMessageNumber);
  372. if(rv != UA_STATUSCODE_GOOD)
  373. return rv;
  374. }
  375. if(dst->groupHeader.sequenceNumberEnabled) {
  376. rv = UA_UInt16_decodeBinary(src, offset, &dst->groupHeader.sequenceNumber);
  377. if(rv != UA_STATUSCODE_GOOD)
  378. return rv;
  379. }
  380. }
  381. // Payload-Header
  382. if(dst->payloadHeaderEnabled) {
  383. if(dst->networkMessageType != UA_NETWORKMESSAGE_DATASET)
  384. return UA_STATUSCODE_BADNOTIMPLEMENTED;
  385. rv = UA_Byte_decodeBinary(src, offset, &dst->payloadHeader.dataSetPayloadHeader.count);
  386. if(rv != UA_STATUSCODE_GOOD)
  387. return rv;
  388. dst->payloadHeader.dataSetPayloadHeader.dataSetWriterIds =
  389. (UA_UInt16 *)UA_Array_new(dst->payloadHeader.dataSetPayloadHeader.count,
  390. &UA_TYPES[UA_TYPES_UINT16]);
  391. for (UA_Byte i = 0; i < dst->payloadHeader.dataSetPayloadHeader.count; i++) {
  392. rv = UA_UInt16_decodeBinary(src, offset,
  393. &dst->payloadHeader.dataSetPayloadHeader.dataSetWriterIds[i]);
  394. if(rv != UA_STATUSCODE_GOOD)
  395. return rv;
  396. }
  397. }
  398. // Timestamp
  399. if(dst->timestampEnabled) {
  400. rv = UA_DateTime_decodeBinary(src, offset, &(dst->timestamp));
  401. if(rv != UA_STATUSCODE_GOOD)
  402. return rv;
  403. }
  404. // Picoseconds
  405. if(dst->picosecondsEnabled) {
  406. rv = UA_UInt16_decodeBinary(src, offset, &(dst->picoseconds));
  407. if(rv != UA_STATUSCODE_GOOD)
  408. return rv;
  409. }
  410. // PromotedFields
  411. if(dst->promotedFieldsEnabled) {
  412. // Size
  413. UA_UInt16 promotedFieldsSize = 0;
  414. rv = UA_UInt16_decodeBinary(src, offset, &promotedFieldsSize);
  415. if(rv != UA_STATUSCODE_GOOD)
  416. return rv;
  417. // promotedFieldsSize: here size in Byte, not the number of objects!
  418. if(promotedFieldsSize > 0) {
  419. // store offset, later compared with promotedFieldsSize
  420. size_t offsetEnd = (*offset) + promotedFieldsSize;
  421. unsigned int counter = 0;
  422. do {
  423. if(counter == 0) {
  424. dst->promotedFields = (UA_Variant*)UA_malloc(UA_TYPES[UA_TYPES_VARIANT].memSize);
  425. // set promotedFieldsSize to the number of objects
  426. dst->promotedFieldsSize = (UA_UInt16) (counter + 1);
  427. } else {
  428. dst->promotedFields = (UA_Variant*)
  429. UA_realloc(dst->promotedFields,
  430. UA_TYPES[UA_TYPES_VARIANT].memSize * (counter + 1));
  431. // set promotedFieldsSize to the number of objects
  432. dst->promotedFieldsSize = (UA_UInt16) (counter + 1);
  433. }
  434. UA_Variant_init(&dst->promotedFields[counter]);
  435. rv = UA_Variant_decodeBinary(src, offset, &dst->promotedFields[counter]);
  436. if(rv != UA_STATUSCODE_GOOD)
  437. return rv;
  438. counter++;
  439. } while ((*offset) < offsetEnd);
  440. }
  441. }
  442. // SecurityHeader
  443. if(dst->securityEnabled) {
  444. // SecurityFlags
  445. v = 0;
  446. rv = UA_Byte_decodeBinary(src, offset, &v);
  447. if(rv != UA_STATUSCODE_GOOD)
  448. return rv;
  449. if((v & SECURITY_HEADER_NM_SIGNED) != 0)
  450. dst->securityHeader.networkMessageSigned = true;
  451. if((v & SECURITY_HEADER_NM_ENCRYPTED) != 0)
  452. dst->securityHeader.networkMessageEncrypted = true;
  453. if((v & SECURITY_HEADER_SEC_FOOTER_ENABLED) != 0)
  454. dst->securityHeader.securityFooterEnabled = true;
  455. if((v & SECURITY_HEADER_FORCE_KEY_RESET) != 0)
  456. dst->securityHeader.forceKeyReset = true;
  457. // SecurityTokenId
  458. rv = UA_UInt32_decodeBinary(src, offset, &dst->securityHeader.securityTokenId);
  459. if(rv != UA_STATUSCODE_GOOD)
  460. return rv;
  461. // NonceLength
  462. rv = UA_Byte_decodeBinary(src, offset, &dst->securityHeader.nonceLength);
  463. if(rv != UA_STATUSCODE_GOOD)
  464. return rv;
  465. // MessageNonce
  466. if(dst->securityHeader.nonceLength > 0) {
  467. rv = UA_ByteString_allocBuffer(&dst->securityHeader.messageNonce,
  468. dst->securityHeader.nonceLength);
  469. if(rv != UA_STATUSCODE_GOOD)
  470. return rv;
  471. for (UA_Byte i = 0; i < dst->securityHeader.nonceLength; i++) {
  472. rv = UA_Byte_decodeBinary(src, offset, &(dst->securityHeader.messageNonce.data[i]));
  473. if(rv != UA_STATUSCODE_GOOD)
  474. return rv;
  475. }
  476. }
  477. // SecurityFooterSize
  478. if(dst->securityHeader.securityFooterEnabled) {
  479. rv = UA_UInt16_decodeBinary(src, offset, &dst->securityHeader.securityFooterSize);
  480. if(rv != UA_STATUSCODE_GOOD)
  481. return rv;
  482. }
  483. }
  484. // Payload
  485. if(dst->networkMessageType != UA_NETWORKMESSAGE_DATASET)
  486. return UA_STATUSCODE_BADNOTIMPLEMENTED;
  487. UA_Byte count = 1;
  488. if(dst->payloadHeaderEnabled) {
  489. count = dst->payloadHeader.dataSetPayloadHeader.count;
  490. if(count > 1) {
  491. dst->payload.dataSetPayload.sizes = (UA_UInt16 *)UA_Array_new(count, &UA_TYPES[UA_TYPES_UINT16]);
  492. for (UA_Byte i = 0; i < count; i++) {
  493. rv = UA_UInt16_decodeBinary(src, offset, &(dst->payload.dataSetPayload.sizes[i]));
  494. if(rv != UA_STATUSCODE_GOOD)
  495. return rv;
  496. }
  497. }
  498. }
  499. dst->payload.dataSetPayload.dataSetMessages = (UA_DataSetMessage*)
  500. UA_calloc(count, sizeof(UA_DataSetMessage));
  501. for(UA_Byte i = 0; i < count; i++) {
  502. rv = UA_DataSetMessage_decodeBinary(src, offset, &(dst->payload.dataSetPayload.dataSetMessages[i]));
  503. if(rv != UA_STATUSCODE_GOOD)
  504. return rv;
  505. }
  506. if(rv != UA_STATUSCODE_GOOD)
  507. return rv;
  508. if(dst->securityEnabled) {
  509. // SecurityFooter
  510. if(dst->securityHeader.securityFooterEnabled && (dst->securityHeader.securityFooterSize > 0)) {
  511. rv = UA_ByteString_allocBuffer(&dst->securityFooter, dst->securityHeader.securityFooterSize);
  512. if (rv != UA_STATUSCODE_GOOD)
  513. return rv;
  514. for (UA_Byte i = 0; i < dst->securityHeader.securityFooterSize; i++) {
  515. rv = UA_Byte_decodeBinary(src, offset, &(dst->securityFooter.data[i]));
  516. if (rv != UA_STATUSCODE_GOOD)
  517. return rv;
  518. }
  519. }
  520. // Signature
  521. if(dst->securityHeader.networkMessageSigned) {
  522. rv = UA_ByteString_decodeBinary(src, offset, &(dst->signature));
  523. if (rv != UA_STATUSCODE_GOOD)
  524. return rv;
  525. }
  526. }
  527. return UA_STATUSCODE_GOOD;
  528. }
  529. UA_StatusCode
  530. UA_NetworkMessage_decodeBinary(const UA_ByteString *src, size_t *offset, UA_NetworkMessage* dst) {
  531. UA_StatusCode retval = UA_NetworkMessage_decodeBinaryInternal(src, offset, dst);
  532. if(retval != UA_STATUSCODE_GOOD)
  533. UA_NetworkMessage_deleteMembers(dst);
  534. return retval;
  535. }
  536. size_t UA_NetworkMessage_calcSizeBinary(const UA_NetworkMessage* p) {
  537. size_t retval = 0;
  538. UA_Byte byte;
  539. size_t size = UA_Byte_calcSizeBinary(&byte); // UADPVersion + UADPFlags
  540. if(UA_NetworkMessage_ExtendedFlags1Enabled(p)) {
  541. size += UA_Byte_calcSizeBinary(&byte);
  542. if(UA_NetworkMessage_ExtendedFlags2Enabled(p))
  543. size += UA_Byte_calcSizeBinary(&byte);
  544. }
  545. if(p->publisherIdEnabled) {
  546. switch (p->publisherIdType) {
  547. case UA_PUBLISHERDATATYPE_BYTE:
  548. size += UA_Byte_calcSizeBinary(&p->publisherId.publisherIdByte);
  549. break;
  550. case UA_PUBLISHERDATATYPE_UINT16:
  551. size += UA_UInt16_calcSizeBinary(&p->publisherId.publisherIdUInt16);
  552. break;
  553. case UA_PUBLISHERDATATYPE_UINT32:
  554. size += UA_UInt32_calcSizeBinary(&p->publisherId.publisherIdUInt32);
  555. break;
  556. case UA_PUBLISHERDATATYPE_UINT64:
  557. size += UA_UInt64_calcSizeBinary(&p->publisherId.publisherIdUInt64);
  558. break;
  559. case UA_PUBLISHERDATATYPE_STRING:
  560. size += UA_String_calcSizeBinary(&p->publisherId.publisherIdString);
  561. break;
  562. }
  563. }
  564. if(p->dataSetClassIdEnabled)
  565. size += UA_Guid_calcSizeBinary(&p->dataSetClassId);
  566. // Group Header
  567. if(p->groupHeaderEnabled) {
  568. size += UA_Byte_calcSizeBinary(&byte);
  569. if(p->groupHeader.writerGroupIdEnabled)
  570. size += UA_UInt16_calcSizeBinary(&p->groupHeader.writerGroupId);
  571. if(p->groupHeader.groupVersionEnabled)
  572. size += UA_UInt32_calcSizeBinary(&p->groupHeader.groupVersion);
  573. if(p->groupHeader.networkMessageNumberEnabled)
  574. size += UA_UInt16_calcSizeBinary(&p->groupHeader.networkMessageNumber);
  575. if(p->groupHeader.sequenceNumberEnabled)
  576. size += UA_UInt16_calcSizeBinary(&p->groupHeader.sequenceNumber);
  577. }
  578. // Payload Header
  579. if(p->payloadHeaderEnabled) {
  580. if(p->networkMessageType == UA_NETWORKMESSAGE_DATASET) {
  581. size += UA_Byte_calcSizeBinary(&p->payloadHeader.dataSetPayloadHeader.count);
  582. if(p->payloadHeader.dataSetPayloadHeader.dataSetWriterIds != NULL) {
  583. size += UA_UInt16_calcSizeBinary(&p->payloadHeader.dataSetPayloadHeader.dataSetWriterIds[0]) *
  584. p->payloadHeader.dataSetPayloadHeader.count;
  585. } else {
  586. return 0; /* no dataSetWriterIds given! */
  587. }
  588. } else {
  589. // not implemented
  590. }
  591. }
  592. if(p->timestampEnabled)
  593. size += UA_DateTime_calcSizeBinary(&p->timestamp);
  594. if(p->picosecondsEnabled)
  595. size += UA_UInt16_calcSizeBinary(&p->picoseconds);
  596. if(p->promotedFieldsEnabled) {
  597. size += UA_UInt16_calcSizeBinary(&p->promotedFieldsSize);
  598. for (UA_UInt16 i = 0; i < p->promotedFieldsSize; i++)
  599. size += UA_Variant_calcSizeBinary(&p->promotedFields[i]);
  600. }
  601. if(p->securityEnabled) {
  602. size += UA_Byte_calcSizeBinary(&byte);
  603. size += UA_UInt32_calcSizeBinary(&p->securityHeader.securityTokenId);
  604. size += UA_Byte_calcSizeBinary(&p->securityHeader.nonceLength);
  605. if(p->securityHeader.nonceLength > 0)
  606. size += (UA_Byte_calcSizeBinary(&p->securityHeader.messageNonce.data[0]) * p->securityHeader.nonceLength);
  607. if(p->securityHeader.securityFooterEnabled)
  608. size += UA_UInt16_calcSizeBinary(&p->securityHeader.securityFooterSize);
  609. }
  610. if(p->networkMessageType == UA_NETWORKMESSAGE_DATASET) {
  611. UA_Byte count = 1;
  612. if(p->payloadHeaderEnabled) {
  613. count = p->payloadHeader.dataSetPayloadHeader.count;
  614. if(count > 1)
  615. size += UA_UInt16_calcSizeBinary(&(p->payload.dataSetPayload.sizes[0])) * count;
  616. }
  617. for (size_t i = 0; i < count; i++)
  618. size += UA_DataSetMessage_calcSizeBinary(&(p->payload.dataSetPayload.dataSetMessages[i]));
  619. }
  620. if (p->securityEnabled) {
  621. if (p->securityHeader.securityFooterEnabled)
  622. size += p->securityHeader.securityFooterSize;
  623. if (p->securityHeader.networkMessageSigned)
  624. size += UA_ByteString_calcSizeBinary(&p->signature);
  625. }
  626. retval = size;
  627. return retval;
  628. }
  629. void
  630. UA_NetworkMessage_deleteMembers(UA_NetworkMessage* p) {
  631. if(p->promotedFieldsEnabled)
  632. UA_Array_delete(p->promotedFields, p->promotedFieldsSize, &UA_TYPES[UA_TYPES_VARIANT]);
  633. if(p->securityEnabled && (p->securityHeader.nonceLength > 0))
  634. UA_ByteString_deleteMembers(&p->securityHeader.messageNonce);
  635. if(p->networkMessageType == UA_NETWORKMESSAGE_DATASET) {
  636. if(p->payloadHeaderEnabled) {
  637. if(p->payloadHeader.dataSetPayloadHeader.dataSetWriterIds != NULL) {
  638. UA_Array_delete(p->payloadHeader.dataSetPayloadHeader.dataSetWriterIds,
  639. p->payloadHeader.dataSetPayloadHeader.count, &UA_TYPES[UA_TYPES_UINT16]);
  640. }
  641. if(p->payload.dataSetPayload.sizes != NULL) {
  642. UA_Array_delete(p->payload.dataSetPayload.sizes,
  643. p->payloadHeader.dataSetPayloadHeader.count, &UA_TYPES[UA_TYPES_UINT16]);
  644. }
  645. }
  646. if(p->payload.dataSetPayload.dataSetMessages != NULL) {
  647. UA_Byte count = 1;
  648. if(p->payloadHeaderEnabled)
  649. count = p->payloadHeader.dataSetPayloadHeader.count;
  650. for (size_t i = 0; i < count; i++)
  651. UA_DataSetMessage_free(&(p->payload.dataSetPayload.dataSetMessages[i]));
  652. UA_free(p->payload.dataSetPayload.dataSetMessages);
  653. }
  654. }
  655. if(p->securityHeader.securityFooterEnabled && (p->securityHeader.securityFooterSize > 0))
  656. UA_ByteString_deleteMembers(&p->securityFooter);
  657. if(p->messageIdEnabled){
  658. UA_String_deleteMembers(&p->messageId);
  659. }
  660. if(p->publisherIdEnabled && p->publisherIdType == UA_PUBLISHERDATATYPE_STRING){
  661. UA_String_deleteMembers(&p->publisherId.publisherIdString);
  662. }
  663. memset(p, 0, sizeof(UA_NetworkMessage));
  664. }
  665. void UA_NetworkMessage_delete(UA_NetworkMessage* p) {
  666. UA_NetworkMessage_deleteMembers(p);
  667. }
  668. UA_Boolean
  669. UA_NetworkMessage_ExtendedFlags1Enabled(const UA_NetworkMessage* src) {
  670. UA_Boolean retval = false;
  671. if((src->publisherIdType != UA_PUBLISHERDATATYPE_BYTE)
  672. || src->dataSetClassIdEnabled
  673. || src->securityEnabled
  674. || src->timestampEnabled
  675. || src->picosecondsEnabled
  676. || UA_NetworkMessage_ExtendedFlags2Enabled(src))
  677. {
  678. retval = true;
  679. }
  680. return retval;
  681. }
  682. UA_Boolean
  683. UA_NetworkMessage_ExtendedFlags2Enabled(const UA_NetworkMessage* src) {
  684. if(src->chunkMessage || src->promotedFieldsEnabled ||
  685. src->networkMessageType != UA_NETWORKMESSAGE_DATASET)
  686. return true;
  687. return false;
  688. }
  689. UA_Boolean
  690. UA_DataSetMessageHeader_DataSetFlags2Enabled(const UA_DataSetMessageHeader* src) {
  691. if(src->dataSetMessageType != UA_DATASETMESSAGE_DATAKEYFRAME ||
  692. src->timestampEnabled || src->picoSecondsIncluded)
  693. return true;
  694. return false;
  695. }
  696. UA_StatusCode
  697. UA_DataSetMessageHeader_encodeBinary(const UA_DataSetMessageHeader* src, UA_Byte **bufPos,
  698. const UA_Byte *bufEnd) {
  699. UA_StatusCode retval = UA_STATUSCODE_BADNOTIMPLEMENTED;
  700. UA_Byte v;
  701. // DataSetFlags1
  702. v = (UA_Byte)src->fieldEncoding;
  703. // shift left 1 bit
  704. v = (UA_Byte)(v << DS_MH_SHIFT_LEN);
  705. if(src->dataSetMessageValid)
  706. v |= DS_MESSAGEHEADER_DS_MSG_VALID;
  707. if(src->dataSetMessageSequenceNrEnabled)
  708. v |= DS_MESSAGEHEADER_SEQ_NR_ENABLED_MASK;
  709. if(src->statusEnabled)
  710. v |= DS_MESSAGEHEADER_STATUS_ENABLED_MASK;
  711. if(src->configVersionMajorVersionEnabled)
  712. v |= DS_MESSAGEHEADER_CONFIGMAJORVERSION_ENABLED_MASK;
  713. if(src->configVersionMinorVersionEnabled)
  714. v |= DS_MESSAGEHEADER_CONFIGMINORVERSION_ENABLED_MASK;
  715. if(UA_DataSetMessageHeader_DataSetFlags2Enabled(src))
  716. v |= DS_MESSAGEHEADER_FLAGS2_ENABLED_MASK;
  717. UA_StatusCode rv = UA_Byte_encodeBinary(&v, bufPos, bufEnd);
  718. if(rv != UA_STATUSCODE_GOOD)
  719. return rv;
  720. // DataSetFlags2
  721. if(UA_DataSetMessageHeader_DataSetFlags2Enabled(src)) {
  722. v = (UA_Byte)src->dataSetMessageType;
  723. if(src->timestampEnabled)
  724. v |= DS_MESSAGEHEADER_TIMESTAMP_ENABLED_MASK;
  725. if(src->picoSecondsIncluded)
  726. v |= DS_MESSAGEHEADER_PICOSECONDS_INCLUDED_MASK;
  727. rv = UA_Byte_encodeBinary(&v, bufPos, bufEnd);
  728. if(rv != UA_STATUSCODE_GOOD)
  729. return rv;
  730. }
  731. // DataSetMessageSequenceNr
  732. if(src->dataSetMessageSequenceNrEnabled) {
  733. rv = UA_UInt16_encodeBinary(&src->dataSetMessageSequenceNr, bufPos, bufEnd);
  734. if(rv != UA_STATUSCODE_GOOD)
  735. return rv;
  736. }
  737. // Timestamp
  738. if(src->timestampEnabled) {
  739. rv = UA_DateTime_encodeBinary(&(src->timestamp), bufPos, bufEnd); /* UtcTime */
  740. if(rv != UA_STATUSCODE_GOOD)
  741. return rv;
  742. }
  743. // PicoSeconds
  744. if(src->picoSecondsIncluded) {
  745. rv = UA_UInt16_encodeBinary(&(src->picoSeconds), bufPos, bufEnd);
  746. if(rv != UA_STATUSCODE_GOOD)
  747. return rv;
  748. }
  749. // Status
  750. if(src->statusEnabled) {
  751. rv = UA_UInt16_encodeBinary(&(src->status), bufPos, bufEnd);
  752. if(rv != UA_STATUSCODE_GOOD)
  753. return rv;
  754. }
  755. // ConfigVersionMajorVersion
  756. if(src->configVersionMajorVersionEnabled) {
  757. rv = UA_UInt32_encodeBinary(&(src->configVersionMajorVersion), bufPos, bufEnd);
  758. if(rv != UA_STATUSCODE_GOOD)
  759. return rv;
  760. }
  761. // ConfigVersionMinorVersion
  762. if(src->configVersionMinorVersionEnabled) {
  763. rv = UA_UInt32_encodeBinary(&(src->configVersionMinorVersion), bufPos, bufEnd);
  764. if(rv != UA_STATUSCODE_GOOD)
  765. return rv;
  766. }
  767. retval = UA_STATUSCODE_GOOD;
  768. return retval;
  769. }
  770. UA_StatusCode
  771. UA_DataSetMessageHeader_decodeBinary(const UA_ByteString *src, size_t *offset,
  772. UA_DataSetMessageHeader* dst) {
  773. UA_StatusCode retval = UA_STATUSCODE_BADNOTIMPLEMENTED;
  774. memset(dst, 0, sizeof(UA_DataSetMessageHeader));
  775. UA_Byte v = 0;
  776. UA_StatusCode rv = UA_Byte_decodeBinary(src, offset, &v);
  777. if(rv != UA_STATUSCODE_GOOD)
  778. return rv;
  779. UA_Byte v2 = v & DS_MESSAGEHEADER_FIELD_ENCODING_MASK;
  780. v2 = (UA_Byte)(v2 >> DS_MH_SHIFT_LEN);
  781. dst->fieldEncoding = (UA_FieldEncoding)v2;
  782. if((v & DS_MESSAGEHEADER_DS_MSG_VALID) != 0)
  783. dst->dataSetMessageValid = true;
  784. if((v & DS_MESSAGEHEADER_SEQ_NR_ENABLED_MASK) != 0)
  785. dst->dataSetMessageSequenceNrEnabled = true;
  786. if((v & DS_MESSAGEHEADER_STATUS_ENABLED_MASK) != 0)
  787. dst->statusEnabled = true;
  788. if((v & DS_MESSAGEHEADER_CONFIGMAJORVERSION_ENABLED_MASK) != 0)
  789. dst->configVersionMajorVersionEnabled = true;
  790. if((v & DS_MESSAGEHEADER_CONFIGMINORVERSION_ENABLED_MASK) != 0)
  791. dst->configVersionMinorVersionEnabled = true;
  792. if((v & DS_MESSAGEHEADER_FLAGS2_ENABLED_MASK) != 0) {
  793. v = 0;
  794. rv = UA_Byte_decodeBinary(src, offset, &v);
  795. if(rv != UA_STATUSCODE_GOOD)
  796. return rv;
  797. dst->dataSetMessageType = (UA_DataSetMessageType)(v & DS_MESSAGEHEADER_DS_MESSAGE_TYPE_MASK);
  798. if((v & DS_MESSAGEHEADER_TIMESTAMP_ENABLED_MASK) != 0)
  799. dst->timestampEnabled = true;
  800. if((v & DS_MESSAGEHEADER_PICOSECONDS_INCLUDED_MASK) != 0)
  801. dst->picoSecondsIncluded = true;
  802. } else {
  803. dst->dataSetMessageType = UA_DATASETMESSAGE_DATAKEYFRAME;
  804. dst->picoSecondsIncluded = false;
  805. }
  806. if(dst->dataSetMessageSequenceNrEnabled) {
  807. rv = UA_UInt16_decodeBinary(src, offset, &dst->dataSetMessageSequenceNr);
  808. if(rv != UA_STATUSCODE_GOOD)
  809. return rv;
  810. } else {
  811. dst->dataSetMessageSequenceNr = 0;
  812. }
  813. if(dst->timestampEnabled) {
  814. rv = UA_DateTime_decodeBinary(src, offset, &dst->timestamp); /* UtcTime */
  815. if(rv != UA_STATUSCODE_GOOD)
  816. return rv;
  817. } else {
  818. dst->timestamp = 0;
  819. }
  820. if(dst->picoSecondsIncluded) {
  821. rv = UA_UInt16_decodeBinary(src, offset, &dst->picoSeconds);
  822. if(rv != UA_STATUSCODE_GOOD)
  823. return rv;
  824. } else {
  825. dst->picoSeconds = 0;
  826. }
  827. if(dst->statusEnabled) {
  828. rv = UA_UInt16_decodeBinary(src, offset, &dst->status);
  829. if(rv != UA_STATUSCODE_GOOD)
  830. return rv;
  831. } else {
  832. dst->status = 0;
  833. }
  834. if(dst->configVersionMajorVersionEnabled) {
  835. rv = UA_UInt32_decodeBinary(src, offset, &dst->configVersionMajorVersion);
  836. if(rv != UA_STATUSCODE_GOOD)
  837. return rv;
  838. } else {
  839. dst->configVersionMajorVersion = 0;
  840. }
  841. if(dst->configVersionMinorVersionEnabled) {
  842. rv = UA_UInt32_decodeBinary(src, offset, &dst->configVersionMinorVersion);
  843. if(rv != UA_STATUSCODE_GOOD)
  844. return rv;
  845. } else {
  846. dst->configVersionMinorVersion = 0;
  847. }
  848. retval = UA_STATUSCODE_GOOD;
  849. return retval;
  850. }
  851. size_t
  852. UA_DataSetMessageHeader_calcSizeBinary(const UA_DataSetMessageHeader* p) {
  853. UA_Byte byte;
  854. size_t size = UA_Byte_calcSizeBinary(&byte); // DataSetMessage Type + Flags
  855. if(UA_DataSetMessageHeader_DataSetFlags2Enabled(p))
  856. size += UA_Byte_calcSizeBinary(&byte);
  857. if(p->dataSetMessageSequenceNrEnabled)
  858. size += UA_UInt16_calcSizeBinary(&p->dataSetMessageSequenceNr);
  859. if(p->timestampEnabled)
  860. size += UA_DateTime_calcSizeBinary(&p->timestamp); /* UtcTime */
  861. if(p->picoSecondsIncluded)
  862. size += UA_UInt16_calcSizeBinary(&p->picoSeconds);
  863. if(p->statusEnabled)
  864. size += UA_UInt16_calcSizeBinary(&p->status);
  865. if(p->configVersionMajorVersionEnabled)
  866. size += UA_UInt32_calcSizeBinary(&p->configVersionMajorVersion);
  867. if(p->configVersionMinorVersionEnabled)
  868. size += UA_UInt32_calcSizeBinary(&p->configVersionMinorVersion);
  869. return size;
  870. }
  871. UA_StatusCode
  872. UA_DataSetMessage_encodeBinary(const UA_DataSetMessage* src, UA_Byte **bufPos,
  873. const UA_Byte *bufEnd) {
  874. UA_StatusCode rv = UA_DataSetMessageHeader_encodeBinary(&src->header, bufPos, bufEnd);
  875. if(rv != UA_STATUSCODE_GOOD)
  876. return rv;
  877. if(src->header.dataSetMessageType == UA_DATASETMESSAGE_DATAKEYFRAME) {
  878. if(src->header.fieldEncoding != UA_FIELDENCODING_RAWDATA) {
  879. rv = UA_UInt16_encodeBinary(&(src->data.keyFrameData.fieldCount), bufPos, bufEnd);
  880. if(rv != UA_STATUSCODE_GOOD)
  881. return rv;
  882. }
  883. if(src->header.fieldEncoding == UA_FIELDENCODING_VARIANT) {
  884. for (UA_UInt16 i = 0; i < src->data.keyFrameData.fieldCount; i++) {
  885. rv = UA_Variant_encodeBinary(&(src->data.keyFrameData.dataSetFields[i].value), bufPos, bufEnd);
  886. if(rv != UA_STATUSCODE_GOOD)
  887. return rv;
  888. }
  889. } else if(src->header.fieldEncoding == UA_FIELDENCODING_RAWDATA) {
  890. return UA_STATUSCODE_BADNOTIMPLEMENTED;
  891. } else if(src->header.fieldEncoding == UA_FIELDENCODING_DATAVALUE) {
  892. for (UA_UInt16 i = 0; i < src->data.keyFrameData.fieldCount; i++) {
  893. rv = UA_DataValue_encodeBinary(&(src->data.keyFrameData.dataSetFields[i]), bufPos, bufEnd);
  894. if(rv != UA_STATUSCODE_GOOD)
  895. return rv;
  896. }
  897. }
  898. } else if(src->header.dataSetMessageType == UA_DATASETMESSAGE_DATADELTAFRAME) {
  899. // Encode Delta Frame
  900. // Here the FieldCount is always present
  901. rv = UA_UInt16_encodeBinary(&(src->data.keyFrameData.fieldCount), bufPos, bufEnd);
  902. if(rv != UA_STATUSCODE_GOOD)
  903. return rv;
  904. if(src->header.fieldEncoding == UA_FIELDENCODING_VARIANT) {
  905. for (UA_UInt16 i = 0; i < src->data.deltaFrameData.fieldCount; i++) {
  906. rv = UA_UInt16_encodeBinary(&(src->data.deltaFrameData.deltaFrameFields[i].fieldIndex), bufPos, bufEnd);
  907. if(rv != UA_STATUSCODE_GOOD)
  908. return rv;
  909. rv = UA_Variant_encodeBinary(&(src->data.deltaFrameData.deltaFrameFields[i].fieldValue.value), bufPos, bufEnd);
  910. if(rv != UA_STATUSCODE_GOOD)
  911. return rv;
  912. }
  913. } else if(src->header.fieldEncoding == UA_FIELDENCODING_RAWDATA) {
  914. return UA_STATUSCODE_BADNOTIMPLEMENTED;
  915. } else if(src->header.fieldEncoding == UA_FIELDENCODING_DATAVALUE) {
  916. for (UA_UInt16 i = 0; i < src->data.deltaFrameData.fieldCount; i++) {
  917. rv = UA_UInt16_encodeBinary(&(src->data.deltaFrameData.deltaFrameFields[i].fieldIndex), bufPos, bufEnd);
  918. if(rv != UA_STATUSCODE_GOOD)
  919. return rv;
  920. rv = UA_DataValue_encodeBinary(&(src->data.deltaFrameData.deltaFrameFields[i].fieldValue), bufPos, bufEnd);
  921. if(rv != UA_STATUSCODE_GOOD)
  922. return rv;
  923. }
  924. }
  925. } else if(src->header.dataSetMessageType != UA_DATASETMESSAGE_KEEPALIVE) {
  926. return UA_STATUSCODE_BADNOTIMPLEMENTED;
  927. }
  928. /* Keep-Alive Message contains no Payload Data */
  929. return UA_STATUSCODE_GOOD;
  930. }
  931. UA_StatusCode
  932. UA_DataSetMessage_decodeBinary(const UA_ByteString *src, size_t *offset, UA_DataSetMessage* dst) {
  933. memset(dst, 0, sizeof(UA_DataSetMessage));
  934. UA_StatusCode rv = UA_DataSetMessageHeader_decodeBinary(src, offset, &dst->header);
  935. if(rv != UA_STATUSCODE_GOOD)
  936. return rv;
  937. if(dst->header.dataSetMessageType == UA_DATASETMESSAGE_DATAKEYFRAME) {
  938. if(dst->header.fieldEncoding != UA_FIELDENCODING_RAWDATA) {
  939. rv = UA_UInt16_decodeBinary(src, offset, &dst->data.keyFrameData.fieldCount);
  940. if(rv != UA_STATUSCODE_GOOD)
  941. return rv;
  942. if(dst->header.fieldEncoding == UA_FIELDENCODING_VARIANT) {
  943. dst->data.keyFrameData.dataSetFields =
  944. (UA_DataValue *)UA_Array_new(dst->data.keyFrameData.fieldCount, &UA_TYPES[UA_TYPES_DATAVALUE]);
  945. for (UA_UInt16 i = 0; i < dst->data.keyFrameData.fieldCount; i++) {
  946. UA_DataValue_init(&dst->data.keyFrameData.dataSetFields[i]);
  947. rv = UA_Variant_decodeBinary(src, offset, &dst->data.keyFrameData.dataSetFields[i].value);
  948. if(rv != UA_STATUSCODE_GOOD)
  949. return rv;
  950. dst->data.keyFrameData.dataSetFields[i].hasValue = true;
  951. }
  952. } else if(dst->header.fieldEncoding == UA_FIELDENCODING_RAWDATA) {
  953. return UA_STATUSCODE_BADNOTIMPLEMENTED;
  954. } else if(dst->header.fieldEncoding == UA_FIELDENCODING_DATAVALUE) {
  955. dst->data.keyFrameData.dataSetFields =
  956. (UA_DataValue *)UA_Array_new(dst->data.keyFrameData.fieldCount, &UA_TYPES[UA_TYPES_DATAVALUE]);
  957. for (UA_UInt16 i = 0; i < dst->data.keyFrameData.fieldCount; i++) {
  958. rv = UA_DataValue_decodeBinary(src, offset, &(dst->data.keyFrameData.dataSetFields[i]));
  959. if(rv != UA_STATUSCODE_GOOD)
  960. return rv;
  961. }
  962. }
  963. }
  964. } else if(dst->header.dataSetMessageType == UA_DATASETMESSAGE_DATADELTAFRAME) {
  965. if(dst->header.fieldEncoding != UA_FIELDENCODING_RAWDATA) {
  966. rv = UA_UInt16_decodeBinary(src, offset, &dst->data.deltaFrameData.fieldCount);
  967. if(rv != UA_STATUSCODE_GOOD)
  968. return rv;
  969. if(dst->header.fieldEncoding == UA_FIELDENCODING_VARIANT) {
  970. size_t memsize = sizeof(UA_DataSetMessage_DeltaFrameField) * dst->data.deltaFrameData.fieldCount;
  971. dst->data.deltaFrameData.deltaFrameFields = (UA_DataSetMessage_DeltaFrameField*)UA_malloc(memsize);
  972. for (UA_UInt16 i = 0; i < dst->data.deltaFrameData.fieldCount; i++) {
  973. rv = UA_UInt16_decodeBinary(src, offset, &dst->data.deltaFrameData.deltaFrameFields[i].fieldIndex);
  974. if(rv != UA_STATUSCODE_GOOD)
  975. return rv;
  976. UA_DataValue_init(&dst->data.deltaFrameData.deltaFrameFields[i].fieldValue);
  977. rv = UA_Variant_decodeBinary(src, offset, &dst->data.deltaFrameData.deltaFrameFields[i].fieldValue.value);
  978. if(rv != UA_STATUSCODE_GOOD)
  979. return rv;
  980. dst->data.deltaFrameData.deltaFrameFields[i].fieldValue.hasValue = true;
  981. }
  982. } else if(dst->header.fieldEncoding == UA_FIELDENCODING_RAWDATA) {
  983. return UA_STATUSCODE_BADNOTIMPLEMENTED;
  984. } else if(dst->header.fieldEncoding == UA_FIELDENCODING_DATAVALUE) {
  985. size_t memsize = sizeof(UA_DataSetMessage_DeltaFrameField) * dst->data.deltaFrameData.fieldCount;
  986. dst->data.deltaFrameData.deltaFrameFields = (UA_DataSetMessage_DeltaFrameField*)UA_malloc(memsize);
  987. for (UA_UInt16 i = 0; i < dst->data.deltaFrameData.fieldCount; i++) {
  988. rv = UA_UInt16_decodeBinary(src, offset, &dst->data.deltaFrameData.deltaFrameFields[i].fieldIndex);
  989. if(rv != UA_STATUSCODE_GOOD)
  990. return rv;
  991. rv = UA_DataValue_decodeBinary(src, offset, &(dst->data.deltaFrameData.deltaFrameFields[i].fieldValue));
  992. if(rv != UA_STATUSCODE_GOOD)
  993. return rv;
  994. }
  995. }
  996. }
  997. } else if(dst->header.dataSetMessageType != UA_DATASETMESSAGE_KEEPALIVE) {
  998. return UA_STATUSCODE_BADNOTIMPLEMENTED;
  999. }
  1000. /* Keep-Alive Message contains no Payload Data */
  1001. return UA_STATUSCODE_GOOD;
  1002. }
  1003. size_t
  1004. UA_DataSetMessage_calcSizeBinary(const UA_DataSetMessage* p) {
  1005. size_t size = UA_DataSetMessageHeader_calcSizeBinary(&p->header);
  1006. if(p->header.dataSetMessageType == UA_DATASETMESSAGE_DATAKEYFRAME) {
  1007. if(p->header.fieldEncoding != UA_FIELDENCODING_RAWDATA)
  1008. size += UA_calcSizeBinary(&p->data.keyFrameData.fieldCount, &UA_TYPES[UA_TYPES_UINT16]);
  1009. if(p->header.fieldEncoding == UA_FIELDENCODING_VARIANT) {
  1010. for (UA_UInt16 i = 0; i < p->data.keyFrameData.fieldCount; i++)
  1011. size += UA_calcSizeBinary(&p->data.keyFrameData.dataSetFields[i].value, &UA_TYPES[UA_TYPES_VARIANT]);
  1012. } else if(p->header.fieldEncoding == UA_FIELDENCODING_RAWDATA) {
  1013. // not implemented
  1014. } else if(p->header.fieldEncoding == UA_FIELDENCODING_DATAVALUE) {
  1015. for (UA_UInt16 i = 0; i < p->data.keyFrameData.fieldCount; i++)
  1016. size += UA_calcSizeBinary(&p->data.keyFrameData.dataSetFields[i], &UA_TYPES[UA_TYPES_DATAVALUE]);
  1017. }
  1018. } else if(p->header.dataSetMessageType == UA_DATASETMESSAGE_DATADELTAFRAME) {
  1019. if(p->header.fieldEncoding != UA_FIELDENCODING_RAWDATA)
  1020. size += UA_calcSizeBinary(&p->data.deltaFrameData.fieldCount, &UA_TYPES[UA_TYPES_UINT16]);
  1021. if(p->header.fieldEncoding == UA_FIELDENCODING_VARIANT) {
  1022. for (UA_UInt16 i = 0; i < p->data.deltaFrameData.fieldCount; i++) {
  1023. size += UA_calcSizeBinary(&p->data.deltaFrameData.deltaFrameFields[i].fieldIndex, &UA_TYPES[UA_TYPES_UINT16]);
  1024. size += UA_calcSizeBinary(&p->data.deltaFrameData.deltaFrameFields[i].fieldValue.value, &UA_TYPES[UA_TYPES_VARIANT]);
  1025. }
  1026. } else if(p->header.fieldEncoding == UA_FIELDENCODING_RAWDATA) {
  1027. // not implemented
  1028. } else if(p->header.fieldEncoding == UA_FIELDENCODING_DATAVALUE) {
  1029. for (UA_UInt16 i = 0; i < p->data.deltaFrameData.fieldCount; i++) {
  1030. size += UA_calcSizeBinary(&p->data.deltaFrameData.deltaFrameFields[i].fieldIndex, &UA_TYPES[UA_TYPES_UINT16]);
  1031. size += UA_calcSizeBinary(&p->data.deltaFrameData.deltaFrameFields[i].fieldValue, &UA_TYPES[UA_TYPES_DATAVALUE]);
  1032. }
  1033. }
  1034. }
  1035. /* KeepAlive-Message contains no Payload Data */
  1036. return size;
  1037. }
  1038. void UA_DataSetMessage_free(const UA_DataSetMessage* p) {
  1039. if(p->header.dataSetMessageType == UA_DATASETMESSAGE_DATAKEYFRAME) {
  1040. if(p->data.keyFrameData.dataSetFields != NULL)
  1041. UA_Array_delete(p->data.keyFrameData.dataSetFields, p->data.keyFrameData.fieldCount,
  1042. &UA_TYPES[UA_TYPES_DATAVALUE]);
  1043. /* Json keys */
  1044. if(p->data.keyFrameData.fieldNames != NULL){
  1045. UA_Array_delete(p->data.keyFrameData.fieldNames, p->data.keyFrameData.fieldCount,
  1046. &UA_TYPES[UA_TYPES_STRING]);
  1047. }
  1048. } else if(p->header.dataSetMessageType == UA_DATASETMESSAGE_DATADELTAFRAME) {
  1049. if(p->data.deltaFrameData.deltaFrameFields != NULL) {
  1050. for(UA_UInt16 i = 0; i < p->data.deltaFrameData.fieldCount; i++) {
  1051. if(p->header.fieldEncoding == UA_FIELDENCODING_DATAVALUE) {
  1052. UA_DataValue_deleteMembers(&p->data.deltaFrameData.deltaFrameFields[i].fieldValue);
  1053. } else if(p->header.fieldEncoding == UA_FIELDENCODING_VARIANT) {
  1054. UA_Variant_deleteMembers(&p->data.deltaFrameData.deltaFrameFields[i].fieldValue.value);
  1055. }
  1056. }
  1057. UA_free(p->data.deltaFrameData.deltaFrameFields);
  1058. }
  1059. }
  1060. }
  1061. #endif /* UA_ENABLE_PUBSUB */