 |
High Performance OPC UA Server SDK
1.2.0.193
|
|
High Performance OPC UA Server SDK
1.2.0.193
|
Contains elements that describe the status of the Server. More...
#include <serverstatusdatatype.h>
Data Fields | |
| ua_datetime | start_time |
| Time (UTC) the server was started. More... | |
| ua_datetime | current_time |
| The current time (UTC) as known by the server. | |
| enum ua_serverstate | state |
| The current state of the server. | |
| struct ua_buildinfo | build_info |
| Build information of the server. | |
| uint32_t | seconds_till_shutdown |
| Approximate number of seconds until the server will be shut down. More... | |
| struct ua_localizedtext | shutdown_reason |
| An optional localized text indicating the reason for the shutdown. More... | |
Related Functions | |
| void | ua_serverstatusdatatype_init (struct ua_serverstatusdatatype *t) |
| Initialize an ua_serverstatusdatatype struct with a valid value. More... | |
| void | ua_serverstatusdatatype_clear (struct ua_serverstatusdatatype *t) |
| Clear all resources alloctated in an ua_serverstatusdatatype struct. More... | |
| int | ua_serverstatusdatatype_compare (const struct ua_serverstatusdatatype *a, const struct ua_serverstatusdatatype *b) |
| Compare two ua_serverstatusdatatype structs. More... | |
| int | ua_serverstatusdatatype_copy (struct ua_serverstatusdatatype *dst, const struct ua_serverstatusdatatype *src) |
| Create a copy of a ua_serverstatusdatatype struct. More... | |
Contains elements that describe the status of the Server.
|
related |
Clear all resources alloctated in an ua_serverstatusdatatype struct.
Frees allocated memory like arrays and resets numeric values. The ua_serverstatusdatatype struct itself is not freed and must be freed by the caller if required. This function always succeeds for a valid ua_serverstatusdatatype struct, that was validly decoded, initilized by ua_serverstatusdatatype_init or created with ua_serverstatusdatatype_copy.
|
related |
Compare two ua_serverstatusdatatype structs.
Compares the content of the ua_serverstatusdatatype struct a to the content of the ua_serverstatusdatatype struct b. If a is smaller than b, an integer less than zero is returned, if a is bigger than b, an integer greater than zero is returned. If both structs are equal zero is returned.
This function creates a total order on ua_serverstatusdatatype structs, so it is well suited to not only determine equality, but also sort multiple instances of this struct.
|
related |
Create a copy of a ua_serverstatusdatatype struct.
Copy all fields from struct ua_serverstatusdatatype src to dst. Creates a deep copy so all content is recusively copied and both src and dst can be used and must be freed separately.
dst is not cleared before the copy operation, so it must not have any allocated data. It may or may not be initilized by the caller before copy.
|
related |
Initialize an ua_serverstatusdatatype struct with a valid value.
After initialization the fields of the struct are set to valid and consistent values and can safley be accessed. An initialized ua_serverstatusdatatype struct can also be passed to ua_serverstatusdatatype_compare, ua_serverstatusdatatype_copy and ua_serverstatusdatatype_clear. This function will always succeed as long as an ua_serverstatusdatatype struct is passed to it.
| seconds_till_shutdown |
Approximate number of seconds until the server will be shut down.
The value is only relevant once the state changes into SHUTDOWN.
| shutdown_reason |
An optional localized text indicating the reason for the shutdown.
The value is only relevant once the state changes into SHUTDOWN.
| start_time |
Time (UTC) the server was started.
This is constant for the server instance and is not reset when the server changes state. Each instance of a server should keep the time when the process started.