ANSI C Based OPC UA Client/Server/PubSub SDK  1.9.1.442
UaServer_Configuration Struct Reference

Contains the configuration of the UaServer. More...

#include <uaserver.h>

Data Fields

OpcUa_UInt uNoOfEndpoints
 Number of endpoints. More...
 
UaServer_EndpointpEndpoints
 The configured endpoints. More...
 
OpcUa_ApplicationDescription ApplicationDescription
 Contains the ApplicationDescription displayed in the server address space. More...
 
OpcUa_BuildInfo BuildInfo
 Contains the BuildInfo displayed in the server address space. More...
 
OpcUa_String MDNSServerName
 The name of the server when it is announced via mDNS. More...
 
OpcUa_UInt32 uNoOfServerCapabilities
 The number of server capabilities supported by the server. More...
 
OpcUa_StringpServerCapabilities
 The set of server capabilities supported by the server. More...
 
OpcUa_Int32 iNoOfServerProfiles
 The number of profiles supported by the server. More...
 
OpcUa_StringpServerProfiles
 The set of profiles supported by the server. More...
 
OpcUa_Int32 iNoOfLocaleIds
 The number of locale IDs supported by the server. More...
 
OpcUa_StringpLocaleIds
 The set of locale IDs supported by the server. More...
 
OpcUa_String RejectedCertificateLocation
 Path to the folder containing rejected certificates. More...
 
OpcUa_UInt uMaxRejectedCertificates
 Maximum number of rejected certificates. More...
 
OpcUa_Boolean bAllowDeprecatedSecurityPolicies
 By default, deprecated SecurityPolicies are rejected by the SDK when loading the configuration. More...
 
OpcUa_String sPasswdFilePath
 The passwd file location. More...
 
OpcUa_String sGroupFilePath
 The group file location. More...
 
OpcUa_uid_t uRootUser
 The ID of the root user. More...
 
OpcUa_gid_t uSecurityAdminGroup
 The ID of the security administrator group. More...
 
OpcUa_String sFallbackSecurityPolicy
 SecurityPolicy to use for UserTokens on non-secure endpoints where no SecurityPolicy or SecurityPolicy::None is set. More...
 
OpcUa_String sUserCertsDir
 The folder containing accepted user certificates for X509 authentication tokens. More...
 
OpcUa_String sUserCrlDir
 The folder containing certificate revocation lists for X509 authentication tokens. More...
 
OpcUa_String sUserIssuerCertsDir
 The folder containing issuer certificates for X509 authentication tokens. More...
 
OpcUa_String sUserIssuerCrlDir
 The folder containing issuer revocation lists for X509 authentication tokens. More...
 
OpcUa_Boolean bDisableErrorUserTokenTimeInvalid
 Flag used to disable the X509 user token validation error BadCertificateTimeInvalid. More...
 
OpcUa_Boolean bDisableErrorUserTokenIssuerTimeInvalid
 Flag used to disable the X509 user token validation error BadCertificateIssuerTimeInvalid. More...
 
OpcUa_Boolean bDisableErrorUserTokenRevocationUnknown
 Flag used to disable the X509 user token validation error BadCertificateRevocationUnknown. More...
 
OpcUa_Boolean bDisableErrorUserTokenIssuerRevocationUnknown
 Flag used to disable the X509 user token validation error BadCertificateIssuerRevocationUnknown. More...
 
OpcUa_Boolean bRegisterAtDiscoveryServer
 If set to true, the server will register at the discovery server in regular intervals. More...
 
OpcUa_String sDiscoveryServerUrl
 The URL of the discovery server. More...
 
OpcUa_UInt uDiscoveryRegistrationInterval
 The registration interval for the discovery server in ms. More...
 
OpcUa_UInt uMaxProviderNodes
 Maximum number of nodes per provider supported by the server. More...
 
OpcUa_UInt uMaxReferencesToReturn
 Maximum number of references to return in a Browse/BrowseNext response. More...
 
OpcUa_UInt uMaxTranslateResults
 Maximum number of nodes to return in a TranslateBrowsePathsToNodeIds response. More...
 
