C++ Based OPC UA Client/Server SDK  1.5.3.346
ServerConfig Class Referenceabstract

Server Configuration Interface definition. More...

#include <serverconfig.h>

Inherited by ServerConfigData.

Public Types

enum  ComDaTimestampSource { INTERNAL, SOURCE_TIMESTAMP, SERVER_TIMESTAMP }
 ComDaTimestampSource enumeration. More...
 
enum  ComAeEventType { SIMPLE_EVENT, TRACKING_EVENT, CONDITION_EVENT }
 ComAeEventType enumeration. More...
 

Public Member Functions

 ServerConfig ()
 construction. More...
 
virtual ~ServerConfig ()
 destruction
 
virtual UaStatus loadConfiguration ()=0
 Load the configuration from the config file. More...
 
virtual UaStatus startUp (ServerManager *pServerManager)=0
 Start up OPC ServerConfig. More...
 
virtual UaStatus shutDown ()=0
 Shut down OPC ServerConfig. More...
 
virtual UaStatus saveConfiguration ()=0
 Save the configuration to the config file. More...
 
virtual UaStatus getEndpointConfiguration (UaString &sRejectedCertificateDirectory, OpcUa_UInt32 &nRejectedCertificatesCount, UaEndpointArray &uaEndpointArray)=0
 Get Endpoint Configuration. More...
 
virtual void endpointOpened (OpcUa_UInt32 index)
 Set state of successfully opened endpoint.
 
virtual UaStatus getCertificateStoreConfigurations (CertificateStoreConfigurationPArray &certificateStores)=0
 Get the configurations for server certificate stores. More...
 
virtual UaStatus getUserIdentityTokenConfig (OpcUa_Boolean &bEnableAnonymous, OpcUa_Boolean &bEnableUserPw, OpcUa_Boolean &bEnableCertificate, OpcUa_Boolean &bEnableKerberosTicket)=0
 Get the enabled settings for the different user identity tokens supported by the server. More...
 
virtual UaStatus getUserIdentityTokenSecurityPolicy (UaString &sSecurityPolicyUri)
 Get the security policy to use when encrypting or signing the UserIdentityToken when it is passed to the server. More...
 
virtual UaStatus getDefaultUserCertificateStore (CertificateStoreConfiguration **ppCertificateStore, UaString &sRejectedCertificateDirectory, OpcUa_UInt32 &nRejectedCertificatesCount, OpcUa_Boolean &bCertificateTokenConfigured)
 Get the configurations for the trust list and rejected folder for user certificates. More...
 
virtual UaStatus getIdsForDefaultRoles (OpcUa_UInt16 &nRootUserId, OpcUa_UInt16 &nSecurityAdminGroupId, OpcUa_UInt16 &nConfigAdminGroupId)
 Get Ids for roles defined in the SDK. More...
 
virtual UaStatus getDiscoveryRegistrationConfig (OpcUa_UInt32 &nRegistrationInterval, UaStringArray &discoveryUrlArray)=0
 Get settings for registration with discovery servers. More...
 
virtual UaStatus getWindowsDiscoveryRegistrationSecuritySetup (OpcUa_Boolean &bAutomaticCertificateExchange, UaString &sDiscoveryServerTrustListLocation, UaString &sDiscoveryServerStoreName, UaString &sDiscoveryServerCertificateName)
 Get settings for exchanging certificates with local discovery server on a windows computer for registration with local windows discovery server. More...
 
virtual UaStatus getSerializerConfiguration (OpcUa_Int32 &iMaxAlloc, OpcUa_Int32 &iMaxStringLength, OpcUa_Int32 &iMaxByteStringLength, OpcUa_Int32 &iMaxArrayLength, OpcUa_Int32 &iMaxMessageSize) const =0
 Get Serializer Configuration. More...
 
virtual UaStatus getStackThreadPoolSettings (OpcUa_Boolean &bEnabled, OpcUa_Int32 &iMinThreads, OpcUa_Int32 &iMaxThreads, OpcUa_Int32 &iMaxJobs, OpcUa_Boolean &bBlockOnAdd, OpcUa_UInt32 &nTimeout) const =0
 Returns the settings for the thread pool used in the OPC UA Stack. More...
 
virtual UaStatus getStackTraceSettings (OpcUa_Boolean &bTraceEnabled, OpcUa_UInt32 &uTraceLevel) const =0
 Get UA Stack trace settings. More...
 
virtual UaStatus getServerTraceSettings (OpcUa_Boolean &bTraceEnabled, OpcUa_UInt32 &uTraceLevel, OpcUa_UInt32 &uMaxTraceEntries, OpcUa_UInt32 &uMaxBackupFiles, UaString &sTraceFile, OpcUa_Boolean &bDisableFlush) const =0
 Get UA Server SDK trace settings. More...
 
virtual UaStatus getTraceEventSettings (OpcUa_UInt32 &uTraceEventLevel) const
 Get UA Server SDK trace event settings. More...
 
virtual OpcUa_Int32 getMaxRequestAge () const =0
 Returns the maximum age of a request the server allows. More...
 
virtual UaStatus getSessionSettings (OpcUa_Int32 &iMaxSessionCount, OpcUa_Int32 &iMaxSessionsPerClient, OpcUa_Int32 &iMinSessionTimeout, OpcUa_Int32 &iMaxSessionTimeout) const =0
 Get the setting parameters for session creation. More...
 
virtual UaStatus getServerSettings (OpcUa_Double &minSupportedSampleRate, UaStringArray &localeIdArray, UaStringArray &serverProfileArray, UaByteStringArray &softwareCertificateArray) const =0
 Get the general setting parameters for the server. More...
 
virtual OpcUa_Int32 getMaxBrowseContinuationPoints () const =0
 Returns the maximum number of Browse Continuation Points managed by the server. More...
 
virtual OpcUa_Int32 getMaxBrowseResults () const
 Returns the maximum number of Browse results for one browse operation. More...
 
virtual OpcUa_Int32 getMaxNodesToBrowse () const
 Returns the maximum number of nodes to browse the server will accept. More...
 
virtual UaStatus getMaxNodesPerHistoryService (OpcUa_UInt32 &iMaxNodesPerHistoryReadData, OpcUa_UInt32 &iMaxNodesPerHistoryReadEvents, OpcUa_UInt32 &iMaxNodesPerHistoryUpdateData, OpcUa_UInt32 &iMaxNodesPerHistoryUpdateEvents) const
 Get the operation limit setting parameters for historical access. More...
 
