Skip to content

Reference

OpcSubscription Members

Provides information about a client initiated subscription.

Reference

OpcSubscription Members ​

Type
OpcSubscription
Namespace
Opc.UaFx.Server
Assembly
Opc.UaFx.Advanced.dll
Package
Opc.UaFx.Advanced v2.59.0

Properties ​

Diagnostics ​

Gets an instance of which provides diagnostic information about the operations performed and activities recognized on this OpcSubscription.

csharp
public OpcSubscriptionDiagnostics Diagnostics { get; }
vbnet
Public ReadOnly Property Diagnostics As OpcSubscriptionDiagnostics

Property value

OpcSubscriptionDiagnostics

An instance of the OpcSubscriptionDiagnostics class with bunch of diagnostic information.

Id ​

Gets the unique identifier of the subscription.

csharp
public int Id { get; }
vbnet
Public ReadOnly Property Id As Integer

Property value

Int32

The unique identifier of the subscription.

MonitoredItemsCount ​

Gets the total number of monitored items observed through this OpcSubscription.

csharp
public int MonitoredItemsCount { get; }
vbnet
Public ReadOnly Property MonitoredItemsCount As Integer

Property value

Int32

The number of monitored items observed. The value also includes monitored items its monitoring may be disabled.

Priority ​

Gets the priority used for publishing data change and event notifications.

csharp
public int Priority { get; }
vbnet
Public ReadOnly Property Priority As Integer

Property value

Int32

The priority of the subscription. The greater the number the earlier are pending notifications published to the client.

PublishingInterval ​

Gets a value indicating the interval used to publish recent data change and event notifications in milliseconds.

csharp
public double PublishingInterval { get; }
vbnet
Public ReadOnly Property PublishingInterval As Double

Property value

Double

The milliseconds used as the interval used for publishing.

PublishingIsEnabled ​

Gets a value indicating whether the publishing of data change and event notifications is enabled for this subscription.

csharp
public bool PublishingIsEnabled { get; }
vbnet
Public ReadOnly Property PublishingIsEnabled As Boolean

Property value

Boolean

The value true if notifications are pusblished to the client; otherwise the value false.

Session ​

Gets the session which owns this OpcSubscription.

csharp
public OpcSession Session { get; }
vbnet
Public ReadOnly Property Session As OpcSession

Property value

OpcSession

An instance of the OpcSession class which owns this subscription.

Methods ​

Dispose ​

2 overloads

OverloadDescription
Dispose()Releases all resources used by the OpcSubscription.
Dispose(bool)protected · virtualReleases the unmanaged resources used by the OpcSubscription and optionally releases the managed resources.

Dispose() ​

Releases all resources used by the OpcSubscription.

csharp
public void Dispose()
vbnet
Public Sub Dispose()

Implements

Dispose()

Dispose(bool) ​

protected · virtual

Releases the unmanaged resources used by the OpcSubscription and optionally releases the managed resources.

csharp
protected virtual void Dispose(bool disposing)
vbnet
Protected Overridable Sub Dispose(disposing As Boolean)

Parameters

NameTypeDescription
disposingBooleanThe value true to release both managed and unmanaged resources; otherwise the value false to release only unmanaged resources.

GetMonitoredItems ​

since v2.50

Provides a sequence of OpcMonitoredItem instances associated with this OpcSubscription.

csharp
public IEnumerable<OpcMonitoredItem> GetMonitoredItems()
vbnet
Public Function GetMonitoredItems() As IEnumerable(Of OpcMonitoredItem)

Returns

IEnumerable<OpcMonitoredItem>

An IEnumerable<T> of OpcMonitoredItem instances.