ISparkplugProducer Interface Members

Connectivity Software User's Guide and Reference

ISparkplugProducer Interface Members

Properties Methods Collapse All

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

The following tables list the members exposed by ISparkplugProducer.

Public Properties

	Name	Description
	ApplicationOnline	Determines whether the Primary Host Application is online.
	ConvertCommandData	Determines whether an attempt will be made to convert the data in the incoming command to the type of the metric.
	DataSourceCondition	Contains the condition of the data source connection associated with the Sparkplug producer.
	DataSourceConnectionMode	Determines when and how the Sparkplug producer (edge node or device) connects and disconnects its data source.
	IsPublishingLocked	Determines whether the publishing is currently locked, i.e. metric data changes are not immediately published.
	IsStarted	Determines whether the component is currently started. (Inherited from OpcLabs.BaseLib.ComponentModel.IReadOnlyStartable)
	MetricIdentificationMode	Defines how the Sparkplug metrics are identified in the Birth and Data messages.
	Metrics	The collection of Sparkplug metrics that this producer publishes.
	ProducerOnline	Determines whether this Sparkplug producer (edge node or device) is online.
	PublishingInterval	The interval in milliseconds at which the Sparkplug producer (edge node or device) publishes its data.
	PublishLastDataOnly	Determines whether the Sparkplug producer (edge node or device) publishes only the last data known.
	ReportByException	Determines whether your code will report any changed data to the producer, or whether the producer will poll for data changes.

Public Methods

	Name	Description
	DataSourceConnectionFailure	Indicates that the data source connection for the edge node or device has failed.
	DataSourceConnectionSuccess	Indicates that the data source connection for the edge node or device has been successfully established.
	DataSourceDisconnectionSuccess	Indicates that the data source connection for the edge node or device has been successfully disconnected.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from System.IDisposable)
	LockPublishing	Locks the publishing of metric data changes, so that they are not immediately published.
	PerformConnectDataSource	In manual data source connection mode, instructs the producer to connect to the data source.
	PerformDisconnectDataSource	In manual data source connection mode, instructs the producer to disconnect from the data source.
	PerformPoll	Performs the periodic polling of data from the data source, and publishes the data payload.
	PublishDataPayload	Publishes the specified data payload to the Sparkplug system (MQTT broker).
	UnlockPublishing	Publishes any assembled metric data changes, and unlocks the publishing.

Extension Methods

	Name	Description
	ConnectDataSourceAction	Defines an action to be performed for connecting the edge node or device to a data source.
	DataSourceConnectionFailure	Overloaded. Indicates that the data source connection for the edge node or device has failed.
	DisconnectDataSourceAction	Defines an action to be performed for disconnecting the edge node or device from a data source.
	DisposableLockPublishing	Locks the publishing of metric data changes and returns an object that unlocks the publishing upon its disposal.
	GetMetric	Gets the Sparkplug metric with the specified metric name from the Sparkplug edge node or device.
	PollFunction	Defines a function that will be called when the producer is polled for data.
	ReadMetric	Reads from a Sparkplug metric with the specified metric name from the Sparkplug edge node or device and returns the Sparkplug data object.
	ReadMetricValue	Reads from a Sparkplug metric with the specified metric name from the Sparkplug edge node or device and returns the metric value.
	WriteMetric	Writes Sparkplug data to a Sparkplug metric with the specified metric name.
	WriteMetricValue	Writes a value to a Sparkplug metric with the specified metric name.

See Also

Reference

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