You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/Using_OO_API.md
+35Lines changed: 35 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2101,3 +2101,38 @@ struct FbVarChar
2101
2101
2102
2102
This document is currently missing 2 types of plugins – ExternalEngine and Trace. Information about them will be made
2103
2103
available in next release of it.
2104
+
2105
+
# Trace plugin
2106
+
2107
+
_TODO_
2108
+
2109
+
# Trace objects
2110
+
2111
+
_TODO_
2112
+
2113
+
# Trace performance statistics
2114
+
2115
+
Trace plugin may retrieve various performance statistics available using the `getPerfStats()` method of the trace object, which returns a pointer to the `IPerformanceStats` interface.
- unsigned getObjectCount() - returns number of objects (e.g. tables) containing non-zero performance counters
2133
+
- unsigned getCountersCapacity() - returns total number of performance counters supported by the implementation (it's the same for all objects of the same type)
2134
+
- unsigned getObjectId(unsigned index) - returns ID of the specified object
2135
+
- const char* getObjectName(unsigned index) - returns name of the specified object
2136
+
- const ISC_INT64* getObjectCounters(unsigned index) - returns pointer to the vector of performance counters (containing getCountersCapacity() elements) of the specified object
2137
+
2138
+
The returned pointer to the vector (as well as the whole instance of `PerformanceStats`) is valid until the object used to obtain the statistics (using the `getPerfStats()` method) is destroyed.
0 commit comments