High Performance OPC UA Server SDK  1.1.0.158
ua_serverstate

An enumeration that defines the execution state of the Server. More...

Enumerations

enum  ua_serverstate {
  UA_SERVERSTATE_RUNNING = 0, UA_SERVERSTATE_FAILED = 1, UA_SERVERSTATE_NOCONFIGURATION = 2, UA_SERVERSTATE_SUSPENDED = 3,
  UA_SERVERSTATE_SHUTDOWN = 4, UA_SERVERSTATE_TEST = 5, UA_SERVERSTATE_COMMUNICATIONFAULT = 6, UA_SERVERSTATE_UNKNOWN = 7,
  UA_SERVERSTATE_MAX_ENUM_VALUE = INT32_MAX
}
 An enumeration that defines the execution state of the Server. More...
 

Functions

const char * ua_serverstate_to_string (enum ua_serverstate serverstate)
 

Detailed Description

An enumeration that defines the execution state of the Server.

Enumeration Type Documentation

An enumeration that defines the execution state of the Server.

Enumerator
UA_SERVERSTATE_RUNNING 

The server is running normally.

This is the usual state for a server.

UA_SERVERSTATE_FAILED 

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.

UA_SERVERSTATE_NOCONFIGURATION 

The server is running but has no configuration information loaded and therefore does not transfer data.

UA_SERVERSTATE_SUSPENDED 

The server has been temporarily suspended by some vendor-specific method and is not receiving or sending data.

UA_SERVERSTATE_SHUTDOWN 

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.

UA_SERVERSTATE_TEST 

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.

UA_SERVERSTATE_COMMUNICATIONFAULT 

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.

UA_SERVERSTATE_UNKNOWN 

This state is used only to indicate that the OPC UA server does not know the state of underlying servers.