OpcUa_UInt uMaxSecureChannels
 Maximum number of SecureChannels. More...
 
OpcUa_Boolean bDisableServerStateChange
 Flag used to disable server state change method. More...
 
OpcUa_UInt uMaxSessions
 Maximum total number of sessions. More...
 
OpcUa_UInt uMaxSessionsPerClient
 Maximum number of sessions the server allows per client. More...
 
OpcUa_UInt uMaxSubscriptions
 Maximum total number of subscriptions. More...
 
OpcUa_UInt uMaxSubscriptionsPerSession
 Maximum number of subscriptions per session. More...
 
OpcUa_UInt uMaxPublishPerSession
 Maximum number of publish requests per session. More...
 
OpcUa_UInt uMaxContinuationPointsPerSession
 Maximum number of continuation points per session. More...
 
OpcUa_UInt uMaxQueryContinuationPointsPerSession
 Maximum number of continuation points per session for Query services. More...
 
OpcUa_UInt uMaxHistoryContinuationPointsPerSession
 Maximum number of continuation points per session for ReadHistory services. More...
 
OpcUa_UInt uMinSessionTimeout
 Minimum session timeout in milliseconds. More...
 
OpcUa_UInt uMaxSessionTimeout
 Maximum session timeout in milliseconds. More...
 
OpcUa_UInt uSessionTimeoutResolution
 Session timeout resolution in milliseconds. More...
 
OpcUa_Double dMinPublishingInterval
 The minimum supported publishing interval. More...
 
OpcUa_Double dMaxPublishingInterval
 The maximum supported publishing interval. More...
 
OpcUa_Double dMinKeepAliveInterval
 The minimum supported KeepAliveInterval for subscriptions. More...
 
OpcUa_Double dMaxKeepAliveInterval
 The maximum supported KeepAliveInterval for subscriptions. More...
 
OpcUa_Double dMinLifetimeInterval
 The minimum supported Lifetime for subscriptions. More...
 
OpcUa_Double dMaxLifetimeInterval
 The maximum supported Lifetime for subscriptions. More...
 
OpcUa_UInt uMaxMonitoredItems
 Maximum total number of monitored items. More...
 
OpcUa_UInt uMaxMonitoredItemsPerSubscription
 Maximum number of monitored items per subscription. More...
 
OpcUa_UInt uGuaranteedMonitoredItemsPerSubscription
 Guaranteed minimum number of monitored items a subscription can create. More...
 
OpcUa_UInt uMaxMonitoredItemsPerSession
 Maximum number of monitored items per session. More...
 
OpcUa_UInt uMaxMonitoredItemsQueueSize
 Maximum queue size for data monitored items. More...
 
OpcUa_UInt uMaxEventMonitoredItemsQueueSize
 Maximum queue size for event monitored items. More...
 
OpcUa_UInt uMaxDataLoggerSubscriptionItems
 Maximum number of monitored items for the subscription containing the data logger nodes. More...
 
OpcUa_UInt uDataLoggerSubscriptionPublishingInterval
 Publishing interval of the subscription containing the data logger nodes. More...
 
OpcUa_UInt uMaxNodesPerRead
 The maximum number of operations in a single Read request. More...
 
OpcUa_UInt uMaxNodesPerWrite
 The maximum number of operations in a single Write request. More...
 
OpcUa_UInt uMaxNodesPerBrowse
 The maximum number of operations in a single Browse request. More...
 
OpcUa_UInt uMaxNodesPerTranslateBrowsePathsToNodeIds
 The maximum number of operations in a single TranslateBrowsePathsToNodeIds request. More...
 
OpcUa_UInt uMaxNodesPerRegisterNodes
 The maximum number of operations in a single RegisterNodes request. More...
 
OpcUa_UInt uMaxNodesPerMethodCall
 The maximum number of operations in a single Call request. More...
 
OpcUa_UInt uMaxMonitoredItemsPerCall
 The maximum number of operations in a single MonitoredItem related request. More...
 
OpcUa_UInt uMaxNodesPerHistoryReadData
 The maximum number of operations in a single data HistoryRead request. More...
 
