Changeset 23643 in vbox for trunk/src/VBox/Main

Timestamp:

Oct 9, 2009 12:23:32 PM (15 years ago)

Author:

vboxsync

Message:

VRDP port range API.

Location:

trunk/src/VBox/Main

Files:

• ConsoleImpl.cpp (modified) (2 diffs)
• ConsoleVRDPServer.cpp (modified) (8 diffs)
• VirtualBoxCallbackImpl.cpp (modified) (1 diff)
• idl/VirtualBox.xidl (modified) (6 diffs)
• include/ConsoleImpl.h (modified) (1 diff)
• include/ConsoleVRDPServer.h (modified) (2 diffs)
• include/DisplayImpl.h (modified) (1 diff)
• include/VRDPServerImpl.h (modified) (3 diffs)
• include/VirtualBoxCallbackImpl.h (modified) (1 diff)
• xml/Settings.cpp (modified) (2 diffs)
• xml/VirtualBox-settings-common.xsd (modified) (1 diff)

trunk/src/VBox/Main/ConsoleImpl.cpp

@@ -3585 +3585 @@
 
 /**
+ * @note Locks this object for reading.
+ */
+void Console::onRemoteDisplayInfoChange()
+{
+    AutoCaller autoCaller(this);
+    AssertComRCReturnVoid(autoCaller.rc());
+
+    AutoReadLock alock(this);
+
+    CallbackList::iterator it = mCallbacks.begin();
+    while (it != mCallbacks.end())
+        (*it++)->OnRemoteDisplayInfoChange();
+}
+
+
+
+/**
  * Called by IInternalSessionControl::OnUSBControllerChange().
  *
@@ -6581 +6598 @@
         {
             Utf8Str errMsg;
-            ULONG port = 0;
-            console->mVRDPServer->COMGETTER(Port)(&port);
-            errMsg = Utf8StrFmt(tr("VRDP server port %d is already in use"),
-                                port);
+            Bstr bstr;
+            console->mVRDPServer->COMGETTER(Ports)(bstr.asOutParam());
+            Utf8Str ports = bstr;
+            errMsg = Utf8StrFmt(tr("VRDP server can't bind to a port: %s"),
+                                ports.raw());
             LogRel(("Warning: failed to launch VRDP server (%Rrc): '%s'\n",
                     vrc, errMsg.raw()));

trunk/src/VBox/Main/ConsoleVRDPServer.cpp

@@ -143 +143 @@
 
     STDMETHOD(OnVRDPServerChange)()
+    {
+        return S_OK;
+    }
+
+    STDMETHOD(OnRemoteDisplayInfoChange)()
     {
         return S_OK;
@@ -622 +627 @@
         case VRDP_QP_NETWORK_PORT:
         {
+            /* This is obsolete, the VRDP server uses VRDP_QP_NETWORK_PORT_RANGE instead. */
             ULONG port = 0;
-            server->mConsole->getVRDPServer ()->COMGETTER(Port) (&port);
-            if (port == 0)
-            {
-                port = VRDP_DEFAULT_PORT;
-            }
 
             if (cbBuffer >= sizeof (uint32_t))
@@ -707 +708 @@
             com::Bstr bstr;
             HRESULT hrc = server->mConsole->machine ()->GetExtraData(Bstr("VBoxInternal2/VRDPPortRange"), bstr.asOutParam());
+            if (hrc != S_OK || bstr == "")
+            {
+                hrc = server->mConsole->getVRDPServer ()->COMGETTER(Ports) (bstr.asOutParam());
+            }
             if (hrc != S_OK)
             {
                 bstr = "";
+            }
+
+            if (bstr == "0")
+            {
+                bstr = "3389";
             }
 
@@ -758 +768 @@
 
             ULONG port = *(uint32_t *)pvBuffer;
+            
+            server->mVRDPBindPort = port;
 
             com::Bstr bstr = Utf8StrFmt("%d", port);
@@ -769 +781 @@
                 *pcbOut = sizeof (uint32_t);
             }
+
+            server->mConsole->onRemoteDisplayInfoChange ();
         } break;
 
@@ -1130 +1144 @@
 
     mConsole->machine ()->SetExtraData(Bstr("VBoxInternal2/VRDPPortRange"), Bstr(""));
+    mVRDPBindPort = -1;
 #endif /* VBOX_WITH_VRDP */
 