virtual OpcUa_Int32 getMaxHistoryContinuationPoints () const =0
 Returns the maximum number of History Continuation Points managed by the server. More...
 
virtual UaStatus getSubscriptionSettings (OpcUa_UInt32 &iMinPublishingInterval, OpcUa_UInt32 &iMaxPublishingInterval, OpcUa_UInt32 &iMinKeepAliveInterval, OpcUa_UInt32 &iMinSubscriptionLifetime, OpcUa_UInt32 &iMaxSubscriptionLifetime, OpcUa_UInt32 &iMaxRetransmissionQueueSize, OpcUa_UInt32 &iMaxNotificationsPerPublish) const =0
 Get the setting parameters for a subscription. More...
 
virtual UaStatus getMonitoredItemSettings (OpcUa_UInt32 &iMaxDataQueueSize, OpcUa_UInt32 &iMaxEventQueueSize) const =0
 Get the setting parameters for a MonitoreItem. More...
 
virtual UaStatus getSubscriptionMaxCountSettings (OpcUa_UInt32 &iMaxSubscriptionCount, OpcUa_UInt32 &iMaxSubscriptionsPerSession, OpcUa_UInt32 &iMaxMonitoredItemCount, OpcUa_UInt32 &iMaxMonitoredItemPerSubscriptionCount, OpcUa_UInt32 &iMaxMonitoredItemPerSessionCount) const
 Get the max object count parameters for Subscriptions. More...
 
virtual UaStatus getAvailableSamplingRates (UaUInt32Array &availableSamplingRates) const =0
 Returns the sampling rates provided by the OPC server. More...
 
virtual OpcUa_StatusCode getBuildInfo (UaString &ProductUri, UaString &ManufacturerName, UaString &ProductName, UaString &sSoftwareVersion, UaString &sBuildNumber, OpcUa_DateTime &BuildDate) const =0
 Returns the build information for the OPC server. More...
 
virtual OpcUa_StatusCode getServerInstanceInfo (UaString &ServerUri, UaLocalizedTextArray &ServerName) const =0
 Returns the server instance information for the OPC server. More...
 
virtual UaString getServerId () const
 Returns the ServerId used for audit events. More...
 
virtual UaStatus getThreadPoolSettings (OpcUa_UInt32 &minSizeTransactionManager, OpcUa_UInt32 &maxSizeTransactionManager, OpcUa_UInt32 &minSizeSubscriptionManager, OpcUa_UInt32 &maxSizeSubscriptionManager) const =0
 Returns the settings for the thread pools used in the OPC server. More...
 
virtual SessioncreateSession (OpcUa_Int32 sessionID, const UaNodeId &authenticationToken)=0
 Creates a session object for the OPC server. More...
 
virtual UaStatus logonSessionUser (Session *pSession, UaUserIdentityToken *pUserIdentityToken)=0
 Validates the user identity token and sets the user for a session. More...
 
virtual OpcUa_Boolean isAuditActivated ()
 Flag indicating if audit events are activated. More...
 
virtual UaStatus getRedundancySettings (OpcUa_RedundancySupport &redundancySupport, UaStringArray &serverUriArray)
 Provides the redundancy settings for the server. More...
 
virtual UaStatus getNetworkRedundancySettings (UaNetworkGroupDataTypes &networkGroupArray)
 Provides the network redundancy settings for NonTransparent redundant servers. More...
 
virtual UaStatus getAdditionalServerEntries (UaApplicationDescriptions &serverDescriptions)
 Provides capability to configure additional servers to be returned in FindServers. More...
 
virtual UaStatus getConfiguredNamespaces (UaUInt16Array &namespaceIndexArray, UaStringArray &namespaceUriArray, UaBoolArray &allowRenameUriArray, UaStringArray &uniqueIdArray, UaStringArray &comAliasArray)
 Provides configuration option for namespaces other than index 0 and 1 (OPC UA and local server). More...
 
virtual UaStatus addConfiguredNamespace (OpcUa_UInt16 namespaceIndex, const UaString &namespaceUri, OpcUa_Boolean allowRenameUri, const UaString &uniqueId)
 Adds a namespaces configuration entry for preconfigured namespaces. More...
 
virtual UaStatus removeConfiguredNamespace (OpcUa_UInt16 namespaceIndex)
 Removes a namespaces configuration entry for preconfigured namespaces. More...
 
virtual UaStatus getTagFileConfiguration (UaString &defaultTagFileName, UaString &tagFileLocation, UaString &tagFileEnding, UaString &defaultFileUpdatePolicy)
 Provides information about tagfile name, path und file ending used in the NodeManagerTagFile. More...
 
virtual UaStatus setTagFileConfiguration (const UaString &defaultTagFileName, const UaString &tagFileLocation, const UaString &tagFileEnding, const UaString &defaultFileUpdatePolicy)
 Set information about tagfile name, path und file ending used in the NodeManagerTagFile. More...
 
virtual UaStatus setServerCertificateThumbprint (const UaString &thumbprint)
 
virtual UaStatus getHttpFileAccess (OpcUa_Boolean &active, UaString &filePath)
 Provides settings for HTTP file access capability. More...
 
virtual UaStatus getComDaPropertyMapping (UaStringArray &propertyNames, UaStringArray &propertyNameSpaces, UaUInt32Array &propertyIds)
 Provides a mapping list of OPC UA property names to COM Data Access property Ids. More...
 
virtual UaStatus addComDaPropertyMapping (const UaString &propertyName, const UaString &propertyNameSpaceUri, OpcUa_UInt32 propertyId)
 Adds an entry to the mapping list of OPC UA property names to COM Data Access property Ids. More...
 
virtual UaStatus getComDaNamespaceInformation (UaString &defaultNamespace, UaUShort &namespaceDelimiter, OpcUa_Boolean &useComAlias)
 Provides additional namespace related information for COM DA Server module. More...
 
virtual ComDaTimestampSource getComDaTimestampSource ()
 Provides the timestamp source for COM Data Access items. More...
 
virtual ComDaTimestampSource getComHdaTimestampSource ()
 Provides the timestamp source for COM Historical Data Access items. More...
 
virtual OpcUa_Boolean getBrowseNextLevelForVariables ()
 When browsing for COM DA items this option causes the server to internally browse one additional level to see if there are any children.
 
virtual UaStatus getComAeNamespaceInformation (UaString &defaultNamespace)
 Provides additional namespace related information for COM A&E Server module. More...
 
