Changeset 34357 in vbox for trunk/src/VBox/Additions

Timestamp:

Nov 25, 2010 10:24:41 AM (14 years ago)

Author:

vboxsync

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

68120

Message:

VBoxTray/InstallHelper: IPC Update.

Location:

trunk/src/VBox/Additions/WINNT

Files:

• Installer/InstallHelper/VBoxGuestInstallHelper.cpp (modified) (1 diff)
• VBoxTray/VBoxIPC.cpp (modified) (8 diffs)
• VBoxTray/VBoxTrayMsg.h (modified) (3 diffs)

trunk/src/VBox/Additions/WINNT/Installer/InstallHelper/VBoxGuestInstallHelper.cpp

@@ -146 +146 @@
     VBOXTRAYIPCHEADER hdr;
     hdr.ulMsg = VBOXTRAYIPCMSGTYPE_SHOWBALLOONMSG;
+    hdr.cbBody = sizeof(VBOXTRAYIPCMSG_SHOWBALLOONMSG);
 
     VBOXTRAYIPCMSG_SHOWBALLOONMSG msg;
-    HRESULT hr = VBoxPopString(msg.szBody, sizeof(msg.szBody) / sizeof(TCHAR));
+    HRESULT hr = VBoxPopString(msg.szContent, sizeof(msg.szContent) / sizeof(TCHAR));
     if (SUCCEEDED(hr))
         hr = VBoxPopString(msg.szTitle, sizeof(msg.szTitle) / sizeof(TCHAR));

trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxIPC.cpp

@@ -26 +26 @@
 #include <VBoxGuestInternal.h>
 
