.NET Based OPC UA Client/Server SDK  2.6.1.422
UnifiedAutomation.UaClient.Discovery Class Reference

The settings for a request. More...

Inherits IDisposable.

Public Member Functions

 Discovery ()
 Create a session for the default client application. More...
 
 Discovery (ApplicationInstance application)
 Create a session for the specified client application. More...
 
void Dispose ()
 Frees any unmanaged resources. More...
 
List< ApplicationDescriptionFindServers (string discoveryUrl)
 Finds the servers known to the discovery server. More...
 
List< ApplicationDescriptionFindServers (string discoveryUrl, List< string > localeIds, List< string > applicationUris, RequestSettings settings)
 Finds the servers known to the discovery server. More...
 
List< ApplicationDescriptionFindServers (string discoveryUrl, string transportProfileUri, List< string > localeIds, List< string > applicationUris, RequestSettings settings)
 Finds the servers known to the discovery server. More...
 
IAsyncResult BeginFindServers (string discoveryUrl, List< string > localeIds, List< string > applicationUris, RequestSettings settings, AsyncCallback callback, object userData)
 Finds the servers known to the discovery server. More...
 
IAsyncResult BeginFindServers (string discoveryUrl, string transportProfileUri, List< string > localeIds, List< string > applicationUris, RequestSettings settings, AsyncCallback callback, object userData)
 Finds the servers known to the discovery server. More...
 
IAsyncResult BeginFindServers (string discoveryUrl, AsyncCallback callback, object userData)
 Finds the servers known to the discovery server. More...
 
List< ApplicationDescriptionEndFindServers (IAsyncResult result)
 Completes an asynchronous disconnect operation. More...
 
List< EndpointDescriptionGetEndpoints (string discoveryUrl)
 Gets the endpoints. More...
 
List< EndpointDescriptionGetEndpoints (string discoveryUrl, List< string > localeIds, List< string > profileUris, RequestSettings settings)
 Gets the endpoints. More...
 
List< EndpointDescriptionGetEndpoints (string discoveryUrl, string transportProfileUri, List< string > localeIds, List< string > profileUris, RequestSettings settings)
 Gets the endpoints. More...
 
