.NET Based OPC UA Client/Server SDK  3.3.3.537
UnifiedAutomation.UaClient.GdsRegisterManagement Class Reference

Automatically registers an application at a Global Discovery Server. More...

Inherits UnifiedAutomation.UaBase.IGlobalDiscoveryService.

Inherited by UnifiedAutomation.UaClient.GdsPullManagement.

Public Member Functions

 GdsRegisterManagement (ApplicationInstanceBase application)
 Creates an instance of GdsRegisterManagement. More...
 
void Dispose ()
 
virtual void Start (GdsSettings settings)
 Starts the registering process. More...
 
virtual void Stop ()
 Starts the unregistering process. More...
 

Protected Member Functions

void DisposeMembers ()
 Disconnects the GdsRegisterManagement.Session and disposes GdsRegisterManagement.Client and GdsRegisterManagement.Session. More...
 
virtual async void DoIntialGdsIntercation (object state)
 Periodically tries to register the application at the GDS. More...
 
async Task ConnectToGdsAsync ()
 Connects to the GDS. More...
 
async Task RegisterIfRequiredAsync ()
 Checks if the application already has been registered and registers it if required. More...
 
virtual void OnApplicationIdUpdated ()
 Is called after ApplicationId was updated. More...
 

Properties

ApplicationInstanceBase Application [get]
 The managed application instance. More...
 
GdsSettings Settings [get, set]
 The configured settings. More...
 
Session Session [get]
 The Session for communicating with the GDS by GdsRegisterManagement.Client. More...
 
CertificateDirectoryClient Client [get, set]
 The CertificateDirectoryClient used for communicating with the GDS. More...
 
Timer Timer [get, set]
 The Timer for initial GDS interaction and periodic status checks (subclasses only). More...
 
NodeId ApplicationId [get]
 The ApplicationId returned by the GDS. More...
 
int OperationTimeout [get, set]
 The default OperationTimeout in milliseconds. More...
 

Events

EventHandler
< BeforeConnectEventArgs
BeforeConnect
 Is called before the Session to the Gds will connect. Can be used to update the user credentials. More...
 
EventHandler
< ActionFailedEventArgs
ConnectFailed
 Is called if the client could not connect to the GDS. More...
 
EventHandler
< ApplicationRegisteredEventArgs
ApplicationRegistered
 Is called after the application has been registered at the GDS. More...
 
EventHandler
< ActionFailedEventArgs
RegisterApplicationFailed
 Is called if registering failed. More...
 
EventHandler< EventArgs > ApplicationUnregistered
 Is called in the application has been unregistered after calling the GdsRegisterManagement.Stop method. More...
 

Detailed Description

Automatically registers an application at a Global Discovery Server.

This class shall be used on server side. It shall be set at UaBase.ApplicationInstanceBase.GdsHandler and the UaSchema.GdsSettings shall be set in the application configuration.

Constructor & Destructor Documentation

UnifiedAutomation.UaClient.GdsRegisterManagement.GdsRegisterManagement ( ApplicationInstanceBase  application)

Creates an instance of GdsRegisterManagement.

Parameters
applicationThe application instance to register.

Member Function Documentation

async Task UnifiedAutomation.UaClient.GdsRegisterManagement.ConnectToGdsAsync ( )
protected

Connects to the GDS.

Creates Session and Client.

void UnifiedAutomation.UaClient.GdsRegisterManagement.DisposeMembers ( )
protected
virtual async void UnifiedAutomation.UaClient.GdsRegisterManagement.DoIntialGdsIntercation ( object  state)
protectedvirtual

Periodically tries to register the application at the GDS.

Is called by a Timer started in the GdsRegisterManagement.Start method.

The cycle time is the configured RetryFrequency in the GdsRegisterManagement.Settings. The Timer gets stopped after registering the application was successful.

Reimplemented in UnifiedAutomation.UaClient.GdsPullManagement.

virtual void UnifiedAutomation.UaClient.GdsRegisterManagement.OnApplicationIdUpdated ( )
protectedvirtual

Is called after ApplicationId was updated.

Reimplemented in UnifiedAutomation.UaClient.GdsPullManagement.

async Task UnifiedAutomation.UaClient.GdsRegisterManagement.RegisterIfRequiredAsync ( )
protected

Checks if the application already has been registered and registers it if required.

virtual void UnifiedAutomation.UaClient.GdsRegisterManagement.Start ( GdsSettings  settings)
virtual

Starts the registering process.

Parameters
settingsThe settings from the application configuration.
Exceptions
Exception
virtual void UnifiedAutomation.UaClient.GdsRegisterManagement.Stop ( )
virtual

Starts the unregistering process.

Property Documentation

ApplicationInstanceBase UnifiedAutomation.UaClient.GdsRegisterManagement.Application
getprotected

The managed application instance.

NodeId UnifiedAutomation.UaClient.GdsRegisterManagement.ApplicationId
getprotected

The ApplicationId returned by the GDS.

CertificateDirectoryClient UnifiedAutomation.UaClient.GdsRegisterManagement.Client
getsetprotected

The CertificateDirectoryClient used for communicating with the GDS.

int UnifiedAutomation.UaClient.GdsRegisterManagement.OperationTimeout
getset

The default OperationTimeout in milliseconds.

If 0, the OperationTimeout of Session.DefaultRequestSettings is used.

Session UnifiedAutomation.UaClient.GdsRegisterManagement.Session
getprotected

The Session for communicating with the GDS by GdsRegisterManagement.Client.

GdsSettings UnifiedAutomation.UaClient.GdsRegisterManagement.Settings
getsetprotected

The configured settings.

Timer UnifiedAutomation.UaClient.GdsRegisterManagement.Timer
getsetprotected

The Timer for initial GDS interaction and periodic status checks (subclasses only).

Event Documentation

EventHandler<ApplicationRegisteredEventArgs> UnifiedAutomation.UaClient.GdsRegisterManagement.ApplicationRegistered

Is called after the application has been registered at the GDS.

EventHandler<EventArgs> UnifiedAutomation.UaClient.GdsRegisterManagement.ApplicationUnregistered

Is called in the application has been unregistered after calling the GdsRegisterManagement.Stop method.

EventHandler<BeforeConnectEventArgs> UnifiedAutomation.UaClient.GdsRegisterManagement.BeforeConnect

Is called before the Session to the Gds will connect. Can be used to update the user credentials.

EventHandler<ActionFailedEventArgs> UnifiedAutomation.UaClient.GdsRegisterManagement.ConnectFailed

Is called if the client could not connect to the GDS.

EventHandler<ActionFailedEventArgs> UnifiedAutomation.UaClient.GdsRegisterManagement.RegisterApplicationFailed

Is called if registering failed.


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