Server Configuration Interface definition. More...

#include <serverconfig.h>

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, UaEndpointArray &uaEndpointArray)=0
	Get Endpoint Configuration. More...

virtual UaStatus	getUserIdentityTokenConfig (OpcUa_Boolean &bEnableAnonymous, OpcUa_Boolean &bEnableUserPw)=0
	Get the enabled settings for the different user identity tokens supported by the server. 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 &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 =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) const =0
	Get UA Server SDK trace 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 &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	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 &iMaxRetransmitionQueueSize, 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 &iMaxMonitoredItemCount, OpcUa_UInt32 &iMaxMonitoredItemPerSubscriptionCount) 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 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 Session *	createSession (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	getAdditionalServerEntries (UaApplicationDescriptions &serverDescriptions)
	Provides capability to configure additional servers to be returned in FindServers. More...

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

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]	sessionID	Session Id created by the server application.
[out]	authenticationToken	Secret session Id created by the server application.

Implemented in ServerConfigBasicXml, and ServerConfigBasicIni.

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] serverDescriptions List 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] availableSamplingRates Array of sampling rates provided by the OPC server.

[out]	ProductUri	Returns the URI that identifies the software containing the OPC server.
[out]	ManufacturerName	Returns the name of the software manufacturer.
[out]	ProductName	Returns the name of the software containing the OPC server.
[out]	sSoftwareVersion	Returns the software version.
[out]	sBuildNumber	Returns the build number.
[out]	BuildDate	Returns the date and time of the build.

[out]	nRegistrationInterval	Interval in milliseconds used to register with the discovery servers.
[out]	discoveryUrlArray	UaString array of discovery server URLs to register with.

[out]	sRejectedCertificateDirectory	The directory to store rejected client certificates.
[out]	uaEndpointArray	UaEndpoint array of configured endpoints for the server.

[out]	iMaxDataQueueSize	Maximum queue size for a data monitored item
[out]	iMaxEventQueueSize	Maximum queue size for an event monitored item

[out]	redundancySupport	Redundancy 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]	serverUriArray	List of server URIs for the servers in the NonTransparent redundant set

[out]	iMaxAlloc	The largest size for a memory block the serializer can do when deserializing a message
[out]	iMaxStringLength	The largest string accepted by the serializer
[out]	iMaxByteStringLength	The largest byte string accepted by the serializer
[out]	iMaxArrayLength	Maximum number of elements in an array accepted by the serializer
[out]	iMaxMessageSize	The maximum number of bytes per message in total

[out]	ServerUri	Returns the URI that identifies the software instance containing the OPC server.
[out]	ServerName	Returns the name of the software instance containing the OPC server.

[out]	minSupportedSampleRate	Minimum supported sample rate by the server provided as capability information to the client
[out]	localeIdArray	Array of LocaleIds that are known to be supported by the server.
[out]	serverProfileArray	Array of conformance profile URIs indicating the features supported by the server.
[out]	softwareCertificateArray	Array of software certificates containing all certificates supported by the server.

[out]	bTraceEnabled	Globally enable/disable trace output from the SDK
[out]	uTraceLevel	Configure the level of messages traced
[out]	uMaxTraceEntries	Maximum number of trace entries in one trace file
[out]	uMaxBackupFiles	Maximum number of backup files
[out]	sTraceFile	Name and path of the trace file

[out]	iMaxSessionCount	Maximum number of sessions the server allows to create
[out]	iMinSessionTimeout	Minimum timeout in ms for a sessions the server allows to set
[out]	iMaxSessionTimeout	Maximum timeout in ms for a sessions the server allows to set

[out]	bEnabled	Controls wether the secure listener uses a thread pool to dispatch received requests
[out]	iMinThreads	The minimum number of threads in the thread pool
[out]	iMaxThreads	The maximum number of threads in the thread pool
[out]	iMaxJobs	The length of the queue with jobs waiting for a free thread
[out]	bBlockOnAdd	If MaxJobs is reached the add operation can block or return an error
[out]	nTimeout	If the add operation blocks on a full job queue, this value sets the max waiting time

[out]	iMaxSubscriptionCount	Maximum number of subscriptions the server allows to create. Default value 0 is unlimited
[out]	iMaxMonitoredItemCount	Maximum number of monitored items the server allows to create. Default value 0 is unlimited
[out]	iMaxMonitoredItemPerSubscriptionCount	Maximum number of monitored items per subscriptions the server allows to create. Default value 0 is unlimited

[out]	iMinPublishingInterval	Minimum publishing interval in milliseconds the server allows
[out]	iMaxPublishingInterval	Maximum publishing interval in milliseconds the server allows
[out]	iMinKeepAliveInterval	Minimum KeepAlive interval in milliseconds the server allows
[out]	iMinSubscriptionLifetime	Minimum Subscription lifetime in milliseconds the server allows
[out]	iMaxSubscriptionLifetime	Maximum Subscription lifetime in milliseconds the server allows
[out]	iMaxRetransmitionQueueSize	Maximum number of messages in the republish queue the server allows per Subscription
[out]	iMaxNotificationsPerPublish	Maximum number of notifications per Publish the server allows

[out]	minSizeTransactionManager	Returns the number of threads that are created when the thread pool for the UaTransactionManager is created.
[out]	maxSizeTransactionManager	Returns the maximum number of threads allowed for the thread pool in the UaTransactionManager.
[out]	minSizeSubscriptionManager	Returns the number of threads that are created when the thread pool for the UaSubscriptionManager is created.
[out]	maxSizeSubscriptionManager	Returns the maximum number of threads allowed for the thread pool in the UaSubscriptionManager.

[out]	bEnableAnonymous	Indicates if Anonymous login is allowed.
[out]	bEnableUserPw	Indicates if login with user and password is activated.

[out]	bAutomaticCertificateExchange	Flag indicating if the certificates should be exchanged
[out]	sDiscoveryServerCertificateFile	File name and path of the discovery server certificate to be stored in the sever trust list. This parameter is ignored if the store of the first endpoint is the Windows certificate store.
[out]	sDiscoveryServerStoreName	Store name used for the local discovery server in the windows certificate store
[out]	sDiscoveryServerCertificateName	Certificate name of the local discovery server in the windows certificate store

[out]	pSession	Interface pointer of the Session
[out]	pUserIdentityToken	User 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.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation