Skip to content

Reference

OpcDiscoveryClient Members

Reference

OpcDiscoveryClient Members ​

Type
OpcDiscoveryClient
Namespace
Opc.UaFx.Client
Assembly
Opc.UaFx.Advanced.dll
Package
Opc.UaFx.Advanced v2.59.0
Also in
Opc.UaFx.Client

Constructors ​

OpcDiscoveryClient ​

4 overloads

OverloadDescription
OpcDiscoveryClient()
OpcDiscoveryClient(string)
OpcDiscoveryClient(Uri)
OpcDiscoveryClient(Uri, OpcApplicationConfiguration)

OpcDiscoveryClient() ​

csharp
public OpcDiscoveryClient()
vbnet
Public Sub New()

OpcDiscoveryClient(string) ​

csharp
public OpcDiscoveryClient(string discoveryUrl)
vbnet
Public Sub New(discoveryUrl As String)

Parameters

NameTypeDescription
discoveryUrlString

Exceptions

ExceptionCondition
ArgumentException
ArgumentNullException
FormatException

OpcDiscoveryClient(Uri) ​

csharp
public OpcDiscoveryClient(Uri discoveryUrl)
vbnet
Public Sub New(discoveryUrl As Uri)

Parameters

NameTypeDescription
discoveryUrlUri

Exceptions

ExceptionCondition
ArgumentNullException

OpcDiscoveryClient(Uri, OpcApplicationConfiguration) ​

csharp
[CLSCompliant(false)]
public OpcDiscoveryClient(
    Uri discoveryUrl,
    OpcApplicationConfiguration configuration)
vbnet
<CLSCompliant(False)>
Public Sub New(
    discoveryUrl As Uri,
    configuration As OpcApplicationConfiguration)

Parameters

NameTypeDescription
discoveryUrlUri
configurationOpcApplicationConfiguration

Exceptions

ExceptionCondition
ArgumentNullException

Properties ​

Configuration ​

csharp
public OpcEndpointConfiguration Configuration { get; }
vbnet
Public ReadOnly Property Configuration As OpcEndpointConfiguration

Property value

OpcEndpointConfiguration

DiscoveryUrl ​

csharp
public Uri DiscoveryUrl { get; }
vbnet
Public ReadOnly Property DiscoveryUrl As Uri

Property value

Uri

Methods ​

Close ​

csharp
public OpcStatus Close()
vbnet
Public Function Close() As OpcStatus

Returns

OpcStatus

DiscoverEndpoints ​

2 overloads

OverloadDescription
DiscoverEndpoints()Discovers the endpoints of the server (OPC 10000-4, GetEndpoints).
DiscoverEndpoints(IEnumerable<string>)since v2.58Discovers the endpoints of the server which use one of the transport profiles specified (OPC 10000-4, GetEndpoints).

Exceptions (all overloads)

ExceptionCondition
OpcExceptionThe server could not be reached or rejected the request, for example because it closed the channel during the handshake. The Code states the reason, such as BadSecureChannelClosed.

DiscoverEndpoints() ​

Discovers the endpoints of the server (OPC 10000-4, GetEndpoints).

csharp
public OpcEndpointDescriptionCollection DiscoverEndpoints()
vbnet
Public Function DiscoverEndpoints() As OpcEndpointDescriptionCollection

Returns

OpcEndpointDescriptionCollection

The endpoints the server returned.

DiscoverEndpoints(IEnumerable<string>) ​

since v2.58

Discovers the endpoints of the server which use one of the transport profiles specified (OPC 10000-4, GetEndpoints).

csharp
public OpcEndpointDescriptionCollection DiscoverEndpoints(
    IEnumerable<string> profileUris)
vbnet
Public Function DiscoverEndpoints(
    profileUris As IEnumerable(Of String)) As OpcEndpointDescriptionCollection

Parameters

NameTypeDescription
profileUrisIEnumerable<String>The URIs of the transport profiles the endpoints have to use, for example http://opcfoundation.org/UA-Profile/Transport/uatcp-uasc-uabinary. A null reference (Nothing in Visual Basic) or an empty sequence discovers the endpoints of every transport profile.

Returns

OpcEndpointDescriptionCollection

The endpoints the server returned for the profileUris.

DiscoverServers ​

2 overloads

OverloadDescription
DiscoverServers()Discovers the servers known to the discovery server (OPC 10000-4, FindServers).
DiscoverServers(IEnumerable<string>)since v2.58Discovers the servers known to the discovery server whose application URI is one of the URIs specified (OPC 10000-4, FindServers).

Exceptions (all overloads)

ExceptionCondition
OpcExceptionThe server could not be reached or rejected the request, for example because it closed the channel during the handshake. The Code states the reason, such as BadSecureChannelClosed.

DiscoverServers() ​

Discovers the servers known to the discovery server (OPC 10000-4, FindServers).

csharp
public OpcApplicationDescriptionCollection DiscoverServers()
vbnet
Public Function DiscoverServers() As OpcApplicationDescriptionCollection

Returns

OpcApplicationDescriptionCollection

The servers the discovery server returned.

DiscoverServers(IEnumerable<string>) ​

since v2.58

Discovers the servers known to the discovery server whose application URI is one of the URIs specified (OPC 10000-4, FindServers).

csharp
public OpcApplicationDescriptionCollection DiscoverServers(
    IEnumerable<string> serverUris)
vbnet
Public Function DiscoverServers(
    serverUris As IEnumerable(Of String)) As OpcApplicationDescriptionCollection

Parameters

NameTypeDescription
serverUrisIEnumerable<String>The application URIs of the servers to discover. A null reference (Nothing in Visual Basic) or an empty sequence discovers every server.

Returns

OpcApplicationDescriptionCollection

The servers the discovery server returned for the serverUris.

Dispose ​

2 overloads

OverloadDescription
Dispose()Releases all resources used by the OpcDiscoveryClient.
Dispose(bool)protected · virtualReleases the unmanaged resources used by the OpcDiscoveryClient and optionally releases the managed resources.

Dispose() ​

Releases all resources used by the OpcDiscoveryClient.

csharp
public void Dispose()
vbnet
Public Sub Dispose()

Implements

Dispose()

Dispose(bool) ​

protected · virtual

Releases the unmanaged resources used by the OpcDiscoveryClient and optionally releases the managed resources.

csharp
protected virtual void Dispose(bool disposing)
vbnet
Protected Overridable Sub Dispose(disposing As Boolean)

Parameters

NameTypeDescription
disposingBooleanThe value true to release both managed and unmanaged resources; otherwise the value false to release only unmanaged resources.