OPC Studio User's Guide and Reference
EasyUASubscriber Class Members
Properties  Methods  Events


OpcLabs.EasyOpcUAComponents Assembly > OpcLabs.EasyOpc.UA.PubSub Namespace : EasyUASubscriber Class

The following tables list the members exposed by EasyUASubscriber.

Public Constructors
 NameDescription
Public ConstructorOverloaded.   
Top
Public Properties
 NameDescription
Public PropertyThe alias provider to be used for resolving aliases by this component. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public PropertyCapacity of the callback queue. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Public PropertyThe idle time before the internal thread executing the queued callbacks is stopped. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Public Property (Inherited from System.ComponentModel.Component)
Public PropertyCan be used to distinguish otherwise equal widgets. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public PropertyContains parameters that influence the behavior of just this instance of the component. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public PropertySpecifies 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)
Public PropertyContains parameters that influence the behavior of the component when it is isolated. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public PropertyProvides dictionary of license data fields and their values. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public PropertyCapacity of the event pull queue for dataset message notifications. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public PropertyCapacity of the event pull queue for resolver access notifications. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public PropertyCapacity of the event pull queue for subscription resolved notifications (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public PropertyDetermines whether the component will deliver all callbacks in a queued manner. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public Propertystatic (Shared in Visual Basic)A shared instance of the subscriber object.  
Public Property (Inherited from System.ComponentModel.Component)
Public PropertyContains synchronization context used by the object when performing asynchronous operations (including event notifications). (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Top
Protected Properties
 NameDescription
Protected Property (Inherited from System.ComponentModel.Component)
Protected Property (Inherited from System.ComponentModel.Component)
Protected Property (Inherited from System.ComponentModel.Component)
Protected PropertyThe service container provided by this widget to inheritors. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Top
Public Methods
 NameDescription
Public MethodChanges parameters of an existing dataset subscription. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public MethodOverridden.   
Public Methodstatic (Shared in Visual Basic)Creates a new instance of the class.  
Public MethodCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodOverloaded. Clean up any resources being used. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public Method (Inherited from object)
Public MethodServes as the default hash function. (Inherited from object)
Public MethodRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public Method (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public Method (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public Method (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public MethodObtains parameters of a specified dataset subscription. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public MethodObtains information about all dataset subscriptions on this IEasyUASubscriber object. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public MethodGets the System.Type of the current instance. (Inherited from object)
Public MethodObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodDetermines whether the given data set subscription handle is known to this client. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public MethodAttempts to pull multiple dataset message event notifications. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public MethodAttempts to pull multiple resolver access event notifications. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public MethodAttempts to pull multiple subscription resolved event notifications. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public MethodRaises a callback or event using a given handler and passing it specified event arguments, optionally specifying whether to enqueue the call. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Public Method (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public MethodSets the object properties back to their defaults. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public MethodSubscribes to a dataset. The IEasyUASubscriber.DataSetMessage event is generated for each dataset message received. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public MethodReturns a string that represents the current object. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public MethodUnsubscribes from all datasets. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public MethodUnsubscribes from a dataset specified by its integer handle. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public MethodOverloaded. Determines whether this object is value equal to the other. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public Method (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Top
Protected Methods
 NameDescription
Protected MethodProcesses an error that has occurred during a callback. Processes an error that has occurred during a callback. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Protected Method (Inherited from System.ComponentModel.Component)
Protected MethodOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodInfrastructure. Infrastructure. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Protected MethodInfrastructure. Infrastructure. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Protected MethodInfrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Protected MethodInfrastructure. Infrastructure. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Protected MethodProcesses an error that has occurred during sending of a callback. Processes an error that has occurred during a callback. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Protected MethodOverloaded. Invokes the specified action in a synchronized manner. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Protected MethodInfrastructure. Infrastructure. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Top
Extension Methods
 NameDescription
Public Extension MethodOverloaded. Changes parameters of an existing dataset field subscription.
Public Extension MethodChanges parameters of an existing dataset subscription, specifying a new filter.
Public Extension MethodObtains parameters of a specified dataset subscription.
Public Extension MethodAttempts to pull a dataset message event notification subscribed to by the SubscribeDataSet method.
Public Extension MethodAttempts to pull a resolver access notification.
Public Extension MethodAttempts to pull a subscription resolved notification.
Public Extension MethodOverloaded. Subscribes to a dataset, using a PubSub connection descriptor, and no filter.
Public Extension MethodOverloaded. Subscribes to a single dataset field from a dataset, using arguments object.
Public Extension MethodOverloaded. Tests whether an OPC UA PubSub connection can be successfully established. Synchronous.

The method 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.

Public Extension MethodOverloaded. Tests whether an OPC UA PubSub connection can be successfully established. Asynchronous.

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.

Public Extension MethodTests whether an OPC UA PubSub subscription can be successfully established. Synchronous.
Public Extension MethodTests whether an OPC UA PubSub subscription can be successfully established. Asynchronous.
Public Extension MethodUnsubscribes from a dataset field specified by its integer handle.
Top
Public Events
 NameDescription
Public EventRaised for every OPC UA PubSub dataset message received. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public Event (Inherited from System.ComponentModel.Component)
Public EventRaised when a failure in the eventing infrastructure occurs. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public EventRaised for loggable entries originating in the OPC-UA subscriber engine and the EasyUASubscriber component. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public EventRaised when the OPC UA PubSub resolver accesses its target. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Public EventRaised when the OPC UA PubSub has resolved the dataset subscription. (Inherited from OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriberCore)
Top
See Also

Reference

EasyUASubscriber Class
OpcLabs.EasyOpc.UA.PubSub Namespace