ua_server.h 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627
  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. /* Data Source */
  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, const UA_Variant *data, const UA_NumericRange *range);
  171. } UA_DataSource;
  172. /* Value Callbacks can be attach to value and value type nodes. If not-null, they are called before
  173. reading and after writing respectively */
  174. typedef struct {
  175. void *handle;
  176. void (*onRead)(void *handle, const UA_NodeId nodeid, const UA_Variant *data, const UA_NumericRange *range);
  177. void (*onWrite)(void *handle, const UA_NodeId nodeid, const UA_Variant *data, const UA_NumericRange *range);
  178. } UA_ValueCallback;
  179. /*******************/
  180. /* Node Management */
  181. /*******************/
  182. /** Add a reference to the server's address space */
  183. UA_StatusCode UA_EXPORT
  184. UA_Server_addReference(UA_Server *server, const UA_NodeId sourceId, const UA_NodeId refTypeId,
  185. const UA_ExpandedNodeId targetId, UA_Boolean isForward);
  186. /* Don't use this function. There are typed versions as inline functions. */
  187. UA_AddNodesResult UA_EXPORT
  188. UA_Server_addNode(UA_Server *server, const UA_NodeClass nodeClass, const UA_NodeId requestedNewNodeId,
  189. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  190. const UA_QualifiedName browseName, const UA_NodeId typeDefinition,
  191. const UA_NodeAttributes *attr, const UA_DataType *attributeType);
  192. static UA_INLINE UA_AddNodesResult
  193. UA_Server_addVariableNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  194. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  195. const UA_QualifiedName browseName, const UA_NodeId typeDefinition,
  196. const UA_VariableAttributes attr) {
  197. return UA_Server_addNode(server, UA_NODECLASS_VARIABLE, requestedNewNodeId, parentNodeId,
  198. referenceTypeId, browseName, typeDefinition, (const UA_NodeAttributes*)&attr,
  199. &UA_TYPES[UA_TYPES_VARIABLEATTRIBUTES]); }
  200. static UA_INLINE UA_AddNodesResult
  201. UA_Server_addVariableTypeNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  202. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  203. const UA_QualifiedName browseName, const UA_VariableTypeAttributes attr) {
  204. return UA_Server_addNode(server, UA_NODECLASS_VARIABLETYPE, requestedNewNodeId, parentNodeId,
  205. referenceTypeId, browseName, UA_NODEID_NULL,
  206. (const UA_NodeAttributes*)&attr, &UA_TYPES[UA_TYPES_VARIABLETYPEATTRIBUTES]); }
  207. static UA_INLINE UA_AddNodesResult
  208. UA_Server_addObjectNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  209. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  210. const UA_QualifiedName browseName, const UA_NodeId typeDefinition,
  211. const UA_ObjectAttributes attr) {
  212. return UA_Server_addNode(server, UA_NODECLASS_OBJECT, requestedNewNodeId, parentNodeId,
  213. referenceTypeId, browseName, typeDefinition, (const UA_NodeAttributes*)&attr,
  214. &UA_TYPES[UA_TYPES_OBJECTATTRIBUTES]); }
  215. static UA_INLINE UA_AddNodesResult
  216. UA_Server_addObjectTypeNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  217. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  218. const UA_QualifiedName browseName, const UA_ObjectTypeAttributes attr) {
  219. return UA_Server_addNode(server, UA_NODECLASS_OBJECTTYPE, requestedNewNodeId, parentNodeId,
  220. referenceTypeId, browseName, UA_NODEID_NULL,
  221. (const UA_NodeAttributes*)&attr, &UA_TYPES[UA_TYPES_OBJECTTYPEATTRIBUTES]); }
  222. static UA_INLINE UA_AddNodesResult
  223. UA_Server_addViewNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  224. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  225. const UA_QualifiedName browseName, const UA_ViewAttributes attr) {
  226. return UA_Server_addNode(server, UA_NODECLASS_VIEW, requestedNewNodeId, parentNodeId,
  227. referenceTypeId, browseName, UA_NODEID_NULL,
  228. (const UA_NodeAttributes*)&attr, &UA_TYPES[UA_TYPES_VIEWATTRIBUTES]); }
  229. static UA_INLINE UA_AddNodesResult
  230. UA_Server_addReferenceTypeNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  231. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  232. const UA_QualifiedName browseName, const UA_ReferenceTypeAttributes attr) {
  233. return UA_Server_addNode(server, UA_NODECLASS_REFERENCETYPE, requestedNewNodeId, parentNodeId,
  234. referenceTypeId, browseName, UA_NODEID_NULL,
  235. (const UA_NodeAttributes*)&attr, &UA_TYPES[UA_TYPES_REFERENCETYPEATTRIBUTES]); }
  236. static UA_INLINE UA_AddNodesResult
  237. UA_Server_addDataTypeNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  238. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  239. const UA_QualifiedName browseName, const UA_DataTypeAttributes attr) {
  240. return UA_Server_addNode(server, UA_NODECLASS_DATATYPE, requestedNewNodeId, parentNodeId,
  241. referenceTypeId, browseName, UA_NODEID_NULL,
  242. (const UA_NodeAttributes*)&attr, &UA_TYPES[UA_TYPES_DATATYPEATTRIBUTES]); }
  243. UA_AddNodesResult UA_EXPORT
  244. UA_Server_addDataSourceVariableNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  245. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  246. const UA_QualifiedName browseName, const UA_NodeId typeDefinition,
  247. const UA_VariableAttributes attr, const UA_DataSource dataSource);
  248. UA_StatusCode UA_EXPORT
  249. UA_Server_addMonodirectionalReference(UA_Server *server, UA_NodeId sourceNodeId, UA_NodeId targetNodeId,
  250. UA_NodeId referenceTypeId, UA_Boolean isforward);
  251. #ifdef ENABLE_METHODCALLS
  252. typedef UA_StatusCode (*UA_MethodCallback)(const UA_NodeId objectId, const UA_Variant *input,
  253. UA_Variant *output, void *handle);
  254. UA_AddNodesResult UA_EXPORT
  255. UA_Server_addMethodNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  256. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  257. const UA_QualifiedName browseName, const UA_MethodAttributes attr,
  258. UA_MethodCallback method, void *handle,
  259. UA_Int32 inputArgumentsSize, const UA_Argument* inputArguments,
  260. UA_Int32 outputArgumentsSize, const UA_Argument* outputArguments);
  261. #endif
  262. UA_StatusCode UA_EXPORT UA_Server_deleteNode(UA_Server *server, UA_NodeId nodeId);
  263. typedef UA_StatusCode (*UA_NodeIteratorCallback) (UA_NodeId childId, UA_Boolean isInverse,
  264. UA_NodeId referenceTypeId, void *handle);
  265. /** Iterate over all nodes referenced by parentNodeId by calling the callback function for each
  266. * child node
  267. *
  268. * @param server The server object.
  269. *
  270. * @param parentNodeId The NodeId of the parent whose references are to be iterated over
  271. *
  272. * @param callback The function of type UA_NodeIteratorCallback to be called for each referenced child
  273. *
  274. * @return Upon success, UA_STATUSCODE_GOOD is returned. An error code otherwise.
  275. */
  276. UA_StatusCode UA_EXPORT
  277. UA_Server_forEachChildNodeCall(UA_Server *server, UA_NodeId parentNodeId,
  278. UA_NodeIteratorCallback callback, void *handle);
  279. /***********************/
  280. /* Set Node Attributes */
  281. /***********************/
  282. /* The following node attributes cannot be changed once the node is created
  283. - NodeClass
  284. - NodeId
  285. - Symmetric
  286. The following attributes will eventually be managed by a userrights layer and are unsupported yet
  287. - WriteMask
  288. - UserWriteMask
  289. - AccessLevel
  290. - UserAccessLevel
  291. - UserExecutable
  292. The following attributes are currently taken from the value variant:
  293. - DataType
  294. - ValueRank
  295. - ArrayDimensions
  296. - Historizing is currently unsupported
  297. */
  298. UA_StatusCode UA_EXPORT
  299. UA_Server_setNodeAttribute_value(UA_Server *server, const UA_NodeId nodeId,
  300. const UA_DataType *type, const UA_Variant value);
  301. /* The value is moved into the node (not copied). The value variant is _inited internally. */
  302. UA_StatusCode UA_EXPORT
  303. UA_Server_setNodeAttribute_value_destructive(UA_Server *server, const UA_NodeId nodeId,
  304. const UA_DataType *type, UA_Variant *value);
  305. /* Succeeds only if the node contains a variant value */
  306. UA_StatusCode UA_EXPORT
  307. UA_Server_setAttribute_value_callback(UA_Server *server, const UA_NodeId nodeId,
  308. const UA_ValueCallback callback);
  309. UA_StatusCode UA_EXPORT
  310. UA_Server_setNodeAttribute_value_dataSource(UA_Server *server, const UA_NodeId nodeId,
  311. const UA_DataSource dataSource);
  312. /* Don't use this function. There are typed versions with no additional overhead. */
  313. UA_StatusCode UA_EXPORT
  314. UA_Server_setNodeAttribute(UA_Server *server, const UA_NodeId nodeId, const UA_AttributeId attributeId,
  315. const UA_DataType *type, const void *value);
  316. static UA_INLINE UA_StatusCode
  317. UA_Server_setNodeAttribute_browseName(UA_Server *server, const UA_NodeId nodeId,
  318. const UA_QualifiedName browseName) {
  319. return UA_Server_setNodeAttribute(server, nodeId, UA_ATTRIBUTEID_BROWSENAME,
  320. &UA_TYPES[UA_TYPES_QUALIFIEDNAME], &browseName); }
  321. static UA_INLINE UA_StatusCode
  322. UA_Server_setNodeAttribute_displayName(UA_Server *server, const UA_NodeId nodeId,
  323. const UA_LocalizedText displayName) {
  324. return UA_Server_setNodeAttribute(server, nodeId, UA_ATTRIBUTEID_DISPLAYNAME,
  325. &UA_TYPES[UA_TYPES_LOCALIZEDTEXT], &displayName); }
  326. static UA_INLINE UA_StatusCode
  327. UA_Server_setNodeAttribute_description(UA_Server *server, const UA_NodeId nodeId,
  328. const UA_LocalizedText description) {
  329. return UA_Server_setNodeAttribute(server, nodeId, UA_ATTRIBUTEID_DESCRIPTION,
  330. &UA_TYPES[UA_TYPES_LOCALIZEDTEXT], &description); }
  331. static UA_INLINE UA_StatusCode
  332. UA_Server_setNodeAttribute_isAbstract(UA_Server *server, const UA_NodeId nodeId,
  333. const UA_Boolean isAbstract) {
  334. return UA_Server_setNodeAttribute(server, nodeId, UA_ATTRIBUTEID_ISABSTRACT,
  335. &UA_TYPES[UA_TYPES_BOOLEAN], &isAbstract); }
  336. static UA_INLINE UA_StatusCode
  337. UA_Server_setNodeAttribute_inverseName(UA_Server *server, const UA_NodeId nodeId,
  338. const UA_LocalizedText inverseName) {
  339. return UA_Server_setNodeAttribute(server, nodeId, UA_ATTRIBUTEID_INVERSENAME,
  340. &UA_TYPES[UA_TYPES_LOCALIZEDTEXT], &inverseName); }
  341. static UA_INLINE UA_StatusCode
  342. UA_Server_setNodeAttribute_containtsNoLoops(UA_Server *server, const UA_NodeId nodeId,
  343. const UA_Boolean containsNoLoops) {
  344. return UA_Server_setNodeAttribute(server, nodeId, UA_ATTRIBUTEID_CONTAINSNOLOOPS,
  345. &UA_TYPES[UA_TYPES_BOOLEAN], &containsNoLoops); }
  346. static UA_INLINE UA_StatusCode
  347. UA_Server_setNodeAttribute_eventNotifier(UA_Server *server, const UA_NodeId nodeId,
  348. const UA_Byte eventNotifier) {
  349. return UA_Server_setNodeAttribute(server, nodeId, UA_ATTRIBUTEID_EVENTNOTIFIER,
  350. &UA_TYPES[UA_TYPES_BYTE], &eventNotifier); }
  351. static UA_INLINE UA_StatusCode
  352. UA_Server_setNodeAttribute_minimumSamplingInterval(UA_Server *server, const UA_NodeId nodeId,
  353. const UA_Double miniumSamplingInterval) {
  354. return UA_Server_setNodeAttribute(server, nodeId, UA_ATTRIBUTEID_MINIMUMSAMPLINGINTERVAL,
  355. &UA_TYPES[UA_TYPES_DOUBLE], &miniumSamplingInterval); }
  356. static UA_INLINE UA_StatusCode
  357. UA_Server_setNodeAttribute_executable(UA_Server *server, const UA_NodeId nodeId,
  358. const UA_Boolean executable) {
  359. return UA_Server_setNodeAttribute(server, nodeId, UA_ATTRIBUTEID_EXECUTABLE,
  360. &UA_TYPES[UA_TYPES_BOOLEAN], &executable); }
  361. #ifdef ENABLE_METHODCALLS
  362. UA_StatusCode UA_EXPORT
  363. UA_Server_setNodeAttribute_method(UA_Server *server, UA_NodeId methodNodeId,
  364. UA_MethodCallback method, void *handle);
  365. #endif
  366. typedef struct {
  367. void * (*constructor)(const UA_NodeId instance); ///< Returns the instance handle attached to the node
  368. void (*destructor)(const UA_NodeId instance, void *instanceHandle);
  369. } UA_ObjectInstanceManagement;
  370. UA_StatusCode UA_EXPORT
  371. UA_Server_setObjectInstanceManagement(UA_Server *server, UA_NodeId nodeId,
  372. UA_ObjectInstanceManagement oim);
  373. /***********************/
  374. /* Get Node Attributes */
  375. /***********************/
  376. /* The following attributes cannot be read. They make no sense to read internally since the "admin"
  377. user always has all rights.
  378. - UserWriteMask
  379. - UserAccessLevel
  380. - UserExecutable
  381. */
  382. /* Don't use this function. There are typed versions for every supported attribute. */
  383. UA_StatusCode UA_EXPORT
  384. UA_Server_getNodeAttribute(UA_Server *server, UA_NodeId nodeId, UA_AttributeId attributeId, void *v);
  385. static UA_INLINE UA_StatusCode
  386. UA_Server_getNodeAttribute_nodeId(UA_Server *server, UA_NodeId nodeId, UA_NodeId *outNodeId) {
  387. return UA_Server_getNodeAttribute(server, nodeId, UA_ATTRIBUTEID_NODEID, outNodeId); }
  388. static UA_INLINE UA_StatusCode
  389. UA_Server_getNodeAttribute_nodeClass(UA_Server *server, UA_NodeId nodeId, UA_NodeClass *outNodeClass) {
  390. return UA_Server_getNodeAttribute(server, nodeId, UA_ATTRIBUTEID_NODECLASS, outNodeClass); }
  391. static UA_INLINE UA_StatusCode
  392. UA_Server_getNodeAttribute_browseName(UA_Server *server, UA_NodeId nodeId, UA_QualifiedName *outBrowseName) {
  393. return UA_Server_getNodeAttribute(server, nodeId, UA_ATTRIBUTEID_BROWSENAME, outBrowseName); }
  394. static UA_INLINE UA_StatusCode
  395. UA_Server_getNodeAttribute_displayName(UA_Server *server, UA_NodeId nodeId, UA_LocalizedText *outDisplayName) {
  396. return UA_Server_getNodeAttribute(server, nodeId, UA_ATTRIBUTEID_DISPLAYNAME, outDisplayName); }
  397. static UA_INLINE UA_StatusCode
  398. UA_Server_getNodeAttribute_description(UA_Server *server, UA_NodeId nodeId, UA_LocalizedText *outDescription) {
  399. return UA_Server_getNodeAttribute(server, nodeId, UA_ATTRIBUTEID_DESCRIPTION, outDescription); }
  400. static UA_INLINE UA_StatusCode
  401. UA_Server_getNodeAttribute_writeMask(UA_Server *server, UA_NodeId nodeId, UA_UInt32 *outWriteMask) {
  402. return UA_Server_getNodeAttribute(server, nodeId, UA_ATTRIBUTEID_WRITEMASK, outWriteMask); }
  403. static UA_INLINE UA_StatusCode
  404. UA_Server_getNodeAttribute_isAbstract(UA_Server *server, UA_NodeId nodeId, UA_Boolean *outIsAbstract) {
  405. return UA_Server_getNodeAttribute(server, nodeId, UA_ATTRIBUTEID_ISABSTRACT, outIsAbstract); }
  406. static UA_INLINE UA_StatusCode
  407. UA_Server_getNodeAttribute_symmetric(UA_Server *server, UA_NodeId nodeId, UA_Boolean *outSymmetric) {
  408. return UA_Server_getNodeAttribute(server, nodeId, UA_ATTRIBUTEID_SYMMETRIC, outSymmetric); }
  409. static UA_INLINE UA_StatusCode
  410. UA_Server_getNodeAttribute_inverseName(UA_Server *server, UA_NodeId nodeId, UA_LocalizedText *outInverseName) {
  411. return UA_Server_getNodeAttribute(server, nodeId, UA_ATTRIBUTEID_INVERSENAME, outInverseName); }
  412. static UA_INLINE UA_StatusCode
  413. UA_Server_getNodeAttribute_containsNoLoops(UA_Server *server, UA_NodeId nodeId, UA_Boolean *outContainsNoLoops) {
  414. return UA_Server_getNodeAttribute(server, nodeId, UA_ATTRIBUTEID_CONTAINSNOLOOPS, outContainsNoLoops); }
  415. static UA_INLINE UA_StatusCode
  416. UA_Server_getNodeAttribute_eventNotifier(UA_Server *server, UA_NodeId nodeId, UA_Byte *outEventNotifier) {
  417. return UA_Server_getNodeAttribute(server, nodeId, UA_ATTRIBUTEID_EVENTNOTIFIER, outEventNotifier); }
  418. static UA_INLINE UA_StatusCode
  419. UA_Server_getNodeAttribute_value(UA_Server *server, UA_NodeId nodeId, UA_Variant *outValue) {
  420. return UA_Server_getNodeAttribute(server, nodeId, UA_ATTRIBUTEID_VALUE, outValue); }
  421. UA_StatusCode UA_EXPORT
  422. UA_Server_getNodeAttribute_value_dataSource(UA_Server *server, UA_NodeId nodeId, UA_DataSource *dataSource);
  423. static UA_INLINE UA_StatusCode
  424. UA_Server_getNodeAttribute_dataType(UA_Server *server, UA_NodeId nodeId, UA_Variant *outDataType) {
  425. return UA_Server_getNodeAttribute(server, nodeId, UA_ATTRIBUTEID_DATATYPE, outDataType); }
  426. static UA_INLINE UA_StatusCode
  427. UA_Server_getNodeAttribute_valueRank(UA_Server *server, UA_NodeId nodeId, UA_Int32 *outValueRank) {
  428. return UA_Server_getNodeAttribute(server, nodeId, UA_ATTRIBUTEID_VALUERANK, outValueRank); }
  429. static UA_INLINE UA_StatusCode
  430. UA_Server_getNodeAttribute_arrayDimensions(UA_Server *server, UA_NodeId nodeId, UA_Int32 *outArrayDimensions) {
  431. return UA_Server_getNodeAttribute(server, nodeId, UA_ATTRIBUTEID_ARRAYDIMENSIONS, outArrayDimensions); }
  432. static UA_INLINE UA_StatusCode
  433. UA_Server_getNodeAttribute_accessLevel(UA_Server *server, UA_NodeId nodeId, UA_UInt32 *outAccessLevel) {
  434. return UA_Server_getNodeAttribute(server, nodeId, UA_ATTRIBUTEID_ACCESSLEVEL, outAccessLevel); }
  435. static UA_INLINE UA_StatusCode
  436. UA_Server_getNodeAttribute_minimumSamplingInterval(UA_Server *server, UA_NodeId nodeId,
  437. UA_Double *outMinimumSamplingInterval) {
  438. return UA_Server_getNodeAttribute(server, nodeId, UA_ATTRIBUTEID_MINIMUMSAMPLINGINTERVAL,
  439. outMinimumSamplingInterval); }
  440. static UA_INLINE UA_StatusCode
  441. UA_Server_getNodeAttribute_historizing(UA_Server *server, UA_NodeId nodeId, UA_Double *outHistorizing) {
  442. return UA_Server_getNodeAttribute(server, nodeId, UA_ATTRIBUTEID_HISTORIZING, outHistorizing); }
  443. static UA_INLINE UA_StatusCode
  444. UA_Server_getNodeAttribute_executable(UA_Server *server, UA_NodeId nodeId, UA_Boolean *outExecutable) {
  445. return UA_Server_getNodeAttribute(server, nodeId, UA_ATTRIBUTEID_EXECUTABLE, outExecutable); }
  446. #ifdef ENABLE_METHODCALLS
  447. UA_StatusCode UA_EXPORT
  448. UA_Server_getNodeAttribute_method(UA_Server *server, UA_NodeId methodNodeId, UA_MethodCallback *method);
  449. #endif
  450. #ifndef __cplusplus /* the external nodestore does not work with c++ so far */
  451. /**
  452. * @ingroup nodestore
  453. *
  454. * @defgroup external_nodestore External Nodestore
  455. *
  456. * @brief An external application that manages its own data and data model
  457. *
  458. * To plug in outside data sources, one can use
  459. *
  460. * - VariableNodes with a data source (functions that are called for read and write access)
  461. * - An external nodestore that is mapped to specific namespaces
  462. *
  463. * If no external nodestore is defined for a nodeid, it is always looked up in
  464. * the "local" nodestore of open62541. Namespace Zero is always in the local
  465. * nodestore.
  466. *
  467. * @{
  468. */
  469. typedef UA_Int32 (*UA_ExternalNodeStore_addNodes)
  470. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_AddNodesItem *nodesToAdd, UA_UInt32 *indices,
  471. UA_UInt32 indicesSize, UA_AddNodesResult* addNodesResults, UA_DiagnosticInfo *diagnosticInfos);
  472. typedef UA_Int32 (*UA_ExternalNodeStore_addReferences)
  473. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_AddReferencesItem* referencesToAdd,
  474. UA_UInt32 *indices,UA_UInt32 indicesSize, UA_StatusCode *addReferencesResults,
  475. UA_DiagnosticInfo *diagnosticInfos);
  476. typedef UA_Int32 (*UA_ExternalNodeStore_deleteNodes)
  477. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_DeleteNodesItem *nodesToDelete, UA_UInt32 *indices,
  478. UA_UInt32 indicesSize, UA_StatusCode *deleteNodesResults, UA_DiagnosticInfo *diagnosticInfos);
  479. typedef UA_Int32 (*UA_ExternalNodeStore_deleteReferences)
  480. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_DeleteReferencesItem *referenceToDelete,
  481. UA_UInt32 *indices, UA_UInt32 indicesSize, UA_StatusCode deleteReferencesresults,
  482. UA_DiagnosticInfo *diagnosticInfos);
  483. typedef UA_Int32 (*UA_ExternalNodeStore_readNodes)
  484. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_ReadValueId *readValueIds, UA_UInt32 *indices,
  485. UA_UInt32 indicesSize,UA_DataValue *readNodesResults, UA_Boolean timeStampToReturn,
  486. UA_DiagnosticInfo *diagnosticInfos);
  487. typedef UA_Int32 (*UA_ExternalNodeStore_writeNodes)
  488. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_WriteValue *writeValues, UA_UInt32 *indices,
  489. UA_UInt32 indicesSize, UA_StatusCode *writeNodesResults, UA_DiagnosticInfo *diagnosticInfo);
  490. typedef UA_Int32 (*UA_ExternalNodeStore_browseNodes)
  491. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_BrowseDescription *browseDescriptions,
  492. UA_UInt32 *indices, UA_UInt32 indicesSize, UA_UInt32 requestedMaxReferencesPerNode,
  493. UA_BrowseResult *browseResults, UA_DiagnosticInfo *diagnosticInfos);
  494. typedef UA_Int32 (*UA_ExternalNodeStore_translateBrowsePathsToNodeIds)
  495. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_BrowsePath *browsePath, UA_UInt32 *indices,
  496. UA_UInt32 indicesSize, UA_BrowsePathResult *browsePathResults, UA_DiagnosticInfo *diagnosticInfos);
  497. typedef UA_Int32 (*UA_ExternalNodeStore_delete)(void *ensHandle);
  498. typedef struct UA_ExternalNodeStore {
  499. void *ensHandle;
  500. UA_ExternalNodeStore_addNodes addNodes;
  501. UA_ExternalNodeStore_deleteNodes deleteNodes;
  502. UA_ExternalNodeStore_writeNodes writeNodes;
  503. UA_ExternalNodeStore_readNodes readNodes;
  504. UA_ExternalNodeStore_browseNodes browseNodes;
  505. UA_ExternalNodeStore_translateBrowsePathsToNodeIds translateBrowsePathsToNodeIds;
  506. UA_ExternalNodeStore_addReferences addReferences;
  507. UA_ExternalNodeStore_deleteReferences deleteReferences;
  508. UA_ExternalNodeStore_delete destroy;
  509. } UA_ExternalNodeStore;
  510. #ifdef UA_EXTERNAL_NAMESPACES
  511. UA_StatusCode UA_EXPORT
  512. UA_Server_addExternalNamespace(UA_Server *server, UA_UInt16 namespaceIndex,
  513. const UA_String *url, UA_ExternalNodeStore *nodeStore);
  514. #endif /* UA_EXTERNAL_NAMESPACES*/
  515. /** @} */
  516. #endif /* external nodestore */
  517. #ifdef __cplusplus
  518. } // extern "C"
  519. #endif
  520. #endif /* UA_SERVER_H_ */