'Declaration
 
<ExtensionAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
Public Shared Function DisconnectDataSourceAction( _
   ByVal producer As ISparkplugProducer, _
   ByVal action As Action(Of ISparkplugProducer) _
) As ISparkplugProducer

'Usage
 
Dim producer As ISparkplugProducer
Dim action As Action(Of ISparkplugProducer)
Dim value As ISparkplugProducer
 
value = ISparkplugProducerExtension.DisconnectDataSourceAction(producer, action)

[Extension()]
[JetBrains.Annotations.NotNull()]
public static ISparkplugProducer DisconnectDataSourceAction( 
   ISparkplugProducer producer,
   Action<ISparkplugProducer> action
)

[Extension()]
[JetBrains.Annotations.NotNull()]
public:
static ISparkplugProducer^ DisconnectDataSourceAction( 
   ISparkplugProducer^ producer,
   Action<ISparkplugProducer^>^ action
) 

Parameters

producer

The Sparkplug producer that will perform the operation.

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

action

The action that disconnects the data source.

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

Return Value

Your code (in the action is expected to disconnect from the data source (for example, a database or a PLC) and call the ISparkplugProducer.DataSourceDisconnectionSuccess method (the disconnection must always "succeed"). This can be done synchronously (while executing the action) or asynchronously (e.g. by using a task or a thread).

Executing the action MUST NOT block the calling thread for any significant amount of time. If the data source disconnection processing can block, perform it asynchronously.

This method works by attaching an event handler to the ISparkplugProducerEvents.DisconnectDataSource 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