C++ Based OPC UA Client/Server SDK  1.5.5.355
UaClientSdk::SubscriptionSettings Class Reference

The SubscriptionSettings class contains the settings for a Subscription. More...

#include <uaclientsdk.h>

Public Member Functions

 SubscriptionSettings ()
 Constructor.
 
 ~SubscriptionSettings ()
 Destructor.
 

Public Attributes

OpcUa_Double publishingInterval
 The publishingInterval defines the cyclic rate in milliseconds at which the subscription is being requested to return notifications to the client. More...
 
OpcUa_UInt32 lifetimeCount
 The subscription has a lifetime that is defined by multiples of the publishingInterval. More...
 
OpcUa_UInt32 maxKeepAliveCount
 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_UInt32 maxNotificationsPerPublish
 The maximum number of notifications that the client wishes to receive in a single publish response. More...
 
OpcUa_Byte priority
 Defines the relative priority of this subscription within the session. More...
 

Detailed Description

The SubscriptionSettings class contains the settings for a Subscription.

Member Data Documentation

OpcUa_UInt32 UaClientSdk::SubscriptionSettings::lifetimeCount

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 you are adjusting the lifetimeCount if you change the publishingInterval.

OpcUa_UInt32 UaClientSdk::SubscriptionSettings::maxKeepAliveCount

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.

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

OpcUa_UInt32 UaClientSdk::SubscriptionSettings::maxNotificationsPerPublish

The maximum number of notifications that the client wishes to receive in a single publish response.

This is one way for the client to limit the memory consumption if that resources is very rare.

OpcUa_Byte UaClientSdk::SubscriptionSettings::priority

Defines the relative priority of this subscription within the session.

If multiple subscriptions need to send notifications to the client, the server will send notifications to the subscription with the highest priority first.

OpcUa_Double UaClientSdk::SubscriptionSettings::publishingInterval

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


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