UA Server SDK C++ Bundle  1.3.3.206
 All Data Structures Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
ServerConfigBasicIni Class Reference

Basic server configuration class using the INI file format for internal use in the class OpcServer. More...

Inherits ServerConfigSettings.

Public Member Functions

 ServerConfigBasicIni (const UaString &sIniFileName, const UaString &sApplicationPath, OpcServerCallback *pOpcServerCallback)
 construction More...
 
UaStatus startUp (ServerManager *)
 Start up OPC ServerConfig. More...
 
UaStatus shutDown ()
 Shut down OPC ServerConfig. More...
 
SessioncreateSession (OpcUa_Int32 sessionID, const UaNodeId &authenticationToken)
 Creates a session object for the OPC server. More...
 
UaStatus logonSessionUser (Session *pSession, UaUserIdentityToken *pUserIdentityToken)
 Validates the user identity token and sets the user for a session. More...
 
- Public Member Functions inherited from ServerConfigSettings
 ServerConfigSettings (const UaString &sIniFilePath, const UaString &sApplicationPath)
 construction More...
 
virtual ~ServerConfigSettings ()
 destruction
 
UaStatus loadConfiguration ()
 Load the configuration from the config file and generate node managers. More...
 
UaStatus saveConfiguration ()
 Save the configuration to the config file. More...
 
- Public Member Functions inherited from ServerConfigData
 ServerConfigData (const UaString &sApplicationPath)
 construction More...
 
virtual ~ServerConfigData ()
 destruction
 
void clear ()
 Clears all members and intializes them with default values.
 
virtual UaStatus getEndpointConfiguration (UaString &sRejectedCertificateDirectory, UaEndpointArray &uaEndpointArray)
 Get Endpoint Configuration. More...
 
virtual UaStatus getUserIdentityTokenConfig (OpcUa_Boolean &bEnableAnonymous, OpcUa_Boolean &bEnableUserPw)
 Get the enabled settings for the different user identity tokens supported by the server. More...
 
virtual UaStatus getDiscoveryRegistrationConfig (OpcUa_UInt32 &nRegistrationInterval, UaStringArray &discoveryUrlArray)
 Get settings for registration with discovery service. More...
 
virtual UaStatus getWindowsDiscoveryRegistrationSecuritySetup (OpcUa_Boolean &bAutomaticCertificateExchange, UaString &sDiscoveryServerCertificateFile, 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
 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
 Returns the settings for the thread pool used in the OPC UA Stack. More...
 
virtual UaStatus getStackTraceSettings (OpcUa_Boolean &bTraceEnabled, OpcUa_UInt32 &uTraceLevel) const
 Get UA Stack trace settings. More...
 
virtual UaStatus getServerTraceSettings (OpcUa_Boolean &bTraceEnabled, OpcUa_UInt32 &uTraceLevel, OpcUa_UInt32 &uMaxTraceEntries, OpcUa_UInt32 &uMaxBackupFiles, UaString &sTraceFile) const
 Get UA Server SDK trace settings. More...
 
virtual OpcUa_Int32 getMaxRequestAge () const
 Returns the maximum age of a request the server allows. More...
 
virtual UaStatus getSessionSettings (OpcUa_Int32 &iMaxSessionCount, OpcUa_Int32 &iMinSessionTimeout, OpcUa_Int32 &iMaxSessionTimeout) const
 Get the setting parameters for session creation. More...
 
virtual UaStatus getServerSettings (OpcUa_Double &minSupportedSampleRate, UaStringArray &localeIdArray, UaStringArray &serverProfileArray, UaByteStringArray &softwareCertificateArray) const
 Get the general setting parameters for the server. More...
 
virtual OpcUa_Int32 getMaxBrowseContinuationPoints () const
 Returns the maximum number of Browse Continuation Points managed by the server. More...
 
virtual OpcUa_Int32 getMaxHistoryContinuationPoints () const
 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 &iMaxRetransmitionQueueSize, OpcUa_UInt32 &iMaxNotificationsPerPublish) const
 Get the setting parameters for a subscription. More...
 
virtual UaStatus getMonitoredItemSettings (OpcUa_UInt32 &iMaxDataQueueSize, OpcUa_UInt32 &iMaxEventQueueSize) const
 Get the setting parameters for a MonitoreItem. More...
 
virtual UaStatus getSubscriptionMaxCountSettings (OpcUa_UInt32 &iMaxSubscriptionCount, OpcUa_UInt32 &iMaxMonitoredItemCount, OpcUa_UInt32 &iMaxMonitoredItemPerSubscriptionCount) const
 Get the max object count parameters for Subscriptions. More...
 
virtual UaStatus getAvailableSamplingRates (UaUInt32Array &availableSamplingRates) const
 Returns the sampling rates provided by the OPC server. More...
 
virtual OpcUa_StatusCode getBuildInfo (UaString &ApplicationUri, UaString &ManufacturerName, UaString &ApplicationName, UaString &sSoftwareVersion, UaString &sBuildNumber, OpcUa_DateTime &BuildDate) const
 Returns the BuildInfo for the server. More...
 
virtual OpcUa_StatusCode getServerInstanceInfo (UaString &ServerUri, UaLocalizedTextArray &ServerName) const
 Returns the server instance information for the OPC server. More...
 
