TestConnection(IEasyUASubscriber,UASubscribeDataSetArguments,Int32) Method

Tests an OPC UA PubSub connection, specifying the subscribe dataset arguments.

Syntax

[Extension()]
public static void TestConnection( 
   IEasyUASubscriber subscriber,
   UASubscribeDataSetArguments subscribeDataSetArguments,
   int waitMilliseconds
)

[Extension()]
public:
static void TestConnection( 
   IEasyUASubscriber^ subscriber,
   UASubscribeDataSetArguments^ subscribeDataSetArguments,
   int waitMilliseconds
)

'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Sub TestConnection( _
   ByVal subscriber As IEasyUASubscriber, _
   ByVal subscribeDataSetArguments As UASubscribeDataSetArguments, _
   ByVal waitMilliseconds As Integer _
)

'Usage
 
Dim subscriber As IEasyUASubscriber
Dim subscribeDataSetArguments As UASubscribeDataSetArguments
Dim waitMilliseconds As Integer
 
IEasyUASubscriberExtension2.TestConnection(subscriber, subscribeDataSetArguments, waitMilliseconds)

Parameters

subscriber

The subscriber object that will perform the operation.

This is typically the OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriber object.

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

subscribeDataSetArguments

Holds all arguments needed to subscribe to a dataset in OPC UA PubSub.

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

waitMilliseconds

Number of milliseconds to wait before the connection test can pass.

Valid values of this parameter are in the range from 0 to 2147483647 (Int32.MaxValue).

Exceptions

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.ArgumentOutOfRangeException	The value of an argument is outside the allowable range of values as defined by the invoked method. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.Threading.Tasks.TaskCanceledException	The task has been cancelled.
OpcLabs.EasyOpc.UA.OperationModel.UAException	The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

This is a synchronous method. For an asynchronous alternative, see TestConnectionAsync(IEasyUASubscriber,UASubscribeDataSetArguments,Int32).

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.

Requirements

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

Reference

IEasyUASubscriberExtension2 Class
IEasyUASubscriberExtension2 Members
Overload List

Documentation Home, Send Documentation Feedback. Technical Support