After GVOApp creation in order to keep track of every VO Application registered in the Hub

Thierry Louge
1 parent a4413814
Showing 5 changed files with 325 additions and 24 deletions
include/GVOApp.hpp
include/GVOHub.hpp
src/vo/GVOApp.cpp
src/vo/GVOHub.cpp
src/vo/Makefile.am
+/***************************************************************************
+ *                      GVOApp.hpp - VO SAMP Hub class                     *
+ * ----------------------------------------------------------------------- *
+ *  copyright (C) 2014 by Thierry Louge                                    *
+ * ----------------------------------------------------------------------- *
+ *                                                                         *
+ *  This program is free software: you can redistribute it and/or modify   *
+ *  it under the terms of the GNU General Public License as published by   *
+ *  the Free Software Foundation, either version 3 of the License, or      *
+ *  (at your option) any later version.                                    *
+ *                                                                         *
+ *  This program is distributed in the hope that it will be useful,        *
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *  GNU General Public License for more details.                           *
+ *                                                                         *
+ *  You should have received a copy of the GNU General Public License      *
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.  *
+ *                                                                         *
+ ***************************************************************************/
+/**
+ * @file GVOApp.hpp
+ * @brief SAMP hub class interface definition
+ * @author Thierry Louge
+ */
+
+#ifndef GVOAPP_HPP
+#define GVOAPP_HPP
+
+/* __ Includes ___________________________________________________________ */
+#include <string>
+#include <list>
+#include "GBase.hpp"
+#include "GXml.hpp"
+#include "GXmlNode.hpp"
+
+
+/***********************************************************************//**
+ * @class GVOApp
+ *
+ * @brief VO SAMP Hub class
+ *
+ * This class implements a SAMP hub for exchanges 
+ * through VO-compatible applications.
+ ***************************************************************************/
+class GVOApp : public GBase {
+
+public:
+    // Constructors and destructors
+    GVOApp(void);
+    GVOApp(const GVOApp& hub);
+    virtual ~GVOApp(void);
+
+    // Operators
+    GVOApp& operator=(const GVOApp& hub);
+
+    // Methods
+    void        clear(void);
+    GVOApp*     clone(void) const;
+    void        start(void);
+    std::string print(const GChatter& chatter = NORMAL) const;
+    //void        connect(void);
+    //void        disconnect(void);
+    //bool        has_hub(void) const;
+    //bool        is_connected(void) const;
+    //GXml        response(void) const;
+
+protected:
+    // Protected methods
+    void        init_members(void);
+    void        copy_members(const GVOApp& client);
+    void        free_members(void);
+    void	init_app(void);
+    void        start_app(void);
+    void        post_string(const std::string& string) const;
+    std::string receive_string(void) const;
+    std::string get_response_value(const GXml& xml, const std::string& name) const;
+    void        get_name_value_pair(const GXmlNode* node, std::string& name, std::string& value) const;
+
+    // Protected data area
+    std::string m_name;        //!< Client name
+    std::string m__id; //!< Id assigned to client by the hub
+    std::list <std::string> registered_calls; //!< calls for which is registered the application.
+    
+};
+
+#endif /* GVOAPP_HPP */
@@ -29,10 +29,12 @@
 /* __ Includes ___________________________________________________________ */
 #include <string>
+#include <list>
 #include <sys/socket.h>
 #include "GBase.hpp"
 #include "GXml.hpp"
 #include "GXmlNode.hpp"
+#include "GVOApp.hpp"
 /***********************************************************************//**
@@ -79,7 +81,7 @@ protected:
     void        unregister(const socklen_t& sock);
     void 	handle_request(const socklen_t& sock);
     void        register_metadata(const GXml& xml,const socklen_t& sock);
-    
+    void        declare_subscriptions(const GXml& xml,const socklen_t& sock);
     // Low-level methods
     void        post_string(const std::string& string) const;
     std::string receive_string(void) const;
@@ -95,15 +97,13 @@ protected:
     std::string m_hub_port;    //!< Hub port (extracted from XML-RPC endpoint)
     std::string m_version;     //!< The version of the SAMP Standard Profile implemented by the hub
     std::string m_client_key;  //!< Private client key
-    std::string m_hub_id;      //!< Hub identifier
-    std::string m_client_id;   //!< Client identifier
+    std::string m_hub_id;      //!< Hub identifier used by the hub when it sends message itself rather than forwarding from others
+    //std::string m_client_id;   //!< Client identifier
     int         m_socket;      //!< Hub socket
     int 	m_nb_clients;  //!< Number of already registered clients
-    struct client_metadata {
-      std::string client_id;
-      std::string client_name;
-    };
-    static client_metadata * Clients; //Array of structure containing clients id and names
+    //std::vector<int> m_client_id; //!< Id assigned to client by the hub.
+    //std::vector<std::string> m_client_name;
+    std::list<GVOApp*> m_connected_apps; //!< list of apps connected to the hub
 };
 #endif /* GVOHUB_HPP */
