EasySparkplugConsumer Class Methods

For a list of all members of this type, see EasySparkplugConsumer members.

Public Methods

	Name	Description
	Clone	Overridden.
	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.EasySparkplug.EasySparkplugConsumerCore)
	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.EasySparkplug.EasySparkplugConsumerCore)
	GetSchema	(Inherited from OpcLabs.BaseLib.Widgets.Widget)
	GetService	(Inherited from OpcLabs.EasySparkplug.EasySparkplugConsumerCore)
	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)
	PublishPayload	Publishes the specified payload to the Sparkplug system. (Inherited from OpcLabs.EasySparkplug.EasySparkplugConsumerCore)
	ReadXml	(Inherited from OpcLabs.BaseLib.Widgets.Widget)
	SubscribeMetric	Subscribes to notifications for the specified metric on an edge node or device. (Inherited from OpcLabs.EasySparkplug.EasySparkplugConsumerCore)
	SubscribePayload	Subscribes to payload notifications from an edge node or device. (Inherited from OpcLabs.EasySparkplug.EasySparkplugConsumerCore)
	ToString	(Inherited from OpcLabs.BaseLib.Widgets.Widget)
	UnsubscribeAllMetrics	Unsubscribes from notifications for all metrics. (Inherited from OpcLabs.EasySparkplug.EasySparkplugConsumerCore)
	UnsubscribeAllPayloads	Unsubscribes from notifications for all payloads. (Inherited from OpcLabs.EasySparkplug.EasySparkplugConsumerCore)
	UnsubscribeMetric	Unsubscribes from metric subscription specified by an integer handle. (Inherited from OpcLabs.EasySparkplug.EasySparkplugConsumerCore)
	UnsubscribePayload	Unsubscribes from payload subscription specified by an integer handle. (Inherited from OpcLabs.EasySparkplug.EasySparkplugConsumerCore)
	ValueEquals	Overloaded. 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)
	WriteXml	(Inherited from OpcLabs.BaseLib.Widgets.Widget)

Top

Protected Methods

	Name	Description
	CallbackError	Processes an error that has occurred during a callback. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
	Finalize	(Inherited from System.ComponentModel.Component)
	MemberwiseClone	Overloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
	OnContextTypesChanged	Infrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
	OnMetricNotification	Raises the MetricNotification event. (Inherited from OpcLabs.EasySparkplug.EasySparkplugConsumerCore)
	OnNotificationEnqueuerOverflow	Infrastructure. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
	OnNotificationEnqueuerOverflowClearing	Infrastructure. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
	OnPayloadNotification	Raises the PayloadNotification event. (Inherited from OpcLabs.EasySparkplug.EasySparkplugConsumerCore)
	ReadXmlElement	Infrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
	SendCallbackError	Processes an error that has occurred during sending of a callback. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
	Synchronize	Overloaded. Invokes the specified action in a synchronized manner. (Inherited from OpcLabs.BaseLib.Widgets.NotifyingWidget)
	WriteXmlElement	Infrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget)

Top

Extension Methods

	Name	Description
	EdgeNodeRebirth	Overloaded. Sends a rebirth request to the specified edge node. If there is an error publishing the payload, this method throws OpcLabs.EasySparkplug.OperationModel.SparkplugException.
	PublishDeviceMetric	Overloaded. 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.
	PublishDevicePayload	Overloaded. 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.
	PublishEdgeNodeMetric	Overloaded. 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.
	PublishEdgeNodePayload	Overloaded. 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.
	PublishMetric	Publishes a payload with a single metric.
	SetState<TNode>	Sets the arbitrary object associated with the node.
	SubscribeDeviceMetric	Overloaded. Subscribes to notifications for the specified metric on a device.
	SubscribeDevicePayload	Overloaded. Subscribes to payload notifications from a device.
	SubscribeEdgeNodeMetric	Overloaded. Subscribes to notifications for the specified metric on an edge node.
	SubscribeEdgeNodePayload	Overloaded. Subscribes to payload notifications from an edge node.
	SubscribeMetric	Subscribes to notifications for the specified metric on an edge node or device, specifying metric subscription arguments and callback.
	SubscribePayload	Subscribes to payload notifications from an edge node or device, specifying payload subscription arguments and callback.
	UnsubscribeAll	Unsubscribes from notifications for all metrics and payloads.

Top

Reference

EasySparkplugConsumer Class
OpcLabs.EasySparkplug Namespace