| Name | Description | |
|---|---|---|
 | EasyUASubscriber Constructor | Overloaded. |
OPC Studio User's Guide and Reference
EasyUASubscriber Class Members
The following tables list the members exposed by EasyUASubscriber.
| Name | Description | |
|---|---|---|
| EasyUASubscriber Constructor | Overloaded. |
| Name | Description | |
|---|---|---|
 | AliasProvider | The alias provider to be used for resolving aliases by this component. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| Container | (Inherited from System.ComponentModel.Component) |
| CustomReference | Can be used to distinguish otherwise equal widgets. (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
| InstanceParameters | Contains parameters that influence the behavior of just this instance of the component. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| Isolated | Specifies that you wish that the EasyUASubscriberCore object instance works with "isolated" connections, i.e. those that are not shared with other instances. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| IsolatedParameters | Contains parameters that influence the behavior of the component when it is isolated. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| LicenseInfo | Provides dictionary of license data fields and their values. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| NotificationQueueCapacity | Capacity of the notification queue. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget) |
| NotificationQueueIdleTimeToSleep | The idle time before the internal thread executing the queued notifications is stopped (in milliseconds). (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget) |
| PullDataSetMessageQueueCapacity | Capacity of the event pull queue for dataset message notifications. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| PullResolverAccessQueueCapacity | Capacity of the event pull queue for resolver access notifications. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| PullSubscriptionResolvedQueueCapacity | Capacity of the event pull queue for subscription resolved notifications (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| QueueNotifications | Determines whether the component will deliver all callbacks in a queued manner. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
 | SharedInstance | A shared instance of the subscriber object. |
| Site | (Inherited from System.ComponentModel.Component) |
| SynchronizationContext | Contains synchronization context used by the object when performing asynchronous operations (including event notifications). (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget) |
| Name | Description | |
|---|---|---|
 | CanRaiseEvents | (Inherited from System.ComponentModel.Component) |
| DesignMode | (Inherited from System.ComponentModel.Component) |
| Events | (Inherited from System.ComponentModel.Component) |
| ServiceContainer | The service container provided by this widget to inheritors. (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
| Name | Description | |
|---|---|---|
 | ChangeDataSetSubscription | Changes parameters of an existing dataset subscription. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| Clone | Overridden. |
| Create | Creates a new instance of the class. |
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject) |
| Dispose | Overloaded. Clean up any resources being used. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| Equals | (Inherited from object) |
| GetHashCode | Serves as the default hash function. (Inherited from object) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject) |
| GetObjectData | (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| GetSchema | (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
| GetService | (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| GetSubscribeDataSetArguments | Obtains parameters of a specified dataset subscription. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| GetSubscribeDataSetArgumentsDictionary | Obtains information about all dataset subscriptions on this IEasyUASubscriber object. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| GetType | Gets the System.Type of the current instance. (Inherited from object) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject) |
| IsKnownDataSetSubscriptionHandle | Determines whether the given data set subscription handle is known to this client. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| PullMultipleDataSetMessages | Attempts to pull multiple dataset message event notifications. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| PullMultipleResolverAccesses | Attempts to pull multiple resolver access event notifications. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| PullMultipleSubscriptionResolvedNotifications | Attempts to pull multiple subscription resolved event notifications. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| ReadXml | (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
| Reset | Sets the object properties back to their defaults. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| SubscribeDataSet | Subscribes to a dataset. The IEasyUASubscriber.DataSetMessage event is generated for each dataset message received. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| ToString | (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| UnsubscribeAllDataSets | Unsubscribes from all datasets. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| UnsubscribeDataSet | Unsubscribes from a dataset specified by its integer handle. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| ValueEquals | Overloaded. Determines whether this object is value equal to the other. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| WriteXml | (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
| Name | Description | |
|---|---|---|
 | ChangeDataSetFieldSubscription | Overloaded. Changes parameters of an existing dataset field subscription. |
| ChangeDataSetSubscription | Changes parameters of an existing dataset subscription, specifying a new filter. |
| GetSubscribeDataSetFieldArguments | Obtains parameters of a specified dataset subscription. |
| PullDataSetMessage | Attempts to pull a dataset message event notification subscribed to by the SubscribeDataSet method. |
| PullResolverAccess | Attempts to pull a resolver access notification. |
| PullSubscriptionResolved | Attempts to pull a subscription resolved notification. |
| SetState<TNode> | Sets the arbitrary object associated with the node. |
| SubscribeDataSet | Overloaded. Subscribes to a dataset, using a PubSub connection descriptor, and no filter. |
| SubscribeDataSetField | Overloaded. Subscribes to a single dataset field from a dataset, using arguments object. |
| TestConnection | Overloaded. The method tests synchronously whether an OPC UA PubSub connection can be successfully established. It returns normally when the test passes. The method throws a OpcLabs.EasyOpc.UA.OperationModel.UAException when there is an error establishing the connection. Due to asynchronous nature of some communication channels, successful test outcome does not always imply that a connection has been fully established. The waitMilliseconds parameter is not a timeout in its traditional sense, i.e. a maximum time allowed for the operation. Here, this method actually waits for the time given by waitMilliseconds parameter unless a failure occurs. |
| TestConnectionAsync | Overloaded. The method tests asynchronously whether an OPC UA PubSub connection can be successfully established. Due to asynchronous nature of some communication channels, successful test outcome does not always imply that a connection has been fully established. The waitMilliseconds parameter is not a timeout in its traditional sense, i.e. a maximum time allowed for the operation. Here, this method actually waits for the time given by waitMilliseconds parameter unless a failure occurs. |
| TestSubscription | Tests whether an OPC UA PubSub subscription can be successfully established. Synchronous. |
| TestSubscriptionAsync | Tests whether an OPC UA PubSub subscription can be successfully established. Asynchronous. |
| UnsubscribeDataSetField | Unsubscribes from a dataset field specified by its integer handle. |
| Name | Description | |
|---|---|---|
 | DataSetMessage | Raised for every OPC UA PubSub dataset message received. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| Disposed | (Inherited from System.ComponentModel.Component) |
| EventingFailure | Raised when a failure in the eventing infrastructure occurs. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| LogEntry | Raised for loggable entries originating in the OPC-UA subscriber engine and the EasyUASubscriber component. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| ResolverAccess | Raised when the OPC UA PubSub resolver accesses its target. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
| SubscriptionResolved | Raised when the OPC UA PubSub has resolved the dataset subscription. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore) |
