GarbageCollectionPeriod Property (UASmartClientEngineParameters)

How often the component cleans up unused objects such as sessions and subscriptions. In milliseconds.

Syntax

Visual Basic
C#
C++/CLI

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

'Usage
 
Dim instance As UASmartClientEngineParameters
Dim value As Integer
 
instance.GarbageCollectionPeriod = value
 
value = instance.GarbageCollectionPeriod

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

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

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

In order to obtain or modify this parameter, access the EasyUAClientSharedParameters.EngineParameters property of static OpcLabs.EasyOpc.UA.EasyUAClientCore.SharedParameters.

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

UASmartClientEngineParameters Class
UASmartClientEngineParameters Members
HoldPeriod 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.