Implement samp.hub.shutdown request.

The samp.hub.shutdown request allows a client to shutdown the VO Hub. This is not part of the SAMP protocol but does not harm. It is basically needed for unit testing.

Implement samp.hub.shutdown request.
The samp.hub.shutdown request allows a client to shutdown the VO Hub. This is not part of the SAMP protocol but does not harm. It is basically needed for unit testing.
Jürgen Knödlseder
1 parent 4e44ffd3
Showing 5 changed files with 87 additions and 11 deletions
include/GVOClient.hpp
include/GVOHub.hpp
src/vo/GVOClient.cpp
src/vo/GVOHub.cpp
test/test_GVO.cpp
@@ -72,6 +72,7 @@ public:
     bool        has_hub(void) const;
     bool        is_connected(void) const;
     bool        ping_hub(void) const;
+    void        shutdown_hub(void) const;
     GXml        execute(const std::string& request) const;
     std::string print(const GChatter& chatter = NORMAL) const;
  
@@ -95,6 +95,7 @@ protected:
                                                           const socklen_t& sock);
     void                   request_get_metadata(const GXml& xml,
                                                 const socklen_t& sock);
+    void                   request_shutdown(const socklen_t& sock);
     std::string            get_client_key(const GXml& xml) const;
     int                    get_client_index(const GXml& xml) const;
     std::string            get_response_value(const GXml& xml,
@@ -289,6 +289,31 @@ bool GVOClient::ping_hub(void) const
  
  
 /***********************************************************************//**
+ * @brief Shutdown VO Hub
+ ***************************************************************************/
+void GVOClient::shutdown_hub(void) const
+{
+    // Declare request
+    std::string request = "";
+    
+    // Set request
+    request.append("<?xml version=\"1.0\"?>\n");
+    request.append("<methodCall>\n");
+    request.append("  <methodName>samp.hub.shutdown</methodName>\n");
+    request.append("  <params>\n");
+    request.append("    <param><value/></param>\n");
+    request.append("  </params>\n");
+    request.append("</methodCall>\n");
+
+    // Execute request
+    execute(request);
+
+    // Return
+    return;
+}
+
+
+/***********************************************************************//**
  * @brief Execute function on server
  *
  * @param[in] request XML request string
@@ -612,15 +637,13 @@ bool GVOClient::require_hub(void)
  
             // Check that Hub is alive
             for (int i = 0; i < 3; ++i) {
-                found = ping_hub();
+                found = find_hub() && ping_hub();
                 if (found) {
                     break;
                 }
+                sleep(1);
             }
  
-            // Get Hub information
-            found = find_hub();
-
         }
  
     } // endif: created own VO Hub
@@ -423,9 +423,6 @@ void GVOHub::start_hub(void)
             // Handle request
             handle_request(newsocket);
  
-            // Close socket
-            close(newsocket);
-            
             // Exit child process
             exit(0);
         }
@@ -438,9 +435,18 @@ void GVOHub::start_hub(void)
             // Wait for the child process to terminate
             int status = 0;
             waitpid(pid, &status, 0);
+
+            // Close socket
+            close(newsocket);
  
             // Send SIG_IGN to child process
             std::signal(pid, SIG_IGN);
+
+            // If we have received a shutdown request then exit the event
+            // loop
+            if (m_clients->registered == -1) {
+                break;
+            }
  
         }
  
@@ -448,7 +454,9 @@ void GVOHub::start_hub(void)
  
     // Close socket
     close(hub_socket);
-    
+std::cout << "\n\n*** Hub shutdown ***" << std::endl;
+system("netstat -npta");
+
     // Return
     return;
 }
@@ -561,6 +569,9 @@ void GVOHub::handle_request(const socklen_t&amp; sock)
     else if (method_called.compare("samp.hub.reply") == 0) {
         request_ping(sock);
     }
+    else if (method_called.compare("samp.hub.shutdown") == 0) {
+        request_shutdown(sock);
+    }
  
     // Return
     return;
@@ -666,7 +677,7 @@ void GVOHub::request_register(const GXml&amp; xml, const socklen_t&amp; sock)
     activate_callbacks("samp.hub.event.register", cl_id);	
  
     // Increment number of registered clients
-    m_clients->registered ++;
+    //m_clients->registered++;
  
     //Return
     return;
@@ -1168,6 +1179,42 @@ void GVOHub::request_get_metadata(const GXml&amp; xml,const socklen_t&amp; sock)
  
  
 /***********************************************************************//**
+ * @brief Handles Hub shutdown requests
+ *
+ * @param[in] sock Socket.
+ *
+ * Handles all incoming Hub shutdown requests.
+ ***************************************************************************/
+void GVOHub::request_shutdown(const socklen_t& sock)
+{
+    // Header
+    #if defined(G_CONSOLE_DUMP)
+    std::cout << "GVOHub::request_shutdown" << std::endl;
+    #endif
+
+    // Set shutdown flag
+    m_clients->registered = -1;
+    
+    // Declare message
+    std::string msg = "";
+
+    // Set response
+    msg.append("<?xml version=\"1.0\"?>\n");
+    msg.append("<methodResponse>\n");
+    msg.append("<params>\n");
+    msg.append("  <param><value/></param>\n");
+    msg.append("</params>\n");
+    msg.append("</methodResponse>\n");
+    
+    // Post response
+    post_string(msg,sock);
+
+    // Return
+    return;
+}
+
+
+/***********************************************************************//**
  * @brief Extract client key from XML request
  *
  * @param[in] xml XML message sent by client.
@@ -124,8 +124,9 @@ system(&quot;netstat -npta&quot;);
     // Cancel thread. We do this here so that for the next test
     // there is no Hub anymore. We do some sleeping to assure that
     // the thread has been canceled.
-    pthread_cancel(thread);
-    sleep(1);
+    //pthread_cancel(thread);
+    //sleep(1);
+    client.shutdown_hub();
 std::cout << "\n*** After thread canel ***" << std::endl;
 system("netstat -npta");
  
@@ -173,6 +174,9 @@ system(&quot;netstat -npta&quot;);
     // Test ping
     test_assert(client.ping_hub(), "Ping Hub.");
  
+    // Shutdown VO Hub
+    client.shutdown_hub();
+
     // Return
     return;
 }