+/***************************************************************************
+ *                     GVOApp.hpp - VO SAMP Hub class                      *
+ * ----------------------------------------------------------------------- *
+ *  copyright (C) 2014 by Thierry Louge                                    *
+ * ----------------------------------------------------------------------- *
+ *                                                                         *
+ *  This program is free software: you can redistribute it and/or modify   *
+ *  it under the terms of the GNU General Public License as published by   *
+ *  the Free Software Foundation, either version 3 of the License, or      *
+ *  (at your option) any later version.                                    *
+ *                                                                         *
+ *  This program is distributed in the hope that it will be useful,        *
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *  GNU General Public License for more details.                           *
+ *                                                                         *
+ *  You should have received a copy of the GNU General Public License      *
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.  *
+ *                                                                         *
+ ***************************************************************************/
+/**
+ * @file GVOApp.cpp
+ * @brief VO  Application connected to SAMP HUB class implementation
+ * @author Thierry Louge
+ */
+
+/* __ Includes ___________________________________________________________ */
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#include <errno.h>
+#endif
+#include <cstdlib>         // std::getenv() function
+#include <cstdio>          // std::fopen(), etc. functions
+#include <cstring>         // std::memset() function
+#include <unistd.h>        // close() function
+#include "GVOApp.hpp"
+
+/* __ Method name definitions ____________________________________________ */
+#define G_HANDLE_REQUEST                  "GVOApp::handle_request(socklen_t)"
+#define G_START_HUB                                     "GVOApp::start_hub()"
+
+/* __ Macros _____________________________________________________________ */
+
+/* __ Coding definitions _________________________________________________ */
+
+/* __ Debug definitions __________________________________________________ */
+
+
+/*==========================================================================
+ =                                                                         =
+ =                         Constructors/destructors                        =
+ =                                                                         =
+ ==========================================================================*/
+
+/***********************************************************************//**
+ * @brief Void constructor
+ ***************************************************************************/
+GVOApp::GVOApp(void)
+{
+    // Initialise members
+    init_members();
+
+    // Return
+    return;
+}
+
+
+/***********************************************************************//**
+ * @brief Copy constructor
+ *
+ * @param[in] hub VO Hub.
+ ***************************************************************************/
+GVOApp::GVOApp(const GVOApp& hub)
+{
+    // Initialise members
+    init_members();
+
+    // Copy members
+    copy_members(hub);
+
+    // Return
+    return;
+}
+
+
+/***********************************************************************//**
+ * @brief Destructor
+ ***************************************************************************/
+GVOApp::~GVOApp(void)
+{
+    
+    // Return
+    return;
+}
+
+
+/*==========================================================================
+ =                                                                         =
+ =                                Operators                                =
+ =                                                                         =
+ ==========================================================================*/
+
+/***********************************************************************//**
+ * @brief Assignment operator
+ *
+ * @param[in] hub VO hub.
+ * @return VO hub.
+ ***************************************************************************/
+GVOApp& GVOApp::operator=(const GVOApp& hub)
+{
+    // Execute only if object is not identical
+    if (this != &hub) {
+
+        // Free members
+        free_members();
+
+        // Initialise members
+        init_members();
+
+        // Copy members
+        copy_members(hub);
+
+    } // endif: object was not identical
+
+    // Return
+    return *this;
+}
+
+
+/*==========================================================================
+ =                                                                         =
+ =                             Public methods                              =
+ =                                                                         =
+ ==========================================================================*/
+
+/***********************************************************************//**
+ * @brief Clear object.
+ *
+ * Reset object to a clean initial state.
+ ***************************************************************************/
+void GVOApp::clear(void)
+{
+    // Free memory and initialise members
+    free_members();
+    init_members();
+
+    // Return
+    return;
+}
+
+
+/***********************************************************************//**
+ * @brief Clone object
+ ***************************************************************************/
+GVOApp* GVOApp::clone(void) const
+{
+    // Clone client
+    return new GVOApp(*this);
+}
+
+
+/***********************************************************************//**
+ * @brief Creates nex application container
+ ***************************************************************************/
+void GVOApp::start_app(void)
+{
+    // Creates Hub
+    printf("Creating new application Container\n");
+    init_app();
+
+    // Return
+    return;
+}
+
@@ -189,7 +189,7 @@ void GVOHub::start(void)
  ***************************************************************************/
 void GVOHub::ping_service(const socklen_t& sock)
 {
-    printf("Registration request received\n");
+    printf("ping call received\n");
     // Declare message
     std::string msg = "";
@@ -218,15 +218,20 @@ void GVOHub::ping_service(const socklen_t&amp; sock)
  ***************************************************************************/
 void GVOHub::register_service(const GXml& xml, const socklen_t& sock)
 {
-    printf("Registration request received\n");
+    
+    printf("Registration request called\n");
+    
     // Declare message
     std::string msg = "";
+    char buffer[124];
     std::string translator = "http://localhost:8001/";
-    //std::string client_name = get_response_value(xml, "samp.name");
+    printf("Message composition\n");
+    //m_client_id.push_back(m_nb_clients);
-    //Clients[m_nb_clients].client_name = get_response_value(xml, "samp.name");
-    //printf("Client name %s",Clients[m_nb_clients].client_name.c_str());
-    //m_nb_clients ++;
+    printf("Message composition 2 \n");
+    sprintf(buffer,"<member><name>samp.self-id</name><value><string>client-id:%d</string></value></member>\n",m_nb_clients);
+    printf(buffer);
+    m_nb_clients ++;
     // Set methodResponse elts
     msg.append("<?xml version=\"1.0\"?>\n");
@@ -234,15 +239,16 @@ void GVOHub::register_service(const GXml&amp; xml, const socklen_t&amp; sock)
     msg.append("\t<params>\n");
     msg.append("\t\t<param>\n\t\t\t<value>\n\t\t\t\t<struct>\n");
     msg.append("<member><name>samp.private-key</name><value><string>client-key:" + m_hub_id + "</string></value></member>\n");
-    msg.append("<member><name>samp.hub-id</name><value><string>hub-id:" + m_hub_id + "</string></value></member>\n");
-    msg.append("<member><name>samp.self-id</name><value><string>client-id:" + m_client_id + "</string></value></member>\n");
+    msg.append("<member><name>samp.hub-id</name><value><string>client-id:" + m_hub_id + "</string></value></member>\n");
+    msg.append(buffer);
     msg.append("<member><name>samp.url-translator</name><value><string>" + translator + "</string></value></member>\n");
     msg.append("</struct></value></param>\n");
     msg.append("</params>\n");
     msg.append("</methodResponse>\n");
     int length = msg.length();
-    
+    printf("Sending message %s\n",msg.c_str());
+    fflush(stdout);
     int n = write(sock,msg.c_str(),length);
     if (n < 0) {
 	printf("Could not write socket buffer.\n");
@@ -275,15 +281,20 @@ void GVOHub::unregister(const socklen_t&amp; sock)
  ***************************************************************************/
 void GVOHub::register_metadata(const GXml& xml,const socklen_t& sock)
 {
+    char buffer[124];
     printf("Client Metadata received\n");
     // Search for metadata values to store
     std::string client_name = get_response_value(xml, "samp.name");
     //std::cout("Client Metadata : \n" + client_name.c_str());
     printf("\nClient Metadata : Name %s\n", client_name.c_str());
+    sprintf(buffer,"Client number: %d\n",m_nb_clients);
+    printf(buffer);
     fflush(stdout);
+    //m_client_name.push_back(client_name.c_str());
     // Declare message
     std::string msg = "";
+    //The hub response to Metadata declaration has no usefull content and can be discarded by the client.
     // Set methodResponse elts
     msg.append("<?xml version=\"1.0\"?>\n");
     msg.append("<methodResponse>\n");
@@ -302,7 +313,37 @@ void GVOHub::register_metadata(const GXml&amp; xml,const socklen_t&amp; sock)
     //Return
     return;
 }
+/***********************************************************************//**
+ * @brief 
+ *
+ *
+ ***************************************************************************/
+void GVOHub::declare_subscriptions(const GXml& xml,const socklen_t& sock)
+{
+    printf("Declare Subscriptions\n");
+    std::string client_subscriptions = get_response_value(xml, "samp.hub.event.subscriptions");
+    printf("\nClient subscriptions: %s\n", client_subscriptions.c_str());
+    // Declare message
+    std::string msg = "";
+    // Set methodResponse elts
+    msg.append("<?xml version=\"1.0\"?>\n");
+    msg.append("<methodResponse>\n");
+    msg.append("</methodResponse>\n");
+
+    int length = msg.length();
+    
+    int n = write(sock,msg.c_str(),length);
+    if (n < 0) {
+	printf("Could not write socket buffer.\n");
+        std::string msg = "Could not write socket buffer.";
+        throw GException::invalid_value(G_HANDLE_REQUEST, msg);
+    }
+
+    printf("Response message sent\n");
+    //Return
+    return;
+}
 /***********************************************************************//**
  * @brief Print VO hub information
  *
@@ -336,7 +377,7 @@ std::string GVOHub::print(const GChatter&amp; chatter) const
         }
         else {
             if (!m_client_key.empty()) {
-                result.append("registered as \""+m_client_id);
+                //result.append("registered as \""+m_client_id);
                 result.append("\" on Hub \""+m_hub_id);
                 result.append("\" via socket "+gammalib::str(m_socket));
             }
@@ -373,12 +414,10 @@ void GVOHub::init_members(void)
     m_version  = "1.3";
     m_client_key.clear();
     m_hub_id   = "b79884e0";
-    m_client_id.clear();
+    //m_client_id.clear();
     m_socket   = -1;         // Signals no socket
     m_nb_clients = 0;	    //  No registered clients at initialization
-    //client_metadata * Clients = new client_metadata[5];
     // Return
-    Clients = new client_metadata[5];
     return;
 }
@@ -399,7 +438,7 @@ void GVOHub::copy_members(const GVOHub&amp; hub)
     m_version    = hub.m_version;
     m_client_key = hub.m_client_key;
     m_hub_id     = hub.m_hub_id;
-    m_client_id  = hub.m_client_id;
+    //m_client_id  = hub.m_client_id;
     m_socket     = hub.m_socket;
     // Return
@@ -575,7 +614,7 @@ void GVOHub::handle_request(const socklen_t&amp; sock)
         ping_service(sock);
     }
     if (method_called.compare("samp.hub.declareSubscriptions") == 0) {
-        ping_service(sock);
+        declare_subscriptions(xml,sock);
     }
     if (method_called.compare("samp.hub.getSubscriptions") == 0) {
         ping_service(sock);
@@ -7,7 +7,8 @@ INCLUDES = -I$(top_srcdir)/include \
 # Define sources for this directory
 sources = GVOClient.cpp \
-          GVOHub.cpp
+          GVOHub.cpp \
+          GVOApp.cpp
 # Build libtool library
 noinst_LTLIBRARIES = libvo.la