'Declaration
 
<ExtensionAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
Public Shared Function PollFunction( _
   ByVal producer As ISparkplugProducer, _
   ByVal pollFunction As Func(Of SparkplugPayload) _
) As ISparkplugProducer

'Usage
 
Dim producer As ISparkplugProducer
Dim pollFunction As Func(Of SparkplugPayload)
Dim value As ISparkplugProducer
 
value = ISparkplugProducerExtension.PollFunction(producer, pollFunction)

[Extension()]
[JetBrains.Annotations.NotNull()]
public static ISparkplugProducer PollFunction( 
   ISparkplugProducer producer,
   Func<SparkplugPayload> pollFunction
)

[Extension()]
[JetBrains.Annotations.NotNull()]
public:
static ISparkplugProducer^ PollFunction( 
   ISparkplugProducer^ producer,
   Func<SparkplugPayload^>^ pollFunction
) 

Parameters

producer

The Sparkplug producer that will perform the operation.

The value of this parameter cannot be null (Nothing in Visual Basic).

pollFunction

The function that polls for the data and returns the payload be to be published.

The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

Your code (in the pollFunction) is expected to collect the data for publishing and providing the whole payload as its return value. The component will then send the payload out (if there is anything to publish), by internally calling the PublishDataPayload method.

When the poll function is defined using this method, the individual metrics will not be polled (read) by the component.

This method works by attaching an event handler to the ISparkplugProducerEvents.Poll event.

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Sparkplug is a trademark of Eclipse Foundation, Inc. "MQTT" is a trademark of the OASIS Open standards consortium. Other related terms are trademarks of their respective owners. Any use of these terms on this site is for descriptive purposes only and does not imply any sponsorship, endorsement or affiliation.

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows