Tests whether an OPC UA PubSub subscription can be successfully established. Synchronous.
Syntax
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
- Arguments needed to subscribe to a dataset.
The value of this parameter cannot be null
(Nothing
in Visual Basic).
- millisecondsTimeout
- A period during which a dataset should be received.
Valid values of this parameter are in the range from 0
to 2147483647 (Int32.MaxValue)
.
Return Value
The method returns a non-null
OpcLabs.EasyOpc.UA.PubSub.UADataSetData when the test passes and a dataset has been received, or a
null
reference if there is no error, but no dataset has been received during the period. The method throws a
OpcLabs.EasyOpc.UA.OperationModel.UAException when there is an error establishing the subscription.
This method can return null
(Nothing
in Visual Basic).
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. |
Requirements
Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows
See Also