IEasySparkplugConsumer Interface Members

Connectivity Software User's Guide and Reference

IEasySparkplugConsumer Interface Members

Methods Collapse All

OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace : IEasySparkplugConsumer Interface

The following tables list the members exposed by IEasySparkplugConsumer.

Public Methods

	Name	Description
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from System.IDisposable)
	GetService	Gets the service object of the specified type. (Inherited from System.IServiceProvider)
	PublishPayload	Publishes the specified payload to the Sparkplug system.
	SubscribeMetric	Subscribes to notifications for the specified metric on an edge node or device.
	SubscribePayload	Subscribes to payload notifications from an edge node or device.
	UnsubscribeAllMetrics	Unsubscribes from notifications for all metrics.
	UnsubscribeAllPayloads	Unsubscribes from notifications for all payloads.
	UnsubscribeMetric	Unsubscribes from metric subscription specified by an integer handle.
	UnsubscribePayload	Unsubscribes from payload subscription specified by an integer handle.

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

See Also

Reference

IEasySparkplugConsumer Interface
OpcLabs.EasySparkplug Namespace

Copyright © 2004-2025 CODE Consulting and Development, s.r.o., Plzen. All rights reserved. Web page: www.opclabs.com

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.