NotificationQueueIdleTimeToSleep Property (NotifyingWidget)

The idle time before the internal thread executing the queued notifications is stopped (in milliseconds).

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Property NotificationQueueIdleTimeToSleep As Integer

'Usage
 
Dim instance As NotifyingWidget
Dim value As Integer
 
instance.NotificationQueueIdleTimeToSleep = value
 
value = instance.NotificationQueueIdleTimeToSleep

public int NotificationQueueIdleTimeToSleep {get; set;}

public:
property int NotificationQueueIdleTimeToSleep {
   int get();
   void set (    int value);
}

Property Value

The idle time in milliseconds. A value of -1 indicates that the thread should never be stopped based on idle time.

The default value of this property is 600000.

Exceptions

Exception Description

Exception	Description
System.ArgumentException	One of the arguments provided to a method is not valid. 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.
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. 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.

System.ArgumentException

One of the arguments provided to a method is not valid.

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.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

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 thread is automatically started when a new notification arrives.

This property allows fine-tuning of the internal notification processing mechanism. Setting a lower value can help conserve system resources by allowing the internal processing thread to stop during periods of inactivity. However, setting this value too low might result in frequent stopping and starting of the thread, which could negatively impact performance. A value of -1 can be used to keep the thread running indefinitely, which might be desirable in scenarios where quick reaction time is important.

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

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