 |
High Performance OPC UA Server SDK
1.2.0.193
|
|
High Performance OPC UA Server SDK
1.2.0.193
|
Contains diagnostic information about subscriptions. More...
#include <subscriptiondiagnosticsdatatype.h>
Data Fields | |
| struct ua_nodeid | session_id |
| Server-assigned identifier of the session the subscription belongs to. | |
| uint32_t | subscription_id |
| Server-assigned identifier of the subscription. | |
| uint8_t | priority |
| The priority the client assigned to the subscription. | |
| double | publishing_interval |
| The publishing interval of the subscription in milliseconds. | |
| uint32_t | max_keep_alive_count |
| The maximum keep-alive count of the subscription. | |
| uint32_t | max_lifetime_count |
| The maximum lifetime count of the subscription. | |
| uint32_t | max_notifications_per_publish |
| The maximum number of notifications per publish response. | |
| bool | publishing_enabled |
| Whether publishing is enabled for the subscription. | |
| uint32_t | modify_count |
| The number of ModifySubscription requests received for the subscription. | |
| uint32_t | enable_count |
| The number of times the subscription has been enabled. | |
| uint32_t | disable_count |
| The number of times the subscription has been disabled. | |
| uint32_t | republish_request_count |
| The number of Republish Service requests that have been received and processed for the subscription. | |
| uint32_t | republish_message_request_count |
| The total number of messages that have been requested to be republished for the subscription. More... | |
| uint32_t | republish_message_count |
| The number of messages that have been successfully republished for the subscription. | |
| uint32_t | transfer_request_count |
| The total number of TransferSubscriptions Service requests that have been received for the subscription. | |
| uint32_t | transferred_to_alt_client_count |
| The number of times the subscription has been transferred to an alternate client. | |
| uint32_t | transferred_to_same_client_count |
| The number of times the subscription has been transferred to an alternate session for the same client. | |
| uint32_t | publish_request_count |
| The number of Publish Service requests that have been received and processed for the subscription. | |
| uint32_t | data_change_notifications_count |
| The number of data change Notifications sent by the subscription. | |
| uint32_t | event_notifications_count |
| The number of Event Notifications sent by the subscription. | |
| uint32_t | notifications_count |
| The total number of Notifications sent by the subscription. | |
| uint32_t | late_publish_request_count |
| The number of times the subscription has entered the LATE State, i.e. More... | |
| uint32_t | current_keep_alive_count |
| The number of times the subscription has entered the KEEPALIVE State. | |
| uint32_t | current_lifetime_count |
| The current lifetime count of the subscription. | |
| uint32_t | unacknowledged_message_count |
| The number of unacknowledged messages saved in the republish queue. | |
| uint32_t | discarded_message_count |
| The number of messages that were discarded before they were acknowledged. | |
| uint32_t | monitored_item_count |
| The total number of monitored items of the subscription, including the disabled monitored items. | |
| uint32_t | disabled_monitored_item_count |
| The number of disabled monitored items of the subscription. | |
| uint32_t | monitoring_queue_overflow_count |
| The number of times a monitored item dropped notifications because of a queue overflow. | |
| uint32_t | next_sequence_number |
| Sequence number for the next notification message. | |
| uint32_t | event_queue_over_flow_count |
| The number of times a monitored item in the subscription has generated an Event of type EventQueueOverflowEventType. | |
Related Functions | |
| void | ua_subscriptiondiagnosticsdatatype_init (struct ua_subscriptiondiagnosticsdatatype *t) |
| Initialize an ua_subscriptiondiagnosticsdatatype struct with a valid value. More... | |
| void | ua_subscriptiondiagnosticsdatatype_clear (struct ua_subscriptiondiagnosticsdatatype *t) |
| Clear all resources alloctated in an ua_subscriptiondiagnosticsdatatype struct. More... | |
| int | ua_subscriptiondiagnosticsdatatype_compare (const struct ua_subscriptiondiagnosticsdatatype *a, const struct ua_subscriptiondiagnosticsdatatype *b) |
| Compare two ua_subscriptiondiagnosticsdatatype structs. More... | |
| int | ua_subscriptiondiagnosticsdatatype_copy (struct ua_subscriptiondiagnosticsdatatype *dst, const struct ua_subscriptiondiagnosticsdatatype *src) |
| Create a copy of a ua_subscriptiondiagnosticsdatatype struct. More... | |
Contains diagnostic information about subscriptions.
|
related |
Clear all resources alloctated in an ua_subscriptiondiagnosticsdatatype struct.
Frees allocated memory like arrays and resets numeric values. The ua_subscriptiondiagnosticsdatatype struct itself is not freed and must be freed by the caller if required. This function always succeeds for a valid ua_subscriptiondiagnosticsdatatype struct, that was validly decoded, initilized by ua_subscriptiondiagnosticsdatatype_init or created with ua_subscriptiondiagnosticsdatatype_copy.
|
related |
Compare two ua_subscriptiondiagnosticsdatatype structs.
Compares the content of the ua_subscriptiondiagnosticsdatatype struct a to the content of the ua_subscriptiondiagnosticsdatatype 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_subscriptiondiagnosticsdatatype 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_subscriptiondiagnosticsdatatype struct.
Copy all fields from struct ua_subscriptiondiagnosticsdatatype 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_subscriptiondiagnosticsdatatype 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_subscriptiondiagnosticsdatatype struct can also be passed to ua_subscriptiondiagnosticsdatatype_compare, ua_subscriptiondiagnosticsdatatype_copy and ua_subscriptiondiagnosticsdatatype_clear. This function will always succeed as long as an ua_subscriptiondiagnosticsdatatype struct is passed to it.
| late_publish_request_count |
The number of times the subscription has entered the LATE State, i.e.
the number of times the publish timer expires and there are unsent notifications.
| republish_message_request_count |
The total number of messages that have been requested to be republished for the subscription.
Note that due to the design of the Republish Service this number is always equal to the republishRequestCount.