.NET Based OPC UA Client/Server SDK  3.1.0.500
UnifiedAutomation.UaBase.DiscoveryClient Class Reference

The client side interface for a UA server. More...

Inherits UnifiedAutomation.UaBase.ClientBase.

Public Member Functions

 DiscoveryClient (ITransportChannel channel)
 Intializes the object with a channel and a message context. More...
 
virtual ResponseHeader FindServers (RequestHeader requestHeader, string endpointUrl, StringCollection localeIds, StringCollection serverUris, out ApplicationDescriptionCollection servers)
 Invokes the FindServers service. More...
 
IAsyncResult BeginFindServers (RequestHeader requestHeader, string endpointUrl, StringCollection localeIds, StringCollection serverUris, AsyncCallback callback, object asyncState)
 Begins an asynchronous invocation of the FindServers service. More...
 
ResponseHeader EndFindServers (IAsyncResult result, out ApplicationDescriptionCollection servers)
 Finishes an asynchronous invocation of the FindServers service. More...
 
virtual ResponseHeader FindServersOnNetwork (RequestHeader requestHeader, uint startingRecordId, uint maxRecordsToReturn, StringCollection serverCapabilityFilter, out DateTime lastCounterResetTime, out ServerOnNetworkCollection servers)
 Invokes the FindServersOnNetwork service. More...
 
IAsyncResult BeginFindServersOnNetwork (RequestHeader requestHeader, uint startingRecordId, uint maxRecordsToReturn, StringCollection serverCapabilityFilter, AsyncCallback callback, object asyncState)
 Begins an asynchronous invocation of the FindServersOnNetwork service. More...
 
ResponseHeader EndFindServersOnNetwork (IAsyncResult result, out DateTime lastCounterResetTime, out ServerOnNetworkCollection servers)
 Finishes an asynchronous invocation of the FindServersOnNetwork service. More...
 
virtual ResponseHeader GetEndpoints (RequestHeader requestHeader, string endpointUrl, StringCollection localeIds, StringCollection profileUris, out EndpointDescriptionCollection endpoints)
 Invokes the GetEndpoints service. More...
 
IAsyncResult BeginGetEndpoints (RequestHeader requestHeader, string endpointUrl, StringCollection localeIds, StringCollection profileUris, AsyncCallback callback, object asyncState)
 Begins an asynchronous invocation of the GetEndpoints service. More...
 
ResponseHeader EndGetEndpoints (IAsyncResult result, out EndpointDescriptionCollection endpoints)
 Finishes an asynchronous invocation of the GetEndpoints service. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaBase.ClientBase
 ClientBase (ITransportChannel channel)
 Intializes the object with a channel and a message context. More...
 
void Dispose ()
 Frees any unmanaged resources. More...
 
virtual void Close ()
 Closes the channel. More...
 

Static Public Member Functions

static DiscoveryClient Create (ApplicationInstanceBase application, EndpointConfiguration configuration, Uri discoveryUrl, string transportProfileUri, ApplicationThreadPool threadPool, IncomingReverseConnectionGroup connectionGroup=null, int timeout=Timeout.Infinite)
 Creates a binding for to use for discovering servers. More...
 
- Static Public Member Functions inherited from UnifiedAutomation.UaBase.ClientBase
static void ValidateResponse (IList response, IList request)
 Validates a response returned by the server. More...
 
static void ValidateDiagnosticInfos (DiagnosticInfoCollection response, IList request)
 Validates a response returned by the server. More...
 

Additional Inherited Members

- Protected Member Functions inherited from UnifiedAutomation.UaBase.ClientBase
virtual void Dispose (bool disposing)
 An overrideable version of the Dispose. More...
 
void CloseChannel ()
 Closes the channel. More...
 
void UpdateRequestHeader (IServiceRequest request, bool useDefaults, string serviceName)
 Updates the header of a service request. More...
 
virtual void RequestCompleted (IServiceRequest request, IServiceResponse response, string serviceName)
 Called when a request completes. More...
 
- Static Protected Member Functions inherited from UnifiedAutomation.UaBase.ClientBase
static void ValidateResponse (ResponseHeader header)
 Throws an exception if a response contains an error. More...
 
static bool IsTransportChannelRequired (EndpointDescription endpoint)
 Determines whether a transport channel required for the specified endpoint. More...
 
- Properties inherited from UnifiedAutomation.UaBase.ClientBase
ITransportChannel TransportChannel [get, protected set]
 Gets or set the channel being wrapped by the client object. More...
 