OpcUa_UInt uMaxNodesPerHistoryReadEvents
 The maximum number of operations in a single event HistoryRead request. More...
 
OpcUa_UInt uMaxNodesPerHistoryUpdateData
 The maximum number of operations in a single data HistoryUpdate request. More...
 
OpcUa_UInt uMaxNodesPerHistoryUpdateEvents
 The maximum number of operations in a single event HistoryUpdate request. More...
 
OpcUa_UInt uMaxNodesPerNodeManagement
 The maximum number of operations in a single node management request. More...
 
OpcUa_UInt uMaxNodesPerQuery
 The maximum number of operations in a single query request. More...
 
struct {
PubSubConfigFile
 File containing a PubSub configuration to load on startup. More...
 
OpcUa_Boolean bPubSubTraceEnabled
 Enables the PubSub module trace. More...
 
OpcUa_Int iPubSubTraceLevel
 PubSub module trace level. More...
 
OpcUa_Int iPubSubTraceFacility
 PubSub module trace facility. More...
 

Detailed Description

Contains the configuration of the UaServer.

Field Documentation

OpcUa_ApplicationDescription UaServer_Configuration::ApplicationDescription

Contains the ApplicationDescription displayed in the server address space.

OpcUa_Boolean UaServer_Configuration::bAllowDeprecatedSecurityPolicies

By default, deprecated SecurityPolicies are rejected by the SDK when loading the configuration.

For backwards compatibility with old applications this behavior can be overridden. Please consider carefully before turning this feature on.

OpcUa_Boolean UaServer_Configuration::bDisableErrorUserTokenIssuerRevocationUnknown

Flag used to disable the X509 user token validation error BadCertificateIssuerRevocationUnknown.

OpcUa_Boolean UaServer_Configuration::bDisableErrorUserTokenIssuerTimeInvalid

Flag used to disable the X509 user token validation error BadCertificateIssuerTimeInvalid.

OpcUa_Boolean UaServer_Configuration::bDisableErrorUserTokenRevocationUnknown

Flag used to disable the X509 user token validation error BadCertificateRevocationUnknown.

OpcUa_Boolean UaServer_Configuration::bDisableErrorUserTokenTimeInvalid

Flag used to disable the X509 user token validation error BadCertificateTimeInvalid.

OpcUa_Boolean UaServer_Configuration::bDisableServerStateChange

Flag used to disable server state change method.

OpcUa_Boolean UaServer_Configuration::bPubSubTraceEnabled

Enables the PubSub module trace.

OpcUa_Boolean UaServer_Configuration::bRegisterAtDiscoveryServer

If set to true, the server will register at the discovery server in regular intervals.

OpcUa_BuildInfo UaServer_Configuration::BuildInfo

Contains the BuildInfo displayed in the server address space.

OpcUa_Double UaServer_Configuration::dMaxKeepAliveInterval

The maximum supported KeepAliveInterval for subscriptions.

OpcUa_Double UaServer_Configuration::dMaxLifetimeInterval

The maximum supported Lifetime for subscriptions.

Should be at least 3 * dMaxKeepAliveInterval.

OpcUa_Double UaServer_Configuration::dMaxPublishingInterval

The maximum supported publishing interval.

OpcUa_Double UaServer_Configuration::dMinKeepAliveInterval

The minimum supported KeepAliveInterval for subscriptions.

OpcUa_Double UaServer_Configuration::dMinLifetimeInterval

The minimum supported Lifetime for subscriptions.

Should be at least 3 * dMinKeepAliveInterval.

OpcUa_Double UaServer_Configuration::dMinPublishingInterval

The minimum supported publishing interval.

OpcUa_Int32 UaServer_Configuration::iNoOfLocaleIds

The number of locale IDs supported by the server.

OpcUa_Int32 UaServer_Configuration::iNoOfServerProfiles

The number of profiles supported by the server.

OpcUa_Int UaServer_Configuration::iPubSubTraceFacility

PubSub module trace facility.

OpcUa_Int UaServer_Configuration::iPubSubTraceLevel

PubSub module trace level.

OpcUa_String UaServer_Configuration::MDNSServerName

The name of the server when it is announced via mDNS.

If not specified the first element of the serverNames array is used.

UaServer_Endpoint* UaServer_Configuration::pEndpoints

The configured endpoints.

OpcUa_String* UaServer_Configuration::pLocaleIds

The set of locale IDs supported by the server.

OpcUa_String* UaServer_Configuration::pServerCapabilities

The set of server capabilities supported by the server.

OpcUa_String* UaServer_Configuration::pServerProfiles

The set of profiles supported by the server.

struct { ... } UaServer_Configuration::PubSubConfigFile

File containing a PubSub configuration to load on startup.

OpcUa_String UaServer_Configuration::RejectedCertificateLocation

Path to the folder containing rejected certificates.

OpcUa_String UaServer_Configuration::sDiscoveryServerUrl

The URL of the discovery server.

OpcUa_String UaServer_Configuration::sFallbackSecurityPolicy

SecurityPolicy to use for UserTokens on non-secure endpoints where no SecurityPolicy or SecurityPolicy::None is set.

OpcUa_String UaServer_Configuration::sGroupFilePath

The group file location.

OpcUa_String UaServer_Configuration::sPasswdFilePath

The passwd file location.

OpcUa_String UaServer_Configuration::sUserCertsDir

The folder containing accepted user certificates for X509 authentication tokens.

OpcUa_String UaServer_Configuration::sUserCrlDir

The folder containing certificate revocation lists for X509 authentication tokens.

OpcUa_String UaServer_Configuration::sUserIssuerCertsDir

The folder containing issuer certificates for X509 authentication tokens.

OpcUa_String UaServer_Configuration::sUserIssuerCrlDir

The folder containing issuer revocation lists for X509 authentication tokens.

OpcUa_UInt UaServer_Configuration::uDataLoggerSubscriptionPublishingInterval

Publishing interval of the subscription containing the data logger nodes.

OpcUa_UInt UaServer_Configuration::uDiscoveryRegistrationInterval

The registration interval for the discovery server in ms.

OpcUa_UInt UaServer_Configuration::uGuaranteedMonitoredItemsPerSubscription

Guaranteed minimum number of monitored items a subscription can create.

OpcUa_UInt UaServer_Configuration::uMaxContinuationPointsPerSession

Maximum number of continuation points per session.

OpcUa_UInt UaServer_Configuration::uMaxDataLoggerSubscriptionItems

Maximum number of monitored items for the subscription containing the data logger nodes.

OpcUa_UInt UaServer_Configuration::uMaxEventMonitoredItemsQueueSize

Maximum queue size for event monitored items.

OpcUa_UInt UaServer_Configuration::uMaxHistoryContinuationPointsPerSession

Maximum number of continuation points per session for ReadHistory services.

OpcUa_UInt UaServer_Configuration::uMaxMonitoredItems

Maximum total number of monitored items.

Set to 0 for no limit.

OpcUa_UInt UaServer_Configuration::uMaxMonitoredItemsPerCall

The maximum number of operations in a single MonitoredItem related request.

OpcUa_UInt UaServer_Configuration::uMaxMonitoredItemsPerSession

Maximum number of monitored items per session.

Set to 0 for no limit.

OpcUa_UInt UaServer_Configuration::uMaxMonitoredItemsPerSubscription

Maximum number of monitored items per subscription.

Set to 0 for no limit.

OpcUa_UInt UaServer_Configuration::uMaxMonitoredItemsQueueSize

Maximum queue size for data monitored items.

OpcUa_UInt UaServer_Configuration::uMaxNodesPerBrowse

The maximum number of operations in a single Browse request.

OpcUa_UInt UaServer_Configuration::uMaxNodesPerHistoryReadData

The maximum number of operations in a single data HistoryRead request.

OpcUa_UInt UaServer_Configuration::uMaxNodesPerHistoryReadEvents

The maximum number of operations in a single event HistoryRead request.

OpcUa_UInt UaServer_Configuration::uMaxNodesPerHistoryUpdateData

The maximum number of operations in a single data HistoryUpdate request.

OpcUa_UInt UaServer_Configuration::uMaxNodesPerHistoryUpdateEvents

The maximum number of operations in a single event HistoryUpdate request.

OpcUa_UInt UaServer_Configuration::uMaxNodesPerMethodCall

The maximum number of operations in a single Call request.

OpcUa_UInt UaServer_Configuration::uMaxNodesPerNodeManagement

The maximum number of operations in a single node management request.

OpcUa_UInt UaServer_Configuration::uMaxNodesPerQuery

The maximum number of operations in a single query request.

OpcUa_UInt UaServer_Configuration::uMaxNodesPerRead

The maximum number of operations in a single Read request.

OpcUa_UInt UaServer_Configuration::uMaxNodesPerRegisterNodes

The maximum number of operations in a single RegisterNodes request.

OpcUa_UInt UaServer_Configuration::uMaxNodesPerTranslateBrowsePathsToNodeIds

The maximum number of operations in a single TranslateBrowsePathsToNodeIds request.

OpcUa_UInt UaServer_Configuration::uMaxNodesPerWrite

The maximum number of operations in a single Write request.

OpcUa_UInt UaServer_Configuration::uMaxProviderNodes

Maximum number of nodes per provider supported by the server.

OpcUa_UInt UaServer_Configuration::uMaxPublishPerSession

Maximum number of publish requests per session.

OpcUa_UInt UaServer_Configuration::uMaxQueryContinuationPointsPerSession

Maximum number of continuation points per session for Query services.

OpcUa_UInt UaServer_Configuration::uMaxReferencesToReturn

Maximum number of references to return in a Browse/BrowseNext response.

OpcUa_UInt UaServer_Configuration::uMaxRejectedCertificates

Maximum number of rejected certificates.

OpcUa_UInt UaServer_Configuration::uMaxSecureChannels

Maximum number of SecureChannels.

The upper limit of this value depends on the CMake settings UASTACK_TCPLISTENER_MAX_CONNECTIONS and UASTACK_SOCKETMANAGER_NUMBER_OF_SOCKETS (equals OPCUA_TCPLISTENER_MAXCONNECTIONS and OPCUA_P_SOCKETMANAGER_NUMBEROFSOCKETS). Set to 0 for no limit.

OpcUa_UInt UaServer_Configuration::uMaxSessions

Maximum total number of sessions.

As most clients use one SecureChannel per session, the upper limits of MaxSecureChannels apply for this setting, too. Set to 0 for no limit.

OpcUa_UInt UaServer_Configuration::uMaxSessionsPerClient

Maximum number of sessions the server allows per client.

Set to 0 for no limit.

OpcUa_UInt UaServer_Configuration::uMaxSessionTimeout

Maximum session timeout in milliseconds.

Set to 0 for no limit.

OpcUa_UInt UaServer_Configuration::uMaxSubscriptions

Maximum total number of subscriptions.

Set to 0 for no limit.

OpcUa_UInt UaServer_Configuration::uMaxSubscriptionsPerSession

Maximum number of subscriptions per session.

Set to 0 for no limit.

OpcUa_UInt UaServer_Configuration::uMaxTranslateResults

Maximum number of nodes to return in a TranslateBrowsePathsToNodeIds response.

OpcUa_UInt UaServer_Configuration::uMinSessionTimeout

Minimum session timeout in milliseconds.

Set to 0 for no limit.

OpcUa_UInt UaServer_Configuration::uNoOfEndpoints

Number of endpoints.

OpcUa_UInt32 UaServer_Configuration::uNoOfServerCapabilities

The number of server capabilities supported by the server.

OpcUa_uid_t UaServer_Configuration::uRootUser

The ID of the root user.

This user has access to all security relevant features like auditing and certificate configuration. The default value is 0.

OpcUa_gid_t UaServer_Configuration::uSecurityAdminGroup

The ID of the security administrator group.

Users in this group can receive audit events and configure certificates. The default value is 0.

OpcUa_UInt UaServer_Configuration::uSessionTimeoutResolution

Session timeout resolution in milliseconds.

Set to 0 for no limitation.


The documentation for this struct was generated from the following file: