UA Bundle SDK .NET  2.2.0.255
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Groups Pages
UnifiedAutomation.UaBase.ModifySubscriptionRequest Class Reference

More...

Inherits UnifiedAutomation.UaBase.IServiceRequest, and UnifiedAutomation.UaBase.IEncodeable.

Public Member Functions

 ModifySubscriptionRequest ()
 The default constructor. More...
 
virtual void Encode (IEncoder encoder)
 
 
virtual void Decode (IDecoder decoder)
 
 
virtual bool IsEqual (IEncodeable encodeable)
 Checks if encodeable is the same object or has the same content More...
 
virtual object Clone ()
 
 

Properties

RequestHeader RequestHeader [get, set]
  More...
 
uint SubscriptionId [get, set]
 The Server-assigned identifier for the Subscription. More...
 
double RequestedPublishingInterval [get, set]
 This interval defines the cyclic rate that the Subscription is being requested to return Notifications to the Client. This interval is expressed in milliseconds. This interval is represented by the publishing timer in the Subscription state table (see 5.13.1.2). The negotiated value for this parameter returned in the response is used as the default sampling interval for MonitoredItems assigned to this Subscription. If the requested value is 0 or negative, the server shall revise with the fastest supported publishing interval. More...
 
uint RequestedLifetimeCount [get, set]
 Requested lifetime count. The lifetime count shall be a mimimum of three times the keep keep-alive count. When the publishing timer has expired this number of times without a Publish request being available to send a NotificationMessage, then the Subscription shall be deleted by the Server. More...
 
uint RequestedMaxKeepAliveCount [get, set]
 Requested maximum keep-alive count. When the publishing timer has expired this number of times without requiring any NotificationMessage to be sent, the Subscription sends a keep-alive Message to the Client. The negotiated value for this parameter is returned in the response. If the requested value is 0, the server shall revise with the smallest supported keep-alive count. More...
 
uint MaxNotificationsPerPublish [get, set]
 The maximum number of notifications that the Client wishes to receive in a single Publish response. A value of zero indicates that there is no limit. More...
 
byte Priority [get, set]
 Indicates the relative priority of the Subscription. When more than one Subscription needs to send Notifications, the Server should dequeue a Publish request to the Subscription with the highest priority number. For Subscriptions with equal priority the Server should dequeue Publish requests in a round-robin fashion. Any Subscription that needs to send a keep-alive Message shall take precedence regardless of its priority, in order to prevent the Subscription from expiring. A Client that does not require special priority settings should set this value to zero. More...
 
virtual ExpandedNodeId TypeId [get]
 
 
virtual ExpandedNodeId BinaryEncodingId [get]
 
 
virtual ExpandedNodeId XmlEncodingId [get]
 
 
- Properties inherited from UnifiedAutomation.UaBase.IServiceRequest
RequestHeader RequestHeader [get, set]
 The header for the request. More...
 
- Properties inherited from UnifiedAutomation.UaBase.IEncodeable
ExpandedNodeId TypeId [get]
 Returns the UA type identifier for the encodable type. More...
 
ExpandedNodeId BinaryEncodingId [get]
 Returns the UA type identifier for the default binary encoding for the type. More...
 
ExpandedNodeId XmlEncodingId [get]
 Returns the UA type identifier for the default XML encoding for the type. More...
 

Detailed Description

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.ModifySubscriptionRequest.ModifySubscriptionRequest ( )
inline

The default constructor.

Member Function Documentation

virtual bool UnifiedAutomation.UaBase.ModifySubscriptionRequest.IsEqual ( IEncodeable  encodeable)
inlinevirtual

Checks if encodeable is the same object or has the same content

Parameters
encodeable
Returns

Property Documentation

uint UnifiedAutomation.UaBase.ModifySubscriptionRequest.MaxNotificationsPerPublish
getset

The maximum number of notifications that the Client wishes to receive in a single Publish response. A value of zero indicates that there is no limit.

byte UnifiedAutomation.UaBase.ModifySubscriptionRequest.Priority
getset

Indicates the relative priority of the Subscription. When more than one Subscription needs to send Notifications, the Server should dequeue a Publish request to the Subscription with the highest priority number. For Subscriptions with equal priority the Server should dequeue Publish requests in a round-robin fashion. Any Subscription that needs to send a keep-alive Message shall take precedence regardless of its priority, in order to prevent the Subscription from expiring. A Client that does not require special priority settings should set this value to zero.

uint UnifiedAutomation.UaBase.ModifySubscriptionRequest.RequestedLifetimeCount
getset

Requested lifetime count. The lifetime count shall be a mimimum of three times the keep keep-alive count. When the publishing timer has expired this number of times without a Publish request being available to send a NotificationMessage, then the Subscription shall be deleted by the Server.

uint UnifiedAutomation.UaBase.ModifySubscriptionRequest.RequestedMaxKeepAliveCount
getset

Requested maximum keep-alive count. When the publishing timer has expired this number of times without requiring any NotificationMessage to be sent, the Subscription sends a keep-alive Message to the Client. The negotiated value for this parameter is returned in the response. If the requested value is 0, the server shall revise with the smallest supported keep-alive count.

double UnifiedAutomation.UaBase.ModifySubscriptionRequest.RequestedPublishingInterval
getset

This interval defines the cyclic rate that the Subscription is being requested to return Notifications to the Client. This interval is expressed in milliseconds. This interval is represented by the publishing timer in the Subscription state table (see 5.13.1.2). The negotiated value for this parameter returned in the response is used as the default sampling interval for MonitoredItems assigned to this Subscription. If the requested value is 0 or negative, the server shall revise with the fastest supported publishing interval.

RequestHeader UnifiedAutomation.UaBase.ModifySubscriptionRequest.RequestHeader
getset

uint UnifiedAutomation.UaBase.ModifySubscriptionRequest.SubscriptionId
getset

The Server-assigned identifier for the Subscription.


The documentation for this class was generated from the following file: