CloseTimeout Property (UAClientSessionParameters)

A timeout for closing the session (in milliseconds).

Syntax

Visual Basic
C#
C++/CLI

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

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

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

[Unit("ms")]
[ValueRange(1, 2147483647)]
public:
property int CloseTimeout {
   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

This parameter is not interpreted by the component; it is simply passed down to the OPC UA Stack for processing.

If the session cannot be closed in a timely manner, it is considered closed anyway, and the component will not use the same session again. The timeout prevents the component from waiting too long or indefinitely for the confirmation. This means that any new requests to the same endpoint will open a new session, as with the properly closed sessions.

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
OperationTimeout Property

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.