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

Macros

#define UACLIENT_SECURECHANNELLIFETIME   3600000
 The lifetime of the SecureChannel in milliseconds before it gets renewed. More...
 
#define UACLIENT_CONNECTTIMEOUT   2500
 The timeout for the connect call in milliseconds. More...
 
#define UACLIENT_CALLTIMEOUT   10000
 The timeout for service calls in milliseconds. More...
 
#define UACLIENT_SESSIONTIMEOUT   1200000
 The timeout for the application session in milliseconds. More...
 
#define UACLIENT_PUBLISHTIMEOUT   60000
 The timeout for publish calls in milliseconds. More...
 
#define UACLIENT_WATCHDOGENABLED   OpcUa_True
 Enable watchdog reads. More...
 
#define UACLIENT_WATCHDOGTIME   5000
 The time between watchdog checks in milliseconds. More...
 
#define UACLIENT_WATCHDOGTIMEOUT   5000
 The timeout for watchdog calls in milliseconds. More...
 
#define UACLIENT_AUTOMATICRECONNECT   OpcUa_True
 A flag indicating if the client SDK should try to reconnect in the case of a connection error. More...
 
#define UACLIENT_RECONNECTDELAY   5000
 The delay between reconnect attempts in milliseconds. More...
 
#define UACLIENT_PUBLISHINGINTERVAL   1000
 The PublishingInterval defines the cyclic rate in milliseconds at which the subscription is being requested to return notifications to the client. More...
 
#define UACLIENT_LIFETIMECOUNT   1200
 The subscription has a lifetime that is defined by multiples of the publishingInterval. More...
 
#define UACLIENT_MAXKEEPALIVECOUNT   5
 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...
 

Detailed Description

Macro Definition Documentation

#define UACLIENT_AUTOMATICRECONNECT   OpcUa_True

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

The default value is OpcUa_True.

#define UACLIENT_CALLTIMEOUT   10000

The timeout for service calls in milliseconds.

The default setting is 10 seconds.

#define UACLIENT_CONNECTTIMEOUT   2500

The timeout for the connect call in milliseconds.

The default value for the connect timeout is 5000 milliseconds.

#define UACLIENT_LIFETIMECOUNT   1200

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.

#define UACLIENT_MAXKEEPALIVECOUNT   5

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.

#define UACLIENT_PUBLISHINGINTERVAL   1000

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

#define UACLIENT_PUBLISHTIMEOUT   60000

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.

#define UACLIENT_RECONNECTDELAY   5000

The delay between reconnect attempts in milliseconds.

The default value for the reconnect delay is 5000 milliseconds.

#define UACLIENT_SECURECHANNELLIFETIME   3600000

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.

#define UACLIENT_SESSIONTIMEOUT   1200000

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 UACLIENT_CALLTIMEOUT). This timeout is only used to ensure that the server is able to release resources if a client is disconnected for a long time.

#define UACLIENT_WATCHDOGENABLED   OpcUa_True

Enable watchdog reads.

#define UACLIENT_WATCHDOGTIME   5000

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.

#define UACLIENT_WATCHDOGTIMEOUT   5000

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.