RetrialDelay Property (UAClientSessionParameters)

A delay before the component will try to reconnect the session, if it failed to connect it previously, or a serious failure occurred related to the session (in milliseconds).

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<UnitAttribute("ms")>
<ValueRangeAttribute(1, 2147483647)>
Public Property RetrialDelay As Integer

'Usage
 
Dim instance As UAClientSessionParameters
Dim value As Integer
 
instance.RetrialDelay = value
 
value = instance.RetrialDelay

[Unit("ms")]
[ValueRange(1, 2147483647)]
public int RetrialDelay {get; set;}

[Unit("ms")]
[ValueRange(1, 2147483647)]
public:
property int RetrialDelay {
   int get();
   void set (    int value);
}

Property Value

Valid values of this property are in the range from 1 to 2147483647 (Int32.MaxValue).

Unit of measurement is ms.

The default value of this property is 10000.

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

The reconnection will be done by the component automatically, as long as there are any open subscriptions, or an explicit UA operation is requested. The static EasyUAClient.RetryAll method can be used to force a retrial on all objects that are in a failure state.

In order to obtain or modify this parameter, in the default state (when OpcLabs.EasyOpc.UA.EasyUAClientCore.Isolated equals to false), access UAClientAdaptableParameters.SessionParameters property of static OpcLabs.EasyOpc.UA.EasyUAClientCore.AdaptableParameters. If you have set OpcLabs.EasyOpc.UA.EasyUAClientCore.Isolated to true, you need to access UAClientAdaptableParameters.SessionParameters property of OpcLabs.EasyOpc.UA.EasyUAClientCore.IsolatedParameters.

The getter method of this property is pure, i.e. it does not have observable side effects.

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

UAClientSessionParameters Class
UAClientSessionParameters 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.