ua_server.h 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532
  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. /* Server Config */
  29. /*****************/
  30. struct UA_ServerNetworkLayer; // forwards declaration
  31. typedef struct UA_ServerNetworkLayer UA_ServerNetworkLayer;
  32. typedef struct {
  33. UA_String username;
  34. UA_String password;
  35. } UA_UsernamePasswordLogin;
  36. typedef struct {
  37. UA_UInt16 nThreads; // only if multithreading is enabled
  38. UA_Logger logger;
  39. UA_BuildInfo buildInfo;
  40. UA_ApplicationDescription applicationDescription;
  41. UA_ByteString serverCertificate;
  42. UA_ConnectionConfig connectionConfig;
  43. size_t networkLayersSize;
  44. UA_ServerNetworkLayer *networkLayers;
  45. UA_Boolean enableAnonymousLogin;
  46. UA_Boolean enableUsernamePasswordLogin;
  47. size_t usernamePasswordLoginsSize;
  48. UA_UsernamePasswordLogin usernamePasswordLogins[];
  49. } UA_ServerConfig;
  50. extern UA_EXPORT const UA_ServerConfig UA_ServerConfig_standard;
  51. /*********************************/
  52. /* Initialize and run the server */
  53. /*********************************/
  54. UA_Server UA_EXPORT * UA_Server_new(const UA_ServerConfig config);
  55. void UA_EXPORT UA_Server_delete(UA_Server *server);
  56. /**
  57. * Runs the main loop of the server. In each iteration, this calls into the networklayers to see if
  58. * jobs have arrived and checks if repeated jobs need to be triggered.
  59. */
  60. UA_StatusCode UA_EXPORT UA_Server_run(UA_Server *server, volatile UA_Boolean *running);
  61. /** The prologue part of UA_Server_run (no need to use if you call UA_Server_run) */
  62. UA_StatusCode UA_EXPORT UA_Server_run_startup(UA_Server *server);
  63. /** One iteration of UA_Server_run (no need to use if you call UA_Server_run) */
  64. UA_StatusCode UA_EXPORT UA_Server_run_iterate(UA_Server *server);
  65. /** The epilogue part of UA_Server_run (no need to use if you call UA_Server_run) */
  66. UA_StatusCode UA_EXPORT UA_Server_run_shutdown(UA_Server *server);
  67. /**
  68. * @param server The server object.
  69. * @param job The job that shall be added.
  70. * @param interval The job shall be repeatedly executed with the given interval (in ms). The
  71. * interval must be larger than 5ms. The first execution occurs at now() + interval at the
  72. * latest.
  73. * @param jobId Set to the guid of the repeated job. This can be used to cancel the job later on. If
  74. * the pointer is null, the guid is not set.
  75. * @return Upon success, UA_STATUSCODE_GOOD is returned. An error code otherwise.
  76. */
  77. UA_StatusCode UA_EXPORT UA_Server_addRepeatedJob(UA_Server *server, UA_Job job,
  78. UA_UInt32 interval, UA_Guid *jobId);
  79. /**
  80. * Remove repeated job. The entry will be removed asynchronously during the next iteration of the
  81. * server main loop.
  82. *
  83. * @param server The server object.
  84. * @param jobId The id of the job that shall be removed.
  85. * @return Upon sucess, UA_STATUSCODE_GOOD is returned. An error code otherwise.
  86. */
  87. UA_StatusCode UA_EXPORT UA_Server_removeRepeatedJob(UA_Server *server, UA_Guid jobId);
  88. /** @brief Add a new namespace to the server. Returns the index of the new namespace */
  89. UA_UInt16 UA_EXPORT UA_Server_addNamespace(UA_Server *server, const char* name);
  90. /**
  91. * Interface to the binary network layers. This structure is returned from the
  92. * function that initializes the network layer. The layer is already bound to a
  93. * specific port and listening. The functions in the structure are never called
  94. * in parallel but only sequentially from the server's main loop. So the network
  95. * layer does not need to be thread-safe.
  96. */
  97. struct UA_ServerNetworkLayer {
  98. void *handle; // pointer to internal data
  99. UA_String discoveryUrl;
  100. /**
  101. * Starts listening on the the networklayer.
  102. *
  103. * @param nl The network layer
  104. * @param logger The logger
  105. * @return Returns UA_STATUSCODE_GOOD or an error code.
  106. */
  107. UA_StatusCode (*start)(UA_ServerNetworkLayer *nl, UA_ConnectionConfig config, UA_Logger logger);
  108. /**
  109. * Gets called from the main server loop and returns the jobs (accumulated messages and close
  110. * events) for dispatch.
  111. *
  112. * @param nl The network layer
  113. * @param jobs When the returned integer is >0, *jobs points to an array of UA_Job of the
  114. * returned size.
  115. * @param timeout The timeout during which an event must arrive in microseconds
  116. * @return The size of the jobs array. If the result is negative, an error has occurred.
  117. */
  118. size_t (*getJobs)(UA_ServerNetworkLayer *nl, UA_Job **jobs, UA_UInt16 timeout);
  119. /**
  120. * Closes the network connection and returns all the jobs that need to be finished before the
  121. * network layer can be safely deleted.
  122. *
  123. * @param nl The network layer
  124. * @param jobs When the returned integer is >0, jobs points to an array of UA_Job of the
  125. * returned size.
  126. * @return The size of the jobs array. If the result is negative, an error has occurred.
  127. */
  128. size_t (*stop)(UA_ServerNetworkLayer *nl, UA_Job **jobs);
  129. /** Deletes the network content. Call only after stopping. */
  130. void (*deleteMembers)(UA_ServerNetworkLayer *nl);
  131. };
  132. /**********************/
  133. /* Set Node Callbacks */
  134. /**********************/
  135. /**
  136. * Datasources are the interface to local data providers. It is expected that
  137. * the read and release callbacks are implemented. The write callback can be set
  138. * to null. The read callback is set to null will result in a BADINTERNALERROR.
  139. */
  140. typedef struct {
  141. void *handle; ///> A custom pointer to reuse the same datasource functions for multiple sources
  142. /**
  143. * Copies the data from the source into the provided value.
  144. *
  145. * @param handle An optional pointer to user-defined data for the specific data source
  146. * @param nodeid Id of the read node
  147. * @param includeSourceTimeStamp If true, then the datasource is expected to set the source
  148. * timestamp in the returned value
  149. * @param range If not null, then the datasource shall return only a selection of the (nonscalar)
  150. * data. Set UA_STATUSCODE_BADINDEXRANGEINVALID in the value if this does not apply.
  151. * @param value The (non-null) DataValue that is returned to the client. The data source sets the
  152. * read data, the result status and optionally a sourcetimestamp.
  153. * @return Returns a status code for logging. Error codes intended for the original caller are set
  154. * in the value. If an error is returned, then no releasing of the value is done.
  155. */
  156. UA_StatusCode (*read)(void *handle, const UA_NodeId nodeid, UA_Boolean includeSourceTimeStamp,
  157. const UA_NumericRange *range, UA_DataValue *value);
  158. /**
  159. * Write into a data source. The write member of UA_DataSource can be empty if the operation
  160. * is unsupported.
  161. *
  162. * @param handle An optional pointer to user-defined data for the specific data source
  163. * @param nodeid Id of the node being written to
  164. * @param data The data to be written into the data source
  165. * @param range An optional data range. If the data source is scalar or does not support writing
  166. * of ranges, then an error code is returned.
  167. * @return Returns a status code that is returned to the user
  168. */
  169. UA_StatusCode (*write)(void *handle, const UA_NodeId nodeid,
  170. const UA_Variant *data, const UA_NumericRange *range);
  171. } UA_DataSource;
  172. UA_StatusCode UA_EXPORT
  173. UA_Server_setVariableNode_dataSource(UA_Server *server, const UA_NodeId nodeId,
  174. const UA_DataSource dataSource);
  175. /* Value Callbacks can be attach to variable and variable type nodes. If
  176. not-null, they are called before reading and after writing respectively */
  177. typedef struct {
  178. void *handle;
  179. void (*onRead)(void *handle, const UA_NodeId nodeid,
  180. const UA_Variant *data, const UA_NumericRange *range);
  181. void (*onWrite)(void *handle, const UA_NodeId nodeid,
  182. const UA_Variant *data, const UA_NumericRange *range);
  183. } UA_ValueCallback;
  184. UA_StatusCode UA_EXPORT
  185. UA_Server_setVariableNode_valueCallback(UA_Server *server, const UA_NodeId nodeId,
  186. const UA_ValueCallback callback);
  187. /* The lifecycle management allows to track the instantiation and deletion of
  188. object nodes derived from object types. */
  189. typedef struct {
  190. void * (*constructor)(const UA_NodeId instance); ///< Returns the instance handle attached to the node
  191. void (*destructor)(const UA_NodeId instance, void *instanceHandle);
  192. } UA_ObjectLifecycleManagement;
  193. UA_StatusCode UA_EXPORT
  194. UA_Server_setObjectTypeNode_instanceLifecycleManagement(UA_Server *server, UA_NodeId nodeId,
  195. UA_ObjectLifecycleManagement olm);
  196. /* Iterate over all nodes referenced by parentNodeId by calling the callback
  197. function for each child node */
  198. typedef UA_StatusCode (*UA_NodeIteratorCallback)(UA_NodeId childId, UA_Boolean isInverse,
  199. UA_NodeId referenceTypeId, void *handle);
  200. UA_StatusCode UA_EXPORT
  201. UA_Server_forEachChildNodeCall(UA_Server *server, UA_NodeId parentNodeId,
  202. UA_NodeIteratorCallback callback, void *handle);
  203. /*******************/
  204. /* Node Management */
  205. /*******************/
  206. UA_StatusCode UA_EXPORT
  207. UA_Server_addReference(UA_Server *server, const UA_NodeId sourceId, const UA_NodeId refTypeId,
  208. const UA_ExpandedNodeId targetId, UA_Boolean isForward);
  209. UA_StatusCode UA_EXPORT
  210. UA_Server_deleteNode(UA_Server *server, const UA_NodeId nodeId, UA_Boolean deleteReferences);
  211. UA_StatusCode UA_EXPORT
  212. UA_Server_deleteReference(UA_Server *server, const UA_NodeId sourceNodeId, const UA_NodeId referenceTypeId,
  213. UA_Boolean isForward, const UA_ExpandedNodeId targetNodeId,
  214. UA_Boolean deleteBidirectional);
  215. /* Don't use this function. There are typed versions as inline functions. */
  216. UA_StatusCode UA_EXPORT
  217. __UA_Server_addNode(UA_Server *server, const UA_NodeClass nodeClass, const UA_NodeId requestedNewNodeId,
  218. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  219. const UA_QualifiedName browseName, const UA_NodeId typeDefinition,
  220. const UA_NodeAttributes *attr, const UA_DataType *attributeType, UA_NodeId *outNewNodeId);
  221. static UA_INLINE UA_StatusCode
  222. UA_Server_addVariableNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  223. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  224. const UA_QualifiedName browseName, const UA_NodeId typeDefinition,
  225. const UA_VariableAttributes attr, UA_NodeId *outNewNodeId) {
  226. return __UA_Server_addNode(server, UA_NODECLASS_VARIABLE, requestedNewNodeId, parentNodeId,
  227. referenceTypeId, browseName, typeDefinition, (const UA_NodeAttributes*)&attr,
  228. &UA_TYPES[UA_TYPES_VARIABLEATTRIBUTES], outNewNodeId); }
  229. static UA_INLINE UA_StatusCode
  230. UA_Server_addVariableTypeNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  231. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  232. const UA_QualifiedName browseName, const UA_VariableTypeAttributes attr,
  233. UA_NodeId *outNewNodeId) {
  234. return __UA_Server_addNode(server, UA_NODECLASS_VARIABLETYPE, requestedNewNodeId, parentNodeId,
  235. referenceTypeId, browseName, UA_NODEID_NULL, (const UA_NodeAttributes*)&attr,
  236. &UA_TYPES[UA_TYPES_VARIABLETYPEATTRIBUTES], outNewNodeId); }
  237. static UA_INLINE UA_StatusCode
  238. UA_Server_addObjectNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  239. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  240. const UA_QualifiedName browseName, const UA_NodeId typeDefinition,
  241. const UA_ObjectAttributes attr, UA_NodeId *outNewNodeId) {
  242. return __UA_Server_addNode(server, UA_NODECLASS_OBJECT, requestedNewNodeId, parentNodeId,
  243. referenceTypeId, browseName, typeDefinition, (const UA_NodeAttributes*)&attr,
  244. &UA_TYPES[UA_TYPES_OBJECTATTRIBUTES], outNewNodeId); }
  245. static UA_INLINE UA_StatusCode
  246. UA_Server_addObjectTypeNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  247. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  248. const UA_QualifiedName browseName, const UA_ObjectTypeAttributes attr,
  249. UA_NodeId *outNewNodeId) {
  250. return __UA_Server_addNode(server, UA_NODECLASS_OBJECTTYPE, requestedNewNodeId, parentNodeId,
  251. referenceTypeId, browseName, UA_NODEID_NULL, (const UA_NodeAttributes*)&attr,
  252. &UA_TYPES[UA_TYPES_OBJECTTYPEATTRIBUTES], outNewNodeId); }
  253. static UA_INLINE UA_StatusCode
  254. UA_Server_addViewNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  255. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  256. const UA_QualifiedName browseName, const UA_ViewAttributes attr,
  257. UA_NodeId *outNewNodeId) {
  258. return __UA_Server_addNode(server, UA_NODECLASS_VIEW, requestedNewNodeId, parentNodeId,
  259. referenceTypeId, browseName, UA_NODEID_NULL, (const UA_NodeAttributes*)&attr,
  260. &UA_TYPES[UA_TYPES_VIEWATTRIBUTES], outNewNodeId); }
  261. static UA_INLINE UA_StatusCode
  262. UA_Server_addReferenceTypeNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  263. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  264. const UA_QualifiedName browseName, const UA_ReferenceTypeAttributes attr,
  265. UA_NodeId *outNewNodeId) {
  266. return __UA_Server_addNode(server, UA_NODECLASS_REFERENCETYPE, requestedNewNodeId, parentNodeId,
  267. referenceTypeId, browseName, UA_NODEID_NULL, (const UA_NodeAttributes*)&attr,
  268. &UA_TYPES[UA_TYPES_REFERENCETYPEATTRIBUTES], outNewNodeId); }
  269. static UA_INLINE UA_StatusCode
  270. UA_Server_addDataTypeNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  271. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  272. const UA_QualifiedName browseName, const UA_DataTypeAttributes attr,
  273. UA_NodeId *outNewNodeId) {
  274. return __UA_Server_addNode(server, UA_NODECLASS_DATATYPE, requestedNewNodeId, parentNodeId,
  275. referenceTypeId, browseName, UA_NODEID_NULL, (const UA_NodeAttributes*)&attr,
  276. &UA_TYPES[UA_TYPES_DATATYPEATTRIBUTES], outNewNodeId); }
  277. UA_StatusCode UA_EXPORT
  278. UA_Server_addDataSourceVariableNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  279. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  280. const UA_QualifiedName browseName, const UA_NodeId typeDefinition,
  281. const UA_VariableAttributes attr, const UA_DataSource dataSource,
  282. UA_NodeId *outNewNodeId);
  283. #ifdef UA_ENABLE_METHODCALLS
  284. typedef UA_StatusCode (*UA_MethodCallback)(void *methodHandle, const UA_NodeId objectId,
  285. size_t inputSize, const UA_Variant *input,
  286. size_t outputSize, UA_Variant *output);
  287. UA_StatusCode UA_EXPORT
  288. UA_Server_addMethodNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  289. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  290. const UA_QualifiedName browseName, const UA_MethodAttributes attr,
  291. UA_MethodCallback method, void *handle,
  292. UA_Int32 inputArgumentsSize, const UA_Argument* inputArguments,
  293. UA_Int32 outputArgumentsSize, const UA_Argument* outputArguments,
  294. UA_NodeId *outNewNodeId);
  295. #endif
  296. /*************************/
  297. /* Write Node Attributes */
  298. /*************************/
  299. /* The following node attributes cannot be written
  300. - NodeClass
  301. - NodeId
  302. - Symmetric
  303. - ContainsNoLoop
  304. The following attributes cannot be written from the server, as there is no "user" in the server
  305. - UserWriteMask
  306. - UserAccessLevel
  307. - UserExecutable
  308. The following attributes are currently taken from the value variant:
  309. TODO: Handle them independent from the variable, ensure that the implicit constraints hold
  310. - DataType
  311. - ValueRank
  312. - ArrayDimensions
  313. - Historizing is currently unsupported
  314. */
  315. /* Don't use this function. There are typed versions with no additional overhead. */
  316. UA_StatusCode UA_EXPORT
  317. __UA_Server_write(UA_Server *server, const UA_NodeId *nodeId, const UA_AttributeId attributeId,
  318. const UA_DataType *type, const void *value);
  319. static UA_INLINE UA_StatusCode
  320. UA_Server_writeBrowseName(UA_Server *server, const UA_NodeId nodeId, const UA_QualifiedName browseName) {
  321. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_BROWSENAME, &UA_TYPES[UA_TYPES_QUALIFIEDNAME], &browseName); }
  322. static UA_INLINE UA_StatusCode
  323. UA_Server_writeDisplayName(UA_Server *server, const UA_NodeId nodeId, const UA_LocalizedText displayName) {
  324. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_DISPLAYNAME, &UA_TYPES[UA_TYPES_LOCALIZEDTEXT], &displayName); }
  325. static UA_INLINE UA_StatusCode
  326. UA_Server_writeDescription(UA_Server *server, const UA_NodeId nodeId, const UA_LocalizedText description) {
  327. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_DESCRIPTION, &UA_TYPES[UA_TYPES_LOCALIZEDTEXT], &description); }
  328. static UA_INLINE UA_StatusCode
  329. UA_Server_writeWriteMask(UA_Server *server, const UA_NodeId nodeId, const UA_UInt32 writeMask) {
  330. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_WRITEMASK, &UA_TYPES[UA_TYPES_UINT32], &writeMask); }
  331. static UA_INLINE UA_StatusCode
  332. UA_Server_writeIsAbstract(UA_Server *server, const UA_NodeId nodeId, const UA_Boolean isAbstract) {
  333. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_ISABSTRACT, &UA_TYPES[UA_TYPES_BOOLEAN], &isAbstract); }
  334. static UA_INLINE UA_StatusCode
  335. UA_Server_writeInverseName(UA_Server *server, const UA_NodeId nodeId, const UA_LocalizedText inverseName) {
  336. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_INVERSENAME, &UA_TYPES[UA_TYPES_LOCALIZEDTEXT], &inverseName); }
  337. static UA_INLINE UA_StatusCode
  338. UA_Server_writeEventNotifier(UA_Server *server, const UA_NodeId nodeId, const UA_Byte eventNotifier) {
  339. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_EVENTNOTIFIER, &UA_TYPES[UA_TYPES_BYTE], &eventNotifier); }
  340. static UA_INLINE UA_StatusCode
  341. UA_Server_writeValue(UA_Server *server, const UA_NodeId nodeId, const UA_Variant value) {
  342. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_VALUE, &UA_TYPES[UA_TYPES_VARIANT], &value); }
  343. static UA_INLINE UA_StatusCode
  344. UA_Server_writeAccessLevel(UA_Server *server, const UA_NodeId nodeId, const UA_UInt32 accessLevel) {
  345. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_ACCESSLEVEL, &UA_TYPES[UA_TYPES_UINT32], &accessLevel); }
  346. static UA_INLINE UA_StatusCode
  347. UA_Server_writeMinimumSamplingInterval(UA_Server *server, const UA_NodeId nodeId, const UA_Double miniumSamplingInterval) {
  348. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_MINIMUMSAMPLINGINTERVAL, &UA_TYPES[UA_TYPES_DOUBLE], &miniumSamplingInterval); }
  349. static UA_INLINE UA_StatusCode
  350. UA_Server_writeExecutable(UA_Server *server, const UA_NodeId nodeId, const UA_Boolean executable) {
  351. return __UA_Server_write(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_read(UA_Server *server, const UA_NodeId *nodeId, UA_AttributeId attributeId, void *v);
  363. static UA_INLINE UA_StatusCode
  364. UA_Server_readNodeId(UA_Server *server, const UA_NodeId nodeId, UA_NodeId *outNodeId) {
  365. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_NODEID, outNodeId); }
  366. static UA_INLINE UA_StatusCode
  367. UA_Server_readNodeClass(UA_Server *server, const UA_NodeId nodeId, UA_NodeClass *outNodeClass) {
  368. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_NODECLASS, outNodeClass); }
  369. static UA_INLINE UA_StatusCode
  370. UA_Server_readBrowseName(UA_Server *server, const UA_NodeId nodeId, UA_QualifiedName *outBrowseName) {
  371. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_BROWSENAME, outBrowseName); }
  372. static UA_INLINE UA_StatusCode
  373. UA_Server_readDisplayName(UA_Server *server, const UA_NodeId nodeId, UA_LocalizedText *outDisplayName) {
  374. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_DISPLAYNAME, outDisplayName); }
  375. static UA_INLINE UA_StatusCode
  376. UA_Server_readDescription(UA_Server *server, const UA_NodeId nodeId, UA_LocalizedText *outDescription) {
  377. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_DESCRIPTION, outDescription); }
  378. static UA_INLINE UA_StatusCode
  379. UA_Server_readWriteMask(UA_Server *server, const UA_NodeId nodeId, UA_UInt32 *outWriteMask) {
  380. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_WRITEMASK, outWriteMask); }
  381. static UA_INLINE UA_StatusCode
  382. UA_Server_readIsAbstract(UA_Server *server, const UA_NodeId nodeId, UA_Boolean *outIsAbstract) {
  383. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_ISABSTRACT, outIsAbstract); }
  384. static UA_INLINE UA_StatusCode
  385. UA_Server_readSymmetric(UA_Server *server, const UA_NodeId nodeId, UA_Boolean *outSymmetric) {
  386. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_SYMMETRIC, outSymmetric); }
  387. static UA_INLINE UA_StatusCode
  388. UA_Server_readInverseName(UA_Server *server, const UA_NodeId nodeId, UA_LocalizedText *outInverseName) {
  389. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_INVERSENAME, outInverseName); }
  390. static UA_INLINE UA_StatusCode
  391. UA_Server_readContainsNoLoop(UA_Server *server, const UA_NodeId nodeId, UA_Boolean *outContainsNoLoops) {
  392. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_CONTAINSNOLOOPS, outContainsNoLoops); }
  393. static UA_INLINE UA_StatusCode
  394. UA_Server_readEventNotifier(UA_Server *server, const UA_NodeId nodeId, UA_Byte *outEventNotifier) {
  395. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_EVENTNOTIFIER, outEventNotifier); }
  396. static UA_INLINE UA_StatusCode
  397. UA_Server_readValue(UA_Server *server, const UA_NodeId nodeId, UA_Variant *outValue) {
  398. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_VALUE, outValue); }
  399. static UA_INLINE UA_StatusCode
  400. UA_Server_readDataType(UA_Server *server, const UA_NodeId nodeId, UA_NodeId *outDataType) {
  401. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_DATATYPE, outDataType); }
  402. static UA_INLINE UA_StatusCode
  403. UA_Server_readValueRank(UA_Server *server, const UA_NodeId nodeId, UA_Int32 *outValueRank) {
  404. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_VALUERANK, outValueRank); }
  405. /* Returns a variant with an int32 array */
  406. static UA_INLINE UA_StatusCode
  407. UA_Server_readArrayDimensions(UA_Server *server, const UA_NodeId nodeId, UA_Variant *outArrayDimensions) {
  408. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_ARRAYDIMENSIONS, outArrayDimensions); }
  409. static UA_INLINE UA_StatusCode
  410. UA_Server_readAccessLevel(UA_Server *server, const UA_NodeId nodeId, UA_UInt32 *outAccessLevel) {
  411. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_ACCESSLEVEL, outAccessLevel); }
  412. static UA_INLINE UA_StatusCode
  413. UA_Server_readMinimumSamplingInterval(UA_Server *server, const UA_NodeId nodeId, UA_Double *outMinimumSamplingInterval) {
  414. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_MINIMUMSAMPLINGINTERVAL, outMinimumSamplingInterval); }
  415. static UA_INLINE UA_StatusCode
  416. UA_Server_readHistorizing(UA_Server *server, const UA_NodeId nodeId, UA_Boolean *outHistorizing) {
  417. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_HISTORIZING, outHistorizing); }
  418. static UA_INLINE UA_StatusCode
  419. UA_Server_readExecutable(UA_Server *server, const UA_NodeId nodeId, UA_Boolean *outExecutable) {
  420. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_EXECUTABLE, outExecutable); }
  421. /****************/
  422. /* Browse Nodes */
  423. /****************/
  424. UA_BrowseResult UA_EXPORT UA_Server_browse(UA_Server *server, UA_UInt32 maxrefs, const UA_BrowseDescription *descr);
  425. UA_BrowseResult UA_Server_browseNext(UA_Server *server, UA_Boolean releaseContinuationPoint, const UA_ByteString *continuationPoint);
  426. /***************/
  427. /* Call Method */
  428. /***************/
  429. #ifdef UA_ENABLE_METHODCALLS
  430. UA_CallMethodResult UA_EXPORT UA_Server_call(UA_Server *server, const UA_CallMethodRequest *request);
  431. #endif
  432. #ifdef __cplusplus
  433. }
  434. #endif
  435. #endif /* UA_SERVER_H_ */