ADNetClient is now an abstract interface. ZMQ and MPINet functionality moved to derived classes.

Author: giltirn

app/pshutdown.cpp

@@ -10,7 +10,7 @@ int main(int argc, char** argv){
     std::cout << "Usage: pshutdown <server address e.g. tcp://localhost:5559>" << std::endl;
     return 1;
   }
-  ADNetClient ad;
+  ADZMQNetClient ad;
   ad.connect_ps(0,0,argv[1]);
   ad.stopServer();
   ad.disconnect_ps();

include/chimbuko/ad/ADNetClient.hpp

@@ -18,7 +18,7 @@ namespace chimbuko{
   public:
     ADNetClient();
 
-    ~ADNetClient();
+    virtual ~ADNetClient();
 
     /**
      * @brief check if the parameter server is in use
@@ -35,13 +35,13 @@ namespace chimbuko{
      * @param srank server process rank. If using ZMQnet this is not applicable
      * @param sname server name. If using ZMQNet this is the server ip address, for MPINet it is not applicable
      */
-    void connect_ps(int rank, int srank = 0, std::string sname="MPINET");
+    virtual void connect_ps(int rank, int srank = 0, std::string sname="MPINET") = 0;
     /**
      * @brief disconnect from the connected parameter server
      * 
      * Called automatically by destructor if not previously called
      */
-    void disconnect_ps();
+    virtual void disconnect_ps() = 0;
 
     /**
      * @brief Return the MPI rank of the parameter server
@@ -58,7 +58,7 @@ namespace chimbuko{
      * @param msg The message
      * @return The response message in serialized format. Use Message::set_msg( <serialized_msg>,  true )  to unpack
      */       
-    std::string send_and_receive(const Message &msg) const;
+    virtual std::string send_and_receive(const Message &msg) const = 0;
 
     /**
      * @brief Send a message to the parameter server and receive the response both as Message objects
@@ -74,7 +74,50 @@ namespace chimbuko{
      */
     void linkPerf(PerfStats* perf){ m_perf = perf; }
 
+  protected:
+    bool m_use_ps;                           /**< true if the parameter server is in use */
+    int m_rank;                              /**< MPI rank of current process */
+    int m_srank;                             /**< server process rank                    */
+    PerfStats * m_perf;                      /**< Performance monitoring */
+  };
+
+  
 #ifdef _USE_ZMQNET
+  /**
+   * @brief Implementation of the ADNetClient interface for the ZMQNet network
+   */
+  class ADZMQNetClient: public ADNetClient{
+  public:
+
+    ADZMQNetClient();
+
+    ~ADZMQNetClient();   
+
+    /**
+     * @brief connect to the parameter server
+     * 
+     * @param rank this process rank
+     * @param srank Ignored for this class
+     * @param sname The server ip address
+     */
+    void connect_ps(int rank, int srank = 0, std::string sname="MPINET") override;
+    /**
+     * @brief disconnect from the connected parameter server
+     * 
+     * Called automatically by destructor if not previously called
+     */
+    void disconnect_ps() override;
+
+    using ADNetClient::send_and_receive;
+
+    /**
+     * @brief Send a message to the parameter server and receive the response in a serialized format
+     * @param msg The message
+     * @return The response message in serialized format. Use Message::set_msg( <serialized_msg>,  true )  to unpack
+     */       
+    std::string send_and_receive(const Message &msg) const override;
+
+
     /**
      * @brief Set the timeout on blocking receives. Must be called prior to connecting
      */
@@ -94,22 +137,50 @@ namespace chimbuko{
      * @brief Issue a stop command to the server. The server will then stop once all clients have disconnected and all messages processed
      */
     void stopServer() const;
-#endif
-
 
   private:
-    bool m_use_ps;                           /**< true if the parameter server is in use */
-    int m_rank;                              /**< MPI rank of current process */
-    int m_srank;                             /**< server process rank                    */
-#ifdef _USE_MPINET
-    MPI_Comm m_comm;                         /**< Instance of the MPI communicator */
-#else
     void* m_context;                         /**< ZeroMQ context */
     void* m_socket;                          /**< ZeroMQ socket */
     int m_recv_timeout_ms;                   /**< Timeout (in ms) on blocking receives (default 30s)*/
+  };
 #endif
-    PerfStats * m_perf;                      /**< Performance monitoring */
+
+#ifdef _USE_MPINET
+  /**
+   * @brief Implementation of the ADNetClient interface for the MPINet network
+   */
+  class ADMPINetClient: public ADNetClient{
+  public:
+    ~ADMPINetClient();   
+
+    /**
+     * @brief connect to the parameter server
+     * 
+     * @param rank this process rank
+     * @param srank server process rank
+     * @param sname Ignored for this class
+     */
+    void connect_ps(int rank, int srank = 0, std::string sname="MPINET") override;
+    /**
+     * @brief disconnect from the connected parameter server
+     * 
+     * Called automatically by destructor if not previously called
+     */
+    void disconnect_ps() override;
+
+    /**
+     * @brief Send a message to the parameter server and receive the response in a serialized format
+     * @param msg The message
+     * @return The response message in serialized format. Use Message::set_msg( <serialized_msg>,  true )  to unpack
+     */       
+    std::string send_and_receive(const Message &msg) const override;
+
+  
+  private:
+    MPI_Comm m_comm;                         /**< Instance of the MPI communicator */
   };
+  
+#endif