ServerShutdownRetrialDelay Property (_UAEnhancedClientSessionParameters)

Retrial delay after server shutdown (in milliseconds).

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Property ServerShutdownRetrialDelay As Integer

'Usage
 
Dim instance As _UAEnhancedClientSessionParameters
Dim value As Integer
 
instance.ServerShutdownRetrialDelay = value
 
value = instance.ServerShutdownRetrialDelay

int ServerShutdownRetrialDelay {get; set;}

property int ServerShutdownRetrialDelay {
   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

A delay before the component will try to reconnect the session, if it has disconnected because the server has changed its state to OpcLabs.EasyOpc.UA.UAServerState.Shutdown. When the server shuts down in this manner, the retrial delay configured by this parameter takes precedence over the usual RetrialDelay used with other types of disconnections.

The recognition of server shutdown only works when the server status monitoring subscription is enabled (the default), that is, when the EnableStatusSubscription equals to true. Whether this parameter will actually have effect also depends on the proper support of this feature in the target OPC UA server.

In order to obtain or modify this parameter, in the default state (when OpcLabs.EasyOpc.UA.EasyUAClientCore.Isolated equals to false), access OpcLabs.EasyOpc.UA.Engine.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 OpcLabs.EasyOpc.UA.Engine.UAClientAdaptableParameters.SessionParameters property of OpcLabs.EasyOpc.UA.EasyUAClientCore.IsolatedParameters.

This member or type is for use from COM. It is not meant to be used from .NET or Python. Refer to the corresponding .NET member or type instead, if you are developing in .NET or Python.

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

_UAEnhancedClientSessionParameters Interface
_UAEnhancedClientSessionParameters 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.