virtual UaStatus getComAeEventCategoryMapping (ComAeEventType eventType, UaUInt32Array &categoryIDs, UaStringArray &categoryNames, UaNodeIdArray &eventTypeIds, UaStringArray &namespaceUris, UaBoolArray &visbilityFlags)
 Provides a mapping list of OPC UA event type NodeIds to COM Alarms and Events category IDs. More...
 
virtual UaStatus addComAeEventCategoryMapping (ComAeEventType eventType, const UaUInt32Array &categoryIDs, const UaStringArray &categoryNames, const UaNodeIdArray &eventTypeIds, const UaStringArray &namespaceUris)
 Adds a mapping list of OPC UA event type NodeIds to COM Alarms and Events category IDs. More...
 
virtual UaStatus getComAeAttributeMapping (ComAeAttributeMappingArray &comAeAttributeMappingArray)
 Get the mapping list of OPC UA event fields to COM Alarms and Events attribute IDs. More...
 
virtual UaStatus addComAeAttributeMapping (OpcUa_UInt32 attributeID, const UaString &attributeName, OpcUa_BuiltInType dataType, OpcUa_Boolean isArray, const UaStringArray &eventFieldPathNames, const UaStringArray &eventFieldPathNamespaceUris)
 Adds an entry to the mapping list of OPC UA event fields to COM Alarms and Events attribute IDs. More...
 
virtual void lockConfigFile ()
 Lock snchronization object for configuratin changes.
 
virtual void unlockConfigFile ()
 Unlock snchronization object for configuratin changes.
 

Detailed Description

Server Configuration Interface definition.

This class is responsible for the start up and shut down of the Server. Also all necessary configuration options can be configured with this class. Services like discovery and getEndpointConfiguration are defined here. This Interface configures the Server and all needed parts of it.

Constructor & Destructor Documentation

ServerConfig::ServerConfig ( )
inline

construction.

Member Function Documentation

UaStatus ServerConfig::addComAeAttributeMapping ( OpcUa_UInt32  attributeID,
const UaString attributeName,
OpcUa_BuiltInType  dataType,
OpcUa_Boolean  isArray,
const UaStringArray eventFieldPathNames,
const UaStringArray eventFieldPathNamespaceUris 
)
virtual

Adds an entry to the mapping list of OPC UA event fields to COM Alarms and Events attribute IDs.

The event type hirarchy and its event fields are managed by the SDK or custom NodeManager implementations is created based on the OPC UA model. In OPC UA, event fields are identified by a path of QualifiedNames starting from the EventType. These QualifiedNames are defined by standardization bodies like the OPC Foundation for the standard OPC UA event types or by vendors or users. for the standard OPC UA event types or by vendors or users. In classic OPC Alarms & Events, attribute IDs are DWORDS. This method adds an entrie to the mapping table of OPC UA event fields to classic OPC Alarms & Events attribute IDs. This mapping table is only needed for servers providing a classic OPC Alarms & Events interface in addition to the OPC UA interface.

Returns
Error code
Parameters
[in]attributeIDAttribute ID
[in]attributeNameAttribute Name
[in]dataTypeData type of the attribute
[in]isArrayArray flag for the data type of the attribute
[in]eventFieldPathNamesList of event field path names
[in]eventFieldPathNamespaceUrisList of event field path namespace URIs

Reimplemented in ServerConfigData, and ServerConfigXml.

UaStatus ServerConfig::addComAeEventCategoryMapping ( ServerConfig::ComAeEventType  eventType,
const UaUInt32Array categoryIDs,
const UaStringArray categoryNames,
const UaNodeIdArray eventTypeIds,
const UaStringArray namespaceUris 
)
virtual

Adds a mapping list of OPC UA event type NodeIds to COM Alarms and Events category IDs.

The event type hirarchy managed by the SDK or custom NodeManager implementations is created based on the OPC UA model. In OPC UA, event types are identified by NodeIds. These NodeIds are defined by standardization bodies like the OPC Foundation for the standard OPC UA event types or by vendors or users. In classic OPC Alarms & Events, event category IDs are DWORDS. This method provides the mapping table of OPC UA event type NodeIds to classic OPC Alarms & Events category IDs. This mapping table is only needed for servers providing a classic OPC Alarms & Events interface in addition to the OPC UA interface. The default implementation does not store the list

Returns
Error code
Parameters
[in]eventTypeEvent type for the categories to add
[in]categoryIDsList of OPC A&E category names
[in]categoryNamesList of OPC A&E category names
[in]eventTypeIdsList of OPC UA event type NodeIds
[in]namespaceUrisList of namespace URIs for the event type id. The string is empty for namespace 0

Reimplemented in ServerConfigData, and ServerConfigXml.

UaStatus ServerConfig::addComDaPropertyMapping ( const UaString propertyName,
const UaString propertyNameSpaceUri,
OpcUa_UInt32  propertyId 
)
virtual

Adds an entry to the mapping list of OPC UA property names to COM Data Access property Ids.

The address space managed by the SDK or custom NodeManager implementations is created based on the OPC UA model. In OPC UA, properties are identified by qualified names. These names are defined by standardization bodies like the OPC Foundation for the standard OPC UA properties or by vendors or users. In classic OPC Data Access, properties are defined by integer IDs defined by the OPC Foundation or by vendors. This method adds an entry to the mapping table of OPC UA porperty names to classic OPC Data Access property IDs. This mapping table is only needed for servers providing a classic OPC Data Access interface in addition to the OPC UA interface. The default implementation is empty and is not storing the added entry

Returns
Error code
Parameters
[in]propertyNameOPC UA Property name
[in]propertyNameSpaceUriOPC UA Property name space URI
[in]propertyIdClassic OPC Data Access Property Id

Reimplemented in ServerConfigData, and ServerConfigXml.

UaStatus ServerConfig::addConfiguredNamespace ( OpcUa_UInt16  namespaceIndex,
const UaString namespaceUri,
OpcUa_Boolean  allowRenameUri,
const UaString uniqueId 
)
virtual

Adds a namespaces configuration entry for preconfigured namespaces.

See also
getConfiguredNamespaces. The default implementation is empty and is not storing the added entry.
Returns
Error code
Parameters
[in]namespaceIndexIndex for the namespace in the namespace table
[in]namespaceUriNamespace URI in the namespace table
[in]allowRenameUriFlag indicating if module responsible for the namespace supports a change of the namespace URI in the configuration
[in]uniqueIdUnique ID required to identify the namespace if the module allows to change the namespace URI in the configuration

Reimplemented in ServerConfigData, and ServerConfigXml.

virtual Session* ServerConfig::createSession ( OpcUa_Int32  sessionID,
const UaNodeId authenticationToken 
)
pure virtual

