ANSI C UA Server SDK  1.5.1.313
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Modules Pages
UaClient_Configuration Struct Reference

Contains the configuration of the UaClient. More...

#include <uaclient.h>

Data Fields

OpcUa_UInt DefaultSecureChannelLifetime
 The lifetime of the SecureChannel in milliseconds before it gets renewed. More...
 
OpcUa_UInt DefaultConnectTimeout
 The timeout for the connect call in milliseconds. More...
 
OpcUa_UInt DefaultCallTimeout
 The timeout for service calls in milliseconds. More...
 
OpcUa_UInt DefaultSessionTimeout
 The timeout for the application session in milliseconds. More...
 
OpcUa_UInt DefaultPublishTimeout
 The timeout for publish calls in milliseconds. More...
 
OpcUa_Boolean DefaultWatchdogEnabled
 Enable watchdog reads. More...
 
OpcUa_UInt DefaultWatchdogTime
 The time between watchdog checks in milliseconds. More...
 
OpcUa_UInt DefaultWatchdogTimeout
 The timeout for watchdog calls in milliseconds. More...
 
OpcUa_Boolean DefaultAutomaticReconnect
 A flag indicating if the client SDK should try to reconnect in the case of a connection error. More...
 
OpcUa_UInt DefaultReconnectDelay
 The delay between reconnect attempts in milliseconds. More...
 
OpcUa_Double DefaultPublishingInterval
 The PublishingInterval defines the cyclic rate in milliseconds at which the subscription is being requested to return notifications to the client. More...
 
OpcUa_UInt DefaultLifetimeCount
 The subscription has a lifetime that is defined by multiples of the publishingInterval. More...
 
OpcUa_UInt DefaultMaxKeepAliveCount
 If the server has no notifications pending for the period of time defined by (MaxKeepAliveCount * PublishingInterval), the server will send a keep alive message to the client. More...
 
OpcUa_ApplicationDescription ApplicationDescription
 Information about the client that will be sent to the server. More...
 
OpcUa_String ClientCertificateLocation
 Path to the certificate file of the client. More...
 
OpcUa_String ClientPrivateKeyLocation
 Path to the private key file of the client. More...
 
OpcUa_CertificateStoreConfiguration PkiConfig
 The PKI configuration of the client. More...
 

Detailed Description

Contains the configuration of the UaClient.

Field Documentation

OpcUa_ApplicationDescription UaClient_Configuration::ApplicationDescription

Information about the client that will be sent to the server.

OpcUa_String UaClient_Configuration::ClientCertificateLocation

Path to the certificate file of the client.

OpcUa_String UaClient_Configuration::ClientPrivateKeyLocation

Path to the private key file of the client.

OpcUa_Boolean UaClient_Configuration::DefaultAutomaticReconnect

A flag indicating if the client SDK should try to reconnect in the case of a connection error.

The default value is OpcUa_True.

OpcUa_UInt UaClient_Configuration::DefaultCallTimeout

The timeout for service calls in milliseconds.

The default setting is 10 seconds.

OpcUa_UInt UaClient_Configuration::DefaultConnectTimeout

The timeout for the connect call in milliseconds.

The default value for the connect timeout is 5000 milliseconds.

OpcUa_UInt UaClient_Configuration::DefaultLifetimeCount

The subscription has a lifetime that is defined by multiples of the publishingInterval.

In other words if the client can't communicate with the server for a period of time shorter than (LifetimeCount * PublishingInterval), then the subscription is still available in the server. After that, the server will delete the subscription. With a publishingInterval of 1000 ms, the default is 20 minutes like the default lifetime of the session. Please make sure to adjust the lifetimeCount if you change the publishingInterval.

OpcUa_UInt UaClient_Configuration::DefaultMaxKeepAliveCount

If the server has no notifications pending for the period of time defined by (MaxKeepAliveCount * PublishingInterval), the server will send a keep alive message to the client.

Thus, client and server know that the other side is still alive even if no data has been exchanged for some time.

OpcUa_Double UaClient_Configuration::DefaultPublishingInterval

The PublishingInterval defines the cyclic rate in milliseconds at which the subscription is being requested to return notifications to the client.

OpcUa_UInt UaClient_Configuration::DefaultPublishTimeout

The timeout for publish calls in milliseconds.

The PublishTimeout is the timeout for Publish requests. It is often necessary to set a higher PublishTimeout because Clients need to make sure that Publish requests are used before they time out. As a rule of thumb the PublishTimeout should be twice as long as the longest MaxKeepAliveCount.

OpcUa_UInt UaClient_Configuration::DefaultReconnectDelay

The delay between reconnect attempts in milliseconds.

The default value for the reconnect delay is 5000 milliseconds.

OpcUa_UInt UaClient_Configuration::DefaultSecureChannelLifetime

The lifetime of the SecureChannel in milliseconds before it gets renewed.

This is the time the key pair exchanged during secure channel establishment are valid. The stack starts the renew process that exchanges new key pairs after 75% of the lifetime. The default lifetime is one hour.

OpcUa_UInt UaClient_Configuration::DefaultSessionTimeout

The timeout for the application session in milliseconds.

The client library ensures that the session does not time out as long as the client application does not call disconnect. The session can time out if the network connection is broken for longer than the defined session timeout. A long timeout ensures that the established application session can be reused after the longer network interruption. Default value is 20 minutes. This timeout has no effect for the individual timeout for a service call (which is set with DefaultCallTimeout). This timeout is only used to ensure that the server is able to release resources if a client is disconnected for a long time.

OpcUa_Boolean UaClient_Configuration::DefaultWatchdogEnabled

Enable watchdog reads.

OpcUa_UInt UaClient_Configuration::DefaultWatchdogTime

The time between watchdog checks in milliseconds.

The default value for the watchdog time is 5000 milliseconds. The minimum value accepted by the SDK is 1000 milliseconds.

OpcUa_UInt UaClient_Configuration::DefaultWatchdogTimeout

The timeout for watchdog calls in milliseconds.

After one unsuccessful call, the timeout will be two times this value for the next call.

The default value for the watchdog time is 5000 milliseconds.

OpcUa_CertificateStoreConfiguration UaClient_Configuration::PkiConfig

The PKI configuration of the client.


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