virtual UaStatus getThreadPoolSettings (OpcUa_UInt32 &minSizeTransactionManager, OpcUa_UInt32 &maxSizeTransactionManager, OpcUa_UInt32 &minSizeSubscriptionManager, OpcUa_UInt32 &maxSizeSubscriptionManager) const
 Returns the settings for the thread pools used in the OPC server. 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 getAdditionalServerEntries (UaApplicationDescriptions &serverDescriptions)
 Provides capability to configure additional servers to be returned in FindServers. More...
 
- Public Member Functions inherited from ServerConfig
 ServerConfig ()
 construction. More...
 
virtual ~ServerConfig ()
 destruction
 

Additional Inherited Members

- Static Public Member Functions inherited from ServerConfigData
static void replaceNodeName (UaString &sString, const UaString &sNodeName)
 Replace placeholder [NodeName] with real node name. More...
 
static void replaceServerName (UaString &sString, const UaString &sServerName)
 Replace placeholder [ServerName] with real server name. More...
 
static void replaceApplicationPath (UaString &sString, const UaString &sApplicationPath)
 Replace placeholder [ApplicationPath] with real application path. More...
 
- Protected Member Functions inherited from ServerConfigData
OpcUa_DateTime getBuildDate () const
 Get the build date from the static compiled in string. More...
 
- Protected Attributes inherited from ServerConfigData
OpcUa_Int32 m_maxRequestAge
 Maximum age of a request the server allows.
 
OpcUa_Int32 m_maxSessionCount
 Maximum number of sessions the server allows to create.
 
OpcUa_Int32 m_minSessionTimeout
 Minimum timeout in ms for a sessions the server allows to set.
 
OpcUa_Int32 m_maxSessionTimeout
 Maximum timeout in ms for a sessions the server allows to set.
 
OpcUa_Int32 m_maxBrowseContinuationPoints
 Maximum number of Browse Continuation Points managed by the server.
 
OpcUa_Int32 m_maxHistoryContinuationPoints
 Maximum number of History Continuation Points managed by the server.
 
OpcUa_UInt32 m_minPublishingInterval
 Minimum publishing interval in milliseconds the server allows.
 
OpcUa_UInt32 m_maxPublishingInterval
 Maximum publishing interval in milliseconds the server allows.
 
OpcUa_UInt32 m_minKeepAliveInterval
 Minimum KeepAlive interval in milliseconds the server allows.
 
OpcUa_UInt32 m_minSubscriptionLifetime
 Minimum Subscription lifetime in milliseconds the server allows.
 
OpcUa_UInt32 m_maxSubscriptionLifetime
 Maximum Subscription lifetime in milliseconds the server allows.
 
OpcUa_UInt32 m_maxRetransmitionQueueSize
 Maximum number of messages in the republish queue the server allows per Subscription.
 
OpcUa_UInt32 m_maxNotificationsPerPublish
 Maximum number of notifications per Publish the server allows.
 
UaUInt32Array m_availableSamplingRates
 Array of sampling rates provided by the OPC server.
 
UaString m_sApplicationUri
 BuildInfo structure.
 
UaString m_sServerUri
 Server Description.
 
OpcUa_Boolean m_bStackThreadPoolEnabled
 UA Stack Thread pool settings.
 
OpcUa_UInt32 m_minSizeTransactionManager
 SDK Thread pool settings.
 
UaString m_sRejectedCertificateDirectory
 Directory to store rejected certificates in.
 
UaEndpointArray m_uaEndpointArray
 Array of UA endpoint descriptions.
 
OpcUa_UInt32 m_nRegistrationInterval
 Discovery server registration settings. More...
 
OpcUa_Int32 m_iMaxAlloc
 These are the Security constraints for the serializer. More...
 
OpcUa_Boolean m_bTraceEnabled
 UA Stack trace settings. More...
 
OpcUa_Boolean m_bSdkTraceEnabled
 UA Server SDK trace settings. More...
 

Detailed Description

Basic server configuration class using the INI file format for internal use in the class OpcServer.

Constructor & Destructor Documentation

ServerConfigBasicIni::ServerConfigBasicIni ( const UaString sIniFileName,
const UaString sApplicationPath,
OpcServerCallback pOpcServerCallback 
)

construction

Parameters
sIniFileNamePath and file name of the INI configuration file.
sApplicationPathThe path of the configuration file and PKI store used to replace path placeholders in the configuration file
pOpcServerCallbackInterface pointer of the callback interface.

Member Function Documentation

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

Creates a session object for the OPC server.

Parameters
sessionIDSession Id created by the server application.
authenticationTokenSecret session Id created by the server application.
Returns
A pointer to the created session.

Implements ServerConfig.

UaStatus ServerConfigBasicIni::logonSessionUser ( Session pSession,
UaUserIdentityToken pUserIdentityToken 
)
virtual

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

Parameters
pSessionInterface to the Session context for the method call
pUserIdentityTokenSecret session Id created by the server application.
Returns
Error code.

Implements ServerConfig.

UaStatus ServerConfigBasicIni::shutDown ( )
inlinevirtual

Shut down OPC ServerConfig.

Returns
Error code

Implements ServerConfig.

UaStatus ServerConfigBasicIni::startUp ( ServerManager pServerManager)
inlinevirtual

Start up OPC ServerConfig.

Returns
Error code

Implements ServerConfig.


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