Creates a session object for the OPC server.

This could be an instance of the default Session class provided by the SDK or a derived class that contains application specific functionality and vendor specific data related to the underlying system.

Returns
Session object
Parameters
[out]sessionIDSession Id created by the server application.
[out]authenticationTokenSecret session Id created by the server application.
UaStatus ServerConfig::getAdditionalServerEntries ( UaApplicationDescriptions serverDescriptions)
virtual

Provides capability to configure additional servers to be returned in FindServers.

Every server must implement FindServers and must return its own application description. This can also be used to run the server on the default port 4840 if only one server is installed on the system. This configuration option allows to run this server on port 4840 but to return also additional servers for a fixed configuration e.g. two servers from the same vendor on one network node.

Returns
Error code
Parameters
[out]serverDescriptionsList of application descriptions containing the information for the additional servers to return.

Reimplemented in ServerConfigData.

virtual UaStatus ServerConfig::getAvailableSamplingRates ( UaUInt32Array availableSamplingRates) const
pure virtual

Returns the sampling rates provided by the OPC server.

Returns
Error code.
Parameters
[out]availableSamplingRatesArray of sampling rates provided by the OPC server.

Implemented in ServerConfigData.

virtual OpcUa_StatusCode ServerConfig::getBuildInfo ( UaString ProductUri,
UaString ManufacturerName,
UaString ProductName,
UaString sSoftwareVersion,
UaString sBuildNumber,
OpcUa_DateTime BuildDate 
) const
pure virtual

Returns the build information for the OPC server.

Returns
the build information for the OPC server.
Parameters
[out]ProductUriReturns the URI that identifies the software containing the OPC server.
[out]ManufacturerNameReturns the name of the software manufacturer.
[out]ProductNameReturns the name of the software containing the OPC server.
[out]sSoftwareVersionReturns the software version.
[out]sBuildNumberReturns the build number.
[out]BuildDateReturns the date and time of the build.

Implemented in ServerConfigData.

virtual UaStatus ServerConfig::getCertificateStoreConfigurations ( CertificateStoreConfigurationPArray &  certificateStores)
pure virtual

Get the configurations for server certificate stores.

Parameters
[out]certificateStoresList of certificate store configurations

Implemented in ServerConfigData.

UaStatus ServerConfig::getComAeAttributeMapping ( ComAeAttributeMappingArray comAeAttributeMappingArray)
virtual

Get the mapping list of OPC UA event fields to COM Alarms and Events attribute IDs.

The event type hirarchy and its event fields are managed by the SDK or custom NodeManager implementations is created based on the OPC UA model. In OPC UA, event fields are identified by a path of QualifiedNames starting from the EventType. These QualifiedNames are defined by standardization bodies like the OPC Foundation for the standard OPC UA event types or by vendors or users. for the standard OPC UA event types or by vendors or users. In classic OPC Alarms & Events, attribute IDs are DWORDS. This method adds an entrie to the mapping table of OPC UA event fields to classic OPC Alarms & Events attribute IDs. This mapping table is only needed for servers providing a classic OPC Alarms & Events interface in addition to the OPC UA interface.

Returns
Error code.
Parameters
[out]comAeAttributeMappingArrayArray of configured mappings between OPC UA event fields and COM Alarms and Events attribute IDs.

Reimplemented in ServerConfigData.

UaStatus ServerConfig::getComAeEventCategoryMapping ( ServerConfig::ComAeEventType  eventType,
UaUInt32Array categoryIDs,
UaStringArray categoryNames,
UaNodeIdArray eventTypeIds,
UaStringArray namespaceUris,
UaBoolArray &  visbilityFlags 
)
virtual

Provides a mapping list of OPC UA event type NodeIds to COM Alarms and Events category IDs.

The event type hirarchy managed by the SDK or custom NodeManager implementations is created based on the OPC UA model. In OPC UA, event types are identified by NodeIds. These NodeIds are defined by standardization bodies like the OPC Foundation for the standard OPC UA event types or by vendors or users. In classic OPC Alarms & Events, event category IDs are DWORDS. This method provides the mapping table of OPC UA event type NodeIds to classic OPC Alarms & Events category IDs. This mapping table is only needed for servers providing a classic OPC Alarms & Events interface in addition to the OPC UA interface. The default implementation returns empty lists

Returns
Error code
Parameters
[in]eventTypeEvent type for the categories to return
[out]categoryIDsList of OPC A&E category names
[out]categoryNamesList of OPC A&E category names
[out]eventTypeIdsList of OPC UA event type NodeIds
[out]namespaceUrisList of namespace URIs for the event type id. The string is empty for namespace 0
[out]visbilityFlagsList of flags indicating if the category is visible

Reimplemented in ServerConfigData.

UaStatus ServerConfig::getComAeNamespaceInformation ( UaString defaultNamespace)
virtual

Provides additional namespace related information for COM A&E Server module.

The default implementation returns empty strings and lists.

Returns
Error code
Parameters
[out]defaultNamespaceDefault namespace URI used to create fully qualified names without namespace URI

Reimplemented in ServerConfigData.

UaStatus ServerConfig::getComDaNamespaceInformation ( UaString defaultNamespace,
UaUShort &  namespaceDelimiter,
OpcUa_Boolean &  useComAlias 
)
virtual

Provides additional namespace related information for COM DA Server module.

The default implementation returns empty strings and lists.

Returns
Error code
Parameters
[out]defaultNamespaceDefault namespace URI used to create ItemIds without namespace URI
[out]namespaceDelimiterDelimiter used in ItemIDs between Namespace URI and Identifier
[out]useComAliasFlag indicating if the COM alias for namespaces is used in ItemIDs

Reimplemented in ServerConfigData.

UaStatus ServerConfig::getComDaPropertyMapping ( UaStringArray propertyNames,
UaStringArray propertyNameSpaces,
UaUInt32Array propertyIds 
)
virtual

Provides a mapping list of OPC UA property names to COM Data Access property Ids.

The address space managed by the SDK or custom NodeManager implementations is created based on the OPC UA model. In OPC UA, properties are identified by qualified names. These names are defined by standardization bodies like the OPC Foundation for the standard OPC UA properties or by vendors or users. In classic OPC Data Access, properties are defined by integer IDs defined by the OPC Foundation or by vendors. This method provides the mapping table of OPC UA porperty names to classic OPC Data Access property IDs. This mapping table is only needed for servers providing a classic OPC Data Access interface in addition to the OPC UA interface. The default implementation returns empty lists

