NotificationRate Property (AESubscriptionParameters)

Notification rate of the event subscription.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<DataMemberAttribute()>
<ValueRangeAttribute(-1, 2147483647)>
Public Property NotificationRate As Integer

'Usage
 
Dim instance As AESubscriptionParameters
Dim value As Integer
 
instance.NotificationRate = value
 
value = instance.NotificationRate

[DataMember()]
[ValueRange(-1, 2147483647)]
public int NotificationRate {get; set;}

[DataMember()]
[ValueRange(-1, 2147483647)]
public:
property int NotificationRate {
   int get();
   void set (    int value);
}

Property Value

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

The default value of this property is -1.

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 notification rate is in milliseconds and tells the server how often to send event notifications. This is a minimum time - do not send event notifications any faster that this UNLESS the buffer size is reached. A value of 0 for notification rate means that the server should send event notifications as soon as it gets them. This property is used to improve communications efficiency between client and server. The notification rate is a recommendation from the client, and the server is allowed to ignore the parameter.

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

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