Merge pull request Eyescale#518 from eile/master

Enable customisation of client loop
tribal-tec · Nov 18, 2015 · c66fab7 · c66fab7
2 parents 83be58c + b7241dc
commit c66fab7
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 16 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,6 +1,6 @@
 
-# Copyright (c) 2010 Daniel Pfeifer <daniel@pfeifer-mail.de>
-#               2010-2015 Stefan Eilemann <eile@eyescale.ch>
+# Copyright (c) 2010-2015 Stefan Eilemann <eile@eyescale.ch>
+#                         Daniel Pfeifer <daniel@pfeifer-mail.de>
 
 cmake_minimum_required(VERSION 2.8 FATAL_ERROR)
 project(Equalizer)
@@ -11,9 +11,9 @@ list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/CMake
 include(GitExternal)
 
 set(VERSION_MAJOR "1")
-set(VERSION_MINOR "10")
+set(VERSION_MINOR "11")
 set(VERSION_PATCH "0")
-set(VERSION_ABI 192)
+set(VERSION_ABI 193)
 
 set(EQUALIZER_INCLUDE_NAME eq)
 include(Common)

diff --git a/doc/Changelog.md b/doc/Changelog.md
@@ -3,6 +3,8 @@ Changelog {#Changelog}
 
 # git master
 
+* [518](https://github.com/Eyescale/Equalizer/pull/518):
+  Enable customisation of client loop
 * [511](https://github.com/Eyescale/Equalizer/pull/511):
   Fix exit behaviour on config parse error
 * [510](https://github.com/Eyescale/Equalizer/issues/510):

diff --git a/eq/client.cpp b/eq/client.cpp
@@ -71,8 +71,8 @@ class Client
     Client()
         : queue( co::Global::getCommandQueueLimit( ))
         , modelUnit( EQ_UNDEFINED_UNIT )
-        , running( false )
         , qtApp( 0 )
+        , running( false )
     {}
 
     CommandQueue queue; //!< The command->node command queue.
@@ -81,8 +81,8 @@ class Client
     ServerSet localServers;
     std::string gpuFilter;
     float modelUnit;
-    bool running;
     QApplication* qtApp;
+    bool running;
 
     void initQt( int argc LB_UNUSED, char** argv LB_UNUSED )
     {
@@ -240,6 +240,7 @@ bool Client::initLocal( const int argc, char** argv )
             return false;
         }
 
+        _impl->running = true;
         clientLoop();
         exitClient();
     }
@@ -295,13 +296,8 @@ bool Client::_setupClient( const std::string& clientArgs )
 void Client::clientLoop()
 {
     LBINFO << "Entered client loop" << std::endl;
-
-    _impl->running = true;
-    while( _impl->running )
+    while( isRunning( ))
         processCommand();
-
-    // cleanup
-    _impl->queue.flush();
 }
 
 bool Client::exitLocal()
@@ -317,6 +313,7 @@ bool Client::exitLocal()
 
 void Client::exitClient()
 {
+    _impl->queue.flush();
     bool ret = exitLocal();
     LBINFO << "Exit " << lunchbox::className( this ) << " process used "
            << getRefCount() << std::endl;
@@ -331,6 +328,11 @@ bool Client::hasCommands()
     return !_impl->queue.isEmpty();
 }
 
+bool Client::isRunning() const
+{
+    return _impl->running;
+}
+
 co::CommandQueue* Client::getMainThreadQueue()
 {
     return &_impl->queue;

diff --git a/eq/client.h b/eq/client.h
@@ -102,6 +102,9 @@ class Client : public fabric::Client
      */
     EQ_API bool hasCommands();
 
+    /** @return true if the clientLoop() should keep running. @version 1.11 */
+    EQ_API bool isRunning() const;
+
     /** @internal @return the command queue to the main node thread. */
     EQ_API co::CommandQueue* getMainThreadQueue() override;
 
@@ -141,9 +144,10 @@ class Client : public fabric::Client
      *
      * As long as the node is running, that is, between initLocal() and an exit
      * send from the server, this method executes received commands using
-     * processCommand() and triggers the message pump between commands.
+     * processCommand() and triggers the message pump between commands. This
+     * default implementation performs 'while( isRunning( )) processCommand();'.
      *
-     * @sa Pipe::createMessagePump()
+     * @sa Pipe::createMessagePump(), isRunning(), processCommand()
      * @version 1.0
      */
     EQ_API virtual void clientLoop();

diff --git a/eq/fabric/client.cpp b/eq/fabric/client.cpp
@@ -86,7 +86,7 @@ bool Client::disconnectServer( co::NodePtr server )
         return false;
     }
 
-    if( co::LocalNode::disconnect( server ))
+    if( disconnect( server ))
         return true;
 
     LBWARN << "Server disconnect failed" << std::endl;
@@ -98,7 +98,7 @@ void Client::processCommand( const uint32_t timeout )
     co::CommandQueue* queue = getMainThreadQueue();
     LBASSERT( queue );
     co::ICommand command = queue->pop( timeout );
-    if( !command.isValid( )) // wakeup() or timeout
+    if( !command.isValid( )) // wakeup() or timeout delivers invalid command
         return;
 
     LBCHECK( command( ));