EndpointDescription EndpointDescription [get]
 The channel being wrapped by the client object. More...
 
EndpointConfiguration EndpointConfiguration [get]
 The channel being wrapped by the client object. More...
 
MessageContext MessageContext [get]
 Gets the message context. More...
 
int DefaultOperationTimeout [get, set]
 Sets the timeout for an operation. More...
 
bool UseTransportChannel [get]
 Gets a value that indicates whether to use the TransportChannel when sending requests. More...
 
bool Disposed [get]
 Whether the object has been disposed. More...
 

Detailed Description

The client side interface for a UA server.

An object used by clients to access a UA discovery service.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.DiscoveryClient.DiscoveryClient ( ITransportChannel  channel)
inline

Intializes the object with a channel and a message context.

Member Function Documentation

IAsyncResult UnifiedAutomation.UaBase.DiscoveryClient.BeginFindServers ( RequestHeader  requestHeader,
string  endpointUrl,
StringCollection  localeIds,
StringCollection  serverUris,
AsyncCallback  callback,
object  asyncState 
)
inline

Begins an asynchronous invocation of the FindServers service.

IAsyncResult UnifiedAutomation.UaBase.DiscoveryClient.BeginFindServersOnNetwork ( RequestHeader  requestHeader,
uint  startingRecordId,
uint  maxRecordsToReturn,
StringCollection  serverCapabilityFilter,
AsyncCallback  callback,
object  asyncState 
)
inline

Begins an asynchronous invocation of the FindServersOnNetwork service.

IAsyncResult UnifiedAutomation.UaBase.DiscoveryClient.BeginGetEndpoints ( RequestHeader  requestHeader,
string  endpointUrl,
StringCollection  localeIds,
StringCollection  profileUris,
AsyncCallback  callback,
object  asyncState 
)
inline

Begins an asynchronous invocation of the GetEndpoints service.

static DiscoveryClient UnifiedAutomation.UaBase.DiscoveryClient.Create ( ApplicationInstanceBase  application,
EndpointConfiguration  configuration,
Uri  discoveryUrl,
string  transportProfileUri,
ApplicationThreadPool  threadPool,
IncomingReverseConnectionGroup  connectionGroup = null,
int  timeout = Timeout.Infinite 
)
inlinestatic

Creates a binding for to use for discovering servers.

Parameters
applicationThe application.
configurationThe configuration.
discoveryUrlThe discovery URL.
transportProfileUriThe transport profile URI.
threadPoolThe thread pool.
connectionGroupThe incoming connection group.
timeoutHow long to wait for a cnnection.
Returns
The new client.
ResponseHeader UnifiedAutomation.UaBase.DiscoveryClient.EndFindServers ( IAsyncResult  result,
out ApplicationDescriptionCollection  servers 
)
inline

Finishes an asynchronous invocation of the FindServers service.

ResponseHeader UnifiedAutomation.UaBase.DiscoveryClient.EndFindServersOnNetwork ( IAsyncResult  result,
out DateTime  lastCounterResetTime,
out ServerOnNetworkCollection  servers 
)
inline

Finishes an asynchronous invocation of the FindServersOnNetwork service.

ResponseHeader UnifiedAutomation.UaBase.DiscoveryClient.EndGetEndpoints ( IAsyncResult  result,
out EndpointDescriptionCollection  endpoints 
)
inline

Finishes an asynchronous invocation of the GetEndpoints service.

virtual ResponseHeader UnifiedAutomation.UaBase.DiscoveryClient.FindServers ( RequestHeader  requestHeader,
string  endpointUrl,
StringCollection  localeIds,
StringCollection  serverUris,
out ApplicationDescriptionCollection  servers 
)
inlinevirtual

Invokes the FindServers service.

virtual ResponseHeader UnifiedAutomation.UaBase.DiscoveryClient.FindServersOnNetwork ( RequestHeader  requestHeader,
uint  startingRecordId,
uint  maxRecordsToReturn,
StringCollection  serverCapabilityFilter,
out DateTime  lastCounterResetTime,
out ServerOnNetworkCollection  servers 
)
inlinevirtual

Invokes the FindServersOnNetwork service.

virtual ResponseHeader UnifiedAutomation.UaBase.DiscoveryClient.GetEndpoints ( RequestHeader  requestHeader,
string  endpointUrl,
StringCollection  localeIds,
StringCollection  profileUris,
out EndpointDescriptionCollection  endpoints 
)
inlinevirtual

Invokes the GetEndpoints service.


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