EasyUA Reference
Subscription Class Members
See Also  Properties  Methods  Events Send Feedback
EasyUA Assembly > Advosol.EasyUA Namespace : Subscription Class

Glossary Item Box

The following tables list the members exposed by Subscription.

Public Properties

 NameDescription
Public PropertyAvailableSequenceNumbers The sequence numbers that are available for republish requests.  
Public PropertyChangesPending Returns true if the subscription has changes that need to be applied.  
Public PropertyCreated Whether the subscription has been created on the server.  
Public PropertyCurrentKeepAliveCount The current keep alive count.  
Public PropertyCurrentLifetimeCount The current lifetime count.  
Public PropertyCurrentPriority The priority assigned to subscription when it was created.  
Public PropertyCurrentPublishingEnabled Whether publishing is currently enabled.  
Public PropertyCurrentPublishingInterval The current publishing interval.  
Public PropertyDisableMonitoredItemCache Gets or sets a value indicating whether the notifications are cached within the monitored items.  
Public PropertyDisplayName A display name for the subscription.  
Public PropertyHandle A local handle assigned to the subscription  
Public PropertyId The unique identifier assigned by the server.  
Public PropertyKeepAliveCount 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.  
Public PropertyLastNotification The last notification received from the server.  
Public PropertyLastNotificationTime The when that the last notification was received.  
Public PropertyLifetimeCount Requested lifetime count. The lifetime count shall be a minimum 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.  
Public PropertyMaxMessageCount The maximum number of messages to keep in the internal cache.  
Public PropertyMaxNotificationsPerPublish 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. The number of notifications per Publish is the sum of monitoredItems in the DataChangeNotification and events in the EventNotificationList.  
Public PropertyMinLifetimeInterval The minimum lifetime for subscriptions in milliseconds.  
Public PropertyMonitoredItemCount Returns the number of monitored items.  
Public PropertyMonitoredItems The items to monitor.  
Public PropertyNotificationCount The number of notifications contained in the last notification message.  
Public PropertyNotifications The cached notifications.  
Public PropertyOutstandingMessageWorkers Get the number of outstanding message workers  
Public PropertyPriority Indicates the relative priority of the Subscription. When more than one Subscription needs to send Notifications, the Server should de-queue a Publish request to the Subscription with the highest priority number. For Subscriptions with equal priority the Server should de-queue Publish requests in a round-robin fashion. A Client that does not require special priority settings should set this value to zero.  
Public PropertyPublishingEnabled Whether publishing is enabled.  
Public PropertyPublishingInterval 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. 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.  
Public PropertyPublishingStopped Returns true if the subscription is not receiving publishes.  
Public PropertyPublishTime The when that the last notification received was published.  
Public PropertySequenceNumber The sequence number assigned to the last notification message.  
Public PropertySession The session that owns the subscription item.  
Public PropertyTimestampsToReturn The timestamps to return with the notification messages.  
Top

Public Methods

 NameDescription
Public MethodAddItemOverloaded.  Adds an item to the subscription. The method ApplyChanges() must be called to make the changes in the server.  
Public MethodAddItems Adds a set of items to the subscription. The method ApplyChanges() must be called to make the changes in the server.  
Public MethodApplyChangesApplies any changes to the subscription items.
Must be called to transmit the pendent changes to the server.  
Public MethodBeginApplyChanges Applies any changes to the subscription items.  
Public MethodBeginCreate Asynchronically creates a subscription in the server.  
Public MethodBeginDelete Asynchronously deletes a subscription on the server.  
Public MethodConditionRefresh Tells the server to refresh all conditions being monitored by the subscription.  
Public MethodCreate Creates a subscription in the server.  
Public MethodDispose Frees any unmanaged resources.  
Public MethodEndApplyChanges Completes an asynchronous BeginApplyChanges operation.  
Public MethodEndCreate Completes an asynchronous BeginCreate operation.  
Public MethodEndDelete Completes an asynchronous BeginDelete operation.  
Public MethodFindItemByClientHandle Returns the MonitoredItem object identified by the client handle.  
Public MethodModify Modifies a subscription on the server.  
Public MethodRemoveItem Removes an item from the subscription. The method ApplyChanges() must be called to make the changes in the server.  
Public MethodRemoveItems Removes a set of items from the subscription. The method ApplyChanges() must be called to make the changes in the server.  
Public MethodRepublish Republishes the specified notification message.  
Public MethodSetMonitoringMode This Service is used to set the monitoring mode for one or more MonitoredItems of a Subscription. Setting the mode to DISABLED causes all queued Notifications to be deleted.  
Public MethodSetPublishingMode Changes the publishing enabled state for the subscription.  
Public MethodStartEventNotificationsActivate event notification according the filter.
The handler for fast event notification handling is installed. Only one handler can be defined (callback, not .NET event). Multiple notifications can be in one callback. If a synchronisation object is defined for the UaApplication then the callback is internally synchronized with Windows so that the event handler use Windows controls.  
Top

Public Events

 NameDescription
Public EventDataChangeCallbackRaised on a publish response with datachange values.
The application can use this event to get a single callback with all datachange values in a publish response. Or, use the Notification event in the MonitoredItem class to get a callback for each Monitored Item.  
Public EventPublishStatusChanged Raised to indicate the publishing state for the subscription has stopped or resumed (see PublishingStopped property).  
Top

See Also

Copyright © 2018 Advosol Inc. All Rights Reserved.