ua_server.h 27 KB

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