ua_server_config.h 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229
  1. /* This Source Code Form is subject to the terms of the Mozilla Public
  2. * License, v. 2.0. If a copy of the MPL was not distributed with this
  3. * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  4. *
  5. * Copyright 2017 (c) Fraunhofer IOSB (Author: Julius Pfrommer)
  6. * Copyright 2017 (c) Stefan Profanter, fortiss GmbH
  7. * Copyright 2017 (c) Henrik Norrman
  8. * Copyright 2018 (c) Fabian Arndt, Root-Core
  9. */
  10. #ifndef UA_SERVER_CONFIG_H_
  11. #define UA_SERVER_CONFIG_H_
  12. #include "ua_server.h"
  13. #include "ua_plugin_log.h"
  14. #include "ua_plugin_network.h"
  15. #include "ua_plugin_access_control.h"
  16. #include "ua_plugin_pki.h"
  17. #include "ua_plugin_securitypolicy.h"
  18. #include "ua_plugin_nodestore.h"
  19. #ifdef UA_ENABLE_PUBSUB
  20. #include "ua_plugin_pubsub.h"
  21. #endif
  22. #ifdef UA_ENABLE_HISTORIZING
  23. #include "ua_plugin_historydatabase.h"
  24. #endif
  25. _UA_BEGIN_DECLS
  26. /**
  27. * .. _server-configuration:
  28. *
  29. * Server Configuration
  30. * --------------------
  31. * The configuration structure is passed to the server during initialization.
  32. * The server expects that the configuration is not modified during runtime.
  33. * Currently, only one server can use a configuration at a time. During
  34. * shutdown, the server will clean up the parts of the configuration that are
  35. * modified at runtime through the provided API.
  36. *
  37. * Examples for configurations are provided in the ``/plugins`` folder.
  38. * The usual usage is as follows:
  39. *
  40. * 1. Create a server configuration with default settings as a starting point
  41. * 2. Modifiy the configuration, e.g. by adding a server certificate
  42. * 3. Instantiate a server with it
  43. * 4. After shutdown of the server, clean up the configuration (free memory)
  44. *
  45. * The :ref:`tutorials` provide a good starting point for this. */
  46. typedef struct {
  47. UA_UInt32 min;
  48. UA_UInt32 max;
  49. } UA_UInt32Range;
  50. typedef struct {
  51. UA_Duration min;
  52. UA_Duration max;
  53. } UA_DurationRange;
  54. struct UA_ServerConfig {
  55. UA_UInt16 nThreads; /* only if multithreading is enabled */
  56. UA_Logger logger;
  57. /* Server Description */
  58. UA_BuildInfo buildInfo;
  59. UA_ApplicationDescription applicationDescription;
  60. UA_ByteString serverCertificate;
  61. /* MDNS Discovery */
  62. #ifdef UA_ENABLE_DISCOVERY
  63. UA_String mdnsServerName;
  64. size_t serverCapabilitiesSize;
  65. UA_String *serverCapabilities;
  66. #endif
  67. /* Custom DataTypes. Attention! Custom datatypes are not cleaned up together
  68. * with the configuration. So it is possible to allocate them on ROM. */
  69. const UA_DataTypeArray *customDataTypes;
  70. /**
  71. * .. note:: See the section on :ref:`generic-types`. Examples for working
  72. * with custom data types are provided in
  73. * ``/examples/custom_datatype/``. */
  74. /* Nodestore */
  75. UA_Nodestore nodestore;
  76. /* Networking */
  77. size_t networkLayersSize;
  78. UA_ServerNetworkLayer *networkLayers;
  79. UA_String customHostname;
  80. #ifdef UA_ENABLE_PUBSUB
  81. /*PubSub network layer */
  82. size_t pubsubTransportLayersSize;
  83. UA_PubSubTransportLayer *pubsubTransportLayers;
  84. #endif
  85. /* Available security policies */
  86. size_t securityPoliciesSize;
  87. UA_SecurityPolicy* securityPolicies;
  88. /* Available endpoints */
  89. size_t endpointsSize;
  90. UA_EndpointDescription *endpoints;
  91. /* Node Lifecycle callbacks */
  92. UA_GlobalNodeLifecycle nodeLifecycle;
  93. /**
  94. * .. note:: See the section for :ref:`node lifecycle
  95. * handling<node-lifecycle>`. */
  96. /* Access Control */
  97. UA_AccessControl accessControl;
  98. /**
  99. * .. note:: See the section for :ref:`access-control
  100. * handling<access-control>`. */
  101. /* Certificate Verification */
  102. UA_CertificateVerification certificateVerification;
  103. /* Relax constraints for the InformationModel */
  104. UA_Boolean relaxEmptyValueConstraint; /* Nominally, only variables with data
  105. * type BaseDataType can have an empty
  106. * value. */
  107. /* Limits for SecureChannels */
  108. UA_UInt16 maxSecureChannels;
  109. UA_UInt32 maxSecurityTokenLifetime; /* in ms */
  110. /* Limits for Sessions */
  111. UA_UInt16 maxSessions;
  112. UA_Double maxSessionTimeout; /* in ms */
  113. /* Operation limits */
  114. UA_UInt32 maxNodesPerRead;
  115. UA_UInt32 maxNodesPerWrite;
  116. UA_UInt32 maxNodesPerMethodCall;
  117. UA_UInt32 maxNodesPerBrowse;
  118. UA_UInt32 maxNodesPerRegisterNodes;
  119. UA_UInt32 maxNodesPerTranslateBrowsePathsToNodeIds;
  120. UA_UInt32 maxNodesPerNodeManagement;
  121. UA_UInt32 maxMonitoredItemsPerCall;
  122. /* Limits for Requests */
  123. UA_UInt32 maxReferencesPerNode;
  124. /* Limits for Subscriptions */
  125. UA_UInt32 maxSubscriptionsPerSession;
  126. UA_DurationRange publishingIntervalLimits; /* in ms (must not be less than 5) */
  127. UA_UInt32Range lifeTimeCountLimits;
  128. UA_UInt32Range keepAliveCountLimits;
  129. UA_UInt32 maxNotificationsPerPublish;
  130. UA_UInt32 maxRetransmissionQueueSize; /* 0 -> unlimited size */
  131. #ifdef UA_ENABLE_SUBSCRIPTIONS_EVENTS
  132. UA_UInt32 maxEventsPerNode; /* 0 -> unlimited size */
  133. #endif
  134. /* Limits for MonitoredItems */
  135. UA_UInt32 maxMonitoredItemsPerSubscription;
  136. UA_DurationRange samplingIntervalLimits; /* in ms (must not be less than 5) */
  137. UA_UInt32Range queueSizeLimits; /* Negotiated with the client */
  138. /* Limits for PublishRequests */
  139. UA_UInt32 maxPublishReqPerSession;
  140. /* Discovery */
  141. #ifdef UA_ENABLE_DISCOVERY
  142. /* Timeout in seconds when to automatically remove a registered server from
  143. * the list, if it doesn't re-register within the given time frame. A value
  144. * of 0 disables automatic removal. Default is 60 Minutes (60*60). Must be
  145. * bigger than 10 seconds, because cleanup is only triggered approximately
  146. * ervery 10 seconds. The server will still be removed depending on the
  147. * state of the semaphore file. */
  148. UA_UInt32 discoveryCleanupTimeout;
  149. #endif
  150. #ifdef UA_ENABLE_SUBSCRIPTIONS
  151. /* Register MonitoredItem in Userland
  152. *
  153. * @param server Allows the access to the server object
  154. * @param sessionId The session id, represented as an node id
  155. * @param sessionContext An optional pointer to user-defined data for the specific data source
  156. * @param nodeid Id of the node in question
  157. * @param nodeidContext An optional pointer to user-defined data, associated
  158. * with the node in the nodestore. Note that, if the node has already been removed,
  159. * this value contains a NULL pointer.
  160. * @param attributeId Identifies which attribute (value, data type etc.) is monitored
  161. * @param removed Determines if the MonitoredItem was removed or created. */
  162. void (*monitoredItemRegisterCallback)(UA_Server *server,
  163. const UA_NodeId *sessionId, void *sessionContext,
  164. const UA_NodeId *nodeId, void *nodeContext,
  165. UA_UInt32 attibuteId, UA_Boolean removed);
  166. #endif
  167. /* Historical Access */
  168. #ifdef UA_ENABLE_HISTORIZING
  169. UA_HistoryDatabase historyDatabase;
  170. UA_Boolean accessHistoryDataCapability;
  171. UA_UInt32 maxReturnDataValues; /* 0 -> unlimited size */
  172. UA_Boolean accessHistoryEventsCapability;
  173. UA_UInt32 maxReturnEventValues; /* 0 -> unlimited size */
  174. UA_Boolean insertDataCapability;
  175. UA_Boolean insertEventCapability;
  176. UA_Boolean insertAnnotationsCapability;
  177. UA_Boolean replaceDataCapability;
  178. UA_Boolean replaceEventCapability;
  179. UA_Boolean updateDataCapability;
  180. UA_Boolean updateEventCapability;
  181. UA_Boolean deleteRawCapability;
  182. UA_Boolean deleteEventCapability;
  183. UA_Boolean deleteAtTimeDataCapability;
  184. #endif
  185. };
  186. _UA_END_DECLS
  187. #endif /* UA_SERVER_CONFIG_H_ */