+
 typedef struct _VBOXIPCCONTEXT
 {
@@ -35 +36 @@
 static VBOXIPCCONTEXT gCtx = {0};
 
+
+/**
+ * Reads an IPC message from a connected client, represented by the IPC
+ * context.
+ *
+ * @return  IPRT status code.
+ * @param   pCtx                    The IPC context.
+ * @param   pMessage                Buffer for receiving the message to be read.
+ * @param   cbMessage               Size (in bytes) of buffer for received message.
+ */
 int VBoxIPCReadMessage(PVBOXIPCCONTEXT pCtx, BYTE *pMessage, DWORD cbMessage)
 {
@@ -57 +68 @@
 }
 
+/**
+ * Skips an IPC message by reading out the outstanding message
+ * body to discard it.
+ *
+ * @return  IPRT status code.
+ * @param   pCtx                    The IPC context.
+ * @param   pHdr                    The header of message to skip.
+ */
+int VBoxIPCSkipMessage(PVBOXIPCCONTEXT pCtx, PVBOXTRAYIPCHEADER pHdr)
+{
+    Assert(pHdr->cbBody);
+    BYTE *pbBuf = (BYTE*)RTMemAlloc(pHdr->cbBody);
+    if (!pbBuf)
+        return VERR_NO_MEMORY;
+    int rc = VBoxIPCReadMessage(pCtx, pbBuf, pHdr->cbBody);
+    RTMemFree(pbBuf);
+    return rc;
+}
+
+/**
+ * Writes an IPC message to the IPC context's client.
+ *
+ * @return  IPRT status code.
+ * @param   pCtx                    The IPC context.
+ * @param   pMessage                Pointer to message to send.
+ * @param   cbMessage               Size (in bytes) of message to send.
+ */
 int VBoxIPCWriteMessage(PVBOXIPCCONTEXT pCtx, BYTE *pMessage, DWORD cbMessage)
 {
@@ -82 +120 @@
  *
  * @return  IPRT status code.
- * @param   pCtx
- * @param   wParam
- * @param   lParam
+ * @param   pCtx                    IPC context of the caller.
+ * @param   wParam                  wParam of received IPC message.
+ * @param   lParam                  lParam of received IPC message.
  */
 int VBoxIPCMsgShowBalloonMsg(PVBOXIPCCONTEXT pCtx, UINT wParam, UINT lParam)
@@ -93 +131 @@
     {
         hlpShowBalloonTip(gInstance, gToolWindow, ID_TRAYICON,
-                          msg.szBody, msg.szTitle,
+                          msg.szContent, msg.szTitle,
                           msg.ulShowMS, msg.ulType);
     }
@@ -99 +137 @@
 }
 
+/**
+ * Takes action to restart VBoxTray (this application).
+ *
+ * @return  IPRT status code.
+ * @param   pCtx                    IPC context of the caller.
+ * @param   wParam                  wParam of received IPC message.
+ * @param   lParam                  lParam of received IPC message.
+ */
+int VBoxIPCMsgRestart(PVBOXIPCCONTEXT pCtx, UINT wParam, UINT lParam)
+{
+    return 0;
+}
+
+/**
+ * Initializes the IPC communication.
+ *
+ * @return  IPRT status code.
+ * @param   pEnv                        The IPC service's environment.
+ * @param   ppInstance                  The instance pointer which refer to this object.
+ * @param   pfStartThread               Pointer to flag whether the IPC service can be started or not.
+ */
 int VBoxIPCInit(const VBOXSERVICEENV *pEnv, void **ppInstance, bool *pfStartThread)
 {
@@ -203 +262 @@
             if (SUCCEEDED(dwErr))
             {
+                Log(("VBoxTray: VBoxIPCThread: Received message %ld ...\n", hdr.ulMsg));
                 switch (hdr.ulMsg)
                 {
+                    case VBOXTRAYIPCMSGTYPE_QUIT:
+                        fTerminate = true;
+                        break;
+
+                    case VBOXTRAYIPCMSGTYPE_RESTART:
+                        rc = VBoxIPCMsgRestart(pCtx, hdr.wParam, hdr.lParam);
+                        if (RT_SUCCESS(rc))
+                            fTerminate = true;
+                        break;
+
                     case VBOXTRAYIPCMSGTYPE_SHOWBALLOONMSG:
                         rc = VBoxIPCMsgShowBalloonMsg(pCtx, hdr.wParam, hdr.lParam);
                         break;
 
-                    /* Someone asked us to quit ... */
-                    case VBOXTRAYIPCMSGTYPE_QUIT:
-                        fTerminate = true;
-                        break;
-
                     default:
+                        /* Unknown message received, try to receive the body and
+                         * just skip it. */
+                        Log(("VBoxTray: VBoxIPCThread: Unknown message %ld, skipping ...\n", hdr.ulMsg));
+                        if (hdr.cbBody)
+                            rc = VBoxIPCSkipMessage(pCtx, &hdr);
                         break;
                 }
@@ -227 +297 @@
         /* Sleep a bit to not eat too much CPU in case the above call always fails. */
         if (WaitForSingleObject(pCtx->pEnv->hStopEvent, 10) == WAIT_OBJECT_0)
-        {
             fTerminate = true;
-            break;
-        }
+        if (fTerminate)
+            Log(("VBoxTray: VBoxIPCThread: Terminating ...\n"));
     } while (!fTerminate);
 

trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxTrayMsg.h

@@ -26 +26 @@
     /** Asks the IPC thread to quit. */
     VBOXTRAYIPCMSGTYPE_QUIT           = 10,
-    /** TODO */
+    /** Restarts VBoxTray. */
+    VBOXTRAYIPCMSGTYPE_RESTART        = 11,
+    /** Shows a balloon message in the tray area. */
     VBOXTRAYIPCMSGTYPE_SHOWBALLOONMSG = 100
 };
@@ -35 +37 @@
     /** Message type. */
     ULONG ulMsg;
+    /** Size of message body
+     *  (without this header). */
+    ULONG cbBody;
     /** User-supplied wParam. */
     ULONG wParam;
@@ -43 +48 @@
 typedef struct _VBOXTRAYIPCMSG_SHOWBALLOONMSG
 {
-    /** Message body. */
-    TCHAR    szBody[256];
-    /** Message body. */
+    /** Message content. */
+    TCHAR    szContent[256];
+    /** Message title. */
     TCHAR    szTitle[64];
     /** Message type. */