ua_server.h 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516
  1. /*
  2. * Copyright (C) 2014 the contributors as stated in the AUTHORS file
  3. *
  4. * This file is part of open62541. open62541 is free software: you can
  5. * redistribute it and/or modify it under the terms of the GNU Lesser General
  6. * Public License, version 3 (as published by the Free Software Foundation) with
  7. * a static linking exception as stated in the LICENSE file provided with
  8. * open62541.
  9. *
  10. * open62541 is distributed in the hope that it will be useful, but WITHOUT ANY
  11. * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  12. * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
  13. * details.
  14. */
  15. #ifndef UA_SERVER_H_
  16. #define UA_SERVER_H_
  17. #ifdef __cplusplus
  18. extern "C" {
  19. #endif
  20. #include "ua_config.h"
  21. #include "ua_types.h"
  22. #include "ua_types_generated.h"
  23. #include "ua_nodeids.h"
  24. #include "ua_log.h"
  25. #include "ua_job.h"
  26. #include "ua_connection.h"
  27. /*********************************/
  28. /* Initialize and run the server */
  29. /*********************************/
  30. typedef struct UA_ServerConfig {
  31. UA_Boolean Login_enableAnonymous;
  32. UA_Boolean Login_enableUsernamePassword;
  33. char** Login_usernames;
  34. char** Login_passwords;
  35. UA_UInt32 Login_loginsCount;
  36. char* Application_applicationURI;
  37. char* Application_applicationName;
  38. } UA_ServerConfig;
  39. extern UA_EXPORT const UA_ServerConfig UA_ServerConfig_standard;
  40. UA_Server UA_EXPORT * UA_Server_new(UA_ServerConfig config);
  41. void UA_EXPORT UA_Server_setServerCertificate(UA_Server *server, UA_ByteString certificate);
  42. void UA_EXPORT UA_Server_delete(UA_Server *server);
  43. /** Sets the logger used by the server */
  44. void UA_EXPORT UA_Server_setLogger(UA_Server *server, UA_Logger logger);
  45. /**
  46. * Runs the main loop of the server. In each iteration, this calls into the networklayers to see if
  47. * jobs have arrived and checks if repeated jobs need to be triggered.
  48. *
  49. * @param server The server object
  50. * @param nThreads The number of worker threads. Is ignored if MULTITHREADING is not activated.
  51. * @param running Points to a boolean value on the heap. When running is set to false, the worker
  52. * threads and the main loop close and the server is shut down.
  53. * @return Indicates whether the server shut down cleanly
  54. */
  55. UA_StatusCode UA_EXPORT UA_Server_run(UA_Server *server, UA_UInt16 nThreads, UA_Boolean *running);
  56. /** The prologue part of UA_Server_run (no need to use if you call UA_Server_run) */
  57. UA_StatusCode UA_EXPORT UA_Server_run_startup(UA_Server *server, UA_UInt16 nThreads, UA_Boolean *running);
  58. /** The epilogue part of UA_Server_run (no need to use if you call UA_Server_run) */
  59. UA_StatusCode UA_EXPORT UA_Server_run_shutdown(UA_Server *server, UA_UInt16 nThreads);
  60. /** One iteration of UA_Server_run (no need to use if you call UA_Server_run) */
  61. UA_StatusCode UA_EXPORT UA_Server_run_mainloop(UA_Server *server, UA_Boolean *running);
  62. /**
  63. * @param server The server object.
  64. * @param job The job that shall be added.
  65. * @param interval The job shall be repeatedly executed with the given interval (in ms). The
  66. * interval must be larger than 5ms. The first execution occurs at now() + interval at the
  67. * latest.
  68. * @param jobId Set to the guid of the repeated job. This can be used to cancel the job later on. If
  69. * the pointer is null, the guid is not set.
  70. * @return Upon success, UA_STATUSCODE_GOOD is returned. An error code otherwise.
  71. */
  72. UA_StatusCode UA_EXPORT UA_Server_addRepeatedJob(UA_Server *server, UA_Job job,
  73. UA_UInt32 interval, UA_Guid *jobId);
  74. /**
  75. * Remove repeated job. The entry will be removed asynchronously during the next iteration of the
  76. * server main loop.
  77. *
  78. * @param server The server object.
  79. * @param jobId The id of the job that shall be removed.
  80. * @return Upon sucess, UA_STATUSCODE_GOOD is returned. An error code otherwise.
  81. */
  82. UA_StatusCode UA_EXPORT UA_Server_removeRepeatedJob(UA_Server *server, UA_Guid jobId);
  83. /**
  84. * Interface to the binary network layers. This structure is returned from the
  85. * function that initializes the network layer. The layer is already bound to a
  86. * specific port and listening. The functions in the structure are never called
  87. * in parallel but only sequentially from the server's main loop. So the network
  88. * layer does not need to be thread-safe.
  89. */
  90. typedef struct UA_ServerNetworkLayer {
  91. UA_String discoveryUrl;
  92. UA_Logger logger; ///< Set during _start
  93. /**
  94. * Starts listening on the the networklayer.
  95. *
  96. * @param nl The network layer
  97. * @param logger The logger
  98. * @return Returns UA_STATUSCODE_GOOD or an error code.
  99. */
  100. UA_StatusCode (*start)(struct UA_ServerNetworkLayer *nl, UA_Logger logger);
  101. /**
  102. * Gets called from the main server loop and returns the jobs (accumulated messages and close
  103. * events) for dispatch.
  104. *
  105. * @param nl The network layer
  106. * @param jobs When the returned integer is >0, *jobs points to an array of UA_Job of the
  107. * returned size.
  108. * @param timeout The timeout during which an event must arrive in microseconds
  109. * @return The size of the jobs array. If the result is negative, an error has occurred.
  110. */
  111. size_t (*getJobs)(struct UA_ServerNetworkLayer *nl, UA_Job **jobs, UA_UInt16 timeout);
  112. /**
  113. * Closes the network connection and returns all the jobs that need to be finished before the
  114. * network layer can be safely deleted.
  115. *
  116. * @param nl The network layer
  117. * @param jobs When the returned integer is >0, jobs points to an array of UA_Job of the
  118. * returned size.
  119. * @return The size of the jobs array. If the result is negative, an error has occurred.
  120. */
  121. size_t (*stop)(struct UA_ServerNetworkLayer *nl, UA_Job **jobs);
  122. /** Deletes the network layer. Call only after a successful shutdown. */
  123. void (*deleteMembers)(struct UA_ServerNetworkLayer *nl);
  124. } UA_ServerNetworkLayer;
  125. /**
  126. * Adds a network layer to the server. The network layer is destroyed together
  127. * with the server. Do not use it after adding it as it might be moved around on
  128. * the heap.
  129. */
  130. void UA_EXPORT UA_Server_addNetworkLayer(UA_Server *server, UA_ServerNetworkLayer *networkLayer);
  131. /** @brief Add a new namespace to the server. Returns the index of the new namespace */
  132. UA_UInt16 UA_EXPORT UA_Server_addNamespace(UA_Server *server, const char* name);
  133. /**********************/
  134. /* Set Node Callbacks */
  135. /**********************/
  136. /**
  137. * Datasources are the interface to local data providers. It is expected that
  138. * the read and release callbacks are implemented. The write callback can be set
  139. * to null.
  140. */
  141. typedef struct {
  142. void *handle; ///> A custom pointer to reuse the same datasource functions for multiple sources
  143. /**
  144. * Copies the data from the source into the provided value.
  145. *
  146. * @param handle An optional pointer to user-defined data for the specific data source
  147. * @param nodeid Id of the read node
  148. * @param includeSourceTimeStamp If true, then the datasource is expected to set the source
  149. * timestamp in the returned value
  150. * @param range If not null, then the datasource shall return only a selection of the (nonscalar)
  151. * data. Set UA_STATUSCODE_BADINDEXRANGEINVALID in the value if this does not apply.
  152. * @param value The (non-null) DataValue that is returned to the client. The data source sets the
  153. * read data, the result status and optionally a sourcetimestamp.
  154. * @return Returns a status code for logging. Error codes intended for the original caller are set
  155. * in the value. If an error is returned, then no releasing of the value is done.
  156. */
  157. UA_StatusCode (*read)(void *handle, const UA_NodeId nodeid, UA_Boolean includeSourceTimeStamp,
  158. const UA_NumericRange *range, UA_DataValue *value);
  159. /**
  160. * Write into a data source. The write member of UA_DataSource can be empty if the operation
  161. * is unsupported.
  162. *
  163. * @param handle An optional pointer to user-defined data for the specific data source
  164. * @param nodeid Id of the node being written to
  165. * @param data The data to be written into the data source
  166. * @param range An optional data range. If the data source is scalar or does not support writing
  167. * of ranges, then an error code is returned.
  168. * @return Returns a status code that is returned to the user
  169. */
  170. UA_StatusCode (*write)(void *handle, const UA_NodeId nodeid,
  171. const UA_Variant *data, const UA_NumericRange *range);
  172. } UA_DataSource;
  173. UA_StatusCode UA_EXPORT
  174. UA_Server_setVariableNode_dataSource(UA_Server *server, const UA_NodeId nodeId,
  175. const UA_DataSource dataSource);
  176. /* Value Callbacks can be attach to variable and variable type nodes. If
  177. not-null, they are called before reading and after writing respectively */
  178. typedef struct {
  179. void *handle;
  180. void (*onRead)(void *handle, const UA_NodeId nodeid,
  181. const UA_Variant *data, const UA_NumericRange *range);
  182. void (*onWrite)(void *handle, const UA_NodeId nodeid,
  183. const UA_Variant *data, const UA_NumericRange *range);
  184. } UA_ValueCallback;
  185. UA_StatusCode UA_EXPORT
  186. UA_Server_setVariableNode_valueCallback(UA_Server *server, const UA_NodeId nodeId,
  187. const UA_ValueCallback callback);
  188. /* The lifecycle management allows to track the instantiation and deletion of
  189. object nodes derived from object types. */
  190. typedef struct {
  191. void * (*constructor)(const UA_NodeId instance); ///< Returns the instance handle attached to the node
  192. void (*destructor)(const UA_NodeId instance, void *instanceHandle);
  193. } UA_ObjectLifecycleManagement;
  194. UA_StatusCode UA_EXPORT
  195. UA_Server_setObjectTypeNode_instanceLifecycleManagement(UA_Server *server, UA_NodeId nodeId,
  196. UA_ObjectLifecycleManagement olm);
  197. /* Iterate over all nodes referenced by parentNodeId by calling the callback
  198. function for each child node */
  199. typedef UA_StatusCode (*UA_NodeIteratorCallback)(UA_NodeId childId, UA_Boolean isInverse,
  200. UA_NodeId referenceTypeId, void *handle);
  201. UA_StatusCode UA_EXPORT
  202. UA_Server_forEachChildNodeCall(UA_Server *server, UA_NodeId parentNodeId,
  203. UA_NodeIteratorCallback callback, void *handle);
  204. /*******************/
  205. /* Node Management */
  206. /*******************/
  207. UA_StatusCode UA_EXPORT
  208. UA_Server_addReference(UA_Server *server, const UA_NodeId sourceId, const UA_NodeId refTypeId,
  209. const UA_ExpandedNodeId targetId, UA_Boolean isForward);
  210. UA_StatusCode UA_EXPORT
  211. UA_Server_deleteNode(UA_Server *server, const UA_NodeId nodeId, UA_Boolean deleteReferences);
  212. UA_StatusCode UA_EXPORT
  213. UA_Server_deleteReference(UA_Server *server, const UA_NodeId sourceNodeId, const UA_NodeId referenceTypeId,
  214. UA_Boolean isForward, const UA_ExpandedNodeId targetNodeId,
  215. UA_Boolean deleteBidirectional);
  216. /* Don't use this function. There are typed versions as inline functions. */
  217. UA_StatusCode UA_EXPORT
  218. __UA_Server_addNode(UA_Server *server, const UA_NodeClass nodeClass, const UA_NodeId requestedNewNodeId,
  219. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  220. const UA_QualifiedName browseName, const UA_NodeId typeDefinition,
  221. const UA_NodeAttributes *attr, const UA_DataType *attributeType, UA_NodeId *outNewNodeId);
  222. static UA_INLINE UA_StatusCode
  223. UA_Server_addVariableNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  224. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  225. const UA_QualifiedName browseName, const UA_NodeId typeDefinition,
  226. const UA_VariableAttributes attr, UA_NodeId *outNewNodeId) {
  227. return __UA_Server_addNode(server, UA_NODECLASS_VARIABLE, requestedNewNodeId, parentNodeId,
  228. referenceTypeId, browseName, typeDefinition, (const UA_NodeAttributes*)&attr,
  229. &UA_TYPES[UA_TYPES_VARIABLEATTRIBUTES], outNewNodeId); }
  230. static UA_INLINE UA_StatusCode
  231. UA_Server_addVariableTypeNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  232. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  233. const UA_QualifiedName browseName, const UA_VariableTypeAttributes attr,
  234. UA_NodeId *outNewNodeId) {
  235. return __UA_Server_addNode(server, UA_NODECLASS_VARIABLETYPE, requestedNewNodeId, parentNodeId,
  236. referenceTypeId, browseName, UA_NODEID_NULL, (const UA_NodeAttributes*)&attr,
  237. &UA_TYPES[UA_TYPES_VARIABLETYPEATTRIBUTES], outNewNodeId); }
  238. static UA_INLINE UA_StatusCode
  239. UA_Server_addObjectNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  240. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  241. const UA_QualifiedName browseName, const UA_NodeId typeDefinition,
  242. const UA_ObjectAttributes attr, UA_NodeId *outNewNodeId) {
  243. return __UA_Server_addNode(server, UA_NODECLASS_OBJECT, requestedNewNodeId, parentNodeId,
  244. referenceTypeId, browseName, typeDefinition, (const UA_NodeAttributes*)&attr,
  245. &UA_TYPES[UA_TYPES_OBJECTATTRIBUTES], outNewNodeId); }
  246. static UA_INLINE UA_StatusCode
  247. UA_Server_addObjectTypeNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  248. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  249. const UA_QualifiedName browseName, const UA_ObjectTypeAttributes attr,
  250. UA_NodeId *outNewNodeId) {
  251. return __UA_Server_addNode(server, UA_NODECLASS_OBJECTTYPE, requestedNewNodeId, parentNodeId,
  252. referenceTypeId, browseName, UA_NODEID_NULL, (const UA_NodeAttributes*)&attr,
  253. &UA_TYPES[UA_TYPES_OBJECTTYPEATTRIBUTES], outNewNodeId); }
  254. static UA_INLINE UA_StatusCode
  255. UA_Server_addViewNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  256. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  257. const UA_QualifiedName browseName, const UA_ViewAttributes attr,
  258. UA_NodeId *outNewNodeId) {
  259. return __UA_Server_addNode(server, UA_NODECLASS_VIEW, requestedNewNodeId, parentNodeId,
  260. referenceTypeId, browseName, UA_NODEID_NULL, (const UA_NodeAttributes*)&attr,
  261. &UA_TYPES[UA_TYPES_VIEWATTRIBUTES], outNewNodeId); }
  262. static UA_INLINE UA_StatusCode
  263. UA_Server_addReferenceTypeNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  264. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  265. const UA_QualifiedName browseName, const UA_ReferenceTypeAttributes attr,
  266. UA_NodeId *outNewNodeId) {
  267. return __UA_Server_addNode(server, UA_NODECLASS_REFERENCETYPE, requestedNewNodeId, parentNodeId,
  268. referenceTypeId, browseName, UA_NODEID_NULL, (const UA_NodeAttributes*)&attr,
  269. &UA_TYPES[UA_TYPES_REFERENCETYPEATTRIBUTES], outNewNodeId); }
  270. static UA_INLINE UA_StatusCode
  271. UA_Server_addDataTypeNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  272. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  273. const UA_QualifiedName browseName, const UA_DataTypeAttributes attr,
  274. UA_NodeId *outNewNodeId) {
  275. return __UA_Server_addNode(server, UA_NODECLASS_DATATYPE, requestedNewNodeId, parentNodeId,
  276. referenceTypeId, browseName, UA_NODEID_NULL, (const UA_NodeAttributes*)&attr,
  277. &UA_TYPES[UA_TYPES_DATATYPEATTRIBUTES], outNewNodeId); }
  278. UA_StatusCode UA_EXPORT
  279. UA_Server_addDataSourceVariableNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  280. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  281. const UA_QualifiedName browseName, const UA_NodeId typeDefinition,
  282. const UA_VariableAttributes attr, const UA_DataSource dataSource,
  283. UA_NodeId *outNewNodeId);
  284. #ifdef ENABLE_METHODCALLS
  285. typedef UA_StatusCode (*UA_MethodCallback)(void *methodHandle, const UA_NodeId objectId,
  286. size_t inputSize, const UA_Variant *input,
  287. size_t outputSize, UA_Variant *output);
  288. UA_StatusCode UA_EXPORT
  289. UA_Server_addMethodNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  290. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  291. const UA_QualifiedName browseName, const UA_MethodAttributes attr,
  292. UA_MethodCallback method, void *handle,
  293. UA_Int32 inputArgumentsSize, const UA_Argument* inputArguments,
  294. UA_Int32 outputArgumentsSize, const UA_Argument* outputArguments,
  295. UA_NodeId *outNewNodeId);
  296. #endif
  297. /*************************/
  298. /* Write Node Attributes */
  299. /*************************/
  300. /* The following node attributes cannot be changed once the node is created
  301. - NodeClass
  302. - NodeId
  303. - Symmetric
  304. - ContainsNoLoop
  305. The following attributes cannot be written, as there is no "user" in the server
  306. - UserWriteMask
  307. - UserAccessLevel
  308. - UserExecutable
  309. The following attributes are currently taken from the value variant:
  310. TODO: Handle them independent from the variable, ensure that the implicit constraints hold
  311. - DataType
  312. - ValueRank
  313. - ArrayDimensions
  314. - Historizing is currently unsupported
  315. */
  316. /* Don't use this function. There are typed versions with no additional overhead. */
  317. UA_StatusCode UA_EXPORT
  318. __UA_Server_writeAttribute(UA_Server *server, const UA_NodeId nodeId, const UA_AttributeId attributeId, const UA_DataType *type, const void *value);
  319. static UA_INLINE UA_StatusCode
  320. UA_Server_writeBrowseNameAttribute(UA_Server *server, const UA_NodeId nodeId, const UA_QualifiedName browseName) {
  321. return __UA_Server_writeAttribute(server, nodeId, UA_ATTRIBUTEID_BROWSENAME, &UA_TYPES[UA_TYPES_QUALIFIEDNAME], &browseName); }
  322. static UA_INLINE UA_StatusCode
  323. UA_Server_writeDisplayNameAttribute(UA_Server *server, const UA_NodeId nodeId, const UA_LocalizedText displayName) {
  324. return __UA_Server_writeAttribute(server, nodeId, UA_ATTRIBUTEID_DISPLAYNAME, &UA_TYPES[UA_TYPES_LOCALIZEDTEXT], &displayName); }
  325. static UA_INLINE UA_StatusCode
  326. UA_Server_writeDescriptionAttribute(UA_Server *server, const UA_NodeId nodeId, const UA_LocalizedText description) {
  327. return __UA_Server_writeAttribute(server, nodeId, UA_ATTRIBUTEID_DESCRIPTION, &UA_TYPES[UA_TYPES_LOCALIZEDTEXT], &description); }
  328. static UA_INLINE UA_StatusCode
  329. UA_Server_writeWriteMaskAttribute(UA_Server *server, const UA_NodeId nodeId, const UA_UInt32 writeMask) {
  330. return __UA_Server_writeAttribute(server, nodeId, UA_ATTRIBUTEID_WRITEMASK, &UA_TYPES[UA_TYPES_UINT32], &writeMask); }
  331. static UA_INLINE UA_StatusCode
  332. UA_Server_writeIsAbstractAttribute(UA_Server *server, const UA_NodeId nodeId, const UA_Boolean isAbstract) {
  333. return __UA_Server_writeAttribute(server, nodeId, UA_ATTRIBUTEID_ISABSTRACT, &UA_TYPES[UA_TYPES_BOOLEAN], &isAbstract); }
  334. static UA_INLINE UA_StatusCode
  335. UA_Server_writeInverseNameAttribute(UA_Server *server, const UA_NodeId nodeId, const UA_LocalizedText inverseName) {
  336. return __UA_Server_writeAttribute(server, nodeId, UA_ATTRIBUTEID_INVERSENAME, &UA_TYPES[UA_TYPES_LOCALIZEDTEXT], &inverseName); }
  337. static UA_INLINE UA_StatusCode
  338. UA_Server_writeEventNotifierAttribute(UA_Server *server, const UA_NodeId nodeId, const UA_Byte eventNotifier) {
  339. return __UA_Server_writeAttribute(server, nodeId, UA_ATTRIBUTEID_EVENTNOTIFIER, &UA_TYPES[UA_TYPES_BYTE], &eventNotifier); }
  340. static UA_INLINE UA_StatusCode
  341. UA_Server_writeValueAttribute(UA_Server *server, const UA_NodeId nodeId, const UA_Variant value) {
  342. return __UA_Server_writeAttribute(server, nodeId, UA_ATTRIBUTEID_VALUE, &UA_TYPES[UA_TYPES_VARIANT], &value); }
  343. static UA_INLINE UA_StatusCode
  344. UA_Server_writeAccessLevelAttribute(UA_Server *server, const UA_NodeId nodeId, const UA_UInt32 accessLevel) {
  345. return __UA_Server_writeAttribute(server, nodeId, UA_ATTRIBUTEID_ACCESSLEVEL, &UA_TYPES[UA_TYPES_UINT32], &accessLevel); }
  346. static UA_INLINE UA_StatusCode
  347. UA_Server_writeMinimumSamplingIntervalAttribute(UA_Server *server, const UA_NodeId nodeId, const UA_Double miniumSamplingInterval) {
  348. return __UA_Server_writeAttribute(server, nodeId, UA_ATTRIBUTEID_MINIMUMSAMPLINGINTERVAL, &UA_TYPES[UA_TYPES_DOUBLE], &miniumSamplingInterval); }
  349. static UA_INLINE UA_StatusCode
  350. UA_Server_writeExecutableAttribute(UA_Server *server, const UA_NodeId nodeId, const UA_Boolean executable) {
  351. return __UA_Server_writeAttribute(server, nodeId, UA_ATTRIBUTEID_EXECUTABLE, &UA_TYPES[UA_TYPES_BOOLEAN], &executable); }
  352. /************************/
  353. /* Read Node Attributes */
  354. /************************/
  355. /* The following attributes cannot be read, since the "admin" user always has all rights.
  356. - UserWriteMask
  357. - UserAccessLevel
  358. - UserExecutable
  359. */
  360. /* Don't use this function. There are typed versions for every supported attribute. */
  361. UA_StatusCode UA_EXPORT
  362. __UA_Server_readAttribute(UA_Server *server, UA_NodeId nodeId, UA_AttributeId attributeId, void *v);
  363. static UA_INLINE UA_StatusCode
  364. UA_Server_readNodeIdAttribute(UA_Server *server, UA_NodeId nodeId, UA_NodeId *outNodeId) {
  365. return __UA_Server_readAttribute(server, nodeId, UA_ATTRIBUTEID_NODEID, outNodeId); }
  366. static UA_INLINE UA_StatusCode
  367. UA_Server_readNodeClassAttribute(UA_Server *server, UA_NodeId nodeId, UA_NodeClass *outNodeClass) {
  368. return __UA_Server_readAttribute(server, nodeId, UA_ATTRIBUTEID_NODECLASS, outNodeClass); }
  369. static UA_INLINE UA_StatusCode
  370. UA_Server_readBrowseNameAttribute(UA_Server *server, UA_NodeId nodeId, UA_QualifiedName *outBrowseName) {
  371. return __UA_Server_readAttribute(server, nodeId, UA_ATTRIBUTEID_BROWSENAME, outBrowseName); }
  372. static UA_INLINE UA_StatusCode
  373. UA_Server_readDisplayNameAttribute(UA_Server *server, UA_NodeId nodeId, UA_LocalizedText *outDisplayName) {
  374. return __UA_Server_readAttribute(server, nodeId, UA_ATTRIBUTEID_DISPLAYNAME, outDisplayName); }
  375. static UA_INLINE UA_StatusCode
  376. UA_Server_readDescriptionAttribute(UA_Server *server, UA_NodeId nodeId, UA_LocalizedText *outDescription) {
  377. return __UA_Server_readAttribute(server, nodeId, UA_ATTRIBUTEID_DESCRIPTION, outDescription); }
  378. static UA_INLINE UA_StatusCode
  379. UA_Server_readWriteMaskAttribute(UA_Server *server, UA_NodeId nodeId, UA_UInt32 *outWriteMask) {
  380. return __UA_Server_readAttribute(server, nodeId, UA_ATTRIBUTEID_WRITEMASK, outWriteMask); }
  381. static UA_INLINE UA_StatusCode
  382. UA_Server_readIsAbstractAttribute(UA_Server *server, UA_NodeId nodeId, UA_Boolean *outIsAbstract) {
  383. return __UA_Server_readAttribute(server, nodeId, UA_ATTRIBUTEID_ISABSTRACT, outIsAbstract); }
  384. static UA_INLINE UA_StatusCode
  385. UA_Server_readSymmetricAttribute(UA_Server *server, UA_NodeId nodeId, UA_Boolean *outSymmetric) {
  386. return __UA_Server_readAttribute(server, nodeId, UA_ATTRIBUTEID_SYMMETRIC, outSymmetric); }
  387. static UA_INLINE UA_StatusCode
  388. UA_Server_readInverseNameAttribute(UA_Server *server, UA_NodeId nodeId, UA_LocalizedText *outInverseName) {
  389. return __UA_Server_readAttribute(server, nodeId, UA_ATTRIBUTEID_INVERSENAME, outInverseName); }
  390. static UA_INLINE UA_StatusCode
  391. UA_Server_readContainsNoLoopAttribute(UA_Server *server, UA_NodeId nodeId, UA_Boolean *outContainsNoLoops) {
  392. return __UA_Server_readAttribute(server, nodeId, UA_ATTRIBUTEID_CONTAINSNOLOOPS, outContainsNoLoops); }
  393. static UA_INLINE UA_StatusCode
  394. UA_Server_readEventNotifierAttribute(UA_Server *server, UA_NodeId nodeId, UA_Byte *outEventNotifier) {
  395. return __UA_Server_readAttribute(server, nodeId, UA_ATTRIBUTEID_EVENTNOTIFIER, outEventNotifier); }
  396. static UA_INLINE UA_StatusCode
  397. UA_Server_readValueAttribute(UA_Server *server, UA_NodeId nodeId, UA_Variant *outValue) {
  398. return __UA_Server_readAttribute(server, nodeId, UA_ATTRIBUTEID_VALUE, outValue); }
  399. static UA_INLINE UA_StatusCode
  400. UA_Server_readDataTypeAttribute(UA_Server *server, UA_NodeId nodeId, UA_NodeId *outDataType) {
  401. return __UA_Server_readAttribute(server, nodeId, UA_ATTRIBUTEID_DATATYPE, outDataType); }
  402. static UA_INLINE UA_StatusCode
  403. UA_Server_readValueRankAttribute(UA_Server *server, UA_NodeId nodeId, UA_Int32 *outValueRank) {
  404. return __UA_Server_readAttribute(server, nodeId, UA_ATTRIBUTEID_VALUERANK, outValueRank); }
  405. // todo: fetch an array with a length field
  406. static UA_INLINE UA_StatusCode
  407. UA_Server_readArrayDimensionsAttribute(UA_Server *server, UA_NodeId nodeId, UA_Int32 *outArrayDimensions) {
  408. return __UA_Server_readAttribute(server, nodeId, UA_ATTRIBUTEID_ARRAYDIMENSIONS, outArrayDimensions); }
  409. static UA_INLINE UA_StatusCode
  410. UA_Server_readAccessLevelAttribute(UA_Server *server, UA_NodeId nodeId, UA_UInt32 *outAccessLevel) {
  411. return __UA_Server_readAttribute(server, nodeId, UA_ATTRIBUTEID_ACCESSLEVEL, outAccessLevel); }
  412. static UA_INLINE UA_StatusCode
  413. UA_Server_readMinimumSamplingIntervalAttribute(UA_Server *server, UA_NodeId nodeId, UA_Double *outMinimumSamplingInterval) {
  414. return __UA_Server_readAttribute(server, nodeId, UA_ATTRIBUTEID_MINIMUMSAMPLINGINTERVAL, outMinimumSamplingInterval); }
  415. static UA_INLINE UA_StatusCode
  416. UA_Server_readHistorizingAttribute(UA_Server *server, UA_NodeId nodeId, UA_Boolean *outHistorizing) {
  417. return __UA_Server_readAttribute(server, nodeId, UA_ATTRIBUTEID_HISTORIZING, outHistorizing); }
  418. static UA_INLINE UA_StatusCode
  419. UA_Server_readExecutableAttribute(UA_Server *server, UA_NodeId nodeId, UA_Boolean *outExecutable) {
  420. return __UA_Server_readAttribute(server, nodeId, UA_ATTRIBUTEID_EXECUTABLE, outExecutable); }
  421. #ifdef __cplusplus
  422. }
  423. #endif
  424. #endif /* UA_SERVER_H_ */