@@ -2019 +2034 @@
 {
 #ifdef VBOX_WITH_VRDP
-    if (mpEntryPoints && mhServer)
+    if (index == VRDP_QI_PORT)
+    {
+        uint32_t cbOut = sizeof (int32_t);
+
+        if (cbBuffer >= cbOut)
+        {
+            *pcbOut = cbOut;
+            *(int32_t *)pvBuffer = (int32_t)mVRDPBindPort;
+        }
+    }
+    else if (mpEntryPoints && mhServer)
     {
         mpEntryPoints->VRDPQueryInfo (mhServer, index, pvBuffer, cbBuffer, pcbOut);
@@ -2242 +2267 @@
 
 IMPL_GETTER_BOOL   (BOOL,    Active,             VRDP_QI_ACTIVE);
+IMPL_GETTER_SCALAR (LONG,    Port,               VRDP_QI_PORT);
 IMPL_GETTER_SCALAR (ULONG,   NumberOfClients,    VRDP_QI_NUMBER_OF_CLIENTS);
 IMPL_GETTER_SCALAR (LONG64,  BeginTime,          VRDP_QI_BEGIN_TIME);

trunk/src/VBox/Main/VirtualBoxCallbackImpl.cpp

@@ -230 +230 @@
     return mConsoleCallback->OnParallelPortChange(aParallelPort);
 }
+
+STDMETHODIMP CallbackWrapper::OnRemoteDisplayInfoChange()
+{
+    if (mConsoleCallback.isNull())
+        return S_OK;
+
+    return mConsoleCallback->OnRemoteDisplayInfoChange();
+}
+
 STDMETHODIMP CallbackWrapper::OnVRDPServerChange()
 {

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

@@ -5441 +5441 @@
   <interface
      name="IConsoleCallback" extends="$unknown"
-     uuid="db67f6e5-799d-474c-8452-b10d7736a412"
+     uuid="d6239535-bda2-4ef7-83f4-f4722e4a3b2c"
      wsmap="suppress"
      >
@@ -5625 +5625 @@
         Interested callees should use IVRDPServer methods and attributes to
         find out what has changed.
+      </desc>
+    </method>
+
+    <method name="onRemoteDisplayInfoChange">
+      <desc>
+        Notification when the status of the VRDP server changes. Interested callees
+        should use <link to="IConsole::RemoteDisplayInfo">IRemoteDisplayInfo</link>
+        attributes to find out what is the current status.
       </desc>
     </method>
@@ -5842 +5850 @@
   <interface
      name="IRemoteDisplayInfo" extends="$unknown"
-     uuid="550104cd-2dfd-4a6c-857d-f6f8e088e62c"
+     uuid="b3741084-806f-4c3b-8c42-ebad1a81e45a"
      wsmap="struct"
      >
@@ -5853 +5861 @@
       <desc>
         Whether the remote display connection is active.
+      </desc>
+    </attribute>
+
+    <attribute name="port" type="long" readonly="yes">
+      <desc>
+        VRDP server port number. If this property is equal to <tt>0</tt>, then
+        the VRDP server failed to start, usually because there are no free TCP
+        ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDP
+        server has not yet been started.
       </desc>
     </attribute>
@@ -11789 +11806 @@
   <interface
      name="IVRDPServer" extends="$unknown"
-     uuid="f4584ae7-6bce-474b-83d6-17d235e6aa89"
+     uuid="72e671bc-1712-4052-ad6b-e45e76d9d3e4"
      wsmap="managed"
      >
@@ -11796 +11813 @@
     </attribute>
 
-    <attribute name="port" type="unsigned long">
-      <desc>
-        VRDP server port number.
+    <attribute name="ports" type="wstring">
+      <desc>
+        VRDP server port numbers.
         <note>
-          Setting the value of this property to <tt>0</tt> will reset the port
-          number to the default value which is
-          currently <tt>3389</tt>. Reading this property will always return a
-          real port number, even after it has been set to <tt>0</tt> (in which
-          case the default port is returned).
+          This is a string of comma separated TCP port numbers or port number ranges.
+          The server will try to bind to one of ports from the list. Example
+          <tt>3000,3010-3012,3015</tt>
         </note>
       </desc>

trunk/src/VBox/Main/include/ConsoleImpl.h

@@ -214 +214 @@
     void onRuntimeError (BOOL aFatal, IN_BSTR aErrorID, IN_BSTR aMessage);
     HRESULT onShowWindow (BOOL aCheck, BOOL *aCanShow, ULONG64 *aWinId);
+    void onRemoteDisplayInfoChange();
 
     static const PDMDRVREG DrvStatusReg;

trunk/src/VBox/Main/include/ConsoleVRDPServer.h

@@ -185 +185 @@
 
     VRDPInputSynch m_InputSynch;
+
+    int32_t mVRDPBindPort;
 #endif /* VBOX_WITH_VRDP */
 
@@ -264 +266 @@
     #define DECL_GETTER(_aType, _aName) STDMETHOD(COMGETTER(_aName)) (_aType *a##_aName)
         DECL_GETTER (BOOL,    Active);
+        DECL_GETTER (LONG,    Port);
         DECL_GETTER (ULONG,   NumberOfClients);
         DECL_GETTER (LONG64,  BeginTime);

trunk/src/VBox/Main/include/DisplayImpl.h

@@ -198 +198 @@
     }
 
+    STDMETHOD(OnRemoteDisplayInfoChange)()
+    {
+        return S_OK;
+    }
+
     STDMETHOD(OnUSBControllerChange)()
     {

trunk/src/VBox/Main/include/VRDPServerImpl.h

@@ -50 +50 @@
             return this == &that ||
                    (mEnabled == that.mEnabled &&
-                    mVRDPPort == that.mVRDPPort &&
+                    mVRDPPorts == that.mVRDPPorts &&
                     mVRDPAddress == that.mVRDPAddress &&
                     mAuthType == that.mAuthType &&
@@ -59 +59 @@
 
         BOOL mEnabled;
-        ULONG mVRDPPort;
+        Bstr mVRDPPorts;
         Bstr mVRDPAddress;
         VRDPAuthType_T mAuthType;
@@ -93 +93 @@
     STDMETHOD(COMGETTER(Enabled)) (BOOL *aEnabled);
     STDMETHOD(COMSETTER(Enabled)) (BOOL aEnable);
-    STDMETHOD(COMGETTER(Port)) (ULONG *aPort);
-    STDMETHOD(COMSETTER(Port)) (ULONG aPort);
+    STDMETHOD(COMGETTER(Ports)) (BSTR *aPorts);
+    STDMETHOD(COMSETTER(Ports)) (IN_BSTR aPorts);
     STDMETHOD(COMGETTER(NetAddress)) (BSTR *aAddress);
     STDMETHOD(COMSETTER(NetAddress)) (IN_BSTR aAddress);

trunk/src/VBox/Main/include/VirtualBoxCallbackImpl.h

@@ -87 +87 @@
     STDMETHOD(OnParallelPortChange) (IParallelPort *aParallelPort);
     STDMETHOD(OnVRDPServerChange)();
+    STDMETHOD(OnRemoteDisplayInfoChange)();
     STDMETHOD(OnUSBControllerChange)();
     STDMETHOD(OnUSBDeviceStateChange) (IUSBDevice *aDevice, BOOL aAttached,

trunk/src/VBox/Main/xml/Settings.cpp

@@ -1545 +1545 @@
         {
             pelmHwChild->getAttributeValue("enabled", hw.vrdpSettings.fEnabled);
-            pelmHwChild->getAttributeValue("port", hw.vrdpSettings.ulPort);
+            pelmHwChild->getAttributeValue("port", hw.vrdpSettings.strPort);
             pelmHwChild->getAttributeValue("netAddress", hw.vrdpSettings.strNetAddress);
 
@@ -2357 +2357 @@
     xml::ElementNode *pelmVRDP = pelmHardware->createChild("RemoteDisplay");
     pelmVRDP->setAttribute("enabled", hw.vrdpSettings.fEnabled);
-    pelmVRDP->setAttribute("port", hw.vrdpSettings.ulPort);
+    pelmVRDP->setAttribute("port", hw.vrdpSettings.strPort);
     if (hw.vrdpSettings.strNetAddress.length())
         pelmVRDP->setAttribute("netAddress", hw.vrdpSettings.strNetAddress);

trunk/src/VBox/Main/xml/VirtualBox-settings-common.xsd

@@ -506 +506 @@
 <xsd:complexType name="TRemoteDisplay">
   <xsd:attribute name="enabled" type="xsd:boolean" use="required"/>
-  <xsd:attribute name="port" type="xsd:unsignedInt" default="0"/>
+  <xsd:attribute name="port" type="xsd:token" default="0"/>
   <xsd:attribute name="netAddress" type="xsd:token" default=""/>
   <xsd:attribute name="authType" type="TVRDPAuthType" default="Null"/>