PublishingInterval Property (UASubscriptionParameters)

The publishing interval (in milliseconds). Defines the cyclic rate that the Subscription is requested to return Notifications to the Client. Zero value has a special meaning.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<UnitAttribute("ms")>
<ValueLimitsAttribute(0, 2147483647)>
Public Property PublishingInterval As Integer

'Usage
 
Dim instance As UASubscriptionParameters
Dim value As Integer
 
instance.PublishingInterval = value
 
value = instance.PublishingInterval

[Unit("ms")]
[ValueLimits(0, 2147483647)]
public int PublishingInterval {get; set;}

[Unit("ms")]
[ValueLimits(0, 2147483647)]
public:
property int PublishingInterval {
   int get();
   void set (    int value);
}

Property Value

Unit of measurement is ms.

The default value of this property is 1000.

Returns the publishing interval (in milliseconds).

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	The value of an argument is outside the allowable range of values as defined by the invoked method. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Exception

Description

System.ArgumentOutOfRangeException

The value of an argument is outside the allowable range of values as defined by the invoked method.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

If you do not specify the publishing interval (leave it at zero), the component will calculate it by dividing the sampling interval (for the monitored item) by the automatic publishing factor (see OpcLabs.EasyOpc.UA.Engine.EasyUAClientEngineParameters.AutomaticPublishingFactor). The resulting value is limited by OpcLabs.EasyOpc.UA.Engine.EasyUAClientEngineParameters.FastestAutomaticPublishingInterval. This means that by default, the publishing interval equals to one half of the sampling interval.

In order to obtain or modify this parameter, access the OpcLabs.EasyOpc.UA.OperationModel.UAMonitoredItemArguments.SubscriptionParameters.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

UASubscriptionParameters Class
UASubscriptionParameters Members

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.