Returns
Error code
Parameters
[out]propertyNamesList of OPC UA Property names
[out]propertyNameSpacesList of OPC UA Property name spaces
[out]propertyIdsList of classic OPC Data Access Property Ids

Reimplemented in ServerConfigData.

ServerConfig::ComDaTimestampSource ServerConfig::getComDaTimestampSource ( )
virtual

Provides the timestamp source for COM Data Access items.

Reimplemented in ServerConfigData.

ServerConfig::ComDaTimestampSource ServerConfig::getComHdaTimestampSource ( )
virtual

Provides the timestamp source for COM Historical Data Access items.

Reimplemented in ServerConfigData.

UaStatus ServerConfig::getConfiguredNamespaces ( UaUInt16Array namespaceIndexArray,
UaStringArray namespaceUriArray,
UaBoolArray &  allowRenameUriArray,
UaStringArray uniqueIdArray,
UaStringArray comAliasArray 
)
virtual

Provides configuration option for namespaces other than index 0 and 1 (OPC UA and local server).

This allows the assignment of namespace URIs to a specific index independent of the loading sequence of NodeManagers.

Returns
Error code
Parameters
[out]namespaceIndexArrayList of indices for the namespaces in the namespace table
[out]namespaceUriArrayList of namespace URIs in the namespace table
[out]allowRenameUriArrayList of flags indicating if module responsible for the namespace supports a change of the namespace URI in the configuration. If this flag is set to true, the optional parameter UniqueId must be provided.
[out]uniqueIdArrayList of unique IDs required to identify the namespace if the module allows to change the namespace URI in the configuration
[out]comAliasArrayList of aliases used to create COM ItemIds or other COM identifiers

Reimplemented in ServerConfigData.

UaStatus ServerConfig::getDefaultUserCertificateStore ( CertificateStoreConfiguration **  ppCertificateStore,
UaString sRejectedCertificateDirectory,
OpcUa_UInt32 &  nRejectedCertificatesCount,
OpcUa_Boolean &  bCertificateTokenConfigured 
)
virtual

Get the configurations for the trust list and rejected folder for user certificates.

Parameters
[out]ppCertificateStoreCertificate store configuration for user certificates
[out]sRejectedCertificateDirectoryThe directory to store rejected user certificates.
[out]nRejectedCertificatesCountThe maximum number of rejected user certificates in the directory
[out]bCertificateTokenConfiguredReturns true if the user identity token certificate is enabled in the configuration

Reimplemented in ServerConfigData.

virtual UaStatus ServerConfig::getDiscoveryRegistrationConfig ( OpcUa_UInt32 &  nRegistrationInterval,
UaStringArray discoveryUrlArray 
)
pure virtual

Get settings for registration with discovery servers.

Returns
OPC UA result code.
Parameters
[out]nRegistrationIntervalInterval in milliseconds used to register with the discovery servers.
[out]discoveryUrlArrayUaString array of discovery server URLs to register with.

Implemented in ServerConfigData.

virtual UaStatus ServerConfig::getEndpointConfiguration ( UaString sRejectedCertificateDirectory,
OpcUa_UInt32 &  nRejectedCertificatesCount,
UaEndpointArray uaEndpointArray 
)
pure virtual

Get Endpoint Configuration.

This method provides the settings necessary for the SDK to open the endpoints for OPC UA communication in the UA stack and to implement the GetEndpoints service in the UA Module.

Returns
Error code.
Parameters
[out]sRejectedCertificateDirectoryThe directory to store rejected client certificates.
[out]nRejectedCertificatesCountThe maximum number of rejected certificates in the directory
[out]uaEndpointArrayUaEndpoint array of configured endpoints for the server.

Implemented in ServerConfigData.

UaStatus ServerConfig::getHttpFileAccess ( OpcUa_Boolean &  active,
UaString filePath 
)
virtual

Provides settings for HTTP file access capability.

The default implementation returns inactive.

Returns
Error code
Parameters
[out]activeFlag indicating if the file access is active.
[out]filePathThe path to the directory with the HTML files.

Reimplemented in ServerConfigData.

UaStatus ServerConfig::getIdsForDefaultRoles ( OpcUa_UInt16 &  nRootUserId,
OpcUa_UInt16 &  nSecurityAdminGroupId,
OpcUa_UInt16 &  nConfigAdminGroupId 
)
virtual

Get Ids for roles defined in the SDK.

These roles are needed to control access to certificate configuration and trace configuration.

Returns
Error code.
Parameters
[out]nRootUserIdId of the root user. This user has all rights. Default is 0.
[out]nSecurityAdminGroupIdId of the security admin group. Members of this group have acceess to administrate certificates. Default is 0.
[out]nConfigAdminGroupIdId of the configuration admin group. Members of this group can configure the trace. Default is 0.

Reimplemented in ServerConfigData.

virtual OpcUa_Int32 ServerConfig::getMaxBrowseContinuationPoints ( ) const
pure virtual

Returns the maximum number of Browse Continuation Points managed by the server.

Returns
Maximum number of Browse Continuation Points managed by the server.

Implemented in ServerConfigData.

OpcUa_Int32 ServerConfig::getMaxBrowseResults ( ) const
virtual

Returns the maximum number of Browse results for one browse operation.

Returns
Maximum number of Browse results for one browse operation.

Reimplemented in ServerConfigData.

virtual OpcUa_Int32 ServerConfig::getMaxHistoryContinuationPoints ( ) const
pure virtual

Returns the maximum number of History Continuation Points managed by the server.

Returns
Maximum number of History Continuation Points managed by the server.

Implemented in ServerConfigData.

UaStatus ServerConfig::getMaxNodesPerHistoryService ( OpcUa_UInt32 &  iMaxNodesPerHistoryReadData,
OpcUa_UInt32 &  iMaxNodesPerHistoryReadEvents,
OpcUa_UInt32 &  iMaxNodesPerHistoryUpdateData,
OpcUa_UInt32 &  iMaxNodesPerHistoryUpdateEvents 
) const
virtual

Get the operation limit setting parameters for historical access.

Returns
Error code.
Parameters
[out]iMaxNodesPerHistoryReadDataMaximum number of nodes for HistoryRead service for Raw, Modified, Processed and AtTime
[out]iMaxNodesPerHistoryReadEventsMaximum number of nodes for HistoryRead service for Events
[out]iMaxNodesPerHistoryUpdateDataMaximum number of nodes for HistoryUpdate service for Data
[out]iMaxNodesPerHistoryUpdateEventsMaximum number of nodes for HistoryUpdate service for Events

