ua_server.h 35 KB

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