ua_server.h 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555
  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_connection.h"
  25. #include "ua_log.h"
  26. /**
  27. * @defgroup server Server
  28. *
  29. * @{
  30. */
  31. typedef struct UA_ServerConfig {
  32. UA_Boolean Login_enableAnonymous;
  33. UA_Boolean Login_enableUsernamePassword;
  34. char** Login_usernames;
  35. char** Login_passwords;
  36. UA_UInt32 Login_loginsCount;
  37. char* Application_applicationURI;
  38. char* Application_applicationName;
  39. } UA_ServerConfig;
  40. extern UA_EXPORT const UA_ServerConfig UA_ServerConfig_standard;
  41. struct UA_Server;
  42. typedef struct UA_Server UA_Server;
  43. UA_Server UA_EXPORT * UA_Server_new(UA_ServerConfig config);
  44. void UA_EXPORT UA_Server_setServerCertificate(UA_Server *server, UA_ByteString certificate);
  45. void UA_EXPORT UA_Server_delete(UA_Server *server);
  46. /** Sets the logger used by the server */
  47. void UA_EXPORT UA_Server_setLogger(UA_Server *server, UA_Logger logger);
  48. UA_Logger UA_EXPORT UA_Server_getLogger(UA_Server *server);
  49. /**
  50. * Runs the main loop of the server. In each iteration, this calls into the networklayers to see if
  51. * jobs have arrived and checks if repeated jobs need to be triggered.
  52. *
  53. * @param server The server object
  54. *
  55. * @param nThreads The number of worker threads. Is ignored if MULTITHREADING is not activated.
  56. *
  57. * @param running Points to a boolean value on the heap. When running is set to false, the worker
  58. * threads and the main loop close and the server is shut down.
  59. *
  60. * @return Indicates whether the server shut down cleanly
  61. *
  62. */
  63. UA_StatusCode UA_EXPORT UA_Server_run(UA_Server *server, UA_UInt16 nThreads, UA_Boolean *running);
  64. /* The prologue part of UA_Server_run (no need to use if you call UA_Server_run) */
  65. UA_StatusCode UA_EXPORT UA_Server_run_startup(UA_Server *server, UA_UInt16 nThreads, UA_Boolean *running);
  66. /* The epilogue part of UA_Server_run (no need to use if you call UA_Server_run) */
  67. UA_StatusCode UA_EXPORT UA_Server_run_shutdown(UA_Server *server, UA_UInt16 nThreads);
  68. /* One iteration of UA_Server_run (no need to use if you call UA_Server_run) */
  69. UA_StatusCode UA_EXPORT UA_Server_run_mainloop(UA_Server *server, UA_Boolean *running);
  70. /**
  71. * Datasources are the interface to local data providers. It is expected that
  72. * the read and release callbacks are implemented. The write callback can be set
  73. * to null.
  74. */
  75. typedef struct {
  76. void *handle; ///> A custom pointer to reuse the same datasource functions for multiple sources
  77. /**
  78. * Copies the data from the source into the provided value.
  79. *
  80. * @param handle An optional pointer to user-defined data for the specific data source
  81. * @param includeSourceTimeStamp If true, then the datasource is expected to set the source
  82. * timestamp in the returned value
  83. * @param range If not null, then the datasource shall return only a selection of the (nonscalar)
  84. * data. Set UA_STATUSCODE_BADINDEXRANGEINVALID in the value if this does not apply.
  85. * @param value The (non-null) DataValue that is returned to the client. The data source sets the
  86. * read data, the result status and optionally a sourcetimestamp.
  87. * @return Returns a status code for logging. Error codes intended for the original caller are set
  88. * in the value. If an error is returned, then no releasing of the value is done.
  89. */
  90. UA_StatusCode (*read)(void *handle, UA_Boolean includeSourceTimeStamp, const UA_NumericRange *range, UA_DataValue *value);
  91. /**
  92. * Write into a data source. The write member of UA_DataSource can be empty if the operation
  93. * is unsupported.
  94. *
  95. * @param handle An optional pointer to user-defined data for the specific data source
  96. * @param data The data to be written into the data source
  97. * @param range An optional data range. If the data source is scalar or does not support writing
  98. * of ranges, then an error code is returned.
  99. * @return Returns a status code that is returned to the user
  100. */
  101. UA_StatusCode (*write)(void *handle, const UA_Variant *data, const UA_NumericRange *range);
  102. } UA_DataSource;
  103. /** @brief Add a new namespace to the server. Returns the index of the new namespace */
  104. UA_UInt16 UA_EXPORT UA_Server_addNamespace(UA_Server *server, const char* name);
  105. /** Add a reference to the server's address space */
  106. UA_StatusCode UA_EXPORT UA_Server_addReference(UA_Server *server, const UA_NodeId sourceId,
  107. const UA_NodeId refTypeId, const UA_ExpandedNodeId targetId);
  108. /** Deletes a node from the nodestore.
  109. *
  110. * @param server The server object
  111. * @param nodeId ID of the node to be deleted
  112. * @return Return UA_STATUSCODE_GOOD if the node was deleted or an appropriate errorcode if the node was not found
  113. * or cannot be deleted.
  114. */
  115. UA_StatusCode UA_EXPORT
  116. UA_Server_deleteNode(UA_Server *server, UA_NodeId nodeId);
  117. #define UA_SERVER_DELETENODEALIAS_DECL(TYPE) \
  118. UA_StatusCode UA_EXPORT UA_Server_delete##TYPE##Node(UA_Server *server, UA_NodeId nodeId);
  119. /** Deletes an ObjectNode from the nodestore. This is a high-level alias for UA_Server_deleteNode()
  120. *
  121. * @param server The server object
  122. * @param nodeId ID of the node to be deleted
  123. *
  124. * @return Return UA_STATUSCODE_GOOD if the node was deleted or an appropriate errorcode if the node was not found
  125. * or cannot be deleted.
  126. */
  127. UA_SERVER_DELETENODEALIAS_DECL(Object)
  128. /** Deletes a VariableNode from the nodestore. This is a high-level alias for UA_Server_deleteNode()
  129. *
  130. * @param server The server object
  131. * @param nodeId ID of the node to be deleted
  132. *
  133. * @return Return UA_STATUSCODE_GOOD if the node was deleted or an appropriate errorcode if the node was not found
  134. * or cannot be deleted.
  135. */
  136. UA_SERVER_DELETENODEALIAS_DECL(Variable)
  137. /** Deletes a ReferenceType node from the nodestore. This is a high-level alias for UA_Server_deleteNode()
  138. *
  139. * @param server The server object
  140. * @param nodeId ID of the node to be deleted
  141. *
  142. * @return Return UA_STATUSCODE_GOOD if the node was deleted or an appropriate errorcode if the node was not found
  143. * or cannot be deleted.
  144. */
  145. UA_SERVER_DELETENODEALIAS_DECL(ReferenceType)
  146. /** Deletes a View Node from the nodestore. This is a high-level alias for UA_Server_deleteNode()
  147. *
  148. * @param server The server object
  149. * @param nodeId ID of the node to be deleted
  150. *
  151. * @return Return UA_STATUSCODE_GOOD if the node was deleted or an appropriate errorcode if the node was not found
  152. * or cannot be deleted.
  153. */
  154. UA_SERVER_DELETENODEALIAS_DECL(View)
  155. /** Deletes a VariableType node from the nodestore. This is a high-level alias for UA_Server_deleteNode()
  156. *
  157. * @param server The server object
  158. * @param nodeId ID of the node to be deleted
  159. *
  160. * @return Return UA_STATUSCODE_GOOD if the node was deleted or an appropriate errorcode if the node was not found
  161. * or cannot be deleted.
  162. */
  163. UA_SERVER_DELETENODEALIAS_DECL(VariableType)
  164. /** Deletes a DataType Node from the nodestore. This is a high-level alias for UA_Server_deleteNode()
  165. *
  166. * @param server The server object
  167. * @param nodeId ID of the node to be deleted
  168. *
  169. * @return Return UA_STATUSCODE_GOOD if the node was deleted or an appropriate errorcode if the node was not found
  170. * or cannot be deleted.
  171. */
  172. UA_SERVER_DELETENODEALIAS_DECL(DataType)
  173. #ifdef ENABLE_METHODCALLS
  174. /** Deletes an MethodNode from the nodestore. This is a high-level alias for UA_Server_deleteNode()
  175. *
  176. * @param server The server object
  177. * @param nodeId ID of the node to be deleted
  178. *
  179. * @return Return UA_STATUSCODE_GOOD if the node was deleted or an appropriate errorcode if the node was not found
  180. * or cannot be deleted.
  181. */
  182. UA_SERVER_DELETENODEALIAS_DECL(Method)
  183. #endif
  184. /** Deletes a copied instance of a node by deallocating it and all its attributes. This assumes that the node was
  185. * priorly copied using getNodeCopy. To delete nodes that are located in the nodestore, use UA_Server_deleteNode()
  186. * instead.
  187. *
  188. * @param server The server object
  189. * @param nodeId ID of the node copy to be deleted
  190. *
  191. * @return Return UA_STATUSCODE_GOOD if the node was deleted or an appropriate errorcode if the node was not found
  192. * or cannot be deleted.
  193. */
  194. UA_StatusCode UA_EXPORT
  195. UA_Server_deleteNodeCopy(UA_Server *server, void **node);
  196. /** Creates a deep copy of a node located in the nodestore and returns it to the userspace. Note that any manipulation
  197. * of this copied node is not reflected by the server, but otherwise not accessible attributes of the node's struct
  198. * can be examined in bulk. node->nodeClass can be used to cast the node to a specific node type. Use
  199. * UA_Server_deleteNodeCopy() to deallocate this node.
  200. *
  201. * @param server The server object
  202. * @param nodeId ID of the node copy to be copied
  203. * @param copyInto Pointer to a NULL pointer that will hold the copy of the node on a successfull return.
  204. *
  205. * @return Return UA_STATUSCODE_GOOD if the node was copied or an appropriate errorcode if the node was not found
  206. * or cannot be copied.
  207. */
  208. UA_StatusCode UA_EXPORT
  209. UA_Server_getNodeCopy(UA_Server *server, UA_NodeId nodeId, void **copyInto);
  210. /** A new variable Node with a value passed in variant.
  211. *
  212. * @param server The server object
  213. * @param nodeId The requested nodeId of the new node. Use the numeric id with i=0 to get a new ID from the server.
  214. * @param browseName The qualified name of this node
  215. * @param displayName The localized text shown when displaying the node
  216. * @param description The localized human readable description
  217. * @param parentNodeId The node under which this node exists ("parent")
  218. * @param referenceTypeId Reference type used by the parent to reference this node
  219. * @param userWriteMask Bitmask defining the user write permissions
  220. * @param writeMask Bitmask defining the write permissions
  221. * @param value A variant containing the value to be assigned to this node.
  222. * @param copyInto Pointer to a NULL pointer that will hold the copy of the node on a successfull return.
  223. *
  224. * @return Return UA_STATUSCODE_GOOD if the node was created or an appropriate error code if not.
  225. */
  226. UA_StatusCode UA_EXPORT
  227. UA_Server_addVariableNode(UA_Server *server, UA_NodeId nodeId, const UA_QualifiedName browseName,
  228. UA_LocalizedText displayName, UA_LocalizedText description, const UA_NodeId parentNodeId,
  229. const UA_NodeId referenceTypeId, UA_UInt32 userWriteMask, UA_UInt32 writeMask,
  230. UA_Variant *value, UA_NodeId *createdNodeId);
  231. UA_StatusCode UA_EXPORT
  232. UA_Server_addObjectNode(UA_Server *server, UA_NodeId nodeId, const UA_QualifiedName browseName,
  233. UA_LocalizedText displayName, UA_LocalizedText description, const UA_NodeId parentNodeId,
  234. const UA_NodeId referenceTypeId, UA_UInt32 userWriteMask, UA_UInt32 writeMask,
  235. const UA_ExpandedNodeId typeDefinition, UA_NodeId *createdNodeId);
  236. UA_StatusCode UA_EXPORT
  237. UA_Server_addReferenceTypeNode(UA_Server *server, UA_NodeId nodeId, UA_QualifiedName browseName,
  238. UA_LocalizedText displayName, UA_LocalizedText description, UA_NodeId parentNodeId,
  239. const UA_NodeId referenceTypeId, UA_UInt32 userWriteMask, UA_UInt32 writeMask,
  240. const UA_ExpandedNodeId typeDefinition, UA_LocalizedText inverseName, UA_NodeId *createdNodeId );
  241. UA_StatusCode UA_EXPORT
  242. UA_Server_addObjectTypeNode(UA_Server *server, UA_NodeId nodeId, UA_QualifiedName browseName,
  243. UA_LocalizedText displayName, UA_LocalizedText description, UA_NodeId parentNodeId,
  244. UA_NodeId referenceTypeId, UA_UInt32 userWriteMask, UA_UInt32 writeMask,
  245. UA_ExpandedNodeId typeDefinition, UA_Boolean isAbstract,
  246. UA_NodeId *createdNodeId );
  247. UA_StatusCode UA_EXPORT
  248. UA_Server_addVariableTypeNode(UA_Server *server, UA_NodeId nodeId, const UA_QualifiedName browseName,
  249. UA_LocalizedText displayName, UA_LocalizedText description, const UA_NodeId parentNodeId,
  250. const UA_NodeId referenceTypeId, UA_UInt32 userWriteMask, UA_UInt32 writeMask,
  251. UA_Variant *value, UA_Int32 valueRank, UA_Boolean isAbstract, UA_NodeId *createdNodeId);
  252. UA_StatusCode UA_EXPORT
  253. UA_Server_addDataTypeNode(UA_Server *server, UA_NodeId nodeId, const UA_QualifiedName browseName,
  254. UA_LocalizedText displayName, UA_LocalizedText description, const UA_NodeId parentNodeId,
  255. const UA_NodeId referenceTypeId, UA_UInt32 userWriteMask, UA_UInt32 writeMask,
  256. UA_ExpandedNodeId typeDefinition, UA_Boolean isAbstract, UA_NodeId *createdNodeId);
  257. UA_StatusCode UA_EXPORT
  258. UA_Server_addViewNode(UA_Server *server, UA_NodeId nodeId, const UA_QualifiedName browseName,
  259. UA_LocalizedText displayName, UA_LocalizedText description, const UA_NodeId parentNodeId,
  260. const UA_NodeId referenceTypeId, UA_UInt32 userWriteMask, UA_UInt32 writeMask,
  261. UA_ExpandedNodeId typeDefinition, UA_NodeId *createdNodeId);
  262. UA_StatusCode UA_EXPORT
  263. UA_Server_addDataSourceVariableNode(UA_Server *server, UA_DataSource dataSource,
  264. const UA_QualifiedName browseName, UA_NodeId nodeId,
  265. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  266. UA_NodeId *createdNodeId);
  267. UA_StatusCode UA_EXPORT
  268. UA_Server_AddMonodirectionalReference(UA_Server *server, UA_NodeId sourceNodeId,
  269. UA_ExpandedNodeId targetNodeId, UA_NodeId referenceTypeId,
  270. UA_Boolean isforward);
  271. #ifdef ENABLE_METHODCALLS
  272. typedef UA_StatusCode (*UA_MethodCallback)(const UA_NodeId objectId, const UA_Variant *input,
  273. UA_Variant *output);
  274. /** Creates a serverside method including input- and output variable descriptions
  275. *
  276. * @param server The server object.
  277. *
  278. * @param browseName BrowseName to be used for the new method.
  279. *
  280. * @param nodeId Requested NodeId for the new method. If a numeric ID with i=0 is used, the server will assign a random unused id.
  281. *
  282. * @param parentNodeId Parent node containing this method. Note that an ObjectNode needs to reference the method with hasProperty in order for the method to be callable.
  283. *
  284. * @param referenceTypeId Reference type ID to be used by the parent to reference the new method.
  285. *
  286. * @param method Userspace Method/Function of type UA_MethodCallback to be called when a client invokes the method using the Call Service Set.
  287. *
  288. * @param inputArgumentsSize Number of input arguments expected to be passed by a calling client.
  289. *
  290. * @param inputArguments Description of input arguments expected to be passed by a calling client.
  291. *
  292. * @param outputArgumentsSize Description of output arguments expected to be passed by a calling client.
  293. *
  294. * @param outputArguments Description of output arguments expected to be passed by a calling client.
  295. *
  296. * @param createdNodeId Actual nodeId of the new method node if UA_StatusCode indicates success. Can be used to determine the random unique ID assigned by the server if i=0 was passed as a nodeId.
  297. *
  298. */
  299. UA_StatusCode UA_EXPORT
  300. UA_Server_addMethodNode(UA_Server *server, const UA_QualifiedName browseName, UA_NodeId nodeId,
  301. const UA_ExpandedNodeId parentNodeId, const UA_NodeId referenceTypeId,
  302. UA_MethodCallback method, UA_Int32 inputArgumentsSize,
  303. const UA_Argument *inputArguments, UA_Int32 outputArgumentsSize,
  304. const UA_Argument *outputArguments,
  305. UA_NodeId *createdNodeId);
  306. #endif
  307. typedef UA_StatusCode (*UA_NodeIteratorCallback)(UA_NodeId childId, UA_Boolean isInverse, UA_NodeId referenceTypeId);
  308. /** Iterate over all nodes referenced by parentNodeId by calling the callback function for each child node
  309. *
  310. * @param server The server object.
  311. *
  312. * @param parentNodeId The NodeId of the parent whose references are to be iterated over
  313. *
  314. * @param callback The function of type UA_NodeIteratorCallback to be called for each referenced child
  315. *
  316. * @return Upon success, UA_STATUSCODE_GOOD is returned. An error code otherwise.
  317. */
  318. UA_StatusCode UA_EXPORT UA_Server_forEachChildNodeCall(UA_Server *server, UA_NodeId parentNodeId, UA_NodeIteratorCallback callback);
  319. /** Jobs describe work that is executed once or repeatedly. */
  320. typedef struct {
  321. enum {
  322. UA_JOBTYPE_NOTHING,
  323. UA_JOBTYPE_DETACHCONNECTION,
  324. UA_JOBTYPE_BINARYMESSAGE,
  325. UA_JOBTYPE_METHODCALL,
  326. UA_JOBTYPE_DELAYEDMETHODCALL,
  327. } type;
  328. union {
  329. UA_Connection *closeConnection;
  330. struct {
  331. UA_Connection *connection;
  332. UA_ByteString message;
  333. } binaryMessage;
  334. struct {
  335. void *data;
  336. void (*method)(UA_Server *server, void *data);
  337. } methodCall;
  338. } job;
  339. } UA_Job;
  340. /**
  341. * @param server The server object.
  342. *
  343. * @param job Pointer to the job that shall be added. The pointer is not freed but copied to an
  344. * internal representation.
  345. *
  346. * @param interval The job shall be repeatedly executed with the given interval (in ms). The
  347. * interval must be larger than 5ms. The first execution occurs at now() + interval at the
  348. * latest.
  349. *
  350. * @param jobId Set to the guid of the repeated job. This can be used to cancel the job later on. If
  351. * the pointer is null, the guid is not set.
  352. *
  353. * @return Upon success, UA_STATUSCODE_GOOD is returned. An error code otherwise.
  354. */
  355. UA_StatusCode UA_EXPORT UA_Server_addRepeatedJob(UA_Server *server, UA_Job job, UA_UInt32 interval,
  356. UA_Guid *jobId);
  357. /**
  358. * Remove repeated job. The entry will be removed asynchronously during the
  359. * next iteration of the server main loop.
  360. *
  361. * @param server The server object.
  362. *
  363. * @param jobId The id of the job that shall be removed.
  364. *
  365. * @return Upon sucess, UA_STATUSCODE_GOOD is returned. An error code otherwise.
  366. */
  367. UA_StatusCode UA_EXPORT UA_Server_removeRepeatedJob(UA_Server *server, UA_Guid jobId);
  368. /**
  369. * Interface to the binary network layers. This structure is returned from the
  370. * function that initializes the network layer. The layer is already bound to a
  371. * specific port and listening. The functions in the structure are never called
  372. * in parallel but only sequentially from the server's main loop. So the network
  373. * layer does not need to be thread-safe.
  374. */
  375. typedef struct UA_ServerNetworkLayer {
  376. void *handle;
  377. UA_String discoveryUrl;
  378. /**
  379. * Starts listening on the the networklayer.
  380. *
  381. * @param nl The network layer
  382. * @param logger The logger
  383. * @return Returns UA_STATUSCODE_GOOD or an error code.
  384. */
  385. UA_StatusCode (*start)(struct UA_ServerNetworkLayer *nl, UA_Logger *logger);
  386. /**
  387. * Gets called from the main server loop and returns the jobs (accumulated messages and close
  388. * events) for dispatch.
  389. *
  390. * @param nl The network layer
  391. * @param jobs When the returned integer is positive, *jobs points to an array of UA_Job of the
  392. * returned size.
  393. * @param timeout The timeout during which an event must arrive in microseconds
  394. * @return The size of the jobs array. If the result is negative, an error has occurred.
  395. */
  396. UA_Int32 (*getJobs)(struct UA_ServerNetworkLayer *nl, UA_Job **jobs, UA_UInt16 timeout);
  397. /**
  398. * Closes the network connection and returns all the jobs that need to be finished before the
  399. * network layer can be safely deleted.
  400. *
  401. * @param nl The network layer
  402. * @param jobs When the returned integer is positive, jobs points to an array of UA_Job of the
  403. * returned size.
  404. * @return The size of the jobs array. If the result is negative, an error has occurred.
  405. */
  406. UA_Int32 (*stop)(struct UA_ServerNetworkLayer *nl, UA_Job **jobs);
  407. /** Deletes the network layer. Call only after a successful shutdown. */
  408. void (*deleteMembers)(struct UA_ServerNetworkLayer *nl);
  409. } UA_ServerNetworkLayer;
  410. /**
  411. * Adds a network layer to the server. The network layer is destroyed together
  412. * with the server. Do not use it after adding it as it might be moved around on
  413. * the heap.
  414. */
  415. void UA_EXPORT UA_Server_addNetworkLayer(UA_Server *server, UA_ServerNetworkLayer networkLayer);
  416. /** @} */
  417. #ifndef __cplusplus /* the external nodestore does not work with c++ so far */
  418. /**
  419. * @ingroup nodestore
  420. *
  421. * @defgroup external_nodestore External Nodestore
  422. *
  423. * @brief An external application that manages its own data and data model
  424. *
  425. * To plug in outside data sources, one can use
  426. *
  427. * - VariableNodes with a data source (functions that are called for read and write access)
  428. * - An external nodestore that is mapped to specific namespaces
  429. *
  430. * If no external nodestore is defined for a nodeid, it is always looked up in
  431. * the "local" nodestore of open62541. Namespace Zero is always in the local
  432. * nodestore.
  433. *
  434. * @{
  435. */
  436. typedef UA_Int32 (*UA_ExternalNodeStore_addNodes)
  437. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_AddNodesItem *nodesToAdd, UA_UInt32 *indices,
  438. UA_UInt32 indicesSize, UA_AddNodesResult* addNodesResults, UA_DiagnosticInfo *diagnosticInfos);
  439. typedef UA_Int32 (*UA_ExternalNodeStore_addReferences)
  440. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_AddReferencesItem* referencesToAdd,
  441. UA_UInt32 *indices,UA_UInt32 indicesSize, UA_StatusCode *addReferencesResults,
  442. UA_DiagnosticInfo *diagnosticInfos);
  443. typedef UA_Int32 (*UA_ExternalNodeStore_deleteNodes)
  444. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_DeleteNodesItem *nodesToDelete, UA_UInt32 *indices,
  445. UA_UInt32 indicesSize, UA_StatusCode *deleteNodesResults, UA_DiagnosticInfo *diagnosticInfos);
  446. typedef UA_Int32 (*UA_ExternalNodeStore_deleteReferences)
  447. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_DeleteReferencesItem *referenceToDelete,
  448. UA_UInt32 *indices, UA_UInt32 indicesSize, UA_StatusCode deleteReferencesresults,
  449. UA_DiagnosticInfo *diagnosticInfos);
  450. typedef UA_Int32 (*UA_ExternalNodeStore_readNodes)
  451. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_ReadValueId *readValueIds, UA_UInt32 *indices,
  452. UA_UInt32 indicesSize,UA_DataValue *readNodesResults, UA_Boolean timeStampToReturn,
  453. UA_DiagnosticInfo *diagnosticInfos);
  454. typedef UA_Int32 (*UA_ExternalNodeStore_writeNodes)
  455. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_WriteValue *writeValues, UA_UInt32 *indices,
  456. UA_UInt32 indicesSize, UA_StatusCode *writeNodesResults, UA_DiagnosticInfo *diagnosticInfo);
  457. typedef UA_Int32 (*UA_ExternalNodeStore_browseNodes)
  458. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_BrowseDescription *browseDescriptions,
  459. UA_UInt32 *indices, UA_UInt32 indicesSize, UA_UInt32 requestedMaxReferencesPerNode,
  460. UA_BrowseResult *browseResults, UA_DiagnosticInfo *diagnosticInfos);
  461. typedef UA_Int32 (*UA_ExternalNodeStore_translateBrowsePathsToNodeIds)
  462. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_BrowsePath *browsePath,
  463. UA_UInt32 *indices, UA_UInt32 indicesSize, UA_BrowsePathResult *browsePathResults, UA_DiagnosticInfo *diagnosticInfos);
  464. typedef UA_Int32 (*UA_ExternalNodeStore_delete)(void *ensHandle);
  465. typedef struct UA_ExternalNodeStore {
  466. void *ensHandle;
  467. UA_ExternalNodeStore_addNodes addNodes;
  468. UA_ExternalNodeStore_deleteNodes deleteNodes;
  469. UA_ExternalNodeStore_writeNodes writeNodes;
  470. UA_ExternalNodeStore_readNodes readNodes;
  471. UA_ExternalNodeStore_browseNodes browseNodes;
  472. UA_ExternalNodeStore_translateBrowsePathsToNodeIds translateBrowsePathsToNodeIds;
  473. UA_ExternalNodeStore_addReferences addReferences;
  474. UA_ExternalNodeStore_deleteReferences deleteReferences;
  475. UA_ExternalNodeStore_delete destroy;
  476. } UA_ExternalNodeStore;
  477. UA_StatusCode UA_EXPORT
  478. UA_Server_addExternalNamespace(UA_Server *server, UA_UInt16 namespaceIndex, const UA_String *url, UA_ExternalNodeStore *nodeStore);
  479. /** @} */
  480. #endif /* external nodestore */
  481. #ifdef __cplusplus
  482. } // extern "C"
  483. #endif
  484. #endif /* UA_SERVER_H_ */