Connection Diagnostic Items
- Last UpdatedMar 27, 2017
- 2 minute read
The connection object contains diagnostic items for a specific connection. The following syntax can be used to access a connection diagnostic item:
$SYS$DIAG/Conn=<ConnIndex>/<Item>
Where:
-
<ConnIndex> is a connection index in the range of 0 to n and always 0 in case of OI Gateway as it supports 1 connection for 1 hierarchy.
-
<Item> is one of the diagnostic item names from the following table.
If the <ConnIndex> does not exists, then 0 will be updated for item of type Integer/Float and "" (blank) will updated for item of type string. Quality of these items will stay as Good.
|
<Item> |
Type |
R/W |
Description |
|
ItemCount |
Int32 |
R |
Number of registered items in this connection. |
|
SubscriptionCount |
Int32 |
R |
Number of subscriptions in this connection. |
|
MonitoredItemCount |
Int32 |
R |
Number of monitored items in all subscriptions in this connection. |
|
MonitoredItemErrCount |
Int32 |
R |
Number of items with bad quality in all subscriptions in this connection. |
|
TotalReads |
Int32 |
R |
Number of reads operations in this connection since connection creation or last reset. |
|
TotalReadErrors |
Int32 |
R |
Number of read operation errors in this connection since service start or last reset. ( An error is counted if 1 or more item reads failed, or the entire read could not be executed ) |
|
TotalItemReads |
Int32 |
R |
Number of read items in this connection since connection creation or last reset. (Does not include subscription updates or items in the diagnostic namespace) |
|
TotalItemReadErrors |
Int32 |
R |
Number of read item errors in this connection since service start or last reset. (Does not include subscription updates or items in the diagnostic namespace.) |
|
TotalWrites |
Int32 |
R |
Number of writes operations in this connection since connection creation or last reset |
|
TotalWriteErrors |
Int32 |
R |
Number of write operation errors in this connection since service start or last reset. ( An error is counted if 1 or more item writes failed, or the entire write could not be executed ) |
|
TotalItemWrites |
Int32 |
R |
Number of items written in this connection since connection creation or last reset. (Does not include items from the diagnostic namespace) |
|
TotalItemWriteErrors |
Int32 |
R |
Number of write item errors this connection since service start or last reset. (Does not include items from the diagnostic namespace) |
|
SubscriptionEvents |
Int32 |
R |
Number of subscription adds or deletes since service start. This counter will rollover to 0 after value reaches Int32_Max. |
|
MaxSubscriptionIndex |
Int32 |
R |
The maximum subscription index number within all currently created subscriptions. Indexes are 0 to n. -1 means there currently are no subscriptions. (i.e. If value is 10, then 0 to 10 inclusive can be used in the system item syntax "conn=x:y" where y is the subscription index ) |
|
ResetTotals |
BOOL |
R/W |
Reset TotalReads, TotalWrites, TotalItemReads, TotalItemWrites, TotalReadErrors, TotalItemReadErrors , TotalWriteErrors and TotalItemWriteErrors |