Changeset 74205 in vbox for trunk/src

Timestamp:

Sep 12, 2018 9:22:06 AM (6 years ago)

Author:

vboxsync

Message:

DnD/HostService: Refactored out more code to the common client and message classes, added documentation (also about deferred client states).

Location:

trunk/src/VBox/HostServices

Files:

• DragAndDrop/Makefile.kmk (modified) (2 diffs)
• DragAndDrop/service.cpp (modified) (14 diffs)
• common (added)
• common/client.cpp (added)
• common/message.cpp (added)

trunk/src/VBox/HostServices/DragAndDrop/Makefile.kmk

@@ -5 +5 @@
 
 #
-# Copyright (C) 2011-2017 Oracle Corporation
+# Copyright (C) 2011-2018 Oracle Corporation
 #
 # This file is part of VirtualBox Open Source Edition (OSE), as
@@ -39 +39 @@
         dndmanager.cpp
 
+VBoxDragAndDropSvc_SOURCES += \
+    ../common/client.cpp \
+    ../common/message.cpp
+
 VBoxDragAndDropSvc_SOURCES.win = \
         VBoxDragAndDropSvc.rc

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

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2011-2017 Oracle Corporation
+ * Copyright (C) 2011-2018 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -51 +51 @@
 public:
 
-    DragAndDropClient(uint32_t uClientId, VBOXHGCMCALLHANDLE hHandle = NULL,
-                      uint32_t uMsg = 0, uint32_t cParms = 0, VBOXHGCMSVCPARM aParms[] = NULL)
-        : HGCM::Client(uClientId, hHandle, uMsg, cParms, aParms)
-        , m_fDeferred(false)
+    DragAndDropClient(uint32_t uClientID)
+        : HGCM::Client(uClientID)
     {
         RT_ZERO(m_SvcCtx);
@@ -66 +64 @@
 public:
 
-    void complete(VBOXHGCMCALLHANDLE hHandle, int rcOp);
-    void completeDeferred(int rcOp);
     void disconnect(void);
-    bool isDeferred(void) const { return m_fDeferred; }
-    void setDeferred(VBOXHGCMCALLHANDLE hHandle, uint32_t u32Function, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
-    void setSvcContext(const HGCM::VBOXHGCMSVCTX &SvcCtx) { m_SvcCtx = SvcCtx; }
-
-protected:
-
-    /** The HGCM service context this client is bound to. */
-    HGCM::VBOXHGCMSVCTX m_SvcCtx;
-    /** Flag indicating whether this client currently is deferred mode,
-     *  meaning that it did not return to the caller yet. */
-    bool                m_fDeferred;
 };
 
@@ -137 +122 @@
 
 /**
- * Completes the call by returning the control back to the guest
- * side code.
- */
-void DragAndDropClient::complete(VBOXHGCMCALLHANDLE hHandle, int rcOp)
-{
-    LogFlowThisFunc(("uClientID=%RU32\n", m_uClientId));
-
-    if (   m_SvcCtx.pHelpers
-        && m_SvcCtx.pHelpers->pfnCallComplete)
-    {
-        m_SvcCtx.pHelpers->pfnCallComplete(hHandle, rcOp);
-    }
-}
-
-/**
- * Completes a deferred call by returning the control back to the guest
- * side code.
- */
-void DragAndDropClient::completeDeferred(int rcOp)
-{
-    AssertMsg(m_fDeferred, ("Client %RU32 is not in deferred mode\n", m_uClientId));
-    Assert(m_hHandle != NULL);
-
-    LogFlowThisFunc(("uClientID=%RU32\n", m_uClientId));
-
-    complete(m_hHandle, rcOp);
-    m_fDeferred = false;
-}
-
-/**
  * Called when the HGCM client disconnected on the guest side.
  * This function takes care of the client's data cleanup and also lets the host
@@ -174 +129 @@
 void DragAndDropClient::disconnect(void)
 {
-    LogFlowThisFunc(("uClient=%RU32\n", m_uClientId));
-
-    if (isDeferred())
-        completeDeferred(VERR_INTERRUPTED);
+    LogFlowThisFunc(("uClient=%RU32\n", m_uClientID));
+
+    if (IsDeferred())
+        CompleteDeferred(VERR_INTERRUPTED);
 
     /*
@@ -191 +146 @@
         int rc2 = m_SvcCtx.pfnHostCallback(m_SvcCtx.pvHostData, GUEST_DND_DISCONNECT, &data, sizeof(data));
         if (RT_FAILURE(rc2))
-            LogFlowFunc(("Warning: Unable to notify host about client %RU32 disconnect, rc=%Rrc\n", m_uClientId, rc2));
+            LogFlowFunc(("Warning: Unable to notify host about client %RU32 disconnect, rc=%Rrc\n", m_uClientID, rc2));
         /* Not fatal. */
     }
 }
-
-/**
- * Set the client's status to deferred, meaning that it does not return to the caller
- * on the guest side yet.
- */
-void DragAndDropClient::setDeferred(VBOXHGCMCALLHANDLE hHandle, uint32_t u32Function, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
-{
-    LogFlowThisFunc(("uClient=%RU32\n", m_uClientId));
-
-    AssertMsg(m_fDeferred == false, ("Client already in deferred mode\n"));
-    m_fDeferred = true;
-
-    m_hHandle = hHandle;
-    m_uMsg    = u32Function;
-    m_cParms  = cParms;
-    m_paParms = paParms;
-}
-
 
 /*********************************************************************************************************************************
@@ -288 +225 @@
         {
             DragAndDropClient *pClient = new DragAndDropClient(u32ClientID);
-            pClient->setSvcContext(m_SvcCtx);
+            pClient->SetSvcContext(m_SvcCtx);
             m_clientMap[u32ClientID] = pClient;
         }
@@ -553 +490 @@
                         rc = paParms[idxProto + 1].getUInt32(&data.uFlags);
                     if (RT_SUCCESS(rc))
-                        rc = pClient->SetProtocolVer(data.uProtocol);
+                        pClient->SetProtocolVer(data.uProtocol);
                     if (RT_SUCCESS(rc))
                     {
@@ -1088 +1025 @@
         {
             AssertPtr(pClient);
-            pClient->setDeferred(callHandle, u32Function, cParms, paParms);
+            pClient->SetDeferred(callHandle, u32Function, cParms, paParms);
             m_clientQueue.push_back(u32ClientID);
         }
@@ -1098 +1035 @@
     }
     else if (pClient)
-        pClient->complete(callHandle, rc);
+        pClient->Complete(callHandle, rc);
     else
     {
@@ -1163 +1100 @@
                     AssertPtr(pClient);
 
-                    int rc2 = pClient->addMessageInfo(HOST_DND_HG_EVT_CANCEL,
-                                                      /* Protocol v3+ also contains the context ID. */
-                                                      pClient->GetProtocolVer() >= 3 ? 1 : 0);
-                    pClient->completeDeferred(rc2);
+                    int rc2 = pClient->SetDeferredMsgInfo(HOST_DND_HG_EVT_CANCEL,
+                                                          /* Protocol v3+ also contains the context ID. */
+                                                          pClient->GetProtocolVer() >= 3 ? 1 : 0);
+                    pClient->CompleteDeferred(rc2);
 
                     m_clientQueue.erase(itQueue);
@@ -1246 +1183 @@
                 if (uMsgClient == GUEST_DND_GET_NEXT_HOST_MSG)
                 {
-                    rc = pClient->addMessageInfo(uMsgNext, cParmsNext);
+                    rc = pClient->SetDeferredMsgInfo(uMsgNext, cParmsNext);
 
                     /* Note: Report the current rc back to the guest. */
-                    pClient->completeDeferred(rc);
+                    pClient->CompleteDeferred(rc);
                 }
                 /*
@@ -1260 +1197 @@
 
                     /* Note: Report the current rc back to the guest. */
-                    pClient->completeDeferred(rc);
+                    pClient->CompleteDeferred(rc);
                 }
                 else /* Should not happen; cancel the operation on the guest. */
@@ -1267 +1204 @@
                              pClient->GetClientID(), uMsgClient, uMsgNext));
 
-                    pClient->completeDeferred(VERR_CANCELLED);
+                    pClient->CompleteDeferred(VERR_CANCELLED);
                 }