Changeset 29867 in vbox for trunk/src/VBox/HostServices/GuestControl

Timestamp:

May 28, 2010 3:09:23 PM (15 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

62112

Message:

r=bird: todos

File:

• trunk/src/VBox/HostServices/GuestControl/service.cpp (modified) (12 diffs)

trunk/src/VBox/HostServices/GuestControl/service.cpp

@@ -28 +28 @@
  *           new host commands to perform. There can be multiple clients connected
  *           to a service. A client is represented by its HGCM client ID.
- * - Context ID: A (almost) unique ID automatically generated on the host (Main API) 
+ * - Context ID: A (almost) unique ID automatically generated on the host (Main API)
  *               to not only distinguish clients but individual requests. Because
  *               the host does not know anything about connected clients it needs
  *               an indicator which it can refer to later. This context ID gets
- *               internally bound by the service to a client which actually processes 
+ *               internally bound by the service to a client which actually processes
  *               the command in order to have a relationship between client<->context ID(s).
  *
  * The host can trigger commands which get buffered by the service (with full HGCM
- * parameter info). As soon as a client connects (or is ready to do some new work) 
- * it gets a buffered host command to process it. This command then will be immediately 
+ * parameter info). As soon as a client connects (or is ready to do some new work)
+ * it gets a buffered host command to process it. This command then will be immediately
  * removed from the command list. If there are ready clients but no new commands to be
  * processed, these clients will be set into a deferred state (that is being blocked
  * to return until a new command is available).
  *
- * If a client needs to inform the host that something happend, it can send a 
+ * If a client needs to inform the host that something happend, it can send a
  * message to a low level HGCM callback registered in Main. This callback contains
- * the actual data as well as the context ID to let the host do the next necessary 
+ * the actual data as well as the context ID to let the host do the next necessary
  * steps for this context. This context ID makes it possible to wait for an event
  * inside the host's Main API function (like starting a process on the guest and
  * wait for getting its PID returned by the client) as well as cancelling blocking
- * host calls in order the client terminated/crashed (HGCM detects disconnected 
+ * host calls in order the client terminated/crashed (HGCM detects disconnected
  * clients and reports it to this service's callback).
  */
@@ -80 +80 @@
 /**
  * Structure for holding all clients with their
- * generated host contexts. This is necessary for 
+ * generated host contexts. This is necessary for
  * mainting the relationship between a client and its context IDs.
  */
@@ -135 +135 @@
     GuestCall() : mClientID(0), mHandle(0), mParms(NULL), mNumParms(0) {}
     /** The normal contructor. */
-    GuestCall(uint32_t aClientID, VBOXHGCMCALLHANDLE aHandle, 
+    GuestCall(uint32_t aClientID, VBOXHGCMCALLHANDLE aHandle,
               VBOXHGCMSVCPARM aParms[], uint32_t cParms)
               : mClientID(aClientID), mHandle(aHandle), mParms(aParms), mNumParms(cParms) {}
@@ -475 +475 @@
     AssertPtr(pCmd);
     int rc;
-  
+
     /* Sufficient parameter space? */
     if (pCmd->mParmBuf.uParmCount > cParms)
@@ -481 +481 @@
         paParms[0].setUInt32(pCmd->mParmBuf.uMsg);       /* Message ID */
         paParms[1].setUInt32(pCmd->mParmBuf.uParmCount); /* Required parameters for message */
-        
+
         /*
         * So this call apparently failed because the guest wanted to peek
@@ -500 +500 @@
  * defer the guest call until we have something from the host.
  */
-int Service::retrieveNextHostCmd(uint32_t u32ClientID, VBOXHGCMCALLHANDLE callHandle, 
+int Service::retrieveNextHostCmd(uint32_t u32ClientID, VBOXHGCMCALLHANDLE callHandle,
                                  uint32_t cParms, VBOXHGCMSVCPARM paParms[])
 {
     int rc = VINF_SUCCESS;
 
-    /* 
+    /*
      * Lookup client in our list so that we can assign the context ID of
      * a command to that client.
@@ -547 +547 @@
               * later reference & cleanup). */
              Assert(curCmd.mContextID > 0);
+             /// @todo r=bird: check if already in the list.
              it->mContextList.push_back(curCmd.mContextID);
 
@@ -568 +569 @@
     {
         if (it->mClientID == u32ClientID)
-        {       
+        {
             if (it->mNumParms >= 2)
             {
                 it->mParms[0].setUInt32(GETHOSTMSG_EXEC_HOST_CANCEL_WAIT); /* Message ID. */
                 it->mParms[1].setUInt32(0);                                /* Required parameters for message. */
-            }              
+            }
             if (mpHelpers)
-                mpHelpers->pfnCallComplete(it->mHandle, rc);      
+                mpHelpers->pfnCallComplete(it->mHandle, rc);
             it = mClientList.erase(it);
         }
@@ -636 +637 @@
         && newCmd.mParmBuf.uParmCount > 0)
     {
-        /* 
+        /*
          * Assume that the context ID *always* is the first parameter,
          * assign the context ID to the command.
@@ -651 +652 @@
         {
             GuestCall guest = mClientList.front();
-            rc = sendHostCmdToGuest(&newCmd, 
+            rc = sendHostCmdToGuest(&newCmd,
                                     guest.mHandle, guest.mNumParms, guest.mParms);
 
@@ -657 +658 @@
             AssertPtr(mpHelpers);
             mpHelpers->pfnCallComplete(guest.mHandle, rc);
-            mClientList.pop_front();                       
-            
+            mClientList.pop_front();
+
             /* If we got VERR_TOO_MUCH_DATA we buffer the host command in the next block
-             * and return success to the host. */            
+             * and return success to the host. */
             if (rc == VERR_TOO_MUCH_DATA)
             {
@@ -675 +676 @@
         if (!fProcessed)
         {
-            mHostCmds.push_back(newCmd);    
+            mHostCmds.push_back(newCmd);
 #if 0
             /* Limit list size by deleting oldest element. */