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

Timestamp:

Jan 31, 2019 11:53:09 AM (6 years ago)

Author:

vboxsync

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

128518

Message:

Guest Control/Main: Renamed GuestSessionTaskInternalOpen() to GuestSessionTaskInternalStart() to match the rest of the terminology. Emphasize rc usage.

Location:

trunk/src/VBox/Main

Files:

• include/GuestSessionImpl.h (modified) (2 diffs)
• include/GuestSessionImplTasks.h (modified) (1 diff)
• src-client/GuestSessionImpl.cpp (modified) (6 diffs)

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

@@ -36 +36 @@
 #include <deque>
 
-class GuestSessionTaskInternalOpen; /* Needed for i_startSessionThreadTask(). */
+class GuestSessionTaskInternalStart; /* Needed for i_startSessionThreadTask(). */
 
 /**
@@ -313 +313 @@
     int                     i_startSession(int *pGuestRc);
     int                     i_startSessionAsync(void);
-    static void             i_startSessionThreadTask(GuestSessionTaskInternalOpen *pTask);
+    static int              i_startSessionThreadTask(GuestSessionTaskInternalStart *pTask);
     Guest                  *i_getParent(void) { return mParent; }
     uint32_t                i_getProtocolVersion(void) { return mData.mProtocolVersion; }

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

@@ -35 +35 @@
 class Guest;
 class GuestSessionTask;
-class GuestSessionTaskInternalOpen;
+class GuestSessionTaskInternalStart;
 
 

trunk/src/VBox/Main/src-client/GuestSessionImpl.cpp

@@ -79 +79 @@
 
 /**
- * Class for asynchronously opening a guest session.
+ * Class for asynchronously starting a guest session.
  */
-class GuestSessionTaskInternalOpen : public GuestSessionTaskInternal
+class GuestSessionTaskInternalStart : public GuestSessionTaskInternal
 {
 public:
 
-    GuestSessionTaskInternalOpen(GuestSession *pSession)
+    GuestSessionTaskInternalStart(GuestSession *pSession)
         : GuestSessionTaskInternal(pSession)
     {
@@ -93 +93 @@
     void handler()
     {
-        GuestSession::i_startSessionThreadTask(this);
+        /* Ignore rc */ GuestSession::i_startSessionThreadTask(this);
     }
 };
@@ -1972 +1972 @@
 }
 
+/**
+ * Starts the guest session asynchronously in a separate thread.
+ *
+ * @returns IPRT status code.
+ */
 int GuestSession::i_startSessionAsync(void)
 {
@@ -1977 +1982 @@
 
     int vrc;
-    GuestSessionTaskInternalOpen* pTask = NULL;
+    GuestSessionTaskInternalStart* pTask = NULL;
     try
     {
-        pTask = new GuestSessionTaskInternalOpen(this);
+        pTask = new GuestSessionTaskInternalStart(this);
         if (!pTask->isOk())
         {
             delete pTask;
-            LogFlow(("GuestSession: Could not create GuestSessionTaskInternalOpen object \n"));
+            LogFlow(("GuestSession: Could not create GuestSessionTaskInternalStart object\n"));
             throw VERR_MEMOBJ_INIT_FAILED;
         }
 
-        /* Asynchronously open the session on the guest by kicking off a
-         * worker thread. */
-        //this function delete pTask in case of exceptions, so there is no need in the call of delete operator
+        /* Asynchronously open the session on the guest by kicking off a worker thread. */
+        /* Note: This function deletes pTask in case of exceptions, so there is no need in the call of delete operator. */
         HRESULT hrc = pTask->createThread();
         vrc = Global::vboxStatusCodeFromCOM(hrc);
@@ -2008 +2012 @@
 }
 
+/**
+ * Static function to start a guest session asynchronously.
+ *
+ * @returns IPRT status code.
+ * @param   pTask               Task object to use for starting the guest session.
+ */
 /* static */
-void GuestSession::i_startSessionThreadTask(GuestSessionTaskInternalOpen *pTask)
+int GuestSession::i_startSessionThreadTask(GuestSessionTaskInternalStart *pTask)
 {
     LogFlowFunc(("pTask=%p\n", pTask));
@@ -2019 +2029 @@
     AutoCaller autoCaller(pSession);
     if (FAILED(autoCaller.rc()))
-        return;
+        return VERR_COM_INVALID_OBJECT_STATE;
 
     int vrc = pSession->i_startSession(NULL /* Guest rc, ignored */);
-/** @todo
- *
- * r=bird: Is it okay to ignore @a vrc here?
- *
- */
-
     /* Nothing to do here anymore. */
 
     LogFlowFuncLeaveRC(vrc);
-    NOREF(vrc);
+    return vrc;
 }