ua_server.h 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468
  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. #ifdef ENABLE_METHODCALLS
  138. /** Deletes an MethodNode from the nodestore. This is a high-level alias for UA_Server_deleteNode()
  139. *
  140. * @param server The server object
  141. * @param nodeId ID of the node to be deleted
  142. *
  143. * @return Return UA_STATUSCODE_GOOD if the node was deleted or an appropriate errorcode if the node was not found
  144. * or cannot be deleted.
  145. */
  146. UA_SERVER_DELETENODEALIAS_DECL(Method)
  147. #endif
  148. /** Deletes a copied instance of a node by deallocating it and all its attributes. This assumes that the node was
  149. * priorly copied using getNodeCopy. To delete nodes that are located in the nodestore, use UA_Server_deleteNode()
  150. * instead.
  151. *
  152. * @param server The server object
  153. * @param nodeId ID of the node copy to be deleted
  154. *
  155. * @return Return UA_STATUSCODE_GOOD if the node was deleted or an appropriate errorcode if the node was not found
  156. * or cannot be deleted.
  157. */
  158. UA_StatusCode UA_EXPORT
  159. UA_Server_deleteNodeCopy(UA_Server *server, void **node);
  160. /** Creates a deep copy of a node located in the nodestore and returns it to the userspace. Note that any manipulation
  161. * of this copied node is not reflected by the server, but otherwise not accessible attributes of the node's struct
  162. * can be examined in bulk. node->nodeClass can be used to cast the node to a specific node type. Use
  163. * UA_Server_deleteNodeCopy() to deallocate this node.
  164. *
  165. * @param server The server object
  166. * @param nodeId ID of the node copy to be copied
  167. * @param copyInto Pointer to a NULL pointer that will hold the copy of the node on a successfull return.
  168. *
  169. * @return Return UA_STATUSCODE_GOOD if the node was copied or an appropriate errorcode if the node was not found
  170. * or cannot be copied.
  171. */
  172. UA_StatusCode UA_EXPORT
  173. UA_Server_getNodeCopy(UA_Server *server, UA_NodeId nodeId, void **copyInto);
  174. UA_StatusCode UA_EXPORT
  175. UA_Server_addVariableNode(UA_Server *server, UA_Variant *value, const UA_QualifiedName browseName,
  176. UA_NodeId nodeId, const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  177. UA_NodeId *createdNodeId
  178. );
  179. UA_StatusCode UA_EXPORT
  180. UA_Server_addObjectNode(UA_Server *server, const UA_QualifiedName browseName,
  181. UA_NodeId nodeId, const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  182. const UA_NodeId typeDefinition,
  183. UA_NodeId *createdNodeId);
  184. UA_StatusCode UA_EXPORT
  185. UA_Server_addDataSourceVariableNode(UA_Server *server, UA_DataSource dataSource,
  186. const UA_QualifiedName browseName, UA_NodeId nodeId,
  187. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  188. UA_NodeId *createdNodeId);
  189. UA_StatusCode UA_EXPORT
  190. UA_Server_AddMonodirectionalReference(UA_Server *server, UA_NodeId sourceNodeId,
  191. UA_ExpandedNodeId targetNodeId, UA_NodeId referenceTypeId,
  192. UA_Boolean isforward);
  193. #ifdef ENABLE_METHODCALLS
  194. typedef UA_StatusCode (*UA_MethodCallback)(const UA_NodeId objectId, const UA_Variant *input,
  195. UA_Variant *output);
  196. /** Creates a serverside method including input- and output variable descriptions
  197. *
  198. * @param server The server object.
  199. *
  200. * @param browseName BrowseName to be used for the new method.
  201. *
  202. * @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.
  203. *
  204. * @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.
  205. *
  206. * @param referenceTypeId Reference type ID to be used by the parent to reference the new method.
  207. *
  208. * @param method Userspace Method/Function of type UA_MethodCallback to be called when a client invokes the method using the Call Service Set.
  209. *
  210. * @param inputArgumentsSize Number of input arguments expected to be passed by a calling client.
  211. *
  212. * @param inputArguments Description of input arguments expected to be passed by a calling client.
  213. *
  214. * @param outputArgumentsSize Description of output arguments expected to be passed by a calling client.
  215. *
  216. * @param outputArguments Description of output arguments expected to be passed by a calling client.
  217. *
  218. * @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.
  219. *
  220. */
  221. UA_StatusCode UA_EXPORT
  222. UA_Server_addMethodNode(UA_Server *server, const UA_QualifiedName browseName, UA_NodeId nodeId,
  223. const UA_ExpandedNodeId parentNodeId, const UA_NodeId referenceTypeId,
  224. UA_MethodCallback method, UA_Int32 inputArgumentsSize,
  225. const UA_Argument *inputArguments, UA_Int32 outputArgumentsSize,
  226. const UA_Argument *outputArguments,
  227. UA_NodeId *createdNodeId);
  228. #endif
  229. typedef UA_StatusCode (*UA_NodeIteratorCallback)(UA_NodeId childId, UA_Boolean isInverse, UA_NodeId referenceTypeId);
  230. /** Iterate over all nodes referenced by parentNodeId by calling the callback function for each child node
  231. *
  232. * @param server The server object.
  233. *
  234. * @param parentNodeId The NodeId of the parent whose references are to be iterated over
  235. *
  236. * @param callback The function of type UA_NodeIteratorCallback to be called for each referenced child
  237. *
  238. * @return Upon success, UA_STATUSCODE_GOOD is returned. An error code otherwise.
  239. */
  240. UA_StatusCode UA_EXPORT UA_Server_forEachChildNodeCall(UA_Server *server, UA_NodeId parentNodeId, UA_NodeIteratorCallback callback);
  241. /** Jobs describe work that is executed once or repeatedly. */
  242. typedef struct {
  243. enum {
  244. UA_JOBTYPE_NOTHING,
  245. UA_JOBTYPE_DETACHCONNECTION,
  246. UA_JOBTYPE_BINARYMESSAGE,
  247. UA_JOBTYPE_METHODCALL,
  248. UA_JOBTYPE_DELAYEDMETHODCALL,
  249. } type;
  250. union {
  251. UA_Connection *closeConnection;
  252. struct {
  253. UA_Connection *connection;
  254. UA_ByteString message;
  255. } binaryMessage;
  256. struct {
  257. void *data;
  258. void (*method)(UA_Server *server, void *data);
  259. } methodCall;
  260. } job;
  261. } UA_Job;
  262. /**
  263. * @param server The server object.
  264. *
  265. * @param job Pointer to the job that shall be added. The pointer is not freed but copied to an
  266. * internal representation.
  267. *
  268. * @param interval The job shall be repeatedly executed with the given interval (in ms). The
  269. * interval must be larger than 5ms. The first execution occurs at now() + interval at the
  270. * latest.
  271. *
  272. * @param jobId Set to the guid of the repeated job. This can be used to cancel the job later on. If
  273. * the pointer is null, the guid is not set.
  274. *
  275. * @return Upon success, UA_STATUSCODE_GOOD is returned. An error code otherwise.
  276. */
  277. UA_StatusCode UA_EXPORT UA_Server_addRepeatedJob(UA_Server *server, UA_Job job, UA_UInt32 interval,
  278. UA_Guid *jobId);
  279. /**
  280. * Remove repeated job. The entry will be removed asynchronously during the
  281. * next iteration of the server main loop.
  282. *
  283. * @param server The server object.
  284. *
  285. * @param jobId The id of the job that shall be removed.
  286. *
  287. * @return Upon sucess, UA_STATUSCODE_GOOD is returned. An error code otherwise.
  288. */
  289. UA_StatusCode UA_EXPORT UA_Server_removeRepeatedJob(UA_Server *server, UA_Guid jobId);
  290. /**
  291. * Interface to the binary network layers. This structure is returned from the
  292. * function that initializes the network layer. The layer is already bound to a
  293. * specific port and listening. The functions in the structure are never called
  294. * in parallel but only sequentially from the server's main loop. So the network
  295. * layer does not need to be thread-safe.
  296. */
  297. typedef struct UA_ServerNetworkLayer {
  298. void *handle;
  299. UA_String discoveryUrl;
  300. /**
  301. * Starts listening on the the networklayer.
  302. *
  303. * @param nl The network layer
  304. * @param logger The logger
  305. * @return Returns UA_STATUSCODE_GOOD or an error code.
  306. */
  307. UA_StatusCode (*start)(struct UA_ServerNetworkLayer *nl, UA_Logger *logger);
  308. /**
  309. * Gets called from the main server loop and returns the jobs (accumulated messages and close
  310. * events) for dispatch.
  311. *
  312. * @param nl The network layer
  313. * @param jobs When the returned integer is positive, *jobs points to an array of UA_Job of the
  314. * returned size.
  315. * @param timeout The timeout during which an event must arrive in microseconds
  316. * @return The size of the jobs array. If the result is negative, an error has occurred.
  317. */
  318. UA_Int32 (*getJobs)(struct UA_ServerNetworkLayer *nl, UA_Job **jobs, UA_UInt16 timeout);
  319. /**
  320. * Closes the network connection and returns all the jobs that need to be finished before the
  321. * network layer can be safely deleted.
  322. *
  323. * @param nl The network layer
  324. * @param jobs When the returned integer is positive, jobs points to an array of UA_Job of the
  325. * returned size.
  326. * @return The size of the jobs array. If the result is negative, an error has occurred.
  327. */
  328. UA_Int32 (*stop)(struct UA_ServerNetworkLayer *nl, UA_Job **jobs);
  329. /** Deletes the network layer. Call only after a successful shutdown. */
  330. void (*deleteMembers)(struct UA_ServerNetworkLayer *nl);
  331. } UA_ServerNetworkLayer;
  332. /**
  333. * Adds a network layer to the server. The network layer is destroyed together
  334. * with the server. Do not use it after adding it as it might be moved around on
  335. * the heap.
  336. */
  337. void UA_EXPORT UA_Server_addNetworkLayer(UA_Server *server, UA_ServerNetworkLayer networkLayer);
  338. /** @} */
  339. #ifndef __cplusplus /* the external nodestore does not work with c++ so far */
  340. /**
  341. * @ingroup nodestore
  342. *
  343. * @defgroup external_nodestore External Nodestore
  344. *
  345. * @brief An external application that manages its own data and data model
  346. *
  347. * To plug in outside data sources, one can use
  348. *
  349. * - VariableNodes with a data source (functions that are called for read and write access)
  350. * - An external nodestore that is mapped to specific namespaces
  351. *
  352. * If no external nodestore is defined for a nodeid, it is always looked up in
  353. * the "local" nodestore of open62541. Namespace Zero is always in the local
  354. * nodestore.
  355. *
  356. * @{
  357. */
  358. typedef UA_Int32 (*UA_ExternalNodeStore_addNodes)
  359. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_AddNodesItem *nodesToAdd, UA_UInt32 *indices,
  360. UA_UInt32 indicesSize, UA_AddNodesResult* addNodesResults, UA_DiagnosticInfo *diagnosticInfos);
  361. typedef UA_Int32 (*UA_ExternalNodeStore_addReferences)
  362. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_AddReferencesItem* referencesToAdd,
  363. UA_UInt32 *indices,UA_UInt32 indicesSize, UA_StatusCode *addReferencesResults,
  364. UA_DiagnosticInfo *diagnosticInfos);
  365. typedef UA_Int32 (*UA_ExternalNodeStore_deleteNodes)
  366. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_DeleteNodesItem *nodesToDelete, UA_UInt32 *indices,
  367. UA_UInt32 indicesSize, UA_StatusCode *deleteNodesResults, UA_DiagnosticInfo *diagnosticInfos);
  368. typedef UA_Int32 (*UA_ExternalNodeStore_deleteReferences)
  369. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_DeleteReferencesItem *referenceToDelete,
  370. UA_UInt32 *indices, UA_UInt32 indicesSize, UA_StatusCode deleteReferencesresults,
  371. UA_DiagnosticInfo *diagnosticInfos);
  372. typedef UA_Int32 (*UA_ExternalNodeStore_readNodes)
  373. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_ReadValueId *readValueIds, UA_UInt32 *indices,
  374. UA_UInt32 indicesSize,UA_DataValue *readNodesResults, UA_Boolean timeStampToReturn,
  375. UA_DiagnosticInfo *diagnosticInfos);
  376. typedef UA_Int32 (*UA_ExternalNodeStore_writeNodes)
  377. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_WriteValue *writeValues, UA_UInt32 *indices,
  378. UA_UInt32 indicesSize, UA_StatusCode *writeNodesResults, UA_DiagnosticInfo *diagnosticInfo);
  379. typedef UA_Int32 (*UA_ExternalNodeStore_browseNodes)
  380. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_BrowseDescription *browseDescriptions,
  381. UA_UInt32 *indices, UA_UInt32 indicesSize, UA_UInt32 requestedMaxReferencesPerNode,
  382. UA_BrowseResult *browseResults, UA_DiagnosticInfo *diagnosticInfos);
  383. typedef UA_Int32 (*UA_ExternalNodeStore_translateBrowsePathsToNodeIds)
  384. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_BrowsePath *browsePath,
  385. UA_UInt32 *indices, UA_UInt32 indicesSize, UA_BrowsePathResult *browsePathResults, UA_DiagnosticInfo *diagnosticInfos);
  386. typedef UA_Int32 (*UA_ExternalNodeStore_delete)(void *ensHandle);
  387. typedef struct UA_ExternalNodeStore {
  388. void *ensHandle;
  389. UA_ExternalNodeStore_addNodes addNodes;
  390. UA_ExternalNodeStore_deleteNodes deleteNodes;
  391. UA_ExternalNodeStore_writeNodes writeNodes;
  392. UA_ExternalNodeStore_readNodes readNodes;
  393. UA_ExternalNodeStore_browseNodes browseNodes;
  394. UA_ExternalNodeStore_translateBrowsePathsToNodeIds translateBrowsePathsToNodeIds;
  395. UA_ExternalNodeStore_addReferences addReferences;
  396. UA_ExternalNodeStore_deleteReferences deleteReferences;
  397. UA_ExternalNodeStore_delete destroy;
  398. } UA_ExternalNodeStore;
  399. UA_StatusCode UA_EXPORT
  400. UA_Server_addExternalNamespace(UA_Server *server, UA_UInt16 namespaceIndex, const UA_String *url, UA_ExternalNodeStore *nodeStore);
  401. /** @} */
  402. #endif /* external nodestore */
  403. #ifdef __cplusplus
  404. } // extern "C"
  405. #endif
  406. #endif /* UA_SERVER_H_ */