ua_server.h 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574
  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 UA_Server_deleteNode(UA_Server *server, UA_NodeId nodeId);
  116. /** A new variable Node with a value passed in variant.
  117. *
  118. * @param server The server object
  119. * @param nodeId The requested nodeId of the new node. Use the numeric id with i=0 to get a new ID from the server.
  120. * @param browseName The qualified name of this node
  121. * @param displayName The localized text shown when displaying the node
  122. * @param description The localized human readable description
  123. * @param userWriteMask Bitmask defining the user write permissions
  124. * @param writeMask Bitmask defining the write permissions
  125. * @param parentNodeId The node under which this node exists ("parent")
  126. * @param referenceTypeId Reference type used by the parent to reference this node
  127. * @param value A variant containing the value to be assigned to this node.
  128. * @param createdNodeId Pointer to a NULL pointer that will hold the copy of the nodeId on a successfull return.
  129. * @return Return UA_STATUSCODE_GOOD if the node was created or an appropriate error code if not.
  130. */
  131. UA_StatusCode UA_EXPORT
  132. UA_Server_addVariableNode(UA_Server *server, const UA_NodeId nodeId, const UA_QualifiedName browseName,
  133. const UA_LocalizedText displayName, const UA_LocalizedText description,
  134. const UA_UInt32 userWriteMask, const UA_UInt32 writeMask,
  135. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  136. UA_Variant *value, UA_NodeId *createdNodeId);
  137. // Missing: eventNotifier
  138. UA_StatusCode UA_EXPORT
  139. UA_Server_addObjectNode(UA_Server *server, const UA_NodeId nodeId, const UA_QualifiedName browseName,
  140. const UA_LocalizedText displayName, const UA_LocalizedText description,
  141. const UA_UInt32 userWriteMask, const UA_UInt32 writeMask,
  142. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  143. const UA_ExpandedNodeId typeDefinition, UA_NodeId *createdNodeId);
  144. // Missing: isAbstract, symmetric
  145. UA_StatusCode UA_EXPORT
  146. UA_Server_addReferenceTypeNode(UA_Server *server, const UA_NodeId nodeId, const UA_QualifiedName browseName,
  147. const UA_LocalizedText displayName, const UA_LocalizedText description,
  148. const UA_UInt32 userWriteMask, const UA_UInt32 writeMask,
  149. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  150. const UA_ExpandedNodeId typeDefinition, const UA_LocalizedText inverseName,
  151. UA_NodeId *createdNodeId );
  152. UA_StatusCode UA_EXPORT
  153. UA_Server_addObjectTypeNode(UA_Server *server, const UA_NodeId nodeId, const UA_QualifiedName browseName,
  154. const UA_LocalizedText displayName, const UA_LocalizedText description,
  155. const UA_UInt32 userWriteMask, const UA_UInt32 writeMask,
  156. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  157. const UA_ExpandedNodeId typeDefinition, const UA_Boolean isAbstract,
  158. UA_NodeId *createdNodeId );
  159. UA_StatusCode UA_EXPORT
  160. UA_Server_addVariableTypeNode(UA_Server *server, const UA_NodeId nodeId, const UA_QualifiedName browseName,
  161. const UA_LocalizedText displayName, const UA_LocalizedText description,
  162. const UA_UInt32 userWriteMask, const UA_UInt32 writeMask,
  163. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  164. UA_Variant *value, const UA_Int32 valueRank, const UA_Boolean isAbstract,
  165. UA_NodeId *createdNodeId);
  166. UA_StatusCode UA_EXPORT
  167. UA_Server_addDataTypeNode(UA_Server *server, const UA_NodeId nodeId, const UA_QualifiedName browseName,
  168. const UA_LocalizedText displayName, const UA_LocalizedText description,
  169. const UA_UInt32 userWriteMask, const UA_UInt32 writeMask,
  170. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  171. const UA_ExpandedNodeId typeDefinition, const UA_Boolean isAbstract,
  172. UA_NodeId *createdNodeId);
  173. UA_StatusCode UA_EXPORT
  174. UA_Server_addViewNode(UA_Server *server, const UA_NodeId nodeId, const UA_QualifiedName browseName,
  175. const UA_LocalizedText displayName, const UA_LocalizedText description,
  176. const UA_UInt32 userWriteMask, const UA_UInt32 writeMask,
  177. const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId,
  178. const UA_ExpandedNodeId typeDefinition, UA_NodeId *createdNodeId);
  179. UA_StatusCode UA_EXPORT
  180. UA_Server_addDataSourceVariableNode(UA_Server *server, const UA_NodeId nodeId, const UA_QualifiedName browseName,
  181. const UA_LocalizedText displayName, const UA_LocalizedText description,
  182. const UA_UInt32 userWriteMask, const UA_UInt32 writeMask, const UA_NodeId parentNodeId,
  183. const UA_NodeId referenceTypeId, const UA_DataSource dataSource, UA_NodeId *createdNodeId);
  184. UA_StatusCode UA_EXPORT
  185. UA_Server_addMonodirectionalReference(UA_Server *server, UA_NodeId sourceNodeId,
  186. UA_ExpandedNodeId targetNodeId, UA_NodeId referenceTypeId,
  187. UA_Boolean isforward);
  188. #ifdef ENABLE_METHODCALLS
  189. typedef UA_StatusCode (*UA_MethodCallback)(const UA_NodeId objectId, const UA_Variant *input,
  190. UA_Variant *output, void *handle);
  191. /** Creates a serverside method including input- and output variable descriptions
  192. *
  193. * @param server The server object.
  194. *
  195. * @param browseName BrowseName to be used for the new method.
  196. *
  197. * @param nodeId Requested NodeId for the new method. If a numeric ID with i=0 is used, the server
  198. * will assign a random unused id.
  199. *
  200. * @param parentNodeId Parent node containing this method. Note that an ObjectNode needs to
  201. * reference the method with hasProperty in order for the method to be callable.
  202. *
  203. * @param referenceTypeId Reference type ID to be used by the parent to reference the new method.
  204. *
  205. * @param method Userspace Method/Function of type UA_MethodCallback to be called when a client
  206. * invokes the method using the Call Service Set.
  207. *
  208. * @param inputArgumentsSize Number of input arguments expected to be passed by a calling client.
  209. *
  210. * @param inputArguments Description of input arguments expected to be passed by a calling client.
  211. *
  212. * @param outputArgumentsSize Description of output arguments expected to be passed by a calling client.
  213. *
  214. * @param outputArguments Description of output arguments expected to be passed by a calling client.
  215. *
  216. * @param createdNodeId Actual nodeId of the new method node if UA_StatusCode indicates success. Can
  217. * be used to determine the random unique ID assigned by the server if i=0 was passed as a nodeId.
  218. *
  219. */
  220. UA_StatusCode UA_EXPORT
  221. UA_Server_addMethodNode(UA_Server *server, const UA_NodeId nodeId, const UA_QualifiedName browseName,
  222. UA_LocalizedText displayName, UA_LocalizedText description, const UA_NodeId parentNodeId,
  223. const UA_NodeId referenceTypeId, UA_UInt32 userWriteMask, UA_UInt32 writeMask,
  224. UA_MethodCallback method, void *handle, UA_Int32 inputArgumentsSize, const UA_Argument *inputArguments,
  225. UA_Int32 outputArgumentsSize, const UA_Argument *outputArguments,
  226. UA_NodeId *createdNodeId);
  227. #endif
  228. #ifndef _HAVE_UA_NODEITERATORCALLBACK_D
  229. #define _HAVE_UA_NODEITERATORCALLBACK_D
  230. typedef UA_StatusCode (*UA_NodeIteratorCallback)(UA_NodeId childId, UA_Boolean isInverse, UA_NodeId referenceTypeId, void *handle);
  231. #endif
  232. /** Iterate over all nodes referenced by parentNodeId by calling the callback function for each child node
  233. *
  234. * @param server The server object.
  235. *
  236. * @param parentNodeId The NodeId of the parent whose references are to be iterated over
  237. *
  238. * @param callback The function of type UA_NodeIteratorCallback to be called for each referenced child
  239. *
  240. * @return Upon success, UA_STATUSCODE_GOOD is returned. An error code otherwise.
  241. */
  242. UA_StatusCode UA_EXPORT UA_Server_forEachChildNodeCall(UA_Server *server, UA_NodeId parentNodeId, UA_NodeIteratorCallback callback, void *handle);
  243. UA_StatusCode UA_EXPORT UA_Server_setNodeAttribute(UA_Server *server, const UA_NodeId nodeId, const UA_AttributeId attributeId, const UA_Variant value);
  244. #define UA_SERVER_SETNODEATTRIBUTE_DECL(ATTRIBUTE, ATTRIBUTEID, TYPE, TYPEINDEX) \
  245. static UA_INLINE UA_StatusCode UA_Server_setNodeAttribute_##ATTRIBUTE(UA_Server *server, const UA_NodeId nodeId, const TYPE value) { \
  246. /* hack to cast to void*. but is treated as const internally. */ \
  247. const UA_Variant var = {.type = &UA_TYPES[TYPEINDEX], .storageType = UA_VARIANT_DATA, \
  248. .arrayLength = -1, .data = (void *)(uintptr_t)&value, \
  249. .arrayDimensionsSize = -1, .arrayDimensions = NULL}; \
  250. return UA_Server_setNodeAttribute(server, nodeId, ATTRIBUTEID, var); \
  251. }
  252. UA_SERVER_SETNODEATTRIBUTE_DECL(nodeId, UA_ATTRIBUTEID_NODEID, UA_NodeId, UA_TYPES_NODEID)
  253. // UA_SERVER_SETNODEATTRIBUTE_DECL(nodeClass, UA_ATTRIBUTEID_NODECLASS, UA_NodeClass, UA_TYPES_NODECLASS) // not supported
  254. UA_SERVER_SETNODEATTRIBUTE_DECL(browseName, UA_ATTRIBUTEID_BROWSENAME, UA_QualifiedName, UA_TYPES_QUALIFIEDNAME)
  255. UA_SERVER_SETNODEATTRIBUTE_DECL(displayName, UA_ATTRIBUTEID_DISPLAYNAME, UA_LocalizedText, UA_TYPES_LOCALIZEDTEXT)
  256. UA_SERVER_SETNODEATTRIBUTE_DECL(description, UA_ATTRIBUTEID_DESCRIPTION, UA_LocalizedText, UA_TYPES_LOCALIZEDTEXT)
  257. UA_SERVER_SETNODEATTRIBUTE_DECL(writeMask, UA_ATTRIBUTEID_WRITEMASK, UA_UInt32, UA_TYPES_UINT32)
  258. UA_SERVER_SETNODEATTRIBUTE_DECL(userWriteMask, UA_ATTRIBUTEID_USERWRITEMASK, UA_UInt32, UA_TYPES_UINT32)
  259. UA_SERVER_SETNODEATTRIBUTE_DECL(isAbstract, UA_ATTRIBUTEID_ISABSTRACT, UA_Boolean, UA_TYPES_BOOLEAN)
  260. UA_SERVER_SETNODEATTRIBUTE_DECL(symmetric, UA_ATTRIBUTEID_SYMMETRIC, UA_Boolean, UA_TYPES_BOOLEAN)
  261. UA_SERVER_SETNODEATTRIBUTE_DECL(inverseName, UA_ATTRIBUTEID_INVERSENAME, UA_LocalizedText, UA_TYPES_LOCALIZEDTEXT)
  262. UA_SERVER_SETNODEATTRIBUTE_DECL(containsNoLoops, UA_ATTRIBUTEID_CONTAINSNOLOOPS, UA_Boolean, UA_TYPES_BOOLEAN)
  263. UA_SERVER_SETNODEATTRIBUTE_DECL(eventNotifier, UA_ATTRIBUTEID_EVENTNOTIFIER, UA_Byte, UA_TYPES_BYTE)
  264. #define UA_Server_setNodeAttribute_value(server, nodeId, value) UA_Server_setNodeAttribute(server, nodeId, UA_ATTRIBUTEID_VALUE, value)
  265. // UA_SERVER_SETNODEATTRIBUTE_DECL(dataType, UA_ATTRIBUTEID_DATATYPE, UA_NodeId, UA_TYPES_NODEID) // not supported. set via the value variant.
  266. // UA_SERVER_SETNODEATTRIBUTE_DECL(valueRank, UA_ATTRIBUTEID_VALUERANK, UA_Int32, UA_TYPES_INT32) // not supported. set via the value variant.
  267. // UA_SERVER_SETNODEATTRIBUTE_DECL(arrayDimensions, UA_ATTRIBUTEID_ARRAYDIMENSIONS, UA_Int32, UA_TYPES_INT32) // not supported. set via the value variant.
  268. UA_SERVER_SETNODEATTRIBUTE_DECL(accessLevel, UA_ATTRIBUTEID_ACCESSLEVEL, UA_UInt32, UA_TYPES_UINT32)
  269. UA_SERVER_SETNODEATTRIBUTE_DECL(userAccessLevel, UA_ATTRIBUTEID_USERACCESSLEVEL, UA_UInt32, UA_TYPES_UINT32)
  270. UA_SERVER_SETNODEATTRIBUTE_DECL(minimumSamplingInterval, UA_ATTRIBUTEID_MINIMUMSAMPLINGINTERVAL, UA_Double, UA_TYPES_DOUBLE)
  271. UA_SERVER_SETNODEATTRIBUTE_DECL(historizing, UA_ATTRIBUTEID_HISTORIZING, UA_Boolean, UA_TYPES_BOOLEAN)
  272. UA_SERVER_SETNODEATTRIBUTE_DECL(executable, UA_ATTRIBUTEID_EXECUTABLE, UA_Boolean, UA_TYPES_BOOLEAN)
  273. UA_SERVER_SETNODEATTRIBUTE_DECL(userExecutable, UA_ATTRIBUTEID_USEREXECUTABLE, UA_Boolean, UA_TYPES_BOOLEAN)
  274. #ifdef ENABLE_METHODCALLS
  275. UA_StatusCode UA_EXPORT
  276. UA_Server_setNodeAttribute_method(UA_Server *server, UA_NodeId methodNodeId, UA_MethodCallback method, void *handle);
  277. #endif
  278. UA_StatusCode UA_EXPORT
  279. UA_Server_setNodeAttribute_valueDataSource(UA_Server *server, UA_NodeId nodeId, UA_DataSource *value);
  280. UA_StatusCode UA_EXPORT
  281. UA_Server_getNodeAttribute(UA_Server *server, UA_NodeId nodeId, UA_AttributeId attributeId, void **value);
  282. #define UA_Server_getNodeAttribute_nodeId(SERVER, NODEID, VALUE) UA_Server_getAttribute(SERVER, NODEID, UA_ATTRIBUTEID_NODEID, (UA_NodeId **) VALUE);
  283. #define UA_Server_getNodeAttribute_nodeClass(SERVER, NODEID, VALUE) UA_Server_getAttribute(SERVER, NODEID, UA_ATTRIBUTEID_NODECLASS, (UA_NodeClass **) VALUE);
  284. #define UA_Server_getNodeAttribute_browseName(SERVER, NODEID, VALUE) UA_Server_getAttribute(SERVER, NODEID, UA_ATTRIBUTEID_BROWSENAME, (UA_QualifiedName **) VALUE);
  285. #define UA_Server_getNodeAttribute_displayName(SERVER, NODEID, VALUE) UA_Server_getAttribute(SERVER, NODEID, UA_ATTRIBUTEID_DISPLAYNAME, (UA_LocalizedText **) VALUE);
  286. #define UA_Server_getNodeAttribute_description(SERVER, NODEID, VALUE) UA_Server_getAttribute(SERVER, NODEID, UA_ATTRIBUTEID_DESCRIPTION, (UA_LocalizedText **) VALUE);
  287. #define UA_Server_getNodeAttribute_writeMask(SERVER, NODEID, VALUE) UA_Server_getNodeAttribute(SERVER, NODEID, UA_ATTRIBUTEID_WRITEMASK, (UA_UInt32 **) VALUE);
  288. #define UA_Server_getNodeAttribute_userWriteMask(SERVER, NODEID, VALUE) UA_Server_getNodeAttribute(SERVER, NODEID, UA_ATTRIBUTEID_USERWRITEMASK, (UA_UInt32 **) VALUE);
  289. #define UA_Server_getNodeAttribute_isAbstract(SERVER, NODEID, VALUE) UA_Server_getNodeAttribute(SERVER, NODEID, UA_ATTRIBUTEID_ISABSTRACT, (UA_Boolean **) VALUE);
  290. #define UA_Server_getNodeAttribute_symmetric(SERVER, NODEID, VALUE) UA_Server_getNodeAttribute(SERVER, NODEID, UA_ATTRIBUTEID_SYMMETRIC, (UA_Boolean **) VALUE);
  291. #define UA_Server_getNodeAttribute_inverseName(SERVER, NODEID, VALUE) UA_Server_getNodeAttribute(SERVER, NODEID, UA_ATTRIBUTEID_INVERSENAME, (UA_LocalizedText **) VALUE);
  292. #define UA_Server_getNodeAttribute_containsNoLoops(SERVER, NODEID, VALUE) UA_Server_getNodeAttribute(SERVER, NODEID, UA_ATTRIBUTEID_CONTAINSNOLOOPS, (UA_Boolean **) VALUE);
  293. #define UA_Server_getNodeAttribute_eventNotifier(SERVER, NODEID, VALUE) UA_Server_getNodeAttribute(SERVER, NODEID, UA_ATTRIBUTEID_EVENTNOTIFIER, (UA_Byte **) VALUE);
  294. #define UA_Server_getNodeAttribute_value(SERVER, NODEID, VALUE) UA_Server_getNodeAttribute(SERVER, NODEID, UA_ATTRIBUTEID_VALUE, (UA_Variant **) VALUE);
  295. #define UA_Server_getNodeAttribute_dataType(SERVER, NODEID, VALUE) UA_Server_getNodeAttribute(SERVER, NODEID, UA_ATTRIBUTEID_DATATYPE, (UA_NodeId **) VALUE);
  296. #define UA_Server_getNodeAttribute_valueRank(SERVER, NODEID, VALUE) UA_Server_getNodeAttribute(SERVER, NODEID, UA_ATTRIBUTEID_VALUERANK, (UA_Int32 **) VALUE);
  297. #define UA_Server_getNodeAttribute_arrayDimensions(SERVER, NODEID, VALUE) UA_Server_getNodeAttribute(SERVER, NODEID, UA_ATTRIBUTEID_ARRAYDIMENSIONS, (UA_Int32 **) VALUE);
  298. #define UA_Server_getNodeAttribute_accessLevel(SERVER, NODEID, VALUE) UA_Server_getNodeAttribute(SERVER, NODEID, UA_ATTRIBUTEID_ACCESSLEVEL, (UA_UInt32 **) VALUE);
  299. #define UA_Server_getNodeAttribute_userAccessLevel(SERVER, NODEID, VALUE) UA_Server_getNodeAttribute(SERVER, NODEID, UA_ATTRIBUTEID_USERACCESSLEVEL, (UA_UInt32 **) VALUE);
  300. #define UA_Server_getNodeAttribute_minimumSamplingInterval(SERVER, NODEID, VALUE) UA_Server_getNodeAttribute(SERVER, NODEID, UA_ATTRIBUTEID_MINIMUMSAMPLINGINTERVAL, (UA_Double **) VALUE);
  301. #define UA_Server_getNodeAttribute_historizing(SERVER, NODEID, VALUE) UA_Server_getNodeAttribute(SERVER, NODEID, UA_ATTRIBUTEID_HISTORIZING, (UA_Boolean **) VALUE);
  302. #define UA_Server_getNodeAttribute_executable(SERVER, NODEID, VALUE) UA_Server_getNodeAttribute(SERVER, NODEID, UA_ATTRIBUTEID_EXECUTABLE, (UA_Boolean **) VALUE);
  303. #define UA_Server_getNodeAttribute_userExecutable(SERVER, NODEID, VALUE) UA_Server_getNodeAttribute(SERVER, NODEID, UA_ATTRIBUTEID_USEREXECUTABLE, (UA_Boolean **) VALUE);
  304. #ifdef ENABLE_METHODCALLS
  305. UA_StatusCode UA_EXPORT
  306. UA_Server_getNodeAttribute_method(UA_Server *server, UA_NodeId methodNodeId, UA_MethodCallback *method);
  307. #endif
  308. UA_StatusCode UA_EXPORT
  309. UA_Server_getNodeAttribute_valueDataSource(UA_Server *server, UA_NodeId nodeId, UA_DataSource **value);
  310. /** Jobs describe work that is executed once or repeatedly. */
  311. typedef struct {
  312. enum {
  313. UA_JOBTYPE_NOTHING,
  314. UA_JOBTYPE_DETACHCONNECTION,
  315. UA_JOBTYPE_BINARYMESSAGE,
  316. UA_JOBTYPE_METHODCALL,
  317. UA_JOBTYPE_DELAYEDMETHODCALL,
  318. } type;
  319. union {
  320. UA_Connection *closeConnection;
  321. struct {
  322. UA_Connection *connection;
  323. UA_ByteString message;
  324. } binaryMessage;
  325. struct {
  326. void *data;
  327. void (*method)(UA_Server *server, void *data);
  328. } methodCall;
  329. } job;
  330. } UA_Job;
  331. /**
  332. * @param server The server object.
  333. *
  334. * @param job Pointer to the job that shall be added. The pointer is not freed but copied to an
  335. * internal representation.
  336. *
  337. * @param interval The job shall be repeatedly executed with the given interval (in ms). The
  338. * interval must be larger than 5ms. The first execution occurs at now() + interval at the
  339. * latest.
  340. *
  341. * @param jobId Set to the guid of the repeated job. This can be used to cancel the job later on. If
  342. * the pointer is null, the guid is not set.
  343. *
  344. * @return Upon success, UA_STATUSCODE_GOOD is returned. An error code otherwise.
  345. */
  346. UA_StatusCode UA_EXPORT UA_Server_addRepeatedJob(UA_Server *server, UA_Job job, UA_UInt32 interval,
  347. UA_Guid *jobId);
  348. /**
  349. * Remove repeated job. The entry will be removed asynchronously during the
  350. * next iteration of the server main loop.
  351. *
  352. * @param server The server object.
  353. *
  354. * @param jobId The id of the job that shall be removed.
  355. *
  356. * @return Upon sucess, UA_STATUSCODE_GOOD is returned. An error code otherwise.
  357. */
  358. UA_StatusCode UA_EXPORT UA_Server_removeRepeatedJob(UA_Server *server, UA_Guid jobId);
  359. /**
  360. * Interface to the binary network layers. This structure is returned from the
  361. * function that initializes the network layer. The layer is already bound to a
  362. * specific port and listening. The functions in the structure are never called
  363. * in parallel but only sequentially from the server's main loop. So the network
  364. * layer does not need to be thread-safe.
  365. */
  366. typedef struct UA_ServerNetworkLayer {
  367. void *handle;
  368. UA_String discoveryUrl;
  369. /**
  370. * Starts listening on the the networklayer.
  371. *
  372. * @param nl The network layer
  373. * @param logger The logger
  374. * @return Returns UA_STATUSCODE_GOOD or an error code.
  375. */
  376. UA_StatusCode (*start)(struct UA_ServerNetworkLayer *nl, UA_Logger *logger);
  377. /**
  378. * Gets called from the main server loop and returns the jobs (accumulated messages and close
  379. * events) for dispatch.
  380. *
  381. * @param nl The network layer
  382. * @param jobs When the returned integer is positive, *jobs points to an array of UA_Job of the
  383. * returned size.
  384. * @param timeout The timeout during which an event must arrive in microseconds
  385. * @return The size of the jobs array. If the result is negative, an error has occurred.
  386. */
  387. UA_Int32 (*getJobs)(struct UA_ServerNetworkLayer *nl, UA_Job **jobs, UA_UInt16 timeout);
  388. /**
  389. * Closes the network connection and returns all the jobs that need to be finished before the
  390. * network layer can be safely deleted.
  391. *
  392. * @param nl The network layer
  393. * @param jobs When the returned integer is positive, jobs points to an array of UA_Job of the
  394. * returned size.
  395. * @return The size of the jobs array. If the result is negative, an error has occurred.
  396. */
  397. UA_Int32 (*stop)(struct UA_ServerNetworkLayer *nl, UA_Job **jobs);
  398. /** Deletes the network layer. Call only after a successful shutdown. */
  399. void (*deleteMembers)(struct UA_ServerNetworkLayer *nl);
  400. } UA_ServerNetworkLayer;
  401. /**
  402. * Adds a network layer to the server. The network layer is destroyed together
  403. * with the server. Do not use it after adding it as it might be moved around on
  404. * the heap.
  405. */
  406. void UA_EXPORT UA_Server_addNetworkLayer(UA_Server *server, UA_ServerNetworkLayer networkLayer);
  407. /** @} */
  408. #ifndef __cplusplus /* the external nodestore does not work with c++ so far */
  409. /**
  410. * @ingroup nodestore
  411. *
  412. * @defgroup external_nodestore External Nodestore
  413. *
  414. * @brief An external application that manages its own data and data model
  415. *
  416. * To plug in outside data sources, one can use
  417. *
  418. * - VariableNodes with a data source (functions that are called for read and write access)
  419. * - An external nodestore that is mapped to specific namespaces
  420. *
  421. * If no external nodestore is defined for a nodeid, it is always looked up in
  422. * the "local" nodestore of open62541. Namespace Zero is always in the local
  423. * nodestore.
  424. *
  425. * @{
  426. */
  427. typedef UA_Int32 (*UA_ExternalNodeStore_addNodes)
  428. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_AddNodesItem *nodesToAdd, UA_UInt32 *indices,
  429. UA_UInt32 indicesSize, UA_AddNodesResult* addNodesResults, UA_DiagnosticInfo *diagnosticInfos);
  430. typedef UA_Int32 (*UA_ExternalNodeStore_addReferences)
  431. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_AddReferencesItem* referencesToAdd,
  432. UA_UInt32 *indices,UA_UInt32 indicesSize, UA_StatusCode *addReferencesResults,
  433. UA_DiagnosticInfo *diagnosticInfos);
  434. typedef UA_Int32 (*UA_ExternalNodeStore_deleteNodes)
  435. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_DeleteNodesItem *nodesToDelete, UA_UInt32 *indices,
  436. UA_UInt32 indicesSize, UA_StatusCode *deleteNodesResults, UA_DiagnosticInfo *diagnosticInfos);
  437. typedef UA_Int32 (*UA_ExternalNodeStore_deleteReferences)
  438. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_DeleteReferencesItem *referenceToDelete,
  439. UA_UInt32 *indices, UA_UInt32 indicesSize, UA_StatusCode deleteReferencesresults,
  440. UA_DiagnosticInfo *diagnosticInfos);
  441. typedef UA_Int32 (*UA_ExternalNodeStore_readNodes)
  442. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_ReadValueId *readValueIds, UA_UInt32 *indices,
  443. UA_UInt32 indicesSize,UA_DataValue *readNodesResults, UA_Boolean timeStampToReturn,
  444. UA_DiagnosticInfo *diagnosticInfos);
  445. typedef UA_Int32 (*UA_ExternalNodeStore_writeNodes)
  446. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_WriteValue *writeValues, UA_UInt32 *indices,
  447. UA_UInt32 indicesSize, UA_StatusCode *writeNodesResults, UA_DiagnosticInfo *diagnosticInfo);
  448. typedef UA_Int32 (*UA_ExternalNodeStore_browseNodes)
  449. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_BrowseDescription *browseDescriptions,
  450. UA_UInt32 *indices, UA_UInt32 indicesSize, UA_UInt32 requestedMaxReferencesPerNode,
  451. UA_BrowseResult *browseResults, UA_DiagnosticInfo *diagnosticInfos);
  452. typedef UA_Int32 (*UA_ExternalNodeStore_translateBrowsePathsToNodeIds)
  453. (void *ensHandle, const UA_RequestHeader *requestHeader, UA_BrowsePath *browsePath,
  454. UA_UInt32 *indices, UA_UInt32 indicesSize, UA_BrowsePathResult *browsePathResults, UA_DiagnosticInfo *diagnosticInfos);
  455. typedef UA_Int32 (*UA_ExternalNodeStore_delete)(void *ensHandle);
  456. typedef struct UA_ExternalNodeStore {
  457. void *ensHandle;
  458. UA_ExternalNodeStore_addNodes addNodes;
  459. UA_ExternalNodeStore_deleteNodes deleteNodes;
  460. UA_ExternalNodeStore_writeNodes writeNodes;
  461. UA_ExternalNodeStore_readNodes readNodes;
  462. UA_ExternalNodeStore_browseNodes browseNodes;
  463. UA_ExternalNodeStore_translateBrowsePathsToNodeIds translateBrowsePathsToNodeIds;
  464. UA_ExternalNodeStore_addReferences addReferences;
  465. UA_ExternalNodeStore_deleteReferences deleteReferences;
  466. UA_ExternalNodeStore_delete destroy;
  467. } UA_ExternalNodeStore;
  468. #ifdef UA_EXTERNAL_NAMESPACES
  469. UA_StatusCode UA_EXPORT
  470. UA_Server_addExternalNamespace(UA_Server *server, UA_UInt16 namespaceIndex, const UA_String *url, UA_ExternalNodeStore *nodeStore);
  471. #endif /* UA_EXTERNAL_NAMESPACES*/
  472. /** @} */
  473. #endif /* external nodestore */
  474. #ifndef _HAVE_UA_INSTANTIONCALLBACK_D
  475. #define _HAVE_UA_INSTANTIONCALLBACK_D
  476. typedef UA_StatusCode (*UA_InstantiationCallback)(UA_NodeId objectId, UA_NodeId definitionId, void *handle);
  477. #endif
  478. typedef struct arrayOfNodeIds_s {
  479. UA_Int32 size;
  480. UA_NodeId *ids;
  481. } arrayOfNodeIds;
  482. UA_StatusCode UA_EXPORT
  483. UA_Server_appendInstanceOfSupertype(UA_Server *server, UA_NodeId nodeId, UA_NodeId appendToNodeId,
  484. arrayOfNodeIds *subtypeRefs, arrayOfNodeIds *componentRefs,
  485. UA_InstantiationCallback callback, arrayOfNodeIds *instantiatedTypes,
  486. void *handle);
  487. void UA_EXPORT
  488. UA_Server_addInstanceOf_instatiateChildNode(UA_Server *server,
  489. arrayOfNodeIds *subtypeRefs, arrayOfNodeIds *componentRefs, arrayOfNodeIds *typedefRefs,
  490. UA_NodeId objectRoot, UA_InstantiationCallback callback, void *typeDefNode,
  491. UA_Boolean instantiateObjects, arrayOfNodeIds *instantiatedTypes, void *handle);
  492. UA_StatusCode UA_EXPORT
  493. UA_Server_addInstanceOf(UA_Server *server, UA_NodeId nodeId, const UA_QualifiedName browseName,
  494. UA_LocalizedText displayName, UA_LocalizedText description, const UA_NodeId parentNodeId,
  495. const UA_NodeId referenceTypeId, UA_UInt32 userWriteMask, UA_UInt32 writeMask,
  496. const UA_ExpandedNodeId typeDefinition, UA_InstantiationCallback callback, void *handle,
  497. UA_NodeId *createdNodeId);
  498. #ifdef __cplusplus
  499. } // extern "C"
  500. #endif
  501. #endif /* UA_SERVER_H_ */