Changeset 48431 in vbox for trunk/src/VBox/Main/include/ClientToken.h

Timestamp:

Sep 11, 2013 2:08:36 PM (11 years ago)

Author:

vboxsync

Message:

Main/Machine+Session: New generic client session watcher implementation based on token objects, works on all platforms and is used for now on XPCOM. Additionally a better error message when several API clients are racing for a lock, previously it could be quite confusing.

File:

• trunk/src/VBox/Main/include/ClientToken.h (modified) (6 diffs)

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

@@ -3 +3 @@
 /** @file
  *
- * VirtualBox API client token abstraction
+ * VirtualBox API client session token abstraction
  */
 
@@ -25 +25 @@
 
 #include "MachineImpl.h"
+#ifdef VBOX_WITH_GENERIC_SESSION_WATCHER
+# include "TokenImpl.h"
+#endif /* VBOX_WITH_GENERIC_SESSION_WATCHER */
 
 #if defined(RT_OS_WINDOWS)
@@ -35 +38 @@
 # define CTTOKENARG -1
 # define CTTOKENTYPE int
+#elif defined(VBOX_WITH_GENERIC_SESSION_WATCHER)
+# define CTTOKENARG NULL
+# define CTTOKENTYPE MachineToken *
 #else
 # error "Port me!"
@@ -49 +55 @@
      * Constructor which creates a usable instance
      *
-     * @param pMachine  Reference to Machine object
+     * @param pMachine          Reference to Machine object
+     * @param pSessionMachine   Reference to corresponding SessionMachine object
      */
-    ClientToken(const ComObjPtr<Machine> &pMachine);
+    ClientToken(const ComObjPtr<Machine> &pMachine, SessionMachine *pSessionMachine);
 
     /**
@@ -74 +81 @@
     CTTOKENTYPE getToken();
 
+#ifndef VBOX_WITH_GENERIC_SESSION_WATCHER
     /**
      * Release token now. Returns information if the client has terminated.
      */
     bool release();
+#endif /* !VBOX_WITH_GENERIC_SESSION_WATCHER */
 
 private:
@@ -88 +97 @@
     CTTOKENTYPE mClientToken;
     Utf8Str mClientTokenId;
+#ifdef VBOX_WITH_GENERIC_SESSION_WATCHER
+    bool mClientTokenPassed;
+#endif
 };