UA Server SDK C++ Bundle
1.4.2.275
|
The UaDiscovery class manages a UA Client side discovery functionality. More...
#include <uadiscovery.h>
Public Member Functions | |
UaDiscovery () | |
Creates a UaDiscovery client object. | |
~UaDiscovery () | |
Destroys the UaDiscovery object. | |
UaStatus | findServers (ServiceSettings &serviceSettings, const UaString &sDiscoveryURL, ClientSecurityInfo &clientSecurityInfo, UaApplicationDescriptions &applicationDescriptions) |
Gets a list of servers known by the discovery server. More... | |
UaStatus | findServers (ServiceSettings &serviceSettings, const UaString &sDiscoveryURL, ClientSecurityInfo &clientSecurityInfo, const UaStringArray &localIds, const UaStringArray &serverUris, UaApplicationDescriptions &applicationDescriptions) |
Gets a list of servers known by the discovery server. More... | |
UaStatus | getEndpoints (ServiceSettings &serviceSettings, const UaString &sDiscoveryURL, ClientSecurityInfo &clientSecurityInfo, UaEndpointDescriptions &endpointDescriptions) |
Gets a list of endpoints supported by the server. More... | |
The UaDiscovery class manages a UA Client side discovery functionality.
Discovery is a two-step approach. In the first step, the available servers are discovered and in the second step the selected server is asked for its available Endpoints, describing combinations of protocols and security settings available to connect to the server.
UaStatus UaClientSdk::UaDiscovery::findServers | ( | ServiceSettings & | serviceSettings, |
const UaString & | sDiscoveryURL, | ||
ClientSecurityInfo & | clientSecurityInfo, | ||
UaApplicationDescriptions & | applicationDescriptions | ||
) |
Gets a list of servers known by the discovery server.
The discovery server is typically a Local Discovery Server (LDS) running on a host with OPC UA servers. It returns the servers available on this host.
The DiscoveryUrls contained in the returned ApplicationDescriptions can be used to call getEndpoints for the server of interest to get all information necessary to connect to this server.
[in,out] | serviceSettings | The general service settings like timeout. See ServiceSettings for more details. |
[in] | sDiscoveryURL | The URL identifying an OPC UA Discovery Server.
|
[in] | clientSecurityInfo | The client defined security settings. See ClientSecurityInfo for more information. |
[out] | applicationDescriptions | Array of OpcUa_ApplicationDescription with the following information.
|
UaStatus UaClientSdk::UaDiscovery::findServers | ( | ServiceSettings & | serviceSettings, |
const UaString & | sDiscoveryURL, | ||
ClientSecurityInfo & | clientSecurityInfo, | ||
const UaStringArray & | localIds, | ||
const UaStringArray & | serverUris, | ||
UaApplicationDescriptions & | applicationDescriptions | ||
) |
Gets a list of servers known by the discovery server.
The discovery server is typically a Local Discovery Server (LDS) running on a host with OPC UA servers. It returns the servers available on this host.
The DiscoveryUrls contained in the returned ApplicationDescriptions can be used to call getEndpoints for the server of interest to get all information necessary to connect to this server.
[in,out] | serviceSettings | The general service settings like timeout. See ServiceSettings for more details. |
[in] | sDiscoveryURL | The URL identifying an OPC UA Discovery Server.
|
[in] | clientSecurityInfo | The client defined security settings. See ClientSecurityInfo for more information. |
[in] | localIds | List of locales to use. The server should return the ServerName using one of locales specified. If the server supports more than one of the requested locales, then the server will use the locale that appears first in this list. If the server does not support any of the requested locales, it chooses an appropriate default locale. The server chooses an appropriate default locale if this list is empty. |
[in] | serverUris | List of servers to return. All known servers are returned if the list is empty. |
[out] | applicationDescriptions | Array of OpcUa_ApplicationDescription with the following information
|
UaStatus UaClientSdk::UaDiscovery::getEndpoints | ( | ServiceSettings & | serviceSettings, |
const UaString & | sDiscoveryURL, | ||
ClientSecurityInfo & | clientSecurityInfo, | ||
UaEndpointDescriptions & | endpointDescriptions | ||
) |
Gets a list of endpoints supported by the server.
The discovery URL used to connect to the server and to get the endpoints is typically returned from findServers or other discovery methods like findServersOnNetwork or queryServersOnDirectory.
The EndpointDescriptions returned from the server provide all information like EnpointUrl, security settings and types of user authentication necessary to connect to the server.
[in,out] | serviceSettings | The general service settings like timeout. See ServiceSettings for more details. |
[in] | sDiscoveryURL | The discovery URL of an OPC UA Server.
|
[in] | clientSecurityInfo | The client defined security settings. See ClientSecurityInfo for more info. |
[out] | endpointDescriptions | Array of OpcUa_EndpointDescription with the following information
|