ua_server.h 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895
  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_types_generated_handling.h"
  24. #include "ua_nodeids.h"
  25. #include "ua_log.h"
  26. #include "ua_job.h"
  27. #include "ua_connection.h"
  28. /**
  29. * .. _server:
  30. *
  31. * Server
  32. * ======
  33. *
  34. * Network Layer
  35. * -------------
  36. * Interface to the binary network layers. The functions in the network layer
  37. * are never called in parallel but only sequentially from the server's main
  38. * loop. So the network layer does not need to be thread-safe. */
  39. struct UA_ServerNetworkLayer;
  40. typedef struct UA_ServerNetworkLayer UA_ServerNetworkLayer;
  41. struct UA_ServerNetworkLayer {
  42. void *handle; // pointer to internal data
  43. UA_String discoveryUrl;
  44. /* Starts listening on the the networklayer.
  45. *
  46. * @param nl The network layer
  47. * @param logger The logger
  48. * @return Returns UA_STATUSCODE_GOOD or an error code. */
  49. UA_StatusCode (*start)(UA_ServerNetworkLayer *nl, UA_Logger logger);
  50. /* Gets called from the main server loop and returns the jobs (accumulated
  51. * messages and close events) for dispatch.
  52. *
  53. * @param nl The network layer
  54. * @param jobs When the returned integer is >0, *jobs points to an array of
  55. * UA_Job of the returned size.
  56. * @param timeout The timeout during which an event must arrive in
  57. * microseconds
  58. * @return The size of the jobs array. If the result is negative,
  59. * an error has occurred. */
  60. size_t (*getJobs)(UA_ServerNetworkLayer *nl, UA_Job **jobs, UA_UInt16 timeout);
  61. /* Closes the network connection and returns all the jobs that need to be
  62. * finished before the network layer can be safely deleted.
  63. *
  64. * @param nl The network layer
  65. * @param jobs When the returned integer is >0, jobs points to an array of
  66. * UA_Job of the returned size.
  67. * @return The size of the jobs array. If the result is negative,
  68. * an error has occurred. */
  69. size_t (*stop)(UA_ServerNetworkLayer *nl, UA_Job **jobs);
  70. /** Deletes the network content. Call only after stopping. */
  71. void (*deleteMembers)(UA_ServerNetworkLayer *nl);
  72. };
  73. /**
  74. * Server Configuration
  75. * --------------------
  76. * The following structure is passed to a new server for configuration. */
  77. typedef struct {
  78. UA_String username;
  79. UA_String password;
  80. } UA_UsernamePasswordLogin;
  81. typedef struct {
  82. UA_UInt32 min;
  83. UA_UInt32 max;
  84. } UA_UInt32Range;
  85. typedef struct {
  86. UA_Double min;
  87. UA_Double max;
  88. } UA_DoubleRange;
  89. typedef struct {
  90. UA_UInt16 nThreads; /* only if multithreading is enabled */
  91. UA_Logger logger;
  92. /* Server Description */
  93. UA_BuildInfo buildInfo;
  94. UA_ApplicationDescription applicationDescription;
  95. UA_ByteString serverCertificate;
  96. /* Networking */
  97. size_t networkLayersSize;
  98. UA_ServerNetworkLayer *networkLayers;
  99. /* Login */
  100. UA_Boolean enableAnonymousLogin;
  101. UA_Boolean enableUsernamePasswordLogin;
  102. size_t usernamePasswordLoginsSize;
  103. UA_UsernamePasswordLogin* usernamePasswordLogins;
  104. /* Limits for SecureChannels */
  105. UA_UInt16 maxSecureChannels;
  106. UA_UInt32 maxSecurityTokenLifetime; /* in ms */
  107. /* Limits for Sessions */
  108. UA_UInt16 maxSessions;
  109. UA_Double maxSessionTimeout; /* in ms */
  110. /* Limits for Subscriptions */
  111. UA_DoubleRange publishingIntervalLimits;
  112. UA_UInt32Range lifeTimeCountLimits;
  113. UA_UInt32Range keepAliveCountLimits;
  114. UA_UInt32 maxNotificationsPerPublish;
  115. UA_UInt32 maxRetransmissionQueueSize; /* 0 -> unlimited size */
  116. /* Limits for MonitoredItems */
  117. UA_DoubleRange samplingIntervalLimits;
  118. UA_UInt32Range queueSizeLimits; /* Negotiated with the client */
  119. } UA_ServerConfig;
  120. /* Add a new namespace to the server. Returns the index of the new namespace */
  121. UA_UInt16 UA_EXPORT UA_Server_addNamespace(UA_Server *server, const char* name);
  122. /**
  123. * Server Lifecycle
  124. * ---------------- */
  125. UA_Server UA_EXPORT * UA_Server_new(const UA_ServerConfig config);
  126. void UA_EXPORT UA_Server_delete(UA_Server *server);
  127. /* Runs the main loop of the server. In each iteration, this calls into the
  128. * networklayers to see if jobs have arrived and checks if repeated jobs need to
  129. * be triggered.
  130. *
  131. * @param server The server object.
  132. * @param running The loop is run as long as *running is true.
  133. * Otherwise, the server shuts down.
  134. * @return Returns the statuscode of the UA_Server_run_shutdown method */
  135. UA_StatusCode UA_EXPORT
  136. UA_Server_run(UA_Server *server, volatile UA_Boolean *running);
  137. /* The prologue part of UA_Server_run (no need to use if you call
  138. * UA_Server_run) */
  139. UA_StatusCode UA_EXPORT UA_Server_run_startup(UA_Server *server);
  140. /* Executes a single iteration of the server's main loop.
  141. *
  142. * @param server The server object.
  143. * @param waitInternal Should we wait for messages in the networklayer?
  144. * Otherwise, the timouts for the networklayers are set to zero.
  145. * The default max wait time is 50millisec.
  146. * @return Returns how long we can wait until the next scheduled
  147. * job (in millisec) */
  148. UA_UInt16 UA_EXPORT
  149. UA_Server_run_iterate(UA_Server *server, UA_Boolean waitInternal);
  150. /* The epilogue part of UA_Server_run (no need to use if you call
  151. * UA_Server_run) */
  152. UA_StatusCode UA_EXPORT UA_Server_run_shutdown(UA_Server *server);
  153. /**
  154. * Repeated jobs
  155. * ------------- */
  156. /* Add a job for cyclic repetition to the server.
  157. *
  158. * @param server The server object.
  159. * @param job The job that shall be added.
  160. * @param interval The job shall be repeatedly executed with the given interval
  161. * (in ms). The interval must be larger than 5ms. The first execution
  162. * occurs at now() + interval at the latest.
  163. * @param jobId Set to the guid of the repeated job. This can be used to cancel
  164. * the job later on. If the pointer is null, the guid is not set.
  165. * @return Upon success, UA_STATUSCODE_GOOD is returned.
  166. * An error code otherwise. */
  167. UA_StatusCode UA_EXPORT
  168. UA_Server_addRepeatedJob(UA_Server *server, UA_Job job,
  169. UA_UInt32 interval, UA_Guid *jobId);
  170. /* Remove repeated job.
  171. *
  172. * @param server The server object.
  173. * @param jobId The id of the job that shall be removed.
  174. * @return Upon sucess, UA_STATUSCODE_GOOD is returned.
  175. * An error code otherwise. */
  176. UA_StatusCode UA_EXPORT
  177. UA_Server_removeRepeatedJob(UA_Server *server, UA_Guid jobId);
  178. /**
  179. * Reading and Writing Node Attributes
  180. * -----------------------------------
  181. * The functions for reading and writing node attributes call the regular read
  182. * and write service in the background that are also used over the network.
  183. *
  184. * The following attributes cannot be read, since the local "admin" user always
  185. * has full rights.
  186. *
  187. * - UserWriteMask
  188. * - UserAccessLevel
  189. * - UserExecutable */
  190. /* Read an attribute of a node. The specialized functions below provide a more
  191. * concise syntax.
  192. *
  193. * @param server The server object.
  194. * @param item ReadValueIds contain the NodeId of the target node, the id of the
  195. * attribute to read and (optionally) an index range to read parts
  196. * of an array only. See the section on NumericRange for the format
  197. * used for array ranges.
  198. * @param timestamps Which timestamps to return for the attribute.
  199. * @return Returns a DataValue that contains either an error code, or a variant
  200. * with the attribute value and the timestamps. */
  201. UA_DataValue UA_EXPORT
  202. UA_Server_read(UA_Server *server, const UA_ReadValueId *item,
  203. UA_TimestampsToReturn timestamps);
  204. /* Don't use this function. There are typed versions for every supported
  205. * attribute. */
  206. UA_StatusCode UA_EXPORT
  207. __UA_Server_read(UA_Server *server, const UA_NodeId *nodeId,
  208. UA_AttributeId attributeId, void *v);
  209. static UA_INLINE UA_StatusCode
  210. UA_Server_readNodeId(UA_Server *server, const UA_NodeId nodeId,
  211. UA_NodeId *outNodeId) {
  212. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_NODEID, outNodeId);
  213. }
  214. static UA_INLINE UA_StatusCode
  215. UA_Server_readNodeClass(UA_Server *server, const UA_NodeId nodeId,
  216. UA_NodeClass *outNodeClass) {
  217. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_NODECLASS,
  218. outNodeClass);
  219. }
  220. static UA_INLINE UA_StatusCode
  221. UA_Server_readBrowseName(UA_Server *server, const UA_NodeId nodeId,
  222. UA_QualifiedName *outBrowseName) {
  223. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_BROWSENAME,
  224. outBrowseName);
  225. }
  226. static UA_INLINE UA_StatusCode
  227. UA_Server_readDisplayName(UA_Server *server, const UA_NodeId nodeId,
  228. UA_LocalizedText *outDisplayName) {
  229. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_DISPLAYNAME,
  230. outDisplayName);
  231. }
  232. static UA_INLINE UA_StatusCode
  233. UA_Server_readDescription(UA_Server *server, const UA_NodeId nodeId,
  234. UA_LocalizedText *outDescription) {
  235. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_DESCRIPTION,
  236. outDescription);
  237. }
  238. static UA_INLINE UA_StatusCode
  239. UA_Server_readWriteMask(UA_Server *server, const UA_NodeId nodeId,
  240. UA_UInt32 *outWriteMask) {
  241. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_WRITEMASK,
  242. outWriteMask);
  243. }
  244. static UA_INLINE UA_StatusCode
  245. UA_Server_readIsAbstract(UA_Server *server, const UA_NodeId nodeId,
  246. UA_Boolean *outIsAbstract) {
  247. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_ISABSTRACT,
  248. outIsAbstract);
  249. }
  250. static UA_INLINE UA_StatusCode
  251. UA_Server_readSymmetric(UA_Server *server, const UA_NodeId nodeId,
  252. UA_Boolean *outSymmetric) {
  253. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_SYMMETRIC,
  254. outSymmetric);
  255. }
  256. static UA_INLINE UA_StatusCode
  257. UA_Server_readInverseName(UA_Server *server, const UA_NodeId nodeId,
  258. UA_LocalizedText *outInverseName) {
  259. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_INVERSENAME,
  260. outInverseName);
  261. }
  262. static UA_INLINE UA_StatusCode
  263. UA_Server_readContainsNoLoop(UA_Server *server, const UA_NodeId nodeId,
  264. UA_Boolean *outContainsNoLoops) {
  265. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_CONTAINSNOLOOPS,
  266. outContainsNoLoops);
  267. }
  268. static UA_INLINE UA_StatusCode
  269. UA_Server_readEventNotifier(UA_Server *server, const UA_NodeId nodeId,
  270. UA_Byte *outEventNotifier) {
  271. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_EVENTNOTIFIER,
  272. outEventNotifier);
  273. }
  274. static UA_INLINE UA_StatusCode
  275. UA_Server_readValue(UA_Server *server, const UA_NodeId nodeId,
  276. UA_Variant *outValue) {
  277. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_VALUE, outValue);
  278. }
  279. static UA_INLINE UA_StatusCode
  280. UA_Server_readDataType(UA_Server *server, const UA_NodeId nodeId,
  281. UA_NodeId *outDataType) {
  282. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_DATATYPE,
  283. outDataType);
  284. }
  285. static UA_INLINE UA_StatusCode
  286. UA_Server_readValueRank(UA_Server *server, const UA_NodeId nodeId,
  287. UA_Int32 *outValueRank) {
  288. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_VALUERANK,
  289. outValueRank);
  290. }
  291. /* Returns a variant with an int32 array */
  292. static UA_INLINE UA_StatusCode
  293. UA_Server_readArrayDimensions(UA_Server *server, const UA_NodeId nodeId,
  294. UA_Variant *outArrayDimensions) {
  295. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_ARRAYDIMENSIONS,
  296. outArrayDimensions);
  297. }
  298. static UA_INLINE UA_StatusCode
  299. UA_Server_readAccessLevel(UA_Server *server, const UA_NodeId nodeId,
  300. UA_Byte *outAccessLevel) {
  301. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_ACCESSLEVEL,
  302. outAccessLevel);
  303. }
  304. static UA_INLINE UA_StatusCode
  305. UA_Server_readMinimumSamplingInterval(UA_Server *server, const UA_NodeId nodeId,
  306. UA_Double *outMinimumSamplingInterval) {
  307. return __UA_Server_read(server, &nodeId,
  308. UA_ATTRIBUTEID_MINIMUMSAMPLINGINTERVAL,
  309. outMinimumSamplingInterval);
  310. }
  311. static UA_INLINE UA_StatusCode
  312. UA_Server_readHistorizing(UA_Server *server, const UA_NodeId nodeId,
  313. UA_Boolean *outHistorizing) {
  314. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_HISTORIZING,
  315. outHistorizing);
  316. }
  317. static UA_INLINE UA_StatusCode
  318. UA_Server_readExecutable(UA_Server *server, const UA_NodeId nodeId,
  319. UA_Boolean *outExecutable) {
  320. return __UA_Server_read(server, &nodeId, UA_ATTRIBUTEID_EXECUTABLE,
  321. outExecutable);
  322. }
  323. /**
  324. * The following node attributes cannot be changed once a node has been created:
  325. *
  326. * - NodeClass
  327. * - NodeId
  328. * - Symmetric
  329. * - ContainsNoLoop
  330. *
  331. * The following attributes cannot be written from the server, as they are
  332. * specific to the different users:
  333. *
  334. * - UserWriteMask
  335. * - UserAccessLevel
  336. * - UserExecutable
  337. *
  338. * Historizing is currently unsupported */
  339. /* Overwrite an attribute of a node. The specialized functions below provide a
  340. * more concise syntax.
  341. *
  342. * @param server The server object.
  343. * @param value WriteValues contain the NodeId of the target node, the id of the
  344. * attribute to overwritten, the actual value and (optionally) an
  345. * index range to replace parts of an array only. of an array only.
  346. * See the section on NumericRange for the format used for array
  347. * ranges.
  348. * @return Returns a status code. */
  349. UA_StatusCode UA_EXPORT
  350. UA_Server_write(UA_Server *server, const UA_WriteValue *value);
  351. /* Don't use this function. There are typed versions with no additional
  352. * overhead. */
  353. UA_StatusCode UA_EXPORT
  354. __UA_Server_write(UA_Server *server, const UA_NodeId *nodeId,
  355. const UA_AttributeId attributeId,
  356. const UA_DataType *attr_type, const void *attr);
  357. static UA_INLINE UA_StatusCode
  358. UA_Server_writeBrowseName(UA_Server *server, const UA_NodeId nodeId,
  359. const UA_QualifiedName browseName) {
  360. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_BROWSENAME,
  361. &UA_TYPES[UA_TYPES_QUALIFIEDNAME], &browseName);
  362. }
  363. static UA_INLINE UA_StatusCode
  364. UA_Server_writeDisplayName(UA_Server *server, const UA_NodeId nodeId,
  365. const UA_LocalizedText displayName) {
  366. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_DISPLAYNAME,
  367. &UA_TYPES[UA_TYPES_LOCALIZEDTEXT], &displayName);
  368. }
  369. static UA_INLINE UA_StatusCode
  370. UA_Server_writeDescription(UA_Server *server, const UA_NodeId nodeId,
  371. const UA_LocalizedText description) {
  372. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_DESCRIPTION,
  373. &UA_TYPES[UA_TYPES_LOCALIZEDTEXT], &description);
  374. }
  375. static UA_INLINE UA_StatusCode
  376. UA_Server_writeWriteMask(UA_Server *server, const UA_NodeId nodeId,
  377. const UA_UInt32 writeMask) {
  378. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_WRITEMASK,
  379. &UA_TYPES[UA_TYPES_UINT32], &writeMask);
  380. }
  381. static UA_INLINE UA_StatusCode
  382. UA_Server_writeIsAbstract(UA_Server *server, const UA_NodeId nodeId,
  383. const UA_Boolean isAbstract) {
  384. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_ISABSTRACT,
  385. &UA_TYPES[UA_TYPES_BOOLEAN], &isAbstract);
  386. }
  387. static UA_INLINE UA_StatusCode
  388. UA_Server_writeInverseName(UA_Server *server, const UA_NodeId nodeId,
  389. const UA_LocalizedText inverseName) {
  390. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_INVERSENAME,
  391. &UA_TYPES[UA_TYPES_LOCALIZEDTEXT], &inverseName);
  392. }
  393. static UA_INLINE UA_StatusCode
  394. UA_Server_writeEventNotifier(UA_Server *server, const UA_NodeId nodeId,
  395. const UA_Byte eventNotifier) {
  396. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_EVENTNOTIFIER,
  397. &UA_TYPES[UA_TYPES_BYTE], &eventNotifier);
  398. }
  399. static UA_INLINE UA_StatusCode
  400. UA_Server_writeValue(UA_Server *server, const UA_NodeId nodeId,
  401. const UA_Variant value) {
  402. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_VALUE,
  403. &UA_TYPES[UA_TYPES_VARIANT], &value);
  404. }
  405. static UA_INLINE UA_StatusCode
  406. UA_Server_writeDataType(UA_Server *server, const UA_NodeId nodeId,
  407. const UA_NodeId dataType) {
  408. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_DATATYPE,
  409. &UA_TYPES[UA_TYPES_NODEID], &dataType);
  410. }
  411. static UA_INLINE UA_StatusCode
  412. UA_Server_writeValueRank(UA_Server *server, const UA_NodeId nodeId,
  413. const UA_Int32 valueRank) {
  414. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_VALUERANK,
  415. &UA_TYPES[UA_TYPES_INT32], &valueRank);
  416. }
  417. static UA_INLINE UA_StatusCode
  418. UA_Server_writeArrayDimensions(UA_Server *server, const UA_NodeId nodeId,
  419. const UA_Variant arrayDimensions) {
  420. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_VALUE,
  421. &UA_TYPES[UA_TYPES_VARIANT], &arrayDimensions);
  422. }
  423. static UA_INLINE UA_StatusCode
  424. UA_Server_writeAccessLevel(UA_Server *server, const UA_NodeId nodeId,
  425. const UA_Byte accessLevel) {
  426. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_ACCESSLEVEL,
  427. &UA_TYPES[UA_TYPES_BYTE], &accessLevel);
  428. }
  429. static UA_INLINE UA_StatusCode
  430. UA_Server_writeMinimumSamplingInterval(UA_Server *server, const UA_NodeId nodeId,
  431. const UA_Double miniumSamplingInterval) {
  432. return __UA_Server_write(server, &nodeId,
  433. UA_ATTRIBUTEID_MINIMUMSAMPLINGINTERVAL,
  434. &UA_TYPES[UA_TYPES_DOUBLE],
  435. &miniumSamplingInterval);
  436. }
  437. static UA_INLINE UA_StatusCode
  438. UA_Server_writeExecutable(UA_Server *server, const UA_NodeId nodeId,
  439. const UA_Boolean executable) {
  440. return __UA_Server_write(server, &nodeId, UA_ATTRIBUTEID_EXECUTABLE,
  441. &UA_TYPES[UA_TYPES_BOOLEAN], &executable); }
  442. /**
  443. * Browsing
  444. * -------- */
  445. UA_BrowseResult UA_EXPORT
  446. UA_Server_browse(UA_Server *server, UA_UInt32 maxrefs,
  447. const UA_BrowseDescription *descr);
  448. UA_BrowseResult UA_EXPORT
  449. UA_Server_browseNext(UA_Server *server, UA_Boolean releaseContinuationPoint,
  450. const UA_ByteString *continuationPoint);
  451. #ifndef HAVE_NODEITER_CALLBACK
  452. #define HAVE_NODEITER_CALLBACK
  453. /* Iterate over all nodes referenced by parentNodeId by calling the callback
  454. * function for each child node (in ifdef because GCC/CLANG handle include order
  455. * differently) */
  456. typedef UA_StatusCode
  457. (*UA_NodeIteratorCallback)(UA_NodeId childId, UA_Boolean isInverse,
  458. UA_NodeId referenceTypeId, void *handle);
  459. #endif
  460. UA_StatusCode UA_EXPORT
  461. UA_Server_forEachChildNodeCall(UA_Server *server, UA_NodeId parentNodeId,
  462. UA_NodeIteratorCallback callback, void *handle);
  463. /**
  464. * Method Call
  465. * ----------- */
  466. #ifdef UA_ENABLE_METHODCALLS
  467. UA_CallMethodResult UA_EXPORT
  468. UA_Server_call(UA_Server *server, const UA_CallMethodRequest *request);
  469. #endif
  470. /**
  471. * Node Management
  472. * ---------------
  473. *
  474. * Callback Mechanisms
  475. * ^^^^^^^^^^^^^^^^^^^
  476. * There are four mechanisms for callbacks from the node-based information model
  477. * into userspace:
  478. *
  479. * - Datasources for variable nodes, where the variable content is managed
  480. * externally
  481. * - Value-callbacks for variable nodes, where userspace is notified when a
  482. * read/write occurs
  483. * - Object lifecycle management, where a user-defined constructor and
  484. * destructor is added to an object type
  485. * - Method callbacks, where a user-defined method is exposed in the information
  486. * model
  487. *
  488. * .. _datasource:
  489. *
  490. * Data Source Callback
  491. * ~~~~~~~~~~~~~~~~~~~~
  492. *
  493. * The server has a unique way of dealing with the content of variables. Instead
  494. * of storing a variant attached to the variable node, the node can point to a
  495. * function with a local data provider. Whenever the value attribute is read,
  496. * the function will be called and asked to provide a UA_DataValue return value
  497. * that contains the value content and additional timestamps.
  498. *
  499. * It is expected that the read callback is implemented. The write callback can
  500. * be set to a null-pointer. */
  501. typedef struct {
  502. void *handle; /* A custom pointer to reuse the same datasource functions for
  503. multiple sources */
  504. /* Copies the data from the source into the provided value.
  505. *
  506. * @param handle An optional pointer to user-defined data for the
  507. * specific data source
  508. * @param nodeid Id of the read node
  509. * @param includeSourceTimeStamp If true, then the datasource is expected to
  510. * set the source timestamp in the returned value
  511. * @param range If not null, then the datasource shall return only a
  512. * selection of the (nonscalar) data. Set
  513. * UA_STATUSCODE_BADINDEXRANGEINVALID in the value if this does not
  514. * apply.
  515. * @param value The (non-null) DataValue that is returned to the client. The
  516. * data source sets the read data, the result status and optionally a
  517. * sourcetimestamp.
  518. * @return Returns a status code for logging. Error codes intended for the
  519. * original caller are set in the value. If an error is returned,
  520. * then no releasing of the value is done. */
  521. UA_StatusCode (*read)(void *handle, const UA_NodeId nodeid,
  522. UA_Boolean includeSourceTimeStamp,
  523. const UA_NumericRange *range, UA_DataValue *value);
  524. /* Write into a data source. The write member of UA_DataSource can be empty
  525. * if the operation is unsupported.
  526. *
  527. * @param handle An optional pointer to user-defined data for the
  528. * specific data source
  529. * @param nodeid Id of the node being written to
  530. * @param data The data to be written into the data source
  531. * @param range An optional data range. If the data source is scalar or does
  532. * not support writing of ranges, then an error code is returned.
  533. * @return Returns a status code that is returned to the user
  534. */
  535. UA_StatusCode (*write)(void *handle, const UA_NodeId nodeid,
  536. const UA_Variant *data, const UA_NumericRange *range);
  537. } UA_DataSource;
  538. UA_StatusCode UA_EXPORT
  539. UA_Server_setVariableNode_dataSource(UA_Server *server, const UA_NodeId nodeId,
  540. const UA_DataSource dataSource);
  541. /**
  542. * .. _value-callback:
  543. *
  544. * Value Callback
  545. * ~~~~~~~~~~~~~~
  546. * Value Callbacks can be attached to variable and variable type nodes. If
  547. * not-null, they are called before reading and after writing respectively. */
  548. typedef struct {
  549. /* Pointer to user-provided data for the callback */
  550. void *handle;
  551. /* Called before the value attribute is read. It is possible to write into the
  552. * value attribute during onRead (using the write service). The node is
  553. * re-opened afterwards so that changes are considered in the following read
  554. * operation.
  555. *
  556. * @param handle Points to user-provided data for the callback.
  557. * @param nodeid The identifier of the node.
  558. * @param data Points to the current node value.
  559. * @param range Points to the numeric range the client wants to read from
  560. * (or NULL). */
  561. void (*onRead)(void *handle, const UA_NodeId nodeid,
  562. const UA_Variant *data, const UA_NumericRange *range);
  563. /* Called after writing the value attribute. The node is re-opened after
  564. * writing so that the new value is visible in the callback.
  565. *
  566. * @param handle Points to user-provided data for the callback.
  567. * @param nodeid The identifier of the node.
  568. * @param data Points to the current node value (after writing).
  569. * @param range Points to the numeric range the client wants to write to (or
  570. * NULL). */
  571. void (*onWrite)(void *handle, const UA_NodeId nodeid,
  572. const UA_Variant *data, const UA_NumericRange *range);
  573. } UA_ValueCallback;
  574. UA_StatusCode UA_EXPORT
  575. UA_Server_setVariableNode_valueCallback(UA_Server *server, const UA_NodeId nodeId,
  576. const UA_ValueCallback callback);
  577. /**
  578. * .. _object-lifecycle:
  579. *
  580. * Object Lifecycle Management Callbacks
  581. * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  582. * Lifecycle management adds constructor and destructor callbacks to
  583. * object types. */
  584. typedef struct {
  585. /* Returns the instance handle that is then attached to the node */
  586. void * (*constructor)(const UA_NodeId instance);
  587. void (*destructor)(const UA_NodeId instance, void *instanceHandle);
  588. } UA_ObjectLifecycleManagement;
  589. UA_StatusCode UA_EXPORT
  590. UA_Server_setObjectTypeNode_lifecycleManagement(UA_Server *server,
  591. UA_NodeId nodeId,
  592. UA_ObjectLifecycleManagement olm);
  593. /**
  594. * Method Callbacks
  595. * ~~~~~~~~~~~~~~~~ */
  596. typedef UA_StatusCode
  597. (*UA_MethodCallback)(void *methodHandle, const UA_NodeId objectId,
  598. size_t inputSize, const UA_Variant *input,
  599. size_t outputSize, UA_Variant *output);
  600. #ifdef UA_ENABLE_METHODCALLS
  601. UA_StatusCode UA_EXPORT
  602. UA_Server_setMethodNode_callback(UA_Server *server, const UA_NodeId methodNodeId,
  603. UA_MethodCallback method, void *handle);
  604. #endif
  605. /**
  606. * .. _addnodes:
  607. *
  608. * Node Addition and Deletion
  609. * ^^^^^^^^^^^^^^^^^^^^^^^^^^
  610. *
  611. * When creating dynamic node instances at runtime, chances are that you will
  612. * not care about the specific NodeId of the new node, as long as you can
  613. * reference it later. When passing numeric NodeIds with a numeric identifier 0,
  614. * the stack evaluates this as "select a random unassigned numeric NodeId in
  615. * that namespace". To find out which NodeId was actually assigned to the new
  616. * node, you may pass a pointer `outNewNodeId`, which will (after a successfull
  617. * node insertion) contain the nodeId of the new node. You may also pass NULL
  618. * pointer if this result is not relevant. The namespace index for nodes you
  619. * create should never be 0, as that index is reserved for OPC UA's
  620. * self-description (namespace * 0).
  621. *
  622. * The methods for node addition and deletion take mostly const arguments that
  623. * are not modified. When creating a node, a deep copy of the node identifier,
  624. * node attributes, etc. is created. Therefore, it is possible to call for
  625. * example `UA_Server_addVariablenode` with a value attribute (a :ref:`variant`)
  626. * pointing to a memory location on the stack. If you need changes to a variable
  627. * value to manifest at a specific memory location, please use a
  628. * :ref:`datasource` or a :ref:`value-callback`. */
  629. /* The instantiation callback is used to track the addition of new nodes. It is
  630. * also called for all sub-nodes contained in an object or variable type node
  631. * that is instantiated. */
  632. typedef struct {
  633. UA_StatusCode (*method)(const UA_NodeId objectId,
  634. const UA_NodeId typeDefinitionId, void *handle);
  635. void *handle;
  636. } UA_InstantiationCallback;
  637. /* Don't use this function. There are typed versions as inline functions. */
  638. UA_StatusCode UA_EXPORT
  639. __UA_Server_addNode(UA_Server *server, const UA_NodeClass nodeClass,
  640. const UA_NodeId requestedNewNodeId,
  641. const UA_NodeId parentNodeId,
  642. const UA_NodeId referenceTypeId,
  643. const UA_QualifiedName browseName,
  644. const UA_NodeId typeDefinition,
  645. const UA_NodeAttributes *attr,
  646. const UA_DataType *attributeType,
  647. UA_InstantiationCallback *instantiationCallback,
  648. UA_NodeId *outNewNodeId);
  649. static UA_INLINE UA_StatusCode
  650. UA_Server_addVariableNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  651. const UA_NodeId parentNodeId,
  652. const UA_NodeId referenceTypeId,
  653. const UA_QualifiedName browseName,
  654. const UA_NodeId typeDefinition,
  655. const UA_VariableAttributes attr,
  656. UA_InstantiationCallback *instantiationCallback,
  657. UA_NodeId *outNewNodeId) {
  658. return __UA_Server_addNode(server, UA_NODECLASS_VARIABLE, requestedNewNodeId,
  659. parentNodeId, referenceTypeId, browseName,
  660. typeDefinition, (const UA_NodeAttributes*)&attr,
  661. &UA_TYPES[UA_TYPES_VARIABLEATTRIBUTES],
  662. instantiationCallback, outNewNodeId);
  663. }
  664. static UA_INLINE UA_StatusCode
  665. UA_Server_addVariableTypeNode(UA_Server *server,
  666. const UA_NodeId requestedNewNodeId,
  667. const UA_NodeId parentNodeId,
  668. const UA_NodeId referenceTypeId,
  669. const UA_QualifiedName browseName,
  670. const UA_NodeId typeDefinition,
  671. const UA_VariableTypeAttributes attr,
  672. UA_InstantiationCallback *instantiationCallback,
  673. UA_NodeId *outNewNodeId) {
  674. return __UA_Server_addNode(server, UA_NODECLASS_VARIABLETYPE,
  675. requestedNewNodeId, parentNodeId, referenceTypeId,
  676. browseName, typeDefinition,
  677. (const UA_NodeAttributes*)&attr,
  678. &UA_TYPES[UA_TYPES_VARIABLETYPEATTRIBUTES],
  679. instantiationCallback, outNewNodeId);
  680. }
  681. static UA_INLINE UA_StatusCode
  682. UA_Server_addObjectNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  683. const UA_NodeId parentNodeId,
  684. const UA_NodeId referenceTypeId,
  685. const UA_QualifiedName browseName,
  686. const UA_NodeId typeDefinition,
  687. const UA_ObjectAttributes attr,
  688. UA_InstantiationCallback *instantiationCallback,
  689. UA_NodeId *outNewNodeId) {
  690. return __UA_Server_addNode(server, UA_NODECLASS_OBJECT, requestedNewNodeId,
  691. parentNodeId, referenceTypeId, browseName,
  692. typeDefinition, (const UA_NodeAttributes*)&attr,
  693. &UA_TYPES[UA_TYPES_OBJECTATTRIBUTES],
  694. instantiationCallback, outNewNodeId);
  695. }
  696. static UA_INLINE UA_StatusCode
  697. UA_Server_addObjectTypeNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  698. const UA_NodeId parentNodeId,
  699. const UA_NodeId referenceTypeId,
  700. const UA_QualifiedName browseName,
  701. const UA_ObjectTypeAttributes attr,
  702. UA_InstantiationCallback *instantiationCallback,
  703. UA_NodeId *outNewNodeId) {
  704. return __UA_Server_addNode(server, UA_NODECLASS_OBJECTTYPE, requestedNewNodeId,
  705. parentNodeId, referenceTypeId, browseName,
  706. UA_NODEID_NULL, (const UA_NodeAttributes*)&attr,
  707. &UA_TYPES[UA_TYPES_OBJECTTYPEATTRIBUTES],
  708. instantiationCallback, outNewNodeId);
  709. }
  710. static UA_INLINE UA_StatusCode
  711. UA_Server_addViewNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  712. const UA_NodeId parentNodeId,
  713. const UA_NodeId referenceTypeId,
  714. const UA_QualifiedName browseName,
  715. const UA_ViewAttributes attr,
  716. UA_InstantiationCallback *instantiationCallback,
  717. UA_NodeId *outNewNodeId) {
  718. return __UA_Server_addNode(server, UA_NODECLASS_VIEW, requestedNewNodeId,
  719. parentNodeId, referenceTypeId, browseName,
  720. UA_NODEID_NULL, (const UA_NodeAttributes*)&attr,
  721. &UA_TYPES[UA_TYPES_VIEWATTRIBUTES],
  722. instantiationCallback, outNewNodeId);
  723. }
  724. static UA_INLINE UA_StatusCode
  725. UA_Server_addReferenceTypeNode(UA_Server *server,
  726. const UA_NodeId requestedNewNodeId,
  727. const UA_NodeId parentNodeId,
  728. const UA_NodeId referenceTypeId,
  729. const UA_QualifiedName browseName,
  730. const UA_ReferenceTypeAttributes attr,
  731. UA_InstantiationCallback *instantiationCallback,
  732. UA_NodeId *outNewNodeId) {
  733. return __UA_Server_addNode(server, UA_NODECLASS_REFERENCETYPE,
  734. requestedNewNodeId, parentNodeId, referenceTypeId,
  735. browseName, UA_NODEID_NULL,
  736. (const UA_NodeAttributes*)&attr,
  737. &UA_TYPES[UA_TYPES_REFERENCETYPEATTRIBUTES],
  738. instantiationCallback, outNewNodeId);
  739. }
  740. static UA_INLINE UA_StatusCode
  741. UA_Server_addDataTypeNode(UA_Server *server,
  742. const UA_NodeId requestedNewNodeId,
  743. const UA_NodeId parentNodeId,
  744. const UA_NodeId referenceTypeId,
  745. const UA_QualifiedName browseName,
  746. const UA_DataTypeAttributes attr,
  747. UA_InstantiationCallback *instantiationCallback,
  748. UA_NodeId *outNewNodeId) {
  749. return __UA_Server_addNode(server, UA_NODECLASS_DATATYPE, requestedNewNodeId,
  750. parentNodeId, referenceTypeId, browseName,
  751. UA_NODEID_NULL, (const UA_NodeAttributes*)&attr,
  752. &UA_TYPES[UA_TYPES_DATATYPEATTRIBUTES],
  753. instantiationCallback, outNewNodeId);
  754. }
  755. UA_StatusCode UA_EXPORT
  756. UA_Server_addDataSourceVariableNode(UA_Server *server,
  757. const UA_NodeId requestedNewNodeId,
  758. const UA_NodeId parentNodeId,
  759. const UA_NodeId referenceTypeId,
  760. const UA_QualifiedName browseName,
  761. const UA_NodeId typeDefinition,
  762. const UA_VariableAttributes attr,
  763. const UA_DataSource dataSource,
  764. UA_NodeId *outNewNodeId);
  765. #ifdef UA_ENABLE_METHODCALLS
  766. UA_StatusCode UA_EXPORT
  767. UA_Server_addMethodNode(UA_Server *server, const UA_NodeId requestedNewNodeId,
  768. const UA_NodeId parentNodeId,
  769. const UA_NodeId referenceTypeId,
  770. const UA_QualifiedName browseName,
  771. const UA_MethodAttributes attr,
  772. UA_MethodCallback method, void *handle,
  773. size_t inputArgumentsSize,
  774. const UA_Argument* inputArguments,
  775. size_t outputArgumentsSize,
  776. const UA_Argument* outputArguments,
  777. UA_NodeId *outNewNodeId);
  778. #endif
  779. UA_StatusCode UA_EXPORT
  780. UA_Server_deleteNode(UA_Server *server, const UA_NodeId nodeId,
  781. UA_Boolean deleteReferences);
  782. /**
  783. * Reference Management
  784. * -------------------- */
  785. UA_StatusCode UA_EXPORT
  786. UA_Server_addReference(UA_Server *server, const UA_NodeId sourceId,
  787. const UA_NodeId refTypeId,
  788. const UA_ExpandedNodeId targetId, UA_Boolean isForward);
  789. UA_StatusCode UA_EXPORT
  790. UA_Server_deleteReference(UA_Server *server, const UA_NodeId sourceNodeId,
  791. const UA_NodeId referenceTypeId, UA_Boolean isForward,
  792. const UA_ExpandedNodeId targetNodeId,
  793. UA_Boolean deleteBidirectional);
  794. #ifdef __cplusplus
  795. }
  796. #endif
  797. #endif /* UA_SERVER_H_ */