VirtualBox

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


Ignore:
Timestamp:
Jul 11, 2008 2:27:01 PM (17 years ago)
Author:
vboxsync
Message:

Performance API, version 0, webservice broken.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r10399 r10528  
    885885  <interface
    886886    name="IVirtualBox" extends="$dispatched"
    887     uuid="2d3b9ea7-25f5-4f07-a8e1-7dd7e0dcf667"
     887    uuid="557a07bc-e6ae-4520-a361-4a8493199137"
    888888    wsmap="managed"
    889889  >
    … …  
    10551055          implemented and therefore this collection is always empty.
    10561056        </note>
     1057      </desc>
     1058    </attribute>
     1059    <attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
     1060      <desc>
     1061        The only instance of IPerformanceCollector.
    10571062      </desc>
    10581063    </attribute>
    … …  
    35303535    </method>
    35313536
    3532     <method name="getProcessorUsage">
    3533       <desc>
    3534         Returns the current processor usage by this virtual machine measured
    3535         over all cores of all processors in the host system.
    3536 
    3537         The values returned for each parameter are in range from <tt>0</tt> (the
    3538         machine is powered off or does not load the CPUs at all) to
    3539         <tt>1 000 000 000</tt> (all cores of all CPUs are fully in use by this
    3540         machine).
    3541       </desc>
    3542       <param name="user" type="unsigned long" dir="out">
    3543         <desc>
    3544           Pecentage of processor time spent executing in user mode.
    3545         </desc>
    3546       </param>
    3547       <param name="system" type="unsigned long" dir="out">
    3548         <desc>
    3549           Pecentage of processor time spent executing in kernel mode.
    3550         </desc>
    3551       </param>
    3552     </method>
    3553 
    35543537  </interface>
    35553538
    … …  
    50535036    </method>
    50545037
    5055     <method name="getProcessorUsage">
    5056       <desc>
    5057         Returns the processor usage by the whole host system measured over all
    5058         cores of all processors of the host machine.
    5059 
    5060         The values returned for each parameter are in range from <tt>0</tt> (the
    5061         machine is powered off or doesn't load the CPUs at all) to
    5062         <tt>1 000 000 000</tt> (all cores of all CPUs are fully loaded by this
    5063         machine).
    5064 
    5065         <note>
    5066           The maximum value is 1000000000 which means that all cores of all CPUs
    5067           are completely used.
    5068         </note>
    5069       </desc>
    5070       <param name="user" type="unsigned long" dir="out">
    5071         <desc>
    5072           Pecentage of processor time spent executing in user mode.
    5073         </desc>
    5074       </param>
    5075       <param name="system" type="unsigned long" dir="out">
    5076         <desc>
    5077           Pecentage of processor time spent executing in kernel mode.
    5078         </desc>
    5079       </param>
    5080       <param name="idle" type="unsigned long" dir="out">
    5081         <desc>
    5082           Pecentage of processor time spent doing nothing.
    5083         </desc>
    5084       </param>
    5085     </method>
    50865038  </interface>
    50875039
    … …  
    1012210074</if>
    1012310075
     10076  <interface
     10077    name="IPerformanceMetric" extends="$unknown"
     10078    uuid="50831d4c-ed55-4221-836c-87b487d3b44a" wsmap="managed"
     10079  >
     10080    <desc>Holds metrics parameters.</desc>
     10081 
     10082    <attribute name="metricName" type="wstring" readonly="yes">
     10083      <desc>
     10084        Name of the metric.
     10085      </desc>
     10086    </attribute>
     10087
     10088    <attribute name="object" type="$unknown" readonly="yes">
     10089      <desc>
     10090        The object this metric belongs to.
     10091      </desc>
     10092    </attribute>
     10093
     10094    <attribute name="period" type="unsigned long" readonly="yes">
     10095      <desc>
     10096        The time interval between samples, measured in seconds.
     10097      </desc>
     10098    </attribute>
     10099
     10100    <attribute name="count" type="unsigned long" readonly="yes">
     10101      <desc>
     10102        The number of recent samples retained by the collector. Older samples
     10103        are discarded.
     10104      </desc>
     10105    </attribute>
     10106
     10107    <attribute name="unit" type="wstring" readonly="yes">
     10108      <desc>
     10109        The unit of measurement.
     10110      </desc>
     10111    </attribute>
     10112
     10113    <attribute name="minimumValue" type="long" readonly="yes">
     10114      <desc>
     10115        The minimum possible value of this metric.
     10116      </desc>
     10117    </attribute>
     10118
     10119    <attribute name="maximumValue" type="long" readonly="yes">
     10120      <desc>
     10121        The maximum possible value of this metric.
     10122      </desc>
     10123    </attribute>
     10124  </interface>
     10125
     10126  <interface
     10127    name="IPerformanceCollector" extends="$unknown"
     10128    uuid="dcd37e5a-3964-43d1-be30-0f3c7234e347"
     10129    wsmap="managed"
     10130  >
     10131    <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"/>.
     10136    </desc>
     10137
     10138    <attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
     10139      <desc>
     10140        An array of unique names of metrics regardless of objects they are
     10141        associated with.
     10142      </desc>
     10143    </attribute>
     10144 
     10145    <method name="getMetrics">
     10146      <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 
     10159    <method name="setupMetrics">
     10160      <desc>
     10161        Sets parameters of specified metrics for a set of objects.
     10162        <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"/>
     10171    </method>
     10172
     10173    <method name="enableMetrics">
     10174      <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"/>
     10183    </method>
     10184
     10185    <method name="disableMetrics">
     10186      <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"/>
     10195    </method>
     10196
     10197    <method name="queryMetricsData">
     10198      <desc>
     10199        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"/>
     10216    </method>
     10217
     10218  </interface>
     10219
    1012410220  <module name="VBoxSVC" context="LocalServer">
    1012510221    <class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
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