Generalize handling OOB objects in the event loop

This does not add any new functionality, but makes it easier to do so
in future.

Signed-off-by: Timo J. Rinne <tri@iki.fi>
Signed-off-by: Ivan Shapovalov <intelfx@intelfx.name>

Author: rinne

src/agent/agent.cc

@@ -138,7 +138,7 @@ ProxyAgent::ProxyAgent( bool is_server, bool dummy )
 
 ProxyAgent::~ProxyAgent( void ) {
 #ifdef SUPPORT_AGENT_FORWARDING
-  shutdown_server();
+  shutdown();
 #endif
 }
 
@@ -154,7 +154,7 @@ void ProxyAgent::close_sessions( void ) {
 #endif
 }
 
-void ProxyAgent::shutdown_server( void ) {
+void ProxyAgent::shutdown( void ) {
 #ifdef SUPPORT_AGENT_FORWARDING
   detach_oob();
   if (ok) {
@@ -176,7 +176,7 @@ void ProxyAgent::attach_oob(OutOfBand *oob_ctl) {
   detach_oob();
   fatal_assert(oob_ctl != NULL);
   oob_ctl_ptr = oob_ctl;
-  comm = oob_ctl_ptr->init(AGENT_FORWARD_OOB_NAME, Network::OOB_MODE_RELIABLE_DATAGRAM);
+  comm = oob_ctl_ptr->init(AGENT_FORWARD_OOB_NAME, Network::OOB_MODE_RELIABLE_DATAGRAM, this);
   fatal_assert(comm != NULL);
 }
 

src/agent/agent.h

@@ -79,7 +79,8 @@ namespace Agent {
     friend class ProxyAgent;
   };
 
-  class ProxyAgent {
+  class ProxyAgent : public Network::OutOfBandPlugin
+  {
   private:
     Network::OutOfBandCommunicator *comm;
     Network::OutOfBand *oob_ctl_ptr;
@@ -100,16 +101,19 @@ namespace Agent {
     ProxyAgent operator=(const ProxyAgent&);  // unimplemented
 
   public:
-    ProxyAgent( bool is_server, bool dummy = false );
-    ~ProxyAgent( void );
-    void attach_oob(Network::OutOfBand *oob_ctl);
-    bool active() { return ok && ((! server) || (l_sock >= 0)); }
-    std::string listener_path( void ) { if ( ok && server && l_sock >= 0 ) return l_path; return ""; }
+    // Required by parent class
+    bool active( void ) { return ok && ((! server) || (l_sock >= 0)); }
     void pre_poll( void );
     void post_poll( void );
     void post_tick( void );
     void close_sessions( void );
-    void shutdown_server( void );
+    void shutdown( void );
+    void attach_oob(Network::OutOfBand *oob_ctl);
+
+    // Class specific stuff
+    ProxyAgent( bool is_server, bool dummy = false );
+    ~ProxyAgent( void );
+    std::string listener_path( void ) { if ( ok && server && l_sock >= 0 ) return l_path; return ""; }
 
     friend class AgentConnection;
   };

src/frontend/mosh-server.cc

@@ -700,9 +700,7 @@ static void serve( int host_fd, Terminal::Complete &terminal, ServerConnection &
 
   bool child_released = false;
 
-  if ( agent.active() ) {
-    agent.attach_oob( network.oob() );
-  }
+  agent.attach_oob(network.oob());
 
   while ( true ) {
     try {
@@ -742,9 +740,7 @@ static void serve( int host_fd, Terminal::Complete &terminal, ServerConnection &
 	sel.add_fd( host_fd );
       }
 
-      if ( agent.active() ) {
-	agent.pre_poll();
-      }
+      network.oob()->pre_poll();
 
       int active_fds = sel.select( timeout );
       if ( active_fds < 0 ) {
@@ -871,7 +867,7 @@ static void serve( int host_fd, Terminal::Complete &terminal, ServerConnection &
         /* If the pty slave is closed, reading from the master can fail with
            EIO (see #264).  So we treat errors on read() like EOF. */
         if ( bytes_read <= 0 ) {
-	  agent.shutdown_server();
+	  network.oob()->shutdown();
 	  network.start_shutdown();
 	} else {
 	  terminal_to_host += terminal.act( string( buf, bytes_read ) );
@@ -903,7 +899,7 @@ static void serve( int host_fd, Terminal::Complete &terminal, ServerConnection &
       if ( sel.any_signal() || idle_shutdown ) {
 	/* shutdown signal */
 	if ( network.has_remote_addr() && (!network.shutdown_in_progress()) ) {
-	  agent.shutdown_server();
+	  network.oob()->shutdown();
 	  network.start_shutdown();
 	} else {
 	  break;
@@ -948,29 +944,25 @@ static void serve( int host_fd, Terminal::Complete &terminal, ServerConnection &
            && time_since_remote_state >= timeout_if_no_client ) {
         fprintf( stderr, "No connection within %llu seconds.\n",
                  static_cast<unsigned long long>( timeout_if_no_client / 1000 ) );
-        agent.shutdown_server();
+        network.oob()->shutdown();
         break;
       }
 
-      if ( agent.active() ) {
-	if ( time_since_remote_state > (AGENT_IDLE_TIMEOUT * 1000) || time_since_remote_state > 30000 ) {
-	  agent.close_sessions();
-	}
-	agent.post_poll();
+      if ( time_since_remote_state > (AGENT_IDLE_TIMEOUT * 1000) || time_since_remote_state > 30000 ) {
+	network.oob()->close_sessions();
       }
+      network.oob()->post_poll();
 
       network.tick();
 
-      if ( agent.active() ) {
-	agent.post_tick();
-      }
+      network.oob()->post_tick();
 
     } catch ( const Network::NetworkException &e ) {
       fprintf( stderr, "%s\n", e.what() );
       spin();
     } catch ( const Crypto::CryptoException &e ) {
       if ( e.fatal ) {
-	agent.shutdown_server();
+	network.oob()->shutdown();
         throw;
       } else {
         fprintf( stderr, "Crypto exception: %s\n", e.what() );

src/frontend/stmclient.cc

@@ -436,9 +436,8 @@ bool STMClient::main( void )
 #endif
 
   Agent::ProxyAgent agent( false, ! forward_agent );
-  if ( agent.active() ) {
-    agent.attach_oob( network->oob() );
-  }
+
+  agent.attach_oob(network->oob());
 
   /* prepare to poll for events */
   Select &sel = Select::get_instance();
@@ -465,9 +464,7 @@ bool STMClient::main( void )
       }
       sel.add_fd( STDIN_FILENO );
 
-      if ( agent.active() ) {
-	agent.pre_poll();
-      }
+      network->oob()->pre_poll();
 
       int active_fds = sel.select( wait_time );
       if ( active_fds < 0 ) {
@@ -496,11 +493,11 @@ bool STMClient::main( void )
 	  break;
 	} else if ( !network->shutdown_in_progress() ) {
 	  overlays.get_notification_engine().set_notification_string( wstring( L"Exiting..." ), true );
-	  agent.shutdown_server();
+	  network->oob()->shutdown();
 	  network->start_shutdown();
 	} else {
 	  /* XXX: cannot be reached? preserved to avoid non-identity transformation during rebase */
-	  agent.shutdown_server();
+	  network->oob()->shutdown();
 	}
       }
 
@@ -521,7 +518,7 @@ bool STMClient::main( void )
           break;
         } else if ( !network->shutdown_in_progress() ) {
           overlays.get_notification_engine().set_notification_string( wstring( L"Signal received, shutting down..." ), true );
-          agent.shutdown_server();
+          network->oob()->shutdown();
           network->start_shutdown();
         }
       }
@@ -550,7 +547,7 @@ bool STMClient::main( void )
 	if ( timestamp() - network->get_latest_remote_state().timestamp > 15000 ) {
 	  if ( !network->shutdown_in_progress() ) {
 	    overlays.get_notification_engine().set_notification_string( wstring( L"Timed out waiting for server..." ), true );
-	    agent.shutdown_server();
+	    network->oob()->shutdown();
 	    network->start_shutdown();
 	  }
 	} else {
@@ -562,15 +559,11 @@ bool STMClient::main( void )
 	overlays.get_notification_engine().set_notification_string( L"" );
       }
 
-      if ( agent.active() ) {
-	agent.post_poll();
-      }
+      network->oob()->post_poll();
 
       network->tick();
 
-      if ( agent.active() ) {
-	agent.post_tick();
-      }
+      network->oob()->post_tick();
 
       string & send_error = network->get_send_error();
       if ( !send_error.empty() ) {

src/network/outofband.cc

@@ -62,16 +62,62 @@ OutOfBand::OutOfBand()
   ack_num_out = 0;
 }
 
-OutOfBandCommunicator *OutOfBand::init(string name, OutOfBandMode mode) {
+OutOfBandCommunicator *OutOfBand::init(string name, OutOfBandMode mode, OutOfBandPlugin *plugin) {
   map < string, OutOfBandCommunicator * >::iterator i = comms.find(name);
   if (i != comms.end()) {
     return NULL;
   }
-  OutOfBandCommunicator *comm = new OutOfBandCommunicator(mode, name, this);
+  OutOfBandCommunicator *comm = new OutOfBandCommunicator(mode, name, this, plugin);
   comms[name] = comm;
   return comm;
 }
 
+void OutOfBand::pre_poll( void ) {
+  map < string, OutOfBandCommunicator * >::iterator i = comms.begin();
+  while (i != comms.end()) {
+    OutOfBandCommunicator *comm = (i++)->second;
+    if (comm->plugin_ptr->active()) {
+      comm->plugin_ptr->pre_poll();
+    }
+  }
+}
+
+void OutOfBand::post_poll( void ) {
+  map < string, OutOfBandCommunicator * >::iterator i = comms.begin();
+  while (i != comms.end()) {
+    OutOfBandCommunicator *comm = (i++)->second;
+    if (comm->plugin_ptr->active()) {
+      comm->plugin_ptr->post_poll();
+    }
+  }
+}
+
+void OutOfBand::post_tick( void ) {
+  map < string, OutOfBandCommunicator * >::iterator i = comms.begin();
+  while (i != comms.end()) {
+    OutOfBandCommunicator *comm = (i++)->second;
+    if (comm->plugin_ptr->active()) {
+      comm->plugin_ptr->post_tick();
+    }
+  }
+}
+
+void OutOfBand::close_sessions( void ) {
+  map < string, OutOfBandCommunicator * >::iterator i = comms.begin();
+  while (i != comms.end()) {
+    OutOfBandCommunicator *comm = (i++)->second;
+    comm->plugin_ptr->close_sessions();
+  }
+}
+
+void OutOfBand::shutdown( void ) {
+  map < string, OutOfBandCommunicator * >::iterator i = comms.begin();
+  while (i != comms.end()) {
+    OutOfBandCommunicator *comm = (i++)->second;
+    comm->plugin_ptr->shutdown();
+  }
+}
+
 void OutOfBand::uninit(string name) {
   map < string, OutOfBandCommunicator * >::iterator i = comms.find(name);
   if (i == comms.end()) {
@@ -199,11 +245,16 @@ string OutOfBand::output(void) {
   return "";
 }
 
-OutOfBandCommunicator::OutOfBandCommunicator(OutOfBandMode oob_mode, string oob_name, OutOfBand *oob_ctl) {
-  mode = oob_mode;
-  name = oob_name;
-  oob_ctl_ptr = oob_ctl;
-  stream_buf = "";
+OutOfBandCommunicator::OutOfBandCommunicator( OutOfBandMode oob_mode, string oob_name,
+                                              OutOfBand *oob_ctl, OutOfBandPlugin *plugin)
+  : mode( oob_mode ),
+    name( oob_name ),
+    stream_buf( "" ),
+    datagram_queue(),
+    plugin_ptr( plugin ),
+    oob_ctl_ptr( oob_ctl )
+{
+  /* */
 }
 
 void OutOfBandCommunicator::send(string data) {

src/network/outofband.h

@@ -54,6 +54,8 @@ namespace Network {
   enum OutOfBandMode { OOB_MODE_STREAM = 1, OOB_MODE_DATAGRAM = 2, OOB_MODE_RELIABLE_DATAGRAM = 3 };
 
   class OutOfBand;
+  class OutOfBandPlugin;
+  class OutOfBandCommunicator;
 
   class OutOfBandCommunicator
   {
@@ -62,9 +64,12 @@ namespace Network {
     string name;
     string stream_buf;
     queue < string > datagram_queue;
+    OutOfBandPlugin *plugin_ptr;
     OutOfBand *oob_ctl_ptr;
     OutOfBand *oob(void) { return oob_ctl_ptr; }
-    OutOfBandCommunicator(OutOfBandMode oob_mode, string oob_name, OutOfBand *oob_ctl);
+    OutOfBandCommunicator(OutOfBandMode oob_mode, string oob_name, OutOfBand *oob_ctl, OutOfBandPlugin *plugin);
+    OutOfBandCommunicator(const OutOfBandCommunicator&);
+    OutOfBandCommunicator operator=(const OutOfBandCommunicator&);
 
   public:
     void send(string data);
@@ -90,7 +95,14 @@ namespace Network {
   public:
     OutOfBand();
     ~OutOfBand() { uninit(); }
-    OutOfBandCommunicator *init(string name, OutOfBandMode mode);
+
+    void pre_poll( void );
+    void post_poll( void );
+    void post_tick( void );
+    void close_sessions( void );
+    void shutdown( void );
+
+    OutOfBandCommunicator *init(string name, OutOfBandMode mode, OutOfBandPlugin *plugin);
     void uninit(string name);
     void uninit(OutOfBandCommunicator *comm);
     void uninit(void);
@@ -102,6 +114,21 @@ namespace Network {
 
     friend class OutOfBandCommunicator;
   };
+
+  class OutOfBandPlugin
+  {
+  public:
+    virtual bool active( void ) = 0;
+    virtual void pre_poll( void ) = 0;
+    virtual void post_poll( void ) = 0;
+    virtual void post_tick( void ) = 0;
+    virtual void close_sessions( void ) = 0;
+    virtual void shutdown( void ) = 0;
+    virtual void attach_oob(Network::OutOfBand *oob_ctl) = 0;
+
+    friend class OutOfBand;
+  };
+
 }
 
 #endif