Reimplemented in ServerConfigData.

OpcUa_Int32 ServerConfig::getMaxNodesToBrowse ( ) const
virtual

Returns the maximum number of nodes to browse the server will accept.

Returns
Maximum number of nodes to browse. Default 0 is unlimited.

Reimplemented in ServerConfigData.

virtual OpcUa_Int32 ServerConfig::getMaxRequestAge ( ) const
pure virtual

Returns the maximum age of a request the server allows.

Returns
Maximum age of a request the server allows.

Implemented in ServerConfigData.

virtual UaStatus ServerConfig::getMonitoredItemSettings ( OpcUa_UInt32 &  iMaxDataQueueSize,
OpcUa_UInt32 &  iMaxEventQueueSize 
) const
pure virtual

Get the setting parameters for a MonitoreItem.

Returns
Error code.
Parameters
[out]iMaxDataQueueSizeMaximum queue size for a data monitored item
[out]iMaxEventQueueSizeMaximum queue size for an event monitored item

Implemented in ServerConfigData.

UaStatus ServerConfig::getNetworkRedundancySettings ( UaNetworkGroupDataTypes networkGroupArray)
virtual

Provides the network redundancy settings for NonTransparent redundant servers.

Returns
Error code
Parameters
[out]networkGroupArrayList of server network groups for NonTransparent redundant set

Reimplemented in ServerConfigData.

UaStatus ServerConfig::getRedundancySettings ( OpcUa_RedundancySupport redundancySupport,
UaStringArray serverUriArray 
)
virtual

Provides the redundancy settings for the server.

There are three main options available, None, NonTransparent (with cold, warm and hot) and Transparent redundancy. This configuration covers the options None and NonTransparent. The option Transparent requires an additional SDK module. This redundancy module is also providing the required settings and creates the corresponding diagnostic and capability object.

Returns
Error code
Parameters
[out]redundancySupportRedundancy support options
  • OpcUa_RedundancySupport_None (serverUriArray is ignored)
  • OpcUa_RedundancySupport_Cold
  • OpcUa_RedundancySupport_Warm
  • OpcUa_RedundancySupport_Hot
  • OpcUa_RedundancySupport_Transparent (other settings are handled by redundancy module)
[out]serverUriArrayList of server URIs for the servers in the NonTransparent redundant set

Reimplemented in ServerConfigData.

virtual UaStatus ServerConfig::getSerializerConfiguration ( OpcUa_Int32 &  iMaxAlloc,
OpcUa_Int32 &  iMaxStringLength,
OpcUa_Int32 &  iMaxByteStringLength,
OpcUa_Int32 &  iMaxArrayLength,
OpcUa_Int32 &  iMaxMessageSize 
) const
pure virtual

Get Serializer Configuration.

These are the Security constraints for the serializer. Set these values carefully.

Returns
Error code.
Parameters
[out]iMaxAllocThe largest size for a memory block the serializer can do when deserializing a message
[out]iMaxStringLengthThe largest string accepted by the serializer
[out]iMaxByteStringLengthThe largest byte string accepted by the serializer
[out]iMaxArrayLengthMaximum number of elements in an array accepted by the serializer
[out]iMaxMessageSizeThe maximum number of bytes per message in total

Implemented in ServerConfigData.

UaString ServerConfig::getServerId ( ) const
virtual

Returns the ServerId used for audit events.

The default implementation returns the ServerUri. Transparent redundant servers must extend the ServerUri with a unique identifier for the server in the redundant set.

Reimplemented in ServerConfigData.

virtual OpcUa_StatusCode ServerConfig::getServerInstanceInfo ( UaString ServerUri,
UaLocalizedTextArray ServerName 
) const
pure virtual

Returns the server instance information for the OPC server.

Returns
the server instance information for the OPC server.
Parameters
[out]ServerUriReturns the URI that identifies the application instance containing the OPC server.
[out]ServerNameReturns the name of the software instance containing the OPC server.

Implemented in ServerConfigData.

virtual UaStatus ServerConfig::getServerSettings ( OpcUa_Double &  minSupportedSampleRate,
UaStringArray localeIdArray,
UaStringArray serverProfileArray,
UaByteStringArray softwareCertificateArray 
) const
pure virtual

Get the general setting parameters for the server.

Returns
Error code.
Parameters
[out]minSupportedSampleRateMinimum supported sample rate by the server provided as capability information to the client
[out]localeIdArrayArray of LocaleIds that are known to be supported by the server.
[out]serverProfileArrayArray of conformance profile URIs indicating the features supported by the server.
[out]softwareCertificateArrayArray of software certificates containing all certificates supported by the server.

Implemented in ServerConfigData.

virtual UaStatus ServerConfig::getServerTraceSettings ( OpcUa_Boolean &  bTraceEnabled,
OpcUa_UInt32 &  uTraceLevel,
OpcUa_UInt32 &  uMaxTraceEntries,
OpcUa_UInt32 &  uMaxBackupFiles,
UaString sTraceFile,
OpcUa_Boolean &  bDisableFlush 
) const
pure virtual

Get UA Server SDK trace settings.

Returns
Error code.
Parameters
[out]bTraceEnabledGlobally enable/disable trace output from the SDK
[out]uTraceLevelConfigures the level of messages traced
  • (0) NoTrace - No Trace
  • (1) Errors - Unexpected errors
  • (2) Warning - Unexpected behaviour that is not an error
  • (3) Info - Information about important activities like connection establishment
  • (4) InterfaceCall - Calls to module interfaces
  • (5) CtorDtor - Creation and destruction of objects
  • (6) ProgramFlow - Internal program flow
  • (7) Data - Data
[out]uMaxTraceEntriesMaximum number of trace entries in one trace file
[out]uMaxBackupFilesMaximum number of backup files
[out]sTraceFileName and path of the trace file
[out]bDisableFlushDisable flushing the trace file after each trace entry

Implemented in ServerConfigData.

virtual UaStatus ServerConfig::getSessionSettings ( OpcUa_Int32 &  iMaxSessionCount,
OpcUa_Int32 &  iMaxSessionsPerClient,
OpcUa_Int32 &  iMinSessionTimeout,
OpcUa_Int32 &  iMaxSessionTimeout 
) const
pure virtual

Get the setting parameters for session creation.

Returns
Error code.
Parameters
[out]iMaxSessionCountMaximum number of sessions the server allows to create
[out]iMaxSessionsPerClientMaximum number of sessions the server allows per Client, 0 is no limitation
[out]iMinSessionTimeoutMinimum timeout in ms for a sessions the server allows to set
[out]iMaxSessionTimeoutMaximum timeout in ms for a sessions the server allows to set

