ua_server_config.h 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  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) Julius Pfrommer, Fraunhofer IOSB
  6. * Copyright 2017 (c) Stefan Profanter, fortiss GmbH
  7. * Copyright 2017 (c) Henrik Norrman
  8. */
  9. #ifndef UA_SERVER_CONFIG_H_
  10. #define UA_SERVER_CONFIG_H_
  11. #ifdef __cplusplus
  12. extern "C" {
  13. #endif
  14. #include "ua_server.h"
  15. #include "ua_plugin_log.h"
  16. #include "ua_plugin_network.h"
  17. #include "ua_plugin_access_control.h"
  18. #include "ua_plugin_pki.h"
  19. #include "ua_plugin_securitypolicy.h"
  20. #include "ua_plugin_nodestore.h"
  21. /**
  22. * .. _server-configuration:
  23. *
  24. * Server Configuration
  25. * --------------------
  26. * The configuration structure is passed to the server during initialization.
  27. * The server expects that the configuration is not modified during runtime.
  28. * Currently, only one server can use a configuration at a time. During
  29. * shutdown, the server will clean up the parts of the configuration that are
  30. * modified at runtime through the provided API.
  31. *
  32. * Examples for configurations are provided in the ``/plugins`` folder.
  33. * The usual usage is as follows:
  34. *
  35. * 1. Create a server configuration with default settings as a starting point
  36. * 2. Modifiy the configuration, e.g. by adding a server certificate
  37. * 3. Instantiate a server with it
  38. * 4. After shutdown of the server, clean up the configuration (free memory)
  39. *
  40. * The :ref:`tutorials` provide a good starting point for this. */
  41. typedef struct {
  42. UA_UInt32 min;
  43. UA_UInt32 max;
  44. } UA_UInt32Range;
  45. typedef struct {
  46. UA_Duration min;
  47. UA_Duration max;
  48. } UA_DurationRange;
  49. struct UA_ServerConfig {
  50. UA_UInt16 nThreads; /* only if multithreading is enabled */
  51. UA_Logger logger;
  52. /* Server Description */
  53. UA_BuildInfo buildInfo;
  54. UA_ApplicationDescription applicationDescription;
  55. UA_ByteString serverCertificate;
  56. /* MDNS Discovery */
  57. #ifdef UA_ENABLE_DISCOVERY
  58. UA_String mdnsServerName;
  59. size_t serverCapabilitiesSize;
  60. UA_String *serverCapabilities;
  61. #endif
  62. /* Custom DataTypes */
  63. size_t customDataTypesSize;
  64. UA_DataType *customDataTypes;
  65. /**
  66. * .. note:: See the section on :ref:`generic-types`. Examples for working
  67. * with custom data types are provided in
  68. * ``/examples/custom_datatype/``. */
  69. /* Nodestore */
  70. UA_Nodestore nodestore;
  71. /* Networking */
  72. size_t networkLayersSize;
  73. UA_ServerNetworkLayer *networkLayers;
  74. UA_String customHostname;
  75. /* Available endpoints */
  76. size_t endpointsSize;
  77. UA_Endpoint *endpoints;
  78. /* Node Lifecycle callbacks */
  79. UA_GlobalNodeLifecycle nodeLifecycle;
  80. /**
  81. * .. note:: See the section for :ref:`node lifecycle
  82. * handling<node-lifecycle>`. */
  83. /* Access Control */
  84. UA_AccessControl accessControl;
  85. /**
  86. * .. note:: See the section for :ref:`access-control
  87. * handling<access-control>`. */
  88. /* Certificate Verification */
  89. UA_CertificateVerification certificateVerification;
  90. /* Limits for SecureChannels */
  91. UA_UInt16 maxSecureChannels;
  92. UA_UInt32 maxSecurityTokenLifetime; /* in ms */
  93. /* Limits for Sessions */
  94. UA_UInt16 maxSessions;
  95. UA_Double maxSessionTimeout; /* in ms */
  96. /* Operation limits */
  97. UA_UInt32 maxNodesPerRead;
  98. UA_UInt32 maxNodesPerWrite;
  99. UA_UInt32 maxNodesPerMethodCall;
  100. UA_UInt32 maxNodesPerBrowse;
  101. UA_UInt32 maxNodesPerRegisterNodes;
  102. UA_UInt32 maxNodesPerTranslateBrowsePathsToNodeIds;
  103. UA_UInt32 maxNodesPerNodeManagement;
  104. UA_UInt32 maxMonitoredItemsPerCall;
  105. /* Limits for Requests */
  106. UA_UInt32 maxReferencesPerNode;
  107. /* Limits for Subscriptions */
  108. UA_UInt32 maxSubscriptionsPerSession;
  109. UA_DurationRange publishingIntervalLimits;
  110. UA_UInt32Range lifeTimeCountLimits;
  111. UA_UInt32Range keepAliveCountLimits;
  112. UA_UInt32 maxNotificationsPerPublish;
  113. UA_UInt32 maxRetransmissionQueueSize; /* 0 -> unlimited size */
  114. /* Limits for MonitoredItems */
  115. UA_UInt32 maxMonitoredItemsPerSubscription;
  116. UA_DurationRange samplingIntervalLimits;
  117. UA_UInt32Range queueSizeLimits; /* Negotiated with the client */
  118. /* Limits for PublishRequests */
  119. UA_UInt32 maxPublishReqPerSession;
  120. /* Discovery */
  121. #ifdef UA_ENABLE_DISCOVERY
  122. /* Timeout in seconds when to automatically remove a registered server from
  123. * the list, if it doesn't re-register within the given time frame. A value
  124. * of 0 disables automatic removal. Default is 60 Minutes (60*60). Must be
  125. * bigger than 10 seconds, because cleanup is only triggered approximately
  126. * ervery 10 seconds. The server will still be removed depending on the
  127. * state of the semaphore file. */
  128. UA_UInt32 discoveryCleanupTimeout;
  129. #endif
  130. };
  131. #ifdef __cplusplus
  132. }
  133. #endif
  134. #endif /* UA_SERVER_CONFIG_H_ */