Skip to content

Reference

OpcSubscriptionSetup Class

Defines a set of properties which can be used to create a whole OpcSubscription including its OpcMonitoredItem objects.

Reference

OpcSubscriptionSetup Class ​

since v2.32

Namespace
Opc.UaFx.Client
Assembly
Opc.UaFx.Advanced.dll
Package
Opc.UaFx.Advanced v2.59.0
Members
OpcSubscriptionSetup Members
Also in
Opc.UaFx.Client

Defines a set of properties which can be used to create a whole OpcSubscription including its OpcMonitoredItem objects.

Syntax ​

csharp
public class OpcSubscriptionSetup
vbnet
Public Class OpcSubscriptionSetup

Inheritance ​

Object → OpcSubscriptionSetup

Constructors ​

NameDescription
OpcSubscriptionSetup3 overloadsInitializes a new instance of the OpcSubscriptionSetup class.

Properties ​

NameDescription
ChangedOccurs then a monitored is added, modified, deleted or changes on the OpcSubscription were applied.
DataChangeReceivedOccurs then a monitored item receives an event notification which is not handled by an OpcDataChangeReceivedEventHandler on its DataChangeReceived event.
DisplayNameGets or sets the name of the OpcSubscription used just for display purpose in the client application.
EventReceivedOccurs then a monitored item receives an event notification which is not handled by an OpcEventReceivedEventHandler on its EventReceived event.
KeepAliveCountGets or sets a value which defines the requested number of times the publishing timer have to expire without any notification being sent before the server have to send a keep-alive message to the client.
LifetimeCountGets or sets a value which defines the requested number of times the publishing timer have to expire without any publish request before the server have to delete this OpcSubscription.
MaxMessageCountGets or sets the maximum number of notifications to keep in the cache.
MaxNotificationsPerPublishGets or sets a value which defines the maximum number of notifications that the client wants to receive in a single publish response.
MinLifetimeIntervalGets or sets a value which defines the minimum lifetime interval to apply in respect of the PublishingInterval and the LifetimeCount configured.
MonitoredItemsGets a read-only collection of OpcMonitoredItem instances associated with this OpcSubscription.
NotificationFailedsince v2.57Occurs then a notification message for the OpcSubscription failed to be received, so that its data changes and events do not reach the monitored items.
NotificationReceivedOccurs then a OpcNotification for this OpcSubscription has been received by the session which owns this OpcSubscription.
PriorityGets or sets a value which defines the relative priority of the subscription used to priorize notifications being send then more than one subscription is to be notified.
PublishingIntervalGets or sets the requested number of milliseconds of the interval within the server have to send cyclic notifications to the client.
PublishingIsEnabledGets or sets a value indicating whether publishing is enabled for this OpcSubscription.
ReceivedDataChangeCallbackGets or sets the callback used to process data changes of the monitored items associated with this OpcSubscription.
ReceivedEventCallbackGets or sets the callback used to process events of the monitored items associated with this OpcSubscription.
TimestampsToReturnGets or sets the timestamps the server shall transmit for each monitored item.
UseMonitoredItemDataCacheGets or sets a value indicating whether this OpcSubscription shall forward notifications received from the server to monitored item individual caches.

Methods ​

NameDescription
AddMonitoredItem15 overloadsAdds the monitored item specified by item to this OpcSubscription.
RemoveMonitoredItem3 overloadsRemoves the monitored item specified by item from the MonitoredItems of this OpcSubscription.
ToStringoverrideReturns a string that represents the current OpcSubscription.

Applies to ​

PackageVersions
Opc.UaFx.Advancedv2.32–v2.59