Implemented in ServerConfigData.

virtual UaStatus ServerConfig::getStackThreadPoolSettings ( OpcUa_Boolean &  bEnabled,
OpcUa_Int32 &  iMinThreads,
OpcUa_Int32 &  iMaxThreads,
OpcUa_Int32 &  iMaxJobs,
OpcUa_Boolean &  bBlockOnAdd,
OpcUa_UInt32 &  nTimeout 
) const
pure virtual

Returns the settings for the thread pool used in the OPC UA Stack.

Returns
Error code.
Parameters
[out]bEnabledControls wether the secure listener uses a thread pool to dispatch received requests
[out]iMinThreadsThe minimum number of threads in the thread pool
[out]iMaxThreadsThe maximum number of threads in the thread pool
[out]iMaxJobsThe length of the queue with jobs waiting for a free thread
[out]bBlockOnAddIf MaxJobs is reached the add operation can block or return an error
[out]nTimeoutIf the add operation blocks on a full job queue, this value sets the max waiting time

Implemented in ServerConfigData.

virtual UaStatus ServerConfig::getStackTraceSettings ( OpcUa_Boolean &  bTraceEnabled,
OpcUa_UInt32 &  uTraceLevel 
) const
pure virtual

Get UA Stack trace settings.

Returns
Error code.
Parameters
[out]bTraceEnabledGlobally enable/disable trace output from the stack (exclude platformlayer)
[out]uTraceLevelConfigures the level of messages traced
  • OPCUA_TRACE_OUTPUT_LEVEL_NONE - No Trace
  • OPCUA_TRACE_OUTPUT_LEVEL_ERROR - Critical errors (unexpected and/or requiring external actions) which require attention
  • OPCUA_TRACE_OUTPUT_LEVEL_WARNING - Non-critical faults which should not go unnoticed but are handled internally
  • OPCUA_TRACE_OUTPUT_LEVEL_SYSTEM - Rare major events (good cases) like initializations, shut-down, etc.
  • OPCUA_TRACE_OUTPUT_LEVEL_INFO - Regular good case events like connects, renews
  • OPCUA_TRACE_OUTPUT_LEVEL_DEBUG - Used for debugging purposes
  • OPCUA_TRACE_OUTPUT_LEVEL_CONTENT - Used to add additional content (i.e. whole message bodies) to debug traces
  • OPCUA_TRACE_OUTPUT_LEVEL_ALL - All outputs

Implemented in ServerConfigData.

UaStatus ServerConfig::getSubscriptionMaxCountSettings ( OpcUa_UInt32 &  iMaxSubscriptionCount,
OpcUa_UInt32 &  iMaxSubscriptionsPerSession,
OpcUa_UInt32 &  iMaxMonitoredItemCount,
OpcUa_UInt32 &  iMaxMonitoredItemPerSubscriptionCount,
OpcUa_UInt32 &  iMaxMonitoredItemPerSessionCount 
) const
virtual

Get the max object count parameters for Subscriptions.

Returns
Error code.
Parameters
[out]iMaxSubscriptionCountMaximum number of subscriptions the server allows to create. Default value 0 is unlimited
[out]iMaxSubscriptionsPerSessionMaximum number of subscriptions the server allows to create per session. Default value 0 is unlimited
[out]iMaxMonitoredItemCountMaximum number of monitored items the server allows to create. Default value 0 is unlimited
[out]iMaxMonitoredItemPerSubscriptionCountMaximum number of monitored items per subscriptions the server allows to create. Default value 0 is unlimited
[out]iMaxMonitoredItemPerSessionCountMaximum number of monitored items per session the server allows to create. Default value 0 is unlimited

Reimplemented in ServerConfigData.

virtual UaStatus ServerConfig::getSubscriptionSettings ( OpcUa_UInt32 &  iMinPublishingInterval,
OpcUa_UInt32 &  iMaxPublishingInterval,
OpcUa_UInt32 &  iMinKeepAliveInterval,
OpcUa_UInt32 &  iMinSubscriptionLifetime,
OpcUa_UInt32 &  iMaxSubscriptionLifetime,
OpcUa_UInt32 &  iMaxRetransmissionQueueSize,
OpcUa_UInt32 &  iMaxNotificationsPerPublish 
) const
pure virtual

Get the setting parameters for a subscription.

Returns
Error code.
Parameters
[out]iMinPublishingIntervalMinimum publishing interval in milliseconds the server allows
[out]iMaxPublishingIntervalMaximum publishing interval in milliseconds the server allows
[out]iMinKeepAliveIntervalMinimum KeepAlive interval in milliseconds the server allows
[out]iMinSubscriptionLifetimeMinimum Subscription lifetime in milliseconds the server allows
[out]iMaxSubscriptionLifetimeMaximum Subscription lifetime in milliseconds the server allows
[out]iMaxRetransmissionQueueSizeMaximum number of messages in the republish queue the server allows per Subscription
[out]iMaxNotificationsPerPublishMaximum number of notifications per Publish the server allows

Implemented in ServerConfigData.

UaStatus ServerConfig::getTagFileConfiguration ( UaString defaultTagFileName,
UaString tagFileLocation,
UaString tagFileEnding,
UaString defaultFileUpdatePolicy 
)
virtual

Provides information about tagfile name, path und file ending used in the NodeManagerTagFile.

The default implementation returns empty strings.

Returns
Error code
Parameters
[out]defaultTagFileNameName of the tagfile to load on server startup.
[out]tagFileLocationThe folder where all tagfiles are stored.
[out]tagFileEndingThe file ending used for new tagfiles.
[out]defaultFileUpdatePolicyHow the Default file gets updated (Auto, Manual).

Reimplemented in ServerConfigData.

virtual UaStatus ServerConfig::getThreadPoolSettings ( OpcUa_UInt32 &  minSizeTransactionManager,
OpcUa_UInt32 &  maxSizeTransactionManager,
OpcUa_UInt32 &  minSizeSubscriptionManager,
OpcUa_UInt32 &  maxSizeSubscriptionManager 
) const
pure virtual

Returns the settings for the thread pools used in the OPC server.

Returns
Error code.
Parameters
[out]minSizeTransactionManagerReturns the number of threads that are created when the thread pool for the UaTransactionManager is created.
[out]maxSizeTransactionManagerReturns the maximum number of threads allowed for the thread pool in the UaTransactionManager.
[out]minSizeSubscriptionManagerReturns the number of threads that are created when the thread pool for the UaSubscriptionManager is created.
[out]maxSizeSubscriptionManagerReturns the maximum number of threads allowed for the thread pool in the UaSubscriptionManager.

