Connectivity Software User's Guide and Reference
EasySparkplugConsumerCore Class Members
Properties  Methods  Events


OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace : EasySparkplugConsumerCore Class

The following tables list the members exposed by EasySparkplugConsumerCore.

Public Constructors
 NameDescription
Public ConstructorOverloaded. Initializes a new instance of the class.  
Top
Public Properties
 NameDescription
Public Property (Inherited from System.ComponentModel.Component)
Public PropertyCan be used to distinguish otherwise equal widgets. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public Propertystatic (Shared in Visual Basic)Default value of the ImplicitHostDescriptor property.  
Public PropertyAn implicit host descriptor, used when the host descriptor is not specified explicitly.  
Public PropertyProvides dictionary of license data fields and their values.  
Public PropertyCapacity of the notification queue. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Public PropertyThe idle time before the internal thread executing the queued notifications is stopped (in milliseconds). (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Public PropertyDetermines whether the component will deliver all notifications in a queued manner. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Public Propertystatic (Shared in Visual Basic)Container for services that are shared by all instances of the component.  
Public Propertystatic (Shared in Visual Basic)Provides services that are shared by all instances of the component.  
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 PropertyDetermines whether the object has been disposed. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Protected PropertyThe service container provided by this widget to inheritors. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Top
Public Methods
 NameDescription
Public MethodOverridden.   
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. Overridden. Clean up any resources being used.  
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 MethodOverridden.   
Public Method (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public MethodOverridden.   
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 MethodPublishes the specified payload to the Sparkplug system.  
Public Method (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public MethodSubscribes to notifications for the specified metric on an edge node or device.  
Public MethodSubscribes to payload notifications from an edge node or device.  
Public Method (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public MethodUnsubscribes from notifications for all metrics.  
Public MethodUnsubscribes from notifications for all payloads.  
Public MethodUnsubscribes from metric subscription specified by an integer handle.  
Public MethodUnsubscribes from payload subscription specified by an integer handle.  
Public MethodOverloaded. Defines a generalized method that classes must implement to create type-specific method for determining value equality of instances. Determines whether this instance has the same value as a given other instance. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Public Method (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Top
Protected Methods
 NameDescription
Protected MethodProcesses an error that has occurred during a callback. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
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. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Protected MethodRaises the MetricNotification event.  
Protected MethodInfrastructure. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Protected MethodInfrastructure. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Protected MethodRaises the PayloadNotification event.  
Protected MethodInfrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Protected MethodProcesses an error that has occurred during sending of a callback. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Protected MethodOverloaded. Invokes the specified action in a synchronized manner. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
Protected MethodInfrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Top
Extension Methods
 NameDescription
Public Extension MethodOverloaded. Sends a rebirth request to the specified edge node.

If there is an error publishing the payload, this method throws OpcLabs.EasySparkplug.OperationModel.SparkplugException.

Public Extension MethodOverloaded. Publishes a payload with a single metric for a Sparkplug device.

In Sparkplug terms, this method effectively sends the DCMD message to the device.

If there is an error publishing the payload, this method throws OpcLabs.EasySparkplug.OperationModel.SparkplugException.

Public Extension MethodOverloaded. Publishes a payload for a Sparkplug device.

In Sparkplug terms, this method effectively sends the DCMD message to the device.

If there is an error publishing the payload, this method throws OpcLabs.EasySparkplug.OperationModel.SparkplugException.

Public Extension MethodOverloaded. Publishes a payload with a single metric for a Sparkplug edge node.

In Sparkplug terms, this method effectively sends the NCMD message to the edge node.

If there is an error publishing the payload, this method throws OpcLabs.EasySparkplug.OperationModel.SparkplugException.

Public Extension MethodOverloaded. Publishes a payload for a Sparkplug edge node.

In Sparkplug terms, this method effectively sends the NCMD message to the edge node.

If there is an error publishing the payload, this method throws OpcLabs.EasySparkplug.OperationModel.SparkplugException.

Public Extension MethodPublishes a payload with a single metric.
Public Extension MethodSets the arbitrary object associated with the node.
Public Extension MethodOverloaded. Subscribes to notifications for the specified metric on a device.
Public Extension MethodOverloaded. Subscribes to payload notifications from a device.
Public Extension MethodOverloaded. Subscribes to notifications for the specified metric on an edge node.
Public Extension MethodOverloaded. Subscribes to payload notifications from an edge node.
Public Extension MethodSubscribes to notifications for the specified metric on an edge node or device, specifying metric subscription arguments and callback.
Public Extension MethodSubscribes to payload notifications from an edge node or device, specifying payload subscription arguments and callback.
Public Extension MethodUnsubscribes from notifications for all metrics and payloads.
Top
Public Events
 NameDescription
Public Event (Inherited from System.ComponentModel.Component)
Public EventRaised for notifications related to subscribed Sparkplug metric.  
Public EventRaised for notifications related to subscribed Sparkplug payload.  
Top
See Also

Reference

EasySparkplugConsumerCore Class
OpcLabs.EasySparkplug Namespace