ua_pubsub.h 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260
  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: Andreas Ebner)
  6. * Copyright (c) 2019 Kalycito Infotech Private Limited
  7. */
  8. #ifndef UA_PUBSUB_H_
  9. #define UA_PUBSUB_H_
  10. #include <open62541/plugin/pubsub.h>
  11. #include <open62541/server.h>
  12. #include <open62541/server_pubsub.h>
  13. #include "open62541_queue.h"
  14. #include "ua_pubsub_networkmessage.h"
  15. _UA_BEGIN_DECLS
  16. #ifdef UA_ENABLE_PUBSUB /* conditional compilation */
  17. /* forward declarations */
  18. struct UA_WriterGroup;
  19. typedef struct UA_WriterGroup UA_WriterGroup;
  20. /* Declaration for ReaderGroup */
  21. struct UA_ReaderGroup;
  22. typedef struct UA_ReaderGroup UA_ReaderGroup;
  23. /* The configuration structs (public part of PubSub entities) are defined in include/ua_plugin_pubsub.h */
  24. /**********************************************/
  25. /* PublishedDataSet */
  26. /**********************************************/
  27. typedef struct UA_PublishedDataSet{
  28. UA_PublishedDataSetConfig config;
  29. UA_DataSetMetaDataType dataSetMetaData;
  30. TAILQ_HEAD(UA_ListOfDataSetField, UA_DataSetField) fields;
  31. UA_NodeId identifier;
  32. UA_UInt16 fieldSize;
  33. UA_UInt16 promotedFieldsCount;
  34. UA_UInt16 configurationFreezeCounter;
  35. TAILQ_ENTRY(UA_PublishedDataSet) listEntry;
  36. } UA_PublishedDataSet;
  37. UA_StatusCode
  38. UA_PublishedDataSetConfig_copy(const UA_PublishedDataSetConfig *src, UA_PublishedDataSetConfig *dst);
  39. UA_PublishedDataSet *
  40. UA_PublishedDataSet_findPDSbyId(UA_Server *server, UA_NodeId identifier);
  41. void
  42. UA_PublishedDataSet_clear(UA_Server *server, UA_PublishedDataSet *publishedDataSet);
  43. /**********************************************/
  44. /* Connection */
  45. /**********************************************/
  46. //the connection config (public part of connection) object is defined in include/ua_plugin_pubsub.h
  47. typedef struct UA_PubSubConnection{
  48. UA_PubSubConnectionConfig *config;
  49. //internal fields
  50. UA_PubSubChannel *channel;
  51. UA_NodeId identifier;
  52. LIST_HEAD(UA_ListOfWriterGroup, UA_WriterGroup) writerGroups;
  53. LIST_HEAD(UA_ListOfPubSubReaderGroup, UA_ReaderGroup) readerGroups;
  54. size_t readerGroupsSize;
  55. TAILQ_ENTRY(UA_PubSubConnection) listEntry;
  56. UA_UInt16 configurationFreezeCounter;
  57. } UA_PubSubConnection;
  58. UA_StatusCode
  59. UA_PubSubConnectionConfig_copy(const UA_PubSubConnectionConfig *src, UA_PubSubConnectionConfig *dst);
  60. UA_PubSubConnection *
  61. UA_PubSubConnection_findConnectionbyId(UA_Server *server, UA_NodeId connectionIdentifier);
  62. void
  63. UA_PubSubConnectionConfig_clear(UA_PubSubConnectionConfig *connectionConfig);
  64. void
  65. UA_PubSubConnection_clear(UA_Server *server, UA_PubSubConnection *connection);
  66. /* Register channel for given connectionIdentifier */
  67. UA_StatusCode
  68. UA_PubSubConnection_regist(UA_Server *server, UA_NodeId *connectionIdentifier);
  69. /**********************************************/
  70. /* DataSetWriter */
  71. /**********************************************/
  72. #ifdef UA_ENABLE_PUBSUB_DELTAFRAMES
  73. typedef struct UA_DataSetWriterSample{
  74. UA_Boolean valueChanged;
  75. UA_DataValue value;
  76. } UA_DataSetWriterSample;
  77. #endif
  78. typedef struct UA_DataSetWriter{
  79. UA_DataSetWriterConfig config;
  80. //internal fields
  81. LIST_ENTRY(UA_DataSetWriter) listEntry;
  82. UA_NodeId identifier;
  83. UA_NodeId linkedWriterGroup;
  84. UA_NodeId connectedDataSet;
  85. UA_ConfigurationVersionDataType connectedDataSetVersion;
  86. UA_PubSubState state;
  87. #ifdef UA_ENABLE_PUBSUB_DELTAFRAMES
  88. UA_UInt16 deltaFrameCounter; //actual count of sent deltaFrames
  89. size_t lastSamplesCount;
  90. UA_DataSetWriterSample *lastSamples;
  91. #endif
  92. UA_UInt16 actualDataSetMessageSequenceCount;
  93. } UA_DataSetWriter;
  94. UA_StatusCode
  95. UA_DataSetWriterConfig_copy(const UA_DataSetWriterConfig *src, UA_DataSetWriterConfig *dst);
  96. UA_DataSetWriter *
  97. UA_DataSetWriter_findDSWbyId(UA_Server *server, UA_NodeId identifier);
  98. UA_StatusCode
  99. UA_DataSetWriter_setPubSubState(UA_Server *server, UA_PubSubState state, UA_DataSetWriter *dataSetWriter);
  100. /**********************************************/
  101. /* Network Message Offsets */
  102. /**********************************************/
  103. /**********************************************/
  104. /* WriterGroup */
  105. /**********************************************/
  106. struct UA_WriterGroup{
  107. UA_WriterGroupConfig config;
  108. //internal fields
  109. LIST_ENTRY(UA_WriterGroup) listEntry;
  110. UA_NodeId identifier;
  111. UA_NodeId linkedConnection;
  112. UA_PubSubConnection *linkedConnectionPtr;
  113. LIST_HEAD(UA_ListOfDataSetWriter, UA_DataSetWriter) writers;
  114. UA_UInt32 writersCount;
  115. UA_UInt64 publishCallbackId;
  116. UA_Boolean publishCallbackIsRegistered;
  117. UA_PubSubState state;
  118. UA_NetworkMessageOffsetBuffer bufferedMessage;
  119. UA_UInt16 sequenceNumber;
  120. };
  121. UA_StatusCode
  122. UA_WriterGroupConfig_copy(const UA_WriterGroupConfig *src, UA_WriterGroupConfig *dst);
  123. UA_WriterGroup *
  124. UA_WriterGroup_findWGbyId(UA_Server *server, UA_NodeId identifier);
  125. UA_StatusCode
  126. UA_WriterGroup_setPubSubState(UA_Server *server, UA_PubSubState state, UA_WriterGroup *writerGroup);
  127. /**********************************************/
  128. /* DataSetField */
  129. /**********************************************/
  130. typedef struct UA_DataSetField{
  131. UA_DataSetFieldConfig config;
  132. //internal fields
  133. TAILQ_ENTRY(UA_DataSetField) listEntry;
  134. UA_NodeId identifier;
  135. UA_NodeId publishedDataSet; //ref to parent pds
  136. UA_FieldMetaData fieldMetaData;
  137. UA_UInt64 sampleCallbackId;
  138. UA_Boolean sampleCallbackIsRegistered;
  139. } UA_DataSetField;
  140. UA_StatusCode
  141. UA_DataSetFieldConfig_copy(const UA_DataSetFieldConfig *src, UA_DataSetFieldConfig *dst);
  142. UA_DataSetField *
  143. UA_DataSetField_findDSFbyId(UA_Server *server, UA_NodeId identifier);
  144. /**********************************************/
  145. /* DataSetReader */
  146. /**********************************************/
  147. /* SubscribedDataSetDataType Definition */
  148. typedef enum {
  149. UA_PUBSUB_SDS_TARGET,
  150. UA_PUBSUB_SDS_MIRROR
  151. }UA_SubscribedDataSetEnumType;
  152. /* DataSetReader Type definition */
  153. typedef struct UA_DataSetReader {
  154. UA_DataSetReaderConfig config;
  155. /* implementation defined fields */
  156. UA_NodeId identifier;
  157. UA_NodeId linkedReaderGroup;
  158. LIST_ENTRY(UA_DataSetReader) listEntry;
  159. UA_SubscribedDataSetEnumType subscribedDataSetType;
  160. UA_TargetVariablesDataType subscribedDataSetTarget;
  161. /* To Do UA_SubscribedDataSetMirrorDataType subscribedDataSetMirror */
  162. }UA_DataSetReader;
  163. /* Delete DataSetReader */
  164. void UA_DataSetReader_delete(UA_Server *server, UA_DataSetReader *dataSetReader);
  165. /* Process Network Message using DataSetReader */
  166. void UA_Server_DataSetReader_process(UA_Server *server, UA_DataSetReader *dataSetReader, UA_DataSetMessage* dataSetMsg);
  167. /* Copy the configuration of DataSetReader */
  168. UA_StatusCode UA_DataSetReaderConfig_copy(const UA_DataSetReaderConfig *src, UA_DataSetReaderConfig *dst);
  169. /* Add TargetVariables */
  170. UA_StatusCode
  171. UA_Server_DataSetReader_addTargetVariables(UA_Server* server, UA_NodeId* parentNode, UA_NodeId dataSetReaderIdentifier, UA_SubscribedDataSetEnumType sdsType);
  172. /**********************************************/
  173. /* ReaderGroup */
  174. /**********************************************/
  175. /* ReaderGroup Type Definition*/
  176. struct UA_ReaderGroup {
  177. UA_ReaderGroupConfig config;
  178. UA_NodeId identifier;
  179. UA_NodeId linkedConnection;
  180. LIST_ENTRY(UA_ReaderGroup) listEntry;
  181. LIST_HEAD(UA_ListOfPubSubDataSetReader, UA_DataSetReader) readers;
  182. /* for simplified information access */
  183. UA_UInt32 readersCount;
  184. UA_UInt64 subscribeCallbackId;
  185. UA_Boolean subscribeCallbackIsRegistered;
  186. };
  187. /* Delete ReaderGroup */
  188. void UA_Server_ReaderGroup_delete(UA_Server *server, UA_ReaderGroup *readerGroup);
  189. /* Copy configuration of ReaderGroup */
  190. UA_StatusCode
  191. UA_ReaderGroupConfig_copy(const UA_ReaderGroupConfig *src, UA_ReaderGroupConfig *dst);
  192. /* Process Network Message */
  193. UA_StatusCode
  194. UA_Server_processNetworkMessage(UA_Server *server, UA_NetworkMessage* pMsg, UA_PubSubConnection *pConnection);
  195. /* Prototypes for internal util functions - some functions maybe removed later
  196. *(currently moved from public to internal)*/
  197. UA_ReaderGroup *UA_ReaderGroup_findRGbyId(UA_Server *server, UA_NodeId identifier);
  198. UA_DataSetReader *UA_ReaderGroup_findDSRbyId(UA_Server *server, UA_NodeId identifier);
  199. /*********************************************************/
  200. /* PublishValues handling */
  201. /*********************************************************/
  202. UA_StatusCode
  203. UA_WriterGroup_addPublishCallback(UA_Server *server, UA_WriterGroup *writerGroup);
  204. void
  205. UA_WriterGroup_publishCallback(UA_Server *server, UA_WriterGroup *writerGroup);
  206. /*********************************************************/
  207. /* SubscribeValues handling */
  208. /*********************************************************/
  209. UA_StatusCode
  210. UA_ReaderGroup_addSubscribeCallback(UA_Server *server, UA_ReaderGroup *readerGroup);
  211. void
  212. UA_ReaderGroup_subscribeCallback(UA_Server *server, UA_ReaderGroup *readerGroup);
  213. #endif /* UA_ENABLE_PUBSUB */
  214. _UA_END_DECLS
  215. #endif /* UA_PUBSUB_H_ */