ua_client_highlevel.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304
  1. #ifndef UA_CLIENT_HIGHLEVEL_H_
  2. #define UA_CLIENT_HIGHLEVEL_H_
  3. #ifdef __cplusplus
  4. extern "C" {
  5. #endif
  6. #include "ua_client.h"
  7. /**
  8. * Get the namespace-index of a namespace-URI
  9. *
  10. * @param client The UA_Client struct for this connection
  11. * @param namespaceUri The interested namespace URI
  12. * @param namespaceIndex The namespace index of the URI. The value is unchanged in case of an error
  13. * @return Indicates whether the operation succeeded or returns an error code
  14. */
  15. UA_StatusCode UA_EXPORT UA_Client_NamespaceGetIndex(UA_Client *client, UA_String *namespaceUri, UA_UInt16 *namespaceIndex);
  16. /* Iterate over all nodes referenced by parentNodeId by calling the callback
  17. f unction for each child node */
  18. typedef UA_StatusCode (*UA_NodeIteratorCallback)(UA_NodeId childId, UA_Boolean isInverse,
  19. UA_NodeId referenceTypeId, void *handle);
  20. UA_StatusCode UA_EXPORT UA_Client_forEachChildNodeCall(UA_Client *client, UA_NodeId parentNodeId, UA_NodeIteratorCallback callback, void *handle) ;
  21. /*******************/
  22. /* Node Management */
  23. /*******************/
  24. UA_StatusCode UA_EXPORT
  25. UA_Client_addReference(UA_Client *client, const UA_NodeId sourceNodeId, const UA_NodeId referenceTypeId,
  26. UA_Boolean isForward, const UA_String targetServerUri,
  27. const UA_ExpandedNodeId targetNodeId, UA_NodeClass targetNodeClass);
  28. UA_StatusCode UA_EXPORT
  29. UA_Client_deleteReference(UA_Client *client, const UA_NodeId sourceNodeId, const UA_NodeId referenceTypeId,
  30. UA_Boolean isForward, const UA_ExpandedNodeId targetNodeId,
  31. UA_Boolean deleteBidirectional);
  32. UA_StatusCode UA_EXPORT
  33. UA_Client_deleteNode(UA_Client *client, const UA_NodeId nodeId, UA_Boolean deleteTargetReferences);
  34. /* Don't call this function, use the typed versions */
  35. UA_StatusCode UA_EXPORT
  36. __UA_Client_addNode(UA_Client *client, const UA_NodeClass nodeClass,
  37. const UA_NodeId requestedNewNodeId, const UA_NodeId parentNodeId,
  38. const UA_NodeId referenceTypeId, const UA_QualifiedName browseName,
  39. const UA_NodeId typeDefinition, const UA_NodeAttributes *attr,
  40. const UA_DataType *attributeType, UA_NodeId *outNewNodeId);
  41. static UA_INLINE UA_StatusCode
  42. UA_Client_addVariableNode(UA_Client *client, const UA_NodeId requestedNewNodeId,
  43. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  44. const UA_QualifiedName browseName, const UA_NodeId typeDefinition,
  45. const UA_VariableAttributes attr, UA_NodeId *outNewNodeId) {
  46. return __UA_Client_addNode(client, UA_NODECLASS_VARIABLE, requestedNewNodeId,
  47. parentNodeId, referenceTypeId, browseName, typeDefinition,
  48. (const UA_NodeAttributes*)&attr, &UA_TYPES[UA_TYPES_VARIABLEATTRIBUTES],
  49. outNewNodeId); }
  50. static UA_INLINE UA_StatusCode
  51. UA_Client_addVariableTypeNode(UA_Client *client, const UA_NodeId requestedNewNodeId,
  52. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  53. const UA_QualifiedName browseName, const UA_VariableTypeAttributes attr,
  54. UA_NodeId *outNewNodeId) {
  55. return __UA_Client_addNode(client, UA_NODECLASS_VARIABLETYPE, requestedNewNodeId,
  56. parentNodeId, referenceTypeId, browseName, UA_NODEID_NULL,
  57. (const UA_NodeAttributes*)&attr, &UA_TYPES[UA_TYPES_VARIABLETYPEATTRIBUTES],
  58. outNewNodeId); }
  59. static UA_INLINE UA_StatusCode
  60. UA_Client_addObjectNode(UA_Client *client, const UA_NodeId requestedNewNodeId,
  61. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  62. const UA_QualifiedName browseName, const UA_NodeId typeDefinition,
  63. const UA_ObjectAttributes attr, UA_NodeId *outNewNodeId) {
  64. return __UA_Client_addNode(client, UA_NODECLASS_OBJECT, requestedNewNodeId,
  65. parentNodeId, referenceTypeId, browseName, typeDefinition,
  66. (const UA_NodeAttributes*)&attr, &UA_TYPES[UA_TYPES_OBJECTATTRIBUTES],
  67. outNewNodeId); }
  68. static UA_INLINE UA_StatusCode
  69. UA_Client_addObjectTypeNode(UA_Client *client, const UA_NodeId requestedNewNodeId,
  70. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  71. const UA_QualifiedName browseName, const UA_ObjectTypeAttributes attr,
  72. UA_NodeId *outNewNodeId) {
  73. return __UA_Client_addNode(client, UA_NODECLASS_OBJECTTYPE, requestedNewNodeId,
  74. parentNodeId, referenceTypeId, browseName, UA_NODEID_NULL,
  75. (const UA_NodeAttributes*)&attr, &UA_TYPES[UA_TYPES_OBJECTTYPEATTRIBUTES],
  76. outNewNodeId); }
  77. static UA_INLINE UA_StatusCode
  78. UA_Client_addViewNode(UA_Client *client, const UA_NodeId requestedNewNodeId,
  79. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  80. const UA_QualifiedName browseName, const UA_ViewAttributes attr,
  81. UA_NodeId *outNewNodeId) {
  82. return __UA_Client_addNode(client, UA_NODECLASS_VIEW, requestedNewNodeId,
  83. parentNodeId, referenceTypeId, browseName, UA_NODEID_NULL,
  84. (const UA_NodeAttributes*)&attr, &UA_TYPES[UA_TYPES_VIEWATTRIBUTES],
  85. outNewNodeId); }
  86. static UA_INLINE UA_StatusCode
  87. UA_Client_addReferenceTypeNode(UA_Client *client, const UA_NodeId requestedNewNodeId,
  88. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  89. const UA_QualifiedName browseName, const UA_ReferenceTypeAttributes attr,
  90. UA_NodeId *outNewNodeId) {
  91. return __UA_Client_addNode(client, UA_NODECLASS_REFERENCETYPE, requestedNewNodeId,
  92. parentNodeId, referenceTypeId, browseName, UA_NODEID_NULL,
  93. (const UA_NodeAttributes*)&attr, &UA_TYPES[UA_TYPES_REFERENCETYPEATTRIBUTES],
  94. outNewNodeId); }
  95. static UA_INLINE UA_StatusCode
  96. UA_Client_addDataTypeNode(UA_Client *client, const UA_NodeId requestedNewNodeId,
  97. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  98. const UA_QualifiedName browseName, const UA_DataTypeAttributes attr,
  99. UA_NodeId *outNewNodeId) {
  100. return __UA_Client_addNode(client, UA_NODECLASS_DATATYPE, requestedNewNodeId,
  101. parentNodeId, referenceTypeId, browseName, UA_NODEID_NULL,
  102. (const UA_NodeAttributes*)&attr, &UA_TYPES[UA_TYPES_DATATYPEATTRIBUTES],
  103. outNewNodeId); }
  104. static UA_INLINE UA_StatusCode
  105. UA_Client_addMethodNode(UA_Client *client, const UA_NodeId requestedNewNodeId,
  106. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  107. const UA_QualifiedName browseName, const UA_MethodAttributes attr,
  108. UA_NodeId *outNewNodeId) {
  109. return __UA_Client_addNode(client, UA_NODECLASS_METHOD, requestedNewNodeId,
  110. parentNodeId, referenceTypeId, browseName, UA_NODEID_NULL,
  111. (const UA_NodeAttributes*)&attr, &UA_TYPES[UA_TYPES_METHODATTRIBUTES],
  112. outNewNodeId); }
  113. /*************************/
  114. /* Attribute Service Set */
  115. /*************************/
  116. /* Don't use this function. There are typed versions for every supported attribute. */
  117. UA_StatusCode UA_EXPORT
  118. __UA_Client_readAttribute(UA_Client *client, UA_NodeId nodeId, UA_AttributeId attributeId,
  119. void *out, const UA_DataType *outDataType);
  120. static UA_INLINE UA_StatusCode
  121. UA_Client_readNodeIdAttribute(UA_Client *client, UA_NodeId nodeId, UA_NodeId *outNodeId) {
  122. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_NODEID,
  123. outNodeId, &UA_TYPES[UA_TYPES_NODEID]); }
  124. static UA_INLINE UA_StatusCode
  125. UA_Client_readNodeClassAttribute(UA_Client *client, UA_NodeId nodeId, UA_NodeClass *outNodeClass) {
  126. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_NODECLASS,
  127. outNodeClass, &UA_TYPES[UA_TYPES_NODECLASS]); }
  128. static UA_INLINE UA_StatusCode
  129. UA_Client_readBrowseNameAttribute(UA_Client *client, UA_NodeId nodeId, UA_QualifiedName *outBrowseName) {
  130. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_BROWSENAME,
  131. outBrowseName, &UA_TYPES[UA_TYPES_QUALIFIEDNAME]); }
  132. static UA_INLINE UA_StatusCode
  133. UA_Client_readDisplayNameAttribute(UA_Client *client, UA_NodeId nodeId, UA_LocalizedText *outDisplayName) {
  134. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_DISPLAYNAME,
  135. outDisplayName, &UA_TYPES[UA_TYPES_LOCALIZEDTEXT]); }
  136. static UA_INLINE UA_StatusCode
  137. UA_Client_readDescriptionAttribute(UA_Client *client, UA_NodeId nodeId, UA_LocalizedText *outDescription) {
  138. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_DESCRIPTION,
  139. outDescription, &UA_TYPES[UA_TYPES_LOCALIZEDTEXT]); }
  140. static UA_INLINE UA_StatusCode
  141. UA_Client_readWriteMaskAttribute(UA_Client *client, UA_NodeId nodeId, UA_UInt32 *outWriteMask) {
  142. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_WRITEMASK,
  143. outWriteMask, &UA_TYPES[UA_TYPES_UINT32]); }
  144. static UA_INLINE UA_StatusCode
  145. UA_Client_readUserWriteMaskAttribute(UA_Client *client, UA_NodeId nodeId, UA_UInt32 *outUserWriteMask) {
  146. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_USERWRITEMASK,
  147. outUserWriteMask, &UA_TYPES[UA_TYPES_UINT32]); }
  148. static UA_INLINE UA_StatusCode
  149. UA_Client_readIsAbstractAttribute(UA_Client *client, UA_NodeId nodeId, UA_Boolean *outIsAbstract) {
  150. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_ISABSTRACT,
  151. outIsAbstract, &UA_TYPES[UA_TYPES_BOOLEAN]); }
  152. static UA_INLINE UA_StatusCode
  153. UA_Client_readSymmetricAttribute(UA_Client *client, UA_NodeId nodeId, UA_Boolean *outSymmetric) {
  154. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_SYMMETRIC,
  155. outSymmetric, &UA_TYPES[UA_TYPES_BOOLEAN]); }
  156. static UA_INLINE UA_StatusCode
  157. UA_Client_readInverseNameAttribute(UA_Client *client, UA_NodeId nodeId, UA_LocalizedText *outInverseName) {
  158. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_INVERSENAME,
  159. outInverseName, &UA_TYPES[UA_TYPES_LOCALIZEDTEXT]); }
  160. static UA_INLINE UA_StatusCode
  161. UA_Client_readContainsNoLoopsAttribute(UA_Client *client, UA_NodeId nodeId, UA_Boolean *outContainsNoLoops) {
  162. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_CONTAINSNOLOOPS,
  163. outContainsNoLoops, &UA_TYPES[UA_TYPES_BOOLEAN]); }
  164. static UA_INLINE UA_StatusCode
  165. UA_Client_readEventNotifierAttribute(UA_Client *client, UA_NodeId nodeId, UA_Byte *outEventNotifier) {
  166. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_EVENTNOTIFIER,
  167. outEventNotifier, &UA_TYPES[UA_TYPES_BYTE]); }
  168. static UA_INLINE UA_StatusCode
  169. UA_Client_readValueAttribute(UA_Client *client, UA_NodeId nodeId, UA_Variant *outValue) {
  170. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_VALUE,
  171. outValue, &UA_TYPES[UA_TYPES_VARIANT]); }
  172. static UA_INLINE UA_StatusCode
  173. UA_Client_readDataTypeAttribute(UA_Client *client, UA_NodeId nodeId, UA_NodeId *outDataType) {
  174. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_DATATYPE,
  175. outDataType, &UA_TYPES[UA_TYPES_NODEID]); }
  176. static UA_INLINE UA_StatusCode
  177. UA_Client_readValueRankAttribute(UA_Client *client, UA_NodeId nodeId, UA_Int32 *outValueRank) {
  178. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_VALUERANK,
  179. outValueRank, &UA_TYPES[UA_TYPES_INT32]); }
  180. // todo: fetch an array
  181. static UA_INLINE UA_StatusCode
  182. UA_Client_readArrayDimensionsAttribute(UA_Client *client, UA_NodeId nodeId, UA_Int32 *outArrayDimensions) {
  183. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_ARRAYDIMENSIONS,
  184. outArrayDimensions, &UA_TYPES[UA_TYPES_INT32]); }
  185. static UA_INLINE UA_StatusCode
  186. UA_Client_readAccessLevelAttribute(UA_Client *client, UA_NodeId nodeId, UA_UInt32 *outAccessLevel) {
  187. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_ACCESSLEVEL,
  188. outAccessLevel, &UA_TYPES[UA_TYPES_UINT32]); }
  189. static UA_INLINE UA_StatusCode
  190. UA_Client_readUserAccessLevelAttribute(UA_Client *client, UA_NodeId nodeId, UA_UInt32 *outUserAccessLevel) {
  191. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_USERACCESSLEVEL,
  192. outUserAccessLevel, &UA_TYPES[UA_TYPES_UINT32]); }
  193. static UA_INLINE UA_StatusCode
  194. UA_Client_readMinimumSamplingIntervalAttribute(UA_Client *client, UA_NodeId nodeId,
  195. UA_Double *outMinimumSamplingInterval) {
  196. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_MINIMUMSAMPLINGINTERVAL,
  197. outMinimumSamplingInterval, &UA_TYPES[UA_TYPES_DOUBLE]); }
  198. static UA_INLINE UA_StatusCode
  199. UA_Client_readHistorizingAttribute(UA_Client *client, UA_NodeId nodeId, UA_Boolean *outHistorizing) {
  200. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_HISTORIZING,
  201. outHistorizing, &UA_TYPES[UA_TYPES_BOOLEAN]); }
  202. static UA_INLINE UA_StatusCode
  203. UA_Client_readExecutableAttribute(UA_Client *client, UA_NodeId nodeId, UA_Boolean *outExecutable) {
  204. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_EXECUTABLE,
  205. outExecutable, &UA_TYPES[UA_TYPES_BOOLEAN]); }
  206. static UA_INLINE UA_StatusCode
  207. UA_Client_readUserExecutableAttribute(UA_Client *client, UA_NodeId nodeId, UA_Boolean *outUserExecutable) {
  208. return __UA_Client_readAttribute(client, nodeId, UA_ATTRIBUTEID_USEREXECUTABLE,
  209. outUserExecutable, &UA_TYPES[UA_TYPES_BOOLEAN]); }
  210. /**********************/
  211. /* Method Service Set */
  212. /**********************/
  213. UA_StatusCode UA_EXPORT
  214. UA_Client_call(UA_Client *client, const UA_NodeId objectId, const UA_NodeId methodId,
  215. size_t inputSize, const UA_Variant *input, size_t *outputSize, UA_Variant **output);
  216. /**************************/
  217. /* Subscriptions Handling */
  218. /**************************/
  219. #ifdef UA_ENABLE_SUBSCRIPTIONS
  220. typedef struct {
  221. UA_Double requestedPublishingInterval;
  222. UA_UInt32 requestedLifetimeCount;
  223. UA_UInt32 requestedMaxKeepAliveCount;
  224. UA_UInt32 maxNotificationsPerPublish;
  225. UA_Boolean publishingEnabled;
  226. UA_Byte priority;
  227. } UA_SubscriptionSettings;
  228. extern const UA_EXPORT UA_SubscriptionSettings UA_SubscriptionSettings_standard;
  229. UA_StatusCode UA_EXPORT
  230. UA_Client_Subscriptions_new(UA_Client *client, UA_SubscriptionSettings settings,
  231. UA_UInt32 *newSubscriptionId);
  232. UA_StatusCode UA_EXPORT
  233. UA_Client_Subscriptions_remove(UA_Client *client, UA_UInt32 subscriptionId);
  234. UA_StatusCode UA_EXPORT UA_Client_Subscriptions_manuallySendPublishRequest(UA_Client *client);
  235. UA_StatusCode UA_EXPORT
  236. UA_Client_Subscriptions_addMonitoredItem(UA_Client *client, UA_UInt32 subscriptionId,
  237. UA_NodeId nodeId, UA_UInt32 attributeID,
  238. void (*handlingFunction)(UA_UInt32 handle, UA_DataValue *value, void *context),
  239. void *handlingContext,
  240. UA_UInt32 *newMonitoredItemId);
  241. UA_StatusCode UA_EXPORT
  242. UA_Client_Subscriptions_removeMonitoredItem(UA_Client *client, UA_UInt32 subscriptionId,
  243. UA_UInt32 monitoredItemId);
  244. #endif
  245. #ifdef __cplusplus
  246. } // extern "C"
  247. #endif
  248. #endif /* UA_CLIENT_HIGHLEVEL_H_ */