.NET Based OPC UA Client/Server SDK  3.0.10.493
UnifiedAutomation.UaBase.RegisteredServer Class Reference

The server to register More...

Inherits UnifiedAutomation.UaBase.IEncodeable.

Public Member Functions

 RegisteredServer ()
 The default constructor. More...
 
virtual void Encode (IEncoder encoder)
 
virtual void Decode (IDecoder decoder)
 
virtual bool IsEqual (IEncodeable encodeable)
 Checks if encodeable is the same object or has the same content More...
 
virtual object Clone ()
 

Properties

string ServerUri [get, set]
 The globally unique identifier for the Server instance. More...
 
string ProductUri [get, set]
 The globally unique identifier for the Server product. More...
 
LocalizedTextCollection ServerNames [get, set]
 A list of localized descriptive names for the Server. More...
 
ApplicationType ServerType [get, set]
 The type of application. More...
 
string GatewayServerUri [get, set]
 The URI of the Gateway Server associated with the DiscoveryUrls. More...
 
StringCollection DiscoveryUrls [get, set]
 A list of Discovery Endpoints for the Server. More...
 
string SemaphoreFilePath [get, set]
 The path to the semaphore file used to identify an automatically-launched server instance. More...
 
bool IsOnline [get, set]
 True if the Server is currently able to accept connections from Clients. More...
 
virtual ExpandedNodeId TypeId [get]
 
virtual ExpandedNodeId BinaryEncodingId [get]
 
virtual ExpandedNodeId XmlEncodingId [get]
 
- Properties inherited from UnifiedAutomation.UaBase.IEncodeable
ExpandedNodeId TypeId [get]
 Returns the UA type identifier for the encodable type. More...
 
ExpandedNodeId BinaryEncodingId [get]
 Returns the UA type identifier for the default binary encoding for the type. More...
 
ExpandedNodeId XmlEncodingId [get]
 Returns the UA type identifier for the default XML encoding for the type. More...
 

Detailed Description

The server to register

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.RegisteredServer.RegisteredServer ( )
inline

The default constructor.

Member Function Documentation

virtual bool UnifiedAutomation.UaBase.RegisteredServer.IsEqual ( IEncodeable  encodeable)
inlinevirtual

Checks if encodeable is the same object or has the same content

Parameters
encodeable
Returns

Implements UnifiedAutomation.UaBase.IEncodeable.

Property Documentation

StringCollection UnifiedAutomation.UaBase.RegisteredServer.DiscoveryUrls
getset

A list of Discovery Endpoints for the Server.

The list shall have at least one valid entry.

string UnifiedAutomation.UaBase.RegisteredServer.GatewayServerUri
getset

The URI of the Gateway Server associated with the DiscoveryUrls.

This value is only specified by Gateway Servers that wish to register the Servers that they provide access to.

For Servers that do not act as a Gateway Server this parameter shall be null.

bool UnifiedAutomation.UaBase.RegisteredServer.IsOnline
getset

True if the Server is currently able to accept connections from Clients.

The DiscoveryServer shall return ApplicationDescriptions to the Client.

The Server is expected to periodically re-register with the DiscoveryServer.

False if the Server is currently unable to accept connections from Clients. The DiscoveryServer shall NOT return ApplicationDescriptions to the Client.

This parameter is ignored if a semaphoreFilePath is provided.

string UnifiedAutomation.UaBase.RegisteredServer.ProductUri
getset

The globally unique identifier for the Server product.

string UnifiedAutomation.UaBase.RegisteredServer.SemaphoreFilePath
getset

The path to the semaphore file used to identify an automatically-launched server instance.

Manually-launched servers will not use this parameter.

If a Semaphore file is provided, the IsOnline flag is ignored.

If a Semaphore file is provided and exists, the LocalDiscoveryServer shall save the registration information in a persistent data store that it reads whenever the LocalDiscoveryServer starts.

If a Semaphore file is specified but does not exist, the Discovery Server shall remove the registration from any persistent data store.

If the Server has registered with a semaphoreFilePath, the DiscoveryServer shall check that this file exists before returning the ApplicationDescription to the client.

If the Server did not register with a semaphoreFilePath (it is null or empty), then the DiscoveryServer does not attempt to verify the existence of the file before returning the ApplicationDescription to the client.

LocalizedTextCollection UnifiedAutomation.UaBase.RegisteredServer.ServerNames
getset

A list of localized descriptive names for the Server.

The list shall have at least one valid entry.

ApplicationType UnifiedAutomation.UaBase.RegisteredServer.ServerType
getset

The type of application.

The value “Client” (The application is a Client) is not allowed. The Service result shall be Bad_InvalidArgument in this case.

string UnifiedAutomation.UaBase.RegisteredServer.ServerUri
getset

The globally unique identifier for the Server instance.

The serverUri matches the applicationUri from the ApplicationDescription.


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