TestConnection(IEasyUASubscriber,UASubscribeDataSetArguments,Int32) Method

Tests whether an OPC UA PubSub connection can be successfully established. Synchronous.

Syntax

Visual Basic
C#
C++/CLI

'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)

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

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

Parameters

subscriber: The subscriber object that will perform the operation.
subscribeDataSetArguments: Holds all arguments needed to subscribe to a dataset in OPC UA PubSub.
waitMilliseconds: Number of milliseconds to wait before the connection test can pass.

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

The method returns normally when the test passes. The method throws a OpcLabs.EasyOpc.UA.OperationModel.UAException when there is an error establishing the connection.

Due to asynchronous nature of some communication channels, successful test outcome does not always imply that a connection has been fully established.

The waitMilliseconds parameter is not a timeout in its traditional sense, i.e. a maximum time allowed for the operation. Here, this method actually waits for the time given by waitMilliseconds parameter unless a failure occurs.

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

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

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