VirtualBox

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


Ignore:
Timestamp:
Oct 24, 2010 3:57:55 PM (15 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
66973
Message:

VRDE: API changes for the VRDP server separation.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r33307 r33386  
    7777  implementation, is used.
    7878
    79   All the parts that a typical VirtualBox user interacts with (the Qt GUI,
    80   the VBoxManage command-line interface and the VBoxVRDP server) are technically
     79  All the parts that a typical VirtualBox user interacts with (the Qt GUI
     80  and the VBoxManage command-line interface) are technically
    8181  front-ends to the Main API and only use the interfaces that are documented
    8282  in this Main API documentation. This ensures that, with any given release
    … …  
    13741374  <interface
    13751375    name="IVirtualBox" extends="$unknown"
    1376     uuid="5e887b09-e3f3-4787-b9f3-8ade5d04d675"
     1376    uuid="2ecb8c49-ce8a-41fc-96da-9a438b44e4b1"
    13771377    wsmap="managed"
    13781378  >
    … …  
    21632163      <param name="result" type="boolean" dir="return">
    21642164        <desc>If firmware of this type and version is available.</desc>
     2165      </param>
     2166    </method>
     2167
     2168    <method name="VRDERegisterLibrary">
     2169      <desc>
     2170        Appends a VRDE library to this VirtualBox installation.
     2171
     2172        The library implements a VirtualBox Remote Desktop Extension (VRDE),
     2173        which is used to remotely connect to the virtual machines.
     2174
     2175        The system library extension (".DLL" or ".so") must be omitted.
     2176        The library must reside in the VirtualBox installation directory.
     2177      </desc>
     2178      <param name="name" type="wstring" dir="in">
     2179        <desc>The library name.</desc>
     2180      </param>
     2181    </method>
     2182
     2183    <method name="VRDEUnregisterLibrary">
     2184      <desc>
     2185        Removes a VRDE library from this VirtualBox installation.
     2186      </desc>
     2187      <param name="name" type="wstring" dir="in">
     2188        <desc>The library name.</desc>
     2189      </param>
     2190    </method>
     2191
     2192    <method name="VRDEListLibraries">
     2193      <desc>
     2194        List registered libraries.
     2195      </desc>
     2196      <param name="names" type="wstring" dir="return" safearray="yes">
     2197        <desc>Array of names of the libraries.</desc>
    21652198      </param>
    21662199    </method>
    … …  
    33463379  <interface
    33473380     name="IMachine" extends="$unknown"
    3348      uuid="14136b33-438a-45de-884c-550e9eb34f23"
     3381     uuid="8934e426-1c09-459f-bbc4-58dba016fbbe"
    33493382     wsmap="managed"
    33503383     >
    … …  
    36493682    </attribute>
    36503683
    3651     <attribute name="VRDPServer" type="IVRDPServer" readonly="yes">
    3652       <desc>VRDP server object.</desc>
     3684    <attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
     3685      <desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
    36533686    </attribute>
    36543687
    … …  
    41244157          <ul>
    41254158            <li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
    4126             <li><tt>"vrdp"</tt>: VBoxHeadless (VRDP Server) front-end</li>
     4159            <li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
    41274160            <li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
    41284161          </ul>
    … …  
    56275660
    56285661  <interface
    5629      name="IRemoteDisplayInfo" extends="$unknown"
    5630      uuid="b3741084-806f-4c3b-8c42-ebad1a81e45a"
     5662     name="IVRDEServerInfo" extends="$unknown"
     5663     uuid="6890123c-5218-42ba-9afd-c71699475115"
    56315664     wsmap="struct"
    56325665     >
    56335666     <desc>
    5634         Contains information about the remote display (VRDP) capabilities and status.
    5635         This is used in the <link to="IConsole::remoteDisplayInfo" /> attribute.
     5667        Contains information about the remote desktop (VRDE) server capabilities and status.
     5668        This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
    56365669     </desc>
    56375670
    56385671    <attribute name="active" type="boolean" readonly="yes">
    56395672      <desc>
    5640         Whether the remote display connection is active.
     5673        Whether the remote desktop connection is active.
    56415674      </desc>
    56425675    </attribute>
    … …  
    56445677    <attribute name="port" type="long" readonly="yes">
    56455678      <desc>
    5646         VRDP server port number. If this property is equal to <tt>0</tt>, then
    5647         the VRDP server failed to start, usually because there are no free TCP
    5648         ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDP
     5679        VRDE server port number. If this property is equal to <tt>0</tt>, then
     5680        the VRDE server failed to start, usually because there are no free IP
     5681        ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
    56495682        server has not yet been started.
    56505683      </desc>
    … …  
    57365769  <interface
    57375770     name="IConsole" extends="$unknown"
    5738      uuid="03cb7897-ea17-4e6c-81ae-4bd90be2fde2"
     5771     uuid="3c4a453e-d27b-44a2-b59d-dda6e1835e57"
    57395772     wsmap="managed"
    57405773     >
    … …  
    58295862    <attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
    58305863      <desc>
    5831         List of USB devices currently attached to the remote VRDP client.
     5864        List of USB devices currently attached to the remote VRDE client.
    58325865        Once a new device is physically attached to the remote host computer,
    58335866        it appears in this list and remains there until detached.
    … …  
    58515884    </attribute>
    58525885
    5853     <attribute name="remoteDisplayInfo" type="IRemoteDisplayInfo" readonly="yes">
    5854       <desc>
    5855         Interface that provides information on Remote Display (VRDP) connection.
     5886    <attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
     5887      <desc>
     5888        Interface that provides information on Remote Desktop Extension (VRDE) connection.
    58565889      </desc>
    58575890    </attribute>
    … …  
    70867119     name="ISystemProperties"
    70877120     extends="$unknown"
    7088      uuid="f8fff1f1-eeb4-4483-a2a4-b4186fab5a1e"
     7121     uuid="2af0100b-fda2-4c6a-8e8f-31e4ba871886"
    70897122     wsmap="managed"
    70907123     >
    … …  
    72787311    </attribute>
    72797312
    7280     <attribute name="remoteDisplayAuthLibrary" type="wstring">
    7281       <desc>
    7282         Library that provides authentication for VRDP clients. The library
     7313    <attribute name="VRDEAuthLibrary" type="wstring">
     7314      <desc>
     7315        Library that provides authentication for Remote Desktop clients. The library
    72837316        is used if a virtual machine's authentication type is set to "external"
    72847317        in the VM RemoteDisplay configuration.
    … …  
    73087341        within the <link to="IWebsessionManager::logon" /> implementation.
    73097342
    7310         As opposed to <link to="ISystemProperties::remoteDisplayAuthLibrary" />,
     7343        As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
    73117344        there is no per-VM setting for this, as the webservice is a global
    73127345        resource (if it is running). Only for this setting (for the webservice),
    … …  
    73177350        The initial value of this property is <tt>"VRDPAuth"</tt>,
    73187351        meaning that the webservice will use the same authentication
    7319         library that is used by default for VBoxVRDP (again, see
    7320         <link to="ISystemProperties::remoteDisplayAuthLibrary" />).
     7352        library that is used by default for VRDE (again, see
     7353        <link to="ISystemProperties::VRDEAuthLibrary" />).
    73217354        The format and calling convention of authentication libraries
    7322         is the same for the webservice as it is for VBoxVRDP.
     7355        is the same for the webservice as it is for VRDE.
    73237356
    73247357        <note>
    … …  
    73267359          initial value.
    73277360        </note>
     7361      </desc>
     7362    </attribute>
     7363
     7364    <attribute name="defaultVRDELibrary" type="wstring">
     7365      <desc>
     7366        Default VRDE library.
     7367
     7368        The default value of this property is an empty string, which means that the
     7369        VRDE is not available.
     7370
     7371        For details about VirtualBox Remote Desktop Extension and how to implement
     7372        it, please refer to the VirtualBox SDK.
    73287373      </desc>
    73297374    </attribute>
    … …  
    1182111866    <attribute name="remote" type="boolean" readonly="yes">
    1182211867      <desc>
    11823         Whether the device is physically connected to a remote VRDP
     11868        Whether the device is physically connected to a remote VRDE
    1182411869        client or to a local host machine.
    1182511870      </desc>
    … …  
    1224812293  </interface>
    1224912294
    12250   <!--
    12251   // IVRDPServer
    12252   /////////////////////////////////////////////////////////////////////////
    12253   -->
    12254 
    1225512295  <enum
    12256     name="VRDPAuthType"
    12257     uuid="3d91887a-b67f-4b33-85bf-2da7ab1ea83a"
     12296    name="AuthType"
     12297    uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
    1225812298  >
    1225912299    <desc>
    12260       VRDP authentication type.
     12300      VirtualBox authentication type.
    1226112301    </desc>
    1226212302
    … …  
    1226812308  </enum>
    1226912309
     12310  <!--
     12311  // IVRDEServer
     12312  /////////////////////////////////////////////////////////////////////////
     12313  -->
     12314
    1227012315  <interface
    12271      name="IVRDPServer" extends="$unknown"
    12272      uuid="7aeeb530-0b08-41fe-835d-9be9ec1dbe5c"
     12316     name="IVRDEServer" extends="$unknown"
     12317     uuid="f68a6b34-6f09-4040-8de1-e8d746c4a9ea"
    1227312318     wsmap="managed"
    1227412319     >
    1227512320    <attribute name="enabled" type="boolean">
    12276       <desc>VRDP server status.</desc>
    12277     </attribute>
    12278 
    12279     <attribute name="ports" type="wstring">
    12280       <desc>
    12281         VRDP server port numbers. The server will try to bind to one of free ports from the list.
    12282         <note>
    12283           This is a string of comma separated TCP port numbers or port number ranges.
    12284           Example <tt>5000,5010-5012,5015</tt>
    12285         </note>
    12286       </desc>
    12287     </attribute>
    12288 
    12289     <attribute name="netAddress" type="wstring">
    12290       <desc>VRDP server address.</desc>
    12291     </attribute>
    12292 
    12293     <attribute name="authType" type="VRDPAuthType">
    12294       <desc>VRDP authentication method.</desc>
     12321      <desc>VRDE server status.</desc>
     12322    </attribute>
     12323
     12324    <attribute name="authType" type="AuthType">
     12325      <desc>VRDE authentication method.</desc>
    1229512326    </attribute>
    1229612327
    … …  
    1230912340      <desc>
    1231012341        Flag whether the existing connection must be dropped and a new connection
    12311         must be established by the VRDP server, when a new client connects in single
     12342        must be established by the VRDE server, when a new client connects in single
    1231212343        connection mode.
    1231312344      </desc>
    … …  
    1231612347    <attribute name="videoChannel" type="boolean">
    1231712348      <desc>
    12318         Flag whether RDP video channel is supported.
     12349        Flag whether video redirectiron channel is enabled.
    1231912350      </desc>
    1232012351    </attribute>
    … …  
    1232512356      </desc>
    1232612357    </attribute>
     12358
     12359    <method name="setVRDEProperty">
     12360      <desc>
     12361        Sets a VRDE specific property string.
     12362
     12363        If you pass @c null or empty string as a key @a value, the given @a key
     12364        will be deleted.
     12365
     12366      </desc>
     12367      <param name="key" type="wstring" dir="in">
     12368        <desc>Name of the key to set.</desc>
     12369      </param>
     12370      <param name="value" type="wstring" dir="in">
     12371        <desc>Value to assign to the key.</desc>
     12372      </param>
     12373    </method>
     12374
     12375    <method name="getVRDEProperty">
     12376      <desc>
     12377        Returns a VRDE specific property string.
     12378
     12379        If the requested data @a key does not exist, this function will
     12380        succeed and return an empty string in the @a value argument.
     12381
     12382      </desc>
     12383      <param name="key" type="wstring" dir="in">
     12384        <desc>Name of the key to get.</desc>
     12385      </param>
     12386      <param name="value" type="wstring" dir="return">
     12387        <desc>Value of the requested key.</desc>
     12388      </param>
     12389    </method>
    1232712390
    1232812391  </interface>
    … …  
    1244212505  <interface
    1244312506     name="IInternalSessionControl" extends="$unknown"
    12444      uuid="0431ef9e-2c2e-42af-87d7-c8f52455f28a"
     12507     uuid="06ef98a7-f7c0-45ba-bf99-9aca7a4d5530"
    1244512508     internal="yes"
    1244612509     wsmap="suppress"
    … …  
    1263112694    </method>
    1263212695
    12633     <method name="onVRDPServerChange">
    12634       <desc>
    12635         Triggered when settings of the VRDP server object of the
     12696    <method name="onVRDEServerChange">
     12697      <desc>
     12698        Triggered when settings of the VRDE server object of the
    1263612699        associated virtual machine have changed.
    1263712700
    … …  
    1385113914  <enum
    1385213915     name="VBoxEventType"
    13853      uuid="1728bb3b-4843-4f12-af67-f7a1f69f3a52">
     13916     uuid="e085d0b1-05e6-4f40-a709-b7266fbdb236">
    1385413917
    1385513918    <desc>
    … …  
    1401314076      </desc>
    1401414077    </const>
    14015     <const name="OnVRDPServerChanged" value="53">
    14016       <desc>
    14017         See <link to="IVRDPServerChangedEvent">IVRDPServerChangedEvent</link>.
     14078    <const name="OnVRDEServerChanged" value="53">
     14079      <desc>
     14080        See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
    1401814081      </desc>
    1401914082    </const>
    … …  
    1405314116      </desc>
    1405414117    </const>
    14055     <const name="OnRemoteDisplayInfoChanged" value="61">
    14056       <desc>
    14057         See <link to="IRemoteDisplayInfoChangedEvent">IRemoteDisplayInfoChangedEvent</link>.
     14118    <const name="OnVRDEServerInfoChanged" value="61">
     14119      <desc>
     14120        See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
    1405814121      </desc>
    1405914122    </const>
    … …  
    1490814971
    1490914972   <interface
    14910      name="IVRDPServerChangedEvent" extends="IEvent"
    14911      uuid="726038B6-6279-4A7A-8037-D041693D1915"
    14912      wsmap="managed" autogen="VBoxEvent" id="OnVRDPServerChanged"
     14973     name="IVRDEServerChangedEvent" extends="IEvent"
     14974     uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
     14975     wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
    1491314976     >
    1491414977    <desc>
    1491514978      Notification when a property of the
    14916       <link to="IMachine::VRDPServer">VRDP server</link> changes.
    14917       Interested callees should use IVRDPServer methods and attributes to
     14979      <link to="IMachine::VRDEServer">VRDE server</link> changes.
     14980      Interested callees should use IVRDEServer methods and attributes to
    1491814981      find out what has changed.
    1491914982    </desc>
    … …  
    1492114984
    1492214985   <interface
    14923      name="IRemoteDisplayInfoChangedEvent" extends="IEvent"
    14924      uuid="65B556C5-2A99-47D8-B311-FC177F0914CD"
    14925      wsmap="managed" autogen="VBoxEvent" id="OnRemoteDisplayInfoChanged"
     14986     name="IVRDEServerInfoChangedEvent" extends="IEvent"
     14987     uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
     14988     wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
    1492614989     >
    1492714990    <desc>
    14928       Notification when the status of the VRDP server changes. Interested callees
    14929       should use <link to="IConsole::remoteDisplayInfo">IRemoteDisplayInfo</link>
     14991      Notification when the status of the VRDE server changes. Interested callees
     14992      should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
    1493014993      attributes to find out what is the current status.
    1493114994    </desc>
Note: See TracChangeset for help on using the changeset viewer.

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