VirtualBox

Changeset 10595 in vbox for trunk/src/VBox/Main/idl


Ignore:
Timestamp:
Jul 14, 2008 12:23:57 PM (17 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
33291
Message:

Main: Performance: Typos, docs, cosmetics.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/VBox/Main/idl/VirtualBox.xidl

    r10544 r10595  
    10571057      </desc>
    10581058    </attribute>
     1059
    10591060    <attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
    10601061      <desc>
    1061         The only instance of IPerformanceCollector.
     1062        Associated performance collector object.
    10621063      </desc>
    10631064    </attribute>
    … …  
    1007410075</if>
    1007510076
     10077  <!--
     10078  // IPerformanceCollector & friends
     10079  /////////////////////////////////////////////////////////////////////////
     10080  -->
     10081
    1007610082  <interface
    1007710083    name="IPerformanceMetric" extends="$unknown"
    1007810084    uuid="50831d4c-ed55-4221-836c-87b487d3b44a" wsmap="managed"
    1007910085  >
    10080     <desc>Holds metrics parameters.</desc>
    10081  
     10086    <desc>
     10087      The IPerformanceMetric interface represents parameters of the given
     10088      performance metric.
     10089    </desc>
     10090
    1008210091    <attribute name="metricName" type="wstring" readonly="yes">
    1008310092      <desc>
    … …  
    1008810097    <attribute name="object" type="$unknown" readonly="yes">
    1008910098      <desc>
    10090         The object this metric belongs to.
     10099        Object this metric belongs to.
    1009110100      </desc>
    1009210101    </attribute>
    … …  
    1009410103    <attribute name="period" type="unsigned long" readonly="yes">
    1009510104      <desc>
    10096         The time interval between samples, measured in seconds.
     10105        Time interval between samples, measured in seconds.
    1009710106      </desc>
    1009810107    </attribute>
    … …  
    1010010109    <attribute name="count" type="unsigned long" readonly="yes">
    1010110110      <desc>
    10102         The number of recent samples retained by the collector. Older samples
     10111        Number of recent samples retained by the performance collector for this
     10112        metric.
     10113
     10114        When the collected sample count exceeds this number, older samples
    1010310115        are discarded.
    1010410116      </desc>
    … …  
    1010710119    <attribute name="unit" type="wstring" readonly="yes">
    1010810120      <desc>
    10109         The unit of measurement.
     10121        Unit of measurement.
    1011010122      </desc>
    1011110123    </attribute>
    … …  
    1011310125    <attribute name="minimumValue" type="long" readonly="yes">
    1011410126      <desc>
    10115         The minimum possible value of this metric.
     10127        Minimum possible value of this metric.
    1011610128      </desc>
    1011710129    </attribute>
    … …  
    1011910131    <attribute name="maximumValue" type="long" readonly="yes">
    1012010132      <desc>
    10121         The maximum possible value of this metric.
     10133        Maximum possible value of this metric.
    1012210134      </desc>
    1012310135    </attribute>
    … …  
    1013010142  >
    1013110143    <desc>
    10132       This object collects and stores performace metrics data. Performance
    10133       metrics are associated with objects like IHost and IMachine. Each object
    10134       has a distict set of performance metrics. It can be obtained with
    10135       <link to="IPerformanceCollector::getMetrics"/>.
     10144      The IPerformanceCollector interfaces represents a service that collects
     10145      and stores performace metrics data.
     10146
     10147      Performance metrics are associated with objects like IHost and IMachine.
     10148      Each object has a distict set of performance metrics. It can be obtained
     10149      with <link to="IPerformanceCollector::getMetrics"/>.
    1013610150    </desc>
    1013710151
    1013810152    <attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
    1013910153      <desc>
    10140         An array of unique names of metrics regardless of objects they are
    10141         associated with.
    10142       </desc>
    10143     </attribute>
    10144  
     10154        Array of unique names of metrics.
     10155
     10156        This array represents all metrics supported by the performance
     10157        collector. Individual objects do not necessarily support all of them.
     10158        <link to="IPerformanceCollector::getMetrics"/> can be used to get the
     10159        list of supported metrics for a particular object.
     10160      </desc>
     10161    </attribute>
     10162
    1014510163    <method name="getMetrics">
    1014610164      <desc>
    10147         Returns parameters (characteristics?) of specified metrics for a set of
    10148         objects.
    10149         <note>
    10150           Null metrics array means all metrics. Null object array means all
    10151           existing objects.
    10152         </note>
    10153       </desc>
    10154       <param name="metricNames" type="wstring" dir="in" safearray="yes"/>
    10155       <param name="objects" type="$unknown" dir="in" safearray="yes"/>
    10156       <param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes"/>
    10157     </method>
    10158  
     10165        Returns parameters of specified metrics for a set of objects.
     10166        <note>
     10167          @c Null metrics array means all metrics. @c Null object array means
     10168          all existing objects.
     10169        </note>
     10170      </desc>
     10171      <param name="metricNames" type="wstring" dir="in" safearray="yes">
     10172        <desc>
     10173          Metric name filter. Currently, only a comma-separated list of metrics
     10174          is supported.
     10175        </desc>
     10176      </param>
     10177      <param name="objects" type="$unknown" dir="in" safearray="yes">
     10178        <desc>
     10179          Set of objects to return metric parameters for.
     10180        </desc>
     10181      </param>
     10182      <param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
     10183        <desc>
     10184          Array of returned metric parameters.
     10185        </desc>
     10186      </param>
     10187    </method>
     10188
    1015910189    <method name="setupMetrics">
    1016010190      <desc>
    1016110191        Sets parameters of specified metrics for a set of objects.
    1016210192        <note>
    10163           Null metrics array means all metrics. Null object array means all
    10164           existing objects.
    10165         </note>
    10166       </desc>
    10167       <param name="metricNames" type="wstring" dir="in" safearray="yes"/>
    10168       <param name="objects" type="$unknown" dir="in" safearray="yes"/>
    10169       <param name="period" type="unsigned long" dir="in"/>
    10170       <param name="count" type="unsigned long" dir="in"/>
     10193          @c Null metrics array means all metrics. @c Null object array means
     10194          all existing objects.
     10195        </note>
     10196      </desc>
     10197      <param name="metricNames" type="wstring" dir="in" safearray="yes">
     10198        <desc>
     10199          Metric name filter. Currently, only a comma-separated list of metrics
     10200          is supported.
     10201        </desc>
     10202      </param>
     10203      <param name="objects" type="$unknown" dir="in" safearray="yes">
     10204        <desc>
     10205          Set of objects to setup metric parameters for.
     10206        </desc>
     10207      </param>
     10208      <param name="period" type="unsigned long" dir="in">
     10209        <desc>
     10210          @todo ???
     10211        </desc>
     10212      </param>
     10213      <param name="count" type="unsigned long" dir="in">
     10214        <desc>
     10215          @todo ???
     10216        </desc>
     10217      </param>
    1017110218    </method>
    1017210219
    1017310220    <method name="enableMetrics">
    1017410221      <desc>
    10175         Turn on collection of specified metrics.
    10176         <note>
    10177           Null metrics array means all metrics. Null object array means all
    10178           existing objects.
    10179         </note>
    10180       </desc>
    10181       <param name="metricNames" type="wstring" dir="in" safearray="yes"/>
    10182       <param name="objects" type="$unknown" dir="in" safearray="yes"/>
     10222        Turns on collecting specified metrics.
     10223        <note>
     10224          @c Null metrics array means all metrics. @c Null object array means
     10225          all existing objects.
     10226        </note>
     10227      </desc>
     10228      <param name="metricNames" type="wstring" dir="in" safearray="yes">
     10229        <desc>
     10230          Metric name filter. Currently, only a comma-separated list of metrics
     10231          is supported.
     10232        </desc>
     10233      </param>
     10234      <param name="objects" type="$unknown" dir="in" safearray="yes">
     10235        <desc>
     10236          Set of objects to enable metrics for.
     10237        </desc>
     10238      </param>
    1018310239    </method>
    1018410240
    1018510241    <method name="disableMetrics">
    1018610242      <desc>
    10187         Turn off collection of specified metrics.
    10188         <note>
    10189           Null metrics array means all metrics. Null object array means all
    10190           existing objects.
    10191         </note>
    10192       </desc>
    10193       <param name="metricNames" type="wstring" dir="in" safearray="yes"/>
    10194       <param name="objects" type="$unknown" dir="in" safearray="yes"/>
     10243        Turns off collecting specified metrics.
     10244        <note>
     10245          @c Null metrics array means all metrics. @c Null object array means
     10246          all existing objects.
     10247        </note>
     10248      </desc>
     10249      <param name="metricNames" type="wstring" dir="in" safearray="yes">
     10250        <desc>
     10251          Metric name filter. Currently, only a comma-separated list of metrics
     10252          is supported.
     10253        </desc>
     10254      </param>
     10255      <param name="objects" type="$unknown" dir="in" safearray="yes">
     10256        <desc>
     10257          Set of objects to disable metrics for.
     10258        </desc>
     10259      </param>
    1019510260    </method>
    1019610261
    … …  
    1019810263      <desc>
    1019910264        Queries collected metrics data for a set of objects.
    10200         <note>
    10201           Null metrics array means all applicable metrics. Null object array
    10202           means all existing objects. The @a returnData parameter is a
    10203           flattened array of arrays. Each start and length of a sub-array is
    10204           indicated by @a returnDataIndices and @a returnDataLengths. The
    10205           rationale behind this API style is that it doesn't require objects
    10206           to be returned, and thus eliminates all but the unavoidable IPC.
    10207         </note>
    10208       </desc>
    10209       <param name="metricNames" type="wstring" dir="in" safearray="yes"/>
    10210       <param name="objects" type="$unknown" dir="in" safearray="yes"/>
    10211       <param name="returnMetricNames" type="wstring" dir="out" safearray="yes"/>
    10212       <param name="returnObjects" type="$unknown" dir="out" safearray="yes"/>
    10213       <param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes"/>
    10214       <param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes"/>
    10215       <param name="returnData" type="long" dir="return" safearray="yes"/>
     10265
     10266        The @a returnData parameter is a flattened array of arrays. Each start
     10267        and length of a sub-array is indicated by @a returnDataIndices and @a
     10268        returnDataLengths.
     10269
     10270        <note>
     10271          @c Null metrics array means all applicable metrics. @c Null object
     10272          array means all existing objects.
     10273        </note>
     10274      </desc>
     10275      <param name="metricNames" type="wstring" dir="in" safearray="yes">
     10276        <desc>
     10277          Metric name filter. Currently, only a comma-separated list of metrics
     10278          is supported.
     10279        </desc>
     10280      </param>
     10281      <param name="objects" type="$unknown" dir="in" safearray="yes">
     10282        <desc>
     10283          Set of objects to query metrics for.
     10284        </desc>
     10285      </param>
     10286      <param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
     10287        <desc>
     10288          @todo ???
     10289        </desc>
     10290      </param>
     10291      <param name="returnObjects" type="$unknown" dir="out" safearray="yes">
     10292        <desc>
     10293          @todo ???
     10294        </desc>
     10295      </param>
     10296      <param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
     10297        <desc>
     10298          @todo ???
     10299        </desc>
     10300      </param>
     10301      <param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
     10302        <desc>
     10303          @todo ???
     10304        </desc>
     10305      </param>
     10306      <param name="returnData" type="long" dir="return" safearray="yes">
     10307        <desc>
     10308          @todo ???
     10309        </desc>
     10310      </param>
    1021610311    </method>
    1021710312
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette