UAServerState Enumeration

This DataType is an enumeration that defines the execution state of the Server.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ComVisibleAttribute(False)>
Public Enum UAServerState 
   Inherits System.Enum
   Implements System.IComparable, System.IConvertible, System.IFormattable

'Usage
 
Dim instance As UAServerState

[ComVisible(false)]
public enum UAServerState : System.Enum, System.IComparable, System.IConvertible, System.IFormattable

[ComVisible(false)]
public enum class UAServerState : public System.Enum, System.IComparable, System.IConvertible, System.IFormattable

Members

Member	Value	Description
CommunicationFault	6	The server is running properly, but is having difficulty accessing data from its data sources. This may be due to communication problems or some other problem preventing the underlying device, control system, etc. from returning valid data. It may be a complete failure, meaning that no data is available, or a partial failure, meaning that some data is still available. It is expected that items affected by the fault will individually return with a BAD FAILURE status code indication for the items. The value of this enum member is `6`.
Failed	1	A vendor-specific fatal error has occurred within the server. The server is no longer functioning. The recovery procedure from this situation is vendor-specific. Most Service requests should be expected to fail. The value of this enum member is `1`.
NoConfiguration	2	The server is running but has no configuration information loaded and therefore does not transfer data. The value of this enum member is `2`.
Running	0	The server is running normally. This is the usual state for a server. The value of this enum member is `0`.
Shutdown	4	The server has shut down or is in the process of shutting down. Depending on the implementation, this might or might not be visible to clients. The value of this enum member is `4`.
Suspended	3	The server has been temporarily suspended by some vendor-specific method and is not receiving or sending data. The value of this enum member is `3`.
Test	5	The server is in Test Mode. The outputs are disconnected from the real hardware, but the server will otherwise behave normally. Inputs may be real or may be simulated depending on the vendor implementation. StatusCode will generally be returned normally. The value of this enum member is `5`.
Unknown	7	This state is used only to indicate that the OPC UA server does not know the state of underlying servers. The value of this enum member is `7`.

Inheritance Hierarchy

System.Object
   System.ValueType
      System.Enum
         OpcLabs.EasyOpc.UA.UAServerState

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

OpcLabs.EasyOpc.UA Namespace

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.