Implemented in ServerConfigData.

UaStatus ServerConfig::getTraceEventSettings ( OpcUa_UInt32 &  uTraceEventLevel) const
virtual

Get UA Server SDK trace event settings.

This configuration option allows clients to get the SDK trace outputs for trace levels Errors, Warning and Info via HistoryRead for Events and/or Events from the server.

Possible values are:

Disabled
traces are only available via trace files
History (default)
traces are available via HistoryRead for Events
HistoryAndEvents
traces are available via History and live Events

Traces are only sent as events or stored for historical access if the trace is active, i.e. UaAppTraceEnabled is set to true, and UaAppTraceLevel (i.e. the server application trace level) is set at least to Errors.

Returns
Error code.
Parameters
[out]uTraceEventLevelConfigures the level of messages traced; possible values are
  • (0) Disabled
  • (1) History
  • (2) HistoryAndEvents

Reimplemented in ServerConfigData.

virtual UaStatus ServerConfig::getUserIdentityTokenConfig ( OpcUa_Boolean &  bEnableAnonymous,
OpcUa_Boolean &  bEnableUserPw,
OpcUa_Boolean &  bEnableCertificate,
OpcUa_Boolean &  bEnableKerberosTicket 
)
pure virtual

Get the enabled settings for the different user identity tokens supported by the server.

Activating other user identity tokens than anonymous requires a user management and the implementation of ServerConfig::logonSessionUser.

Returns
Error code.
Parameters
[out]bEnableAnonymousIndicates if Anonymous login is allowed.
[out]bEnableUserPwIndicates if login with user and password is activated.
[out]bEnableCertificateIndicates if login with user certificate is activated.
[out]bEnableKerberosTicketIndicates if login with Kerberos token is activated.

Implemented in ServerConfigData.

UaStatus ServerConfig::getUserIdentityTokenSecurityPolicy ( UaString sSecurityPolicyUri)
virtual

Get the security policy to use when encrypting or signing the UserIdentityToken when it is passed to the server.

Returns
Error code.
Parameters
[out]sSecurityPolicyUriThe SecurityPolicyUri to use when encrypting or signing the UserIdentityToken.

Reimplemented in ServerConfigData.

UaStatus ServerConfig::getWindowsDiscoveryRegistrationSecuritySetup ( OpcUa_Boolean &  bAutomaticCertificateExchange,
UaString sDiscoveryServerTrustListLocation,
UaString sDiscoveryServerStoreName,
UaString sDiscoveryServerCertificateName 
)
virtual

Get settings for exchanging certificates with local discovery server on a windows computer for registration with local windows discovery server.

Returns
OPC UA result code.
Parameters
[out]bAutomaticCertificateExchangeFlag indicating if the certificates should be exchanged
[out]sDiscoveryServerTrustListLocationPath of the local discovery server trust list. This is where the server copies it's certificate to.
[out]sDiscoveryServerStoreNameStore name used for the local discovery server in the windows certificate store
[out]sDiscoveryServerCertificateNameCertificate name of the local discovery server in the windows certificate store

Reimplemented in ServerConfigData.

OpcUa_Boolean ServerConfig::isAuditActivated ( )
virtual

Flag indicating if audit events are activated.

Returns
True if audit events are active and False if not.

Reimplemented in ServerConfigData.

virtual UaStatus ServerConfig::loadConfiguration ( )
pure virtual

Load the configuration from the config file.

This is the first method called after the creation of ServerConfig. This method must load all configuration options and must create all NodeManagers before the method startUp is called. The configuration can be loaded from a file, a data base or any other source to overwrite default settings defined in the constructor of the implementation class.

Returns
Error code.

Implemented in ServerConfigXml, and ServerConfigIni.

virtual UaStatus ServerConfig::logonSessionUser ( Session pSession,
UaUserIdentityToken pUserIdentityToken 
)
pure virtual

Validates the user identity token and sets the user for a session.

Returns
Error code
Parameters
[out]pSessionInterface pointer of the Session
[out]pUserIdentityTokenUser identity token contained in an ExtensionObject used to handle different types of user identity tokens like user/password or an X509 certificate. It provides the credentials of the user associated with the Client application. The implementation of this method must use these credentials to determine whether the Client should be allowed to activate a Session and what resources the Client has access to during this Session.If the method is not able to validate the user or if the user has no right to access the server, the method must return the status code OpcUa_BadUserAccessDenied.
UaStatus ServerConfig::removeConfiguredNamespace ( OpcUa_UInt16  namespaceIndex)
virtual

Removes a namespaces configuration entry for preconfigured namespaces.

See also
getConfiguredNamespaces. The default implementation is empty and is not storing the added entry.
Returns
Error code
Parameters
[in]namespaceIndexIndex for the namespace in the namespace table

Reimplemented in ServerConfigData, and ServerConfigXml.

virtual UaStatus ServerConfig::saveConfiguration ( )
pure virtual

Save the configuration to the config file.

Returns
Error code.

Implemented in ServerConfigXml, and ServerConfigIni.

UaStatus ServerConfig::setServerCertificateThumbprint ( const UaString thumbprint)
virtual
Parameters
[in]thumbprintThumbprint of the server certificate used for windows store.
UaStatus ServerConfig::setTagFileConfiguration ( const UaString defaultTagFileName,
const UaString tagFileLocation,
const UaString tagFileEnding,
const UaString defaultFileUpdatePolicy 
)
virtual

Set information about tagfile name, path und file ending used in the NodeManagerTagFile.

The default implementation does nothing.

Returns
Error code
Parameters
[in]defaultTagFileNameName of the tagfile to load on server startup.
[in]tagFileLocationThe folder where all tagfiles are stored.
[in]tagFileEndingThe file ending used for new tagfiles.
[in]defaultFileUpdatePolicyHow the Default file gets updated (Auto, Manual).

Reimplemented in ServerConfigData, and ServerConfigXml.

virtual UaStatus ServerConfig::shutDown ( )
pure virtual

Shut down OPC ServerConfig.

Returns
Error code
virtual UaStatus ServerConfig::startUp ( ServerManager pServerManager)
pure virtual

Start up OPC ServerConfig.

Returns
Error code
Parameters
[in]pServerManagerInterface to the central ServerManager object. This interface pointer should be stored in the NodeManager instance to have access to core module objects like the root NodeManager or the ServerConfig.

The documentation for this class was generated from the following files: