Changeset 9db22d for src/Fragmentation/Automation/Operations

Timestamp:

Jul 2, 2012, 8:32:08 AM (13 years ago)

Author:

Frederik Heber <heber@…>

Branches:

Action_Thermostats, Add_AtomRandomPerturbation, Add_FitFragmentPartialChargesAction, Add_RotateAroundBondAction, Add_SelectAtomByNameAction, Added_ParseSaveFragmentResults, AddingActions_SaveParseParticleParameters, Adding_Graph_to_ChangeBondActions, Adding_MD_integration_tests, Adding_ParticleName_to_Atom, Adding_StructOpt_integration_tests, AtomFragments, Automaking_mpqc_open, AutomationFragmentation_failures, Candidate_v1.5.4, Candidate_v1.6.0, Candidate_v1.6.1, ChangeBugEmailaddress, ChangingTestPorts, ChemicalSpaceEvaluator, CombiningParticlePotentialParsing, Combining_Subpackages, Debian_Package_split, Debian_package_split_molecuildergui_only, Disabling_MemDebug, Docu_Python_wait, EmpiricalPotential_contain_HomologyGraph, EmpiricalPotential_contain_HomologyGraph_documentation, Enable_parallel_make_install, Enhance_userguide, Enhanced_StructuralOptimization, Enhanced_StructuralOptimization_continued, Example_ManyWaysToTranslateAtom, Exclude_Hydrogens_annealWithBondGraph, FitPartialCharges_GlobalError, Fix_BoundInBox_CenterInBox_MoleculeActions, Fix_ChargeSampling_PBC, Fix_ChronosMutex, Fix_FitPartialCharges, Fix_FitPotential_needs_atomicnumbers, Fix_ForceAnnealing, Fix_IndependentFragmentGrids, Fix_ParseParticles, Fix_ParseParticles_split_forward_backward_Actions, Fix_PopActions, Fix_QtFragmentList_sorted_selection, Fix_Restrictedkeyset_FragmentMolecule, Fix_StatusMsg, Fix_StepWorldTime_single_argument, Fix_Verbose_Codepatterns, Fix_fitting_potentials, Fixes, ForceAnnealing_goodresults, ForceAnnealing_oldresults, ForceAnnealing_tocheck, ForceAnnealing_with_BondGraph, ForceAnnealing_with_BondGraph_continued, ForceAnnealing_with_BondGraph_continued_betteresults, ForceAnnealing_with_BondGraph_contraction-expansion, FragmentAction_writes_AtomFragments, FragmentMolecule_checks_bonddegrees, GeometryObjects, Gui_Fixes, Gui_displays_atomic_force_velocity, ImplicitCharges, IndependentFragmentGrids, IndependentFragmentGrids_IndividualZeroInstances, IndependentFragmentGrids_IntegrationTest, IndependentFragmentGrids_Sole_NN_Calculation, JobMarket_RobustOnKillsSegFaults, JobMarket_StableWorkerPool, JobMarket_unresolvable_hostname_fix, MoreRobust_FragmentAutomation, ODR_violation_mpqc_open, PartialCharges_OrthogonalSummation, PdbParser_setsAtomName, PythonUI_with_named_parameters, QtGui_reactivate_TimeChanged_changes, Recreated_GuiChecks, Rewrite_FitPartialCharges, RotateToPrincipalAxisSystem_UndoRedo, SaturateAtoms_findBestMatching, SaturateAtoms_singleDegree, StoppableMakroAction, Subpackage_CodePatterns, Subpackage_JobMarket, Subpackage_LinearAlgebra, Subpackage_levmar, Subpackage_mpqc_open, Subpackage_vmg, Switchable_LogView, ThirdParty_MPQC_rebuilt_buildsystem, TrajectoryDependenant_MaxOrder, TremoloParser_IncreasedPrecision, TremoloParser_MultipleTimesteps, TremoloParser_setsAtomName, Ubuntu_1604_changes, stable

Children:

d57585

Parents:

17017b

git-author:

Frederik Heber <heber@…> (05/11/12 18:23:22)

git-committer:

Frederik Heber <heber@…> (07/02/12 08:32:08)

Message:

AsyncOperation and all derived classes changed their cstor and operator() signature for success/failure callback handlers.

• This allows starting certain functions depending on whether an asynchronous operation succeeded or not.
• FragmentController and PoolWorker are adapted to new AsyncOperation's cstor and operator() signatures.

Location:

src/Fragmentation/Automation/Operations

Files:

• AsyncOperation.cpp (modified) (5 diffs)
• AsyncOperation.hpp (modified) (3 diffs)
• Controllers/CheckResultsOperation.hpp (modified) (1 diff)
• Controllers/GetNextJobIdOperation.hpp (modified) (1 diff)
• Controllers/ReceiveResultsOperation.hpp (modified) (1 diff)
• Controllers/SendJobsOperation.hpp (modified) (1 diff)
• Servers/SendJobToWorkerOperation.hpp (modified) (1 diff)
• Servers/ShutdownWorkerOperation.hpp (modified) (1 diff)
• Workers/EnrollInPoolOperation.hpp (modified) (1 diff)
• Workers/ObtainJobOperation.hpp (modified) (1 diff)
• Workers/SubmitResultOperation.hpp (modified) (1 diff)

src/Fragmentation/Automation/Operations/AsyncOperation.cpp

@@ -27 +27 @@
 
 #include <boost/bind.hpp>
+#include <boost/function.hpp>
 #include <vector>
 #include "Connection.hpp" // Must come before boost/serialization headers.
 #include "CodePatterns/Info.hpp"
 #include "CodePatterns/Log.hpp"
+
+void NoOp() {}
+
+// static instances
+const boost::function<void ()> AsyncOperation::NoOpCallback = boost::bind(&NoOp);
 
 /** Callback function when an operation has been completed.
@@ -42 +48 @@
   {
     LOG(1, "INFO: AsyncOperation completed.");
+    callback_on_success();
   }
   else
@@ -48 +55 @@
     Exitflag = ErrorFlag;
     ELOG(1, e.message());
+    callback_on_failure();
   }
 
@@ -68 +76 @@
 {
   Info info(__FUNCTION__);
+
   // Resolve the host name into an IP address.
   boost::asio::ip::tcp::resolver resolver(connection_.socket().get_io_service());
@@ -81 +90 @@
       boost::asio::placeholders::error, ++endpoint_iterator));
 }
-

src/Fragmentation/Automation/Operations/AsyncOperation.hpp

@@ -32 +32 @@
  * update signal at operation's end is not triggered.
  */
-class AsyncOperation : public Operation, public Observable {
+class AsyncOperation : public Operation, public Observable
+{
+public:
+  //!> static function as default callback on success/failure of operation that does nothing
+  static const boost::function<void ()> NoOpCallback;
 public:
   /** Constructor for class AsyncOperation.
@@ -38 +42 @@
    * \param _name name for this AsyncOperation for retrieval from a registry
    * \param _connection connection to operate on
+   * \param callback_on_success function to call when operation ends successfully
+   * \param callback_on_failure function to call when operation fails
    */
   AsyncOperation(
       const std::string &_name,
-      Connection &_connection) :
+      Connection &_connection,
+      const boost::function<void ()> &_callback_on_success = NoOpCallback,
+      const boost::function<void ()> &_callback_on_failure = NoOpCallback) :
     Operation(_name, _connection),
-    Observable(_name)
+    Observable(_name),
+    callback_on_success(_callback_on_success),
+    callback_on_failure(_callback_on_failure)
   {}
 
@@ -67 +77 @@
   /// internal function to disconnect from server
   void disconnect();
+
+private:
+  //!> Callback function on successful end of operation
+  boost::function<void ()> callback_on_success;
+  //!> Callback function on end of operation with failure
+  boost::function<void ()> callback_on_failure;
 };
 

src/Fragmentation/Automation/Operations/Controllers/CheckResultsOperation.hpp

@@ -28 +28 @@
 public:
   /// Constructor for class CheckResultsOperation.
-  CheckResultsOperation(Connection &_connection) :
-    AsyncOperation(std::string("checkresults"), _connection),
+  CheckResultsOperation(Connection &_connection,
+      const boost::function<void ()> &_callback_on_success = NoOpCallback,
+      const boost::function<void ()> &_callback_on_failure = NoOpCallback) :
+    AsyncOperation(std::string("checkresults"), _connection, _callback_on_success, _callback_on_failure),
     jobInfo((size_t)2, 0)
         {}

src/Fragmentation/Automation/Operations/Controllers/GetNextJobIdOperation.hpp

@@ -29 +29 @@
 public:
   /// Constructor for class GetNextJobIdOperation.
-  GetNextJobIdOperation(Connection &_connection) :
-    AsyncOperation(std::string("getnextjobid"), _connection)
+  GetNextJobIdOperation(Connection &_connection,
+      const boost::function<void ()> &_callback_on_success = NoOpCallback,
+      const boost::function<void ()> &_callback_on_failure = NoOpCallback) :
+    AsyncOperation(std::string("getnextjobid"), _connection, _callback_on_success, _callback_on_failure)
   {}
   /// Destructor for class GetNextJobIdOperation

src/Fragmentation/Automation/Operations/Controllers/ReceiveResultsOperation.hpp

@@ -26 +26 @@
 public:
   /// Constructor for class ReceiveResultsOperation.
-  ReceiveResultsOperation(Connection &_connection) :
-    AsyncOperation(std::string("receiveresults"), _connection) {}
+  ReceiveResultsOperation(Connection &_connection,
+      const boost::function<void ()> &_callback_on_success = NoOpCallback,
+      const boost::function<void ()> &_callback_on_failure = NoOpCallback) :
+    AsyncOperation(std::string("receiveresults"), _connection, _callback_on_success, _callback_on_failure)
+    {}
   /// Destructor for class ReceiveResultsOperation
   ~ReceiveResultsOperation() {}

src/Fragmentation/Automation/Operations/Controllers/SendJobsOperation.hpp

@@ -26 +26 @@
 public:
   /// Constructor for class SendJobsOperation.
-  SendJobsOperation(Connection &_connection) :
-    AsyncOperation(std::string("sendjobs"), _connection) {}
+  SendJobsOperation(Connection &_connection,
+      const boost::function<void ()> &_callback_on_success = NoOpCallback,
+      const boost::function<void ()> &_callback_on_failure = NoOpCallback) :
+    AsyncOperation(std::string("sendjobs"), _connection, _callback_on_success, _callback_on_failure)
+    {}
   /// Destructor for class SendJobsOperation
   ~SendJobsOperation() {}

src/Fragmentation/Automation/Operations/Servers/SendJobToWorkerOperation.hpp

@@ -31 +31 @@
    * @param _connection connection for operation
    */
-  SendJobToWorkerOperation(Connection &_connection) :
-    AsyncOperation(std::string("sendjobtoworker"),_connection),
+  SendJobToWorkerOperation(Connection &_connection,
+      const boost::function<void ()> &_callback_on_success = NoOpCallback,
+      const boost::function<void ()> &_callback_on_failure = NoOpCallback) :
+    AsyncOperation(std::string("sendjobtoworker"),_connection, _callback_on_success, _callback_on_failure),
     job( new SystemCommandJob(std::string("/bin/true"), std::string("donothing"), JobId::NoJob) )
   {}

src/Fragmentation/Automation/Operations/Servers/ShutdownWorkerOperation.hpp

@@ -29 +29 @@
 public:
   /// Constructor for class ShutdownWorkerOperation.
-  ShutdownWorkerOperation(Connection &_connection) :
-    AsyncOperation(std::string("shutdown"),_connection) {}
+  ShutdownWorkerOperation(Connection &_connection,
+      const boost::function<void ()> &_callback_on_success = NoOpCallback,
+      const boost::function<void ()> &_callback_on_failure = NoOpCallback) :
+    AsyncOperation(std::string("shutdown"),_connection, _callback_on_success, _callback_on_failure) {}
   /// Destructor for class ShutdownWorkerOperation
   ~ShutdownWorkerOperation() {}

src/Fragmentation/Automation/Operations/Workers/EnrollInPoolOperation.hpp

@@ -29 +29 @@
 public:
   /// Constructor for class EnrollInPoolOperation.
-  EnrollInPoolOperation(Connection &_connection, const WorkerAddress &_address) :
-    AsyncOperation(std::string("enrollinpool"),_connection),
+  EnrollInPoolOperation(Connection &_connection, const WorkerAddress &_address,
+      const boost::function<void ()> &_callback_on_success = NoOpCallback,
+      const boost::function<void ()> &_callback_on_failure = NoOpCallback) :
+    AsyncOperation(std::string("enrollinpool"),_connection, _callback_on_success, _callback_on_failure),
     address(_address),
     EnrollmentFlag(false)

src/Fragmentation/Automation/Operations/Workers/ObtainJobOperation.hpp

@@ -28 +28 @@
 public:
   /// Constructor for class ObtainJobOperation.
-  ObtainJobOperation(Connection &_connection) :
-    AsyncOperation(std::string("obtainjob"),_connection) {}
+  ObtainJobOperation(Connection &_connection,
+      const boost::function<void ()> &_callback_on_success = NoOpCallback,
+      const boost::function<void ()> &_callback_on_failure = NoOpCallback) :
+    AsyncOperation(std::string("obtainjob"),_connection, _callback_on_success, _callback_on_failure)
+    {}
   /// Destructor for class ObtainJobOperation
   ~ObtainJobOperation() {}

src/Fragmentation/Automation/Operations/Workers/SubmitResultOperation.hpp

@@ -29 +29 @@
 public:
   /// Constructor for class SubmitResultOperation.
-  SubmitResultOperation(Connection &_connection, const WorkerAddress &_address) :
-    AsyncOperation(std::string("submitresult"),_connection),
+  SubmitResultOperation(Connection &_connection, const WorkerAddress &_address,
+      const boost::function<void ()> &_callback_on_success = NoOpCallback,
+      const boost::function<void ()> &_callback_on_failure = NoOpCallback) :
+    AsyncOperation(std::string("submitresult"),_connection, _callback_on_success, _callback_on_failure),
     result( new FragmentResult(JobId::NoJob, std::string("EmptyResult")) ),
     address(_address),