IAsyncResult BeginGetEndpoints (string discoveryUrl, List< string > localeIds, List< string > profileUris, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the get endpoints. More...
 
IAsyncResult BeginGetEndpoints (string discoveryUrl, string transportProfileUri, List< string > localeIds, List< string > profileUris, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the get endpoints. More...
 
IAsyncResult BeginGetEndpoints (string discoveryUrl, AsyncCallback callback, object userData)
 Begins the get endpoints. More...
 
List< EndpointDescriptionEndGetEndpoints (IAsyncResult result)
 Ends the get endpoints. More...
 
List< ServerOnNetworkFindServersOnNetwork (string discoveryUrl)
 Finds the servers known to the discovery server. More...
 
List< ServerOnNetworkFindServersOnNetwork (string discoveryUrl, uint startingRecordId, uint maxRecordsToReturn, IList< string > serverCapabilityFilter, RequestSettings settings, out DateTime lastCounterResetTime)
 Finds the servers known to the discovery server. More...
 
List< ServerOnNetworkFindServersOnNetwork (string discoveryUrl, string transportProfileUri, uint startingRecordId, uint maxRecordsToReturn, IList< string > serverCapabilityFilter, RequestSettings settings, out DateTime lastCounterResetTime)
 Finds the servers known to the discovery server. More...
 
IAsyncResult BeginFindServersOnNetwork (string discoveryUrl, uint startingRecordId, uint maxRecordsToReturn, IList< string > serverCapabilityFilter, RequestSettings settings, AsyncCallback callback, object userData)
 Finds the servers known to the discovery server. More...
 
IAsyncResult BeginFindServersOnNetwork (string discoveryUrl, string transportProfileUri, uint startingRecordId, uint maxRecordsToReturn, IList< string > serverCapabilityFilter, RequestSettings settings, AsyncCallback callback, object userData)
 Finds the servers known to the discovery server. More...
 
IAsyncResult BeginFindServersOnNetwork (string discoveryUrl, AsyncCallback callback, object userData)
 Finds the servers known to the discovery server. More...
 
List< ServerOnNetworkEndFindServersOnNetwork (IAsyncResult result, out DateTime lastCounterResetTime)
 Completes an asynchronous disconnect operation. More...
 
EndpointDescription GetMostSecureEndpoint (string discoveryUrl)
 Returns the most secure endpoint supported by a server. More...
 
IAsyncResult BeginGetMostSecureEndpoint (string discoveryUrl, AsyncCallback callback, object userData)
 Begins a request for the most secure endpoint supported by a server. More...
 
EndpointDescription EndGetMostSecureEndpoint (IAsyncResult result)
 Ends the get endpoints. More...
 

Protected Member Functions

virtual void Dispose (bool disposing)
 An overrideable version of the Dispose. More...
 

Properties

ApplicationInstance Application [get]
 Gets the application. More...
 
RequestSettings DefaultRequestSettings [get, set]
 Gets or sets the default request settings. More...
 
int SecureChannelTimeout [get, set]
 Gets or sets the secure channel timeout. More...
 

Detailed Description

The settings for a request.

Constructor & Destructor Documentation

UnifiedAutomation.UaClient.Discovery.Discovery ( )
inline

Create a session for the default client application.

UnifiedAutomation.UaClient.Discovery.Discovery ( ApplicationInstance  application)
inline

Create a session for the specified client application.

Member Function Documentation

IAsyncResult UnifiedAutomation.UaClient.Discovery.BeginFindServers ( string  discoveryUrl,
List< string >  localeIds,
List< string >  applicationUris,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)
inline

Finds the servers known to the discovery server.

Parameters
discoveryUrlThe discovery URL.
localeIdsThe locale ids.
applicationUrisThe application uris.
settingsThe request settings.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
An object which must be passed to the EndFindServers() method.
IAsyncResult UnifiedAutomation.UaClient.Discovery.BeginFindServers ( string  discoveryUrl,
string  transportProfileUri,
List< string >  localeIds,
List< string >  applicationUris,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)
inline

Finds the servers known to the discovery server.

Parameters
discoveryUrlThe discovery URL.
transportProfileUriThe transport profile URI.
localeIdsThe locale ids.
applicationUrisThe application uris.
settingsThe request settings.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
An object which must be passed to the EndFindServers() method.
IAsyncResult UnifiedAutomation.UaClient.Discovery.BeginFindServers ( string  discoveryUrl,
AsyncCallback  callback,
object  userData 
)
inline

Finds the servers known to the discovery server.

Parameters
discoveryUrlThe discovery URL.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
An object which must be passed to the EndFindServers() method.
IAsyncResult UnifiedAutomation.UaClient.Discovery.BeginFindServersOnNetwork ( string  discoveryUrl,
uint  startingRecordId,
uint  maxRecordsToReturn,
IList< string >  serverCapabilityFilter,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)
inline

Finds the servers known to the discovery server.

Parameters
discoveryUrlThe discovery URL.
startingRecordIdThe starting record identifier.
maxRecordsToReturnThe maximum records to return.
serverCapabilityFilterThe server capability filter.
settingsThe request settings.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
An object which must be passed to the EndFindServersOnNetwork() method.
IAsyncResult UnifiedAutomation.UaClient.Discovery.BeginFindServersOnNetwork ( string  discoveryUrl,
string  transportProfileUri,
uint  startingRecordId,
uint  maxRecordsToReturn,
IList< string >  serverCapabilityFilter,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)
inline

Finds the servers known to the discovery server.

Parameters
discoveryUrlThe discovery URL.
transportProfileUriThe transport profile URI.
startingRecordIdThe starting record identifier.
maxRecordsToReturnThe maximum records to return.
serverCapabilityFilterThe server capability filter.
settingsThe request settings.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
An object which must be passed to the EndFindServersOnNetwork() method.
Exceptions
System.ArgumentExceptionURL does not appear to be valid.;discoveryUrl
IAsyncResult UnifiedAutomation.UaClient.Discovery.BeginFindServersOnNetwork ( string  discoveryUrl,
AsyncCallback  callback,
object  userData 
)
inline

Finds the servers known to the discovery server.

Parameters
discoveryUrlThe discovery URL.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
An object which must be passed to the EndFindServersOnNetwork() method.
IAsyncResult UnifiedAutomation.UaClient.Discovery.BeginGetEndpoints ( string  discoveryUrl,
List< string >  localeIds,
List< string >  profileUris,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)
inline

Begins the get endpoints.

Parameters
discoveryUrlThe discovery URL.
localeIdsThe locale ids.
profileUrisThe application uris.
settingsThe settings.
callbackThe callback.
userDataThe user data.
Returns
IAsyncResult UnifiedAutomation.UaClient.Discovery.BeginGetEndpoints ( string  discoveryUrl,
string  transportProfileUri,
List< string >  localeIds,
List< string >  profileUris,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)
inline

Begins the get endpoints.

Parameters
discoveryUrlThe discovery URL.
transportProfileUriThe transport profile URI.
localeIdsThe locale ids.
profileUrisThe application uris.
settingsThe settings.
callbackThe callback.
userDataThe user data.
Returns
IAsyncResult UnifiedAutomation.UaClient.Discovery.BeginGetEndpoints ( string  discoveryUrl,
AsyncCallback  callback,
object  userData 
)
inline

Begins the get endpoints.

Parameters
discoveryUrlThe discovery URL.
callbackThe callback.
userDataThe user data.
Returns
IAsyncResult UnifiedAutomation.UaClient.Discovery.BeginGetMostSecureEndpoint ( string  discoveryUrl,
AsyncCallback  callback,
object  userData 
)
inline

Begins a request for the most secure endpoint supported by a server.

Parameters
discoveryUrlThe server's discovery URL.
callbackThe callback.
userDataThe user data.
Returns
void UnifiedAutomation.UaClient.Discovery.Dispose ( )
inline

Frees any unmanaged resources.

virtual void UnifiedAutomation.UaClient.Discovery.Dispose ( bool  disposing)
inlineprotectedvirtual

An overrideable version of the Dispose.

List<ApplicationDescription> UnifiedAutomation.UaClient.Discovery.EndFindServers ( IAsyncResult  result)
inline

Completes an asynchronous disconnect operation.

Parameters
resultThe object returned from the BeginFindServers method.
Returns
List<ServerOnNetwork> UnifiedAutomation.UaClient.Discovery.EndFindServersOnNetwork ( IAsyncResult  result,
out DateTime  lastCounterResetTime 
)
inline

Completes an asynchronous disconnect operation.

Parameters
resultThe object returned from the BeginFindServersOnNetwork method.
lastCounterResetTimeThe last counter reset time.
Returns
The next batch of servers the known to the discovery server.
List<EndpointDescription> UnifiedAutomation.UaClient.Discovery.EndGetEndpoints ( IAsyncResult  result)
inline

Ends the get endpoints.

Parameters
resultThe result.
Returns
EndpointDescription UnifiedAutomation.UaClient.Discovery.EndGetMostSecureEndpoint ( IAsyncResult  result)
inline

Ends the get endpoints.

Parameters
resultThe result.
Returns
List<ApplicationDescription> UnifiedAutomation.UaClient.Discovery.FindServers ( string  discoveryUrl)
inline

Finds the servers known to the discovery server.

Parameters
discoveryUrlThe discovery URL.
Returns
List<ApplicationDescription> UnifiedAutomation.UaClient.Discovery.FindServers ( string  discoveryUrl,
List< string >  localeIds,
List< string >  applicationUris,
RequestSettings  settings 
)
inline

Finds the servers known to the discovery server.

Parameters
discoveryUrlThe discovery URL.
localeIdsThe locale ids.
applicationUrisThe application uris.
settingsThe request settings.
Returns
List<ApplicationDescription> UnifiedAutomation.UaClient.Discovery.FindServers ( string  discoveryUrl,
string  transportProfileUri,
List< string >  localeIds,
List< string >  applicationUris,
RequestSettings  settings 
)
inline

Finds the servers known to the discovery server.

Parameters
discoveryUrlThe discovery URL.
transportProfileUriThe transport profile URI.
localeIdsThe locale ids.
applicationUrisThe application uris.
settingsThe request settings.
Returns
List<ServerOnNetwork> UnifiedAutomation.UaClient.Discovery.FindServersOnNetwork ( string  discoveryUrl)
inline

Finds the servers known to the discovery server.

Parameters
discoveryUrlThe discovery URL.
Returns
The first batch of servers known to the discovery server.
List<ServerOnNetwork> UnifiedAutomation.UaClient.Discovery.FindServersOnNetwork ( string  discoveryUrl,
uint  startingRecordId,
uint  maxRecordsToReturn,
IList< string >  serverCapabilityFilter,
RequestSettings  settings,
out DateTime  lastCounterResetTime 
)
inline

Finds the servers known to the discovery server.

Parameters
discoveryUrlThe discovery URL.
startingRecordIdThe starting record identifier.
maxRecordsToReturnThe maximum records to return.
serverCapabilityFilterThe server capability filters.
settingsThe request settings.
lastCounterResetTimeThe last counter reset time.
Returns
The next batch of servers the known to the discovery server.
List<ServerOnNetwork> UnifiedAutomation.UaClient.Discovery.FindServersOnNetwork ( string  discoveryUrl,
string  transportProfileUri,
uint  startingRecordId,
uint  maxRecordsToReturn,
IList< string >  serverCapabilityFilter,
RequestSettings  settings,
out DateTime  lastCounterResetTime 
)
inline

Finds the servers known to the discovery server.

Parameters
discoveryUrlThe discovery URL.
transportProfileUriThe transport profile URI.
startingRecordIdThe starting record identifier.
maxRecordsToReturnThe maximum records to return.
serverCapabilityFilterThe server capability filter.
settingsThe request settings.
lastCounterResetTimeThe last counter reset time.
Returns
The next batch of servers the known to the discovery server.
List<EndpointDescription> UnifiedAutomation.UaClient.Discovery.GetEndpoints ( string  discoveryUrl)
inline

Gets the endpoints.

Parameters
discoveryUrlThe discovery URL.
Returns
List<EndpointDescription> UnifiedAutomation.UaClient.Discovery.GetEndpoints ( string  discoveryUrl,
List< string >  localeIds,
List< string >  profileUris,
RequestSettings  settings 
)
inline

Gets the endpoints.

Parameters
discoveryUrlThe discovery URL.
localeIdsThe locale ids.
profileUrisThe profile uris.
settingsThe settings.
Returns
List<EndpointDescription> UnifiedAutomation.UaClient.Discovery.GetEndpoints ( string  discoveryUrl,
string  transportProfileUri,
List< string >  localeIds,
List< string >  profileUris,
RequestSettings  settings 
)
inline

Gets the endpoints.

Parameters
discoveryUrlThe discovery URL.
transportProfileUriThe transport profile URI.
localeIdsThe locale ids.
profileUrisThe profile uris.
settingsThe settings.
Returns
EndpointDescription UnifiedAutomation.UaClient.Discovery.GetMostSecureEndpoint ( string  discoveryUrl)
inline

Returns the most secure endpoint supported by a server.

Parameters
discoveryUrlThe server's discovery URL.
Returns
The most secure endpoint.

Property Documentation

ApplicationInstance UnifiedAutomation.UaClient.Discovery.Application
get

Gets the application.

RequestSettings UnifiedAutomation.UaClient.Discovery.DefaultRequestSettings
getset

Gets or sets the default request settings.

The default request settings.

int UnifiedAutomation.UaClient.Discovery.SecureChannelTimeout
getset

Gets or sets the secure channel timeout.

The secure channel timeout.


The documentation for this class was generated from the following file: