source: src/Fragmentation/Automation/FragmentScheduler.cpp@ ef2767

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
Last change on this file since ef2767 was ef2767, checked in by Frederik Heber <heber@…>, 13 years ago

Server and Worker now also correctly exchange result.

  • Server uses FragmentQueue which also stores the obtained result.
  • Worker calls received FragmentJob::Work() function and returns the thereby calculated FragmentResult.
  • Regression test for Server/Worker now checks whether job #1 is listed twice, this basically checks whether the result has been exchanged.

There have been some concepts to understand to get this working and these

shall be briefly recorded here:

  • asynchronous communication can only work on objects that live beyond the scope of where they have been called, e.g. therefore FragmentScheduler contains a FragmentResult and FragmentWorker a FragmentJob instance. They receive this object and need the write access in the scope of the aync. comm. and not of the caller's scope. This is probably because the initial argument is only used to set up a buffer of correct length. However, the received instance is created/deserialized first when the communication is completed. And this may well be after the caller's scope has been left.
  • This is different to read operations as probably there the object to send is immediately serialized and placed into an internal buffer such that later access is only to this buffer and not to the original instance which therefore does not need to exist anymore. That's why the above Schedulder and Worker do not have the "other" instance as class members as well.
  • chaining asynchronous communications, e.g. a write after a read has been performed, can only be done by using the callback functions that the async_write/read gets as parameters. They are called when the one operation has finished and therein the next operation can then be launched. This way a successful chain is executed.
  • Property mode set to 100644
File size: 4.3 KB
Line 
1/*
2 * Project: MoleCuilder
3 * Description: creates and alters molecular systems
4 * Copyright (C) 2011 University of Bonn. All rights reserved.
5 * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
6 */
7
8/*
9 * \file FragmentScheduler.cpp
10 *
11 * This file strongly follows the Serialization example from the boost::asio
12 * library (see server.cpp)
13 *
14 * Created on: Oct 19, 2011
15 * Author: heber
16 */
17
18// include config.h
19#ifdef HAVE_CONFIG_H
20#include <config.h>
21#endif
22
23// boost asio needs specific operator new
24#include <boost/asio.hpp>
25
26#include "CodePatterns/MemDebug.hpp"
27
28#include <boost/bind.hpp>
29#include <boost/lexical_cast.hpp>
30#include <iostream>
31#include <vector>
32#include "Connection.hpp" // Must come before boost/serialization headers.
33#include <boost/serialization/vector.hpp>
34#include "CodePatterns/Info.hpp"
35#include "CodePatterns/Log.hpp"
36#include "FragmentJob.hpp"
37#include "JobId.hpp"
38
39#include "FragmentScheduler.hpp"
40
41FragmentJob FragmentScheduler::NoJob(std::string("NoJob"), JobId::NoJob);
42
43FragmentScheduler::FragmentScheduler(boost::asio::io_service& io_service, unsigned short port) :
44 acceptor_(io_service,
45 boost::asio::ip::tcp::endpoint(boost::asio::ip::tcp::v4(), port)
46 ),
47 result(JobId::NoJob)
48{
49 Info info(__FUNCTION__);
50 FragmentJob s(std::string("test"), 1);
51 JobsQueue.pushJob(s);
52
53 // Start an accept operation for a new connection.
54 connection_ptr new_conn(new Connection(acceptor_.get_io_service()));
55 acceptor_.async_accept(new_conn->socket(),
56 boost::bind(&FragmentScheduler::handle_accept, this,
57 boost::asio::placeholders::error, new_conn));
58}
59
60/// Handle completion of a accept operation.
61void FragmentScheduler::handle_accept(const boost::system::error_code& e, connection_ptr conn)
62{
63 Info info(__FUNCTION__);
64 if (!e)
65 {
66 // Successfully accepted a new connection.
67 // Check whether there are jobs in the queue
68 if (JobsQueue.isJobPresent()) {
69 // pop a job and send it to the client.
70 FragmentJob job(JobsQueue.popJob());
71 // The connection::async_write() function will automatically
72 // serialize the data structure for us.
73 LOG(1, "INFO: Sending job #" << job.getId() << ".");
74 conn->async_write(job,
75 boost::bind(&FragmentScheduler::handle_write, this,
76 boost::asio::placeholders::error, conn));
77
78 // Start an accept operation for a new Connection only when there
79 // are still jobs present otherwise we quit.
80 connection_ptr new_conn(new Connection(acceptor_.get_io_service()));
81 acceptor_.async_accept(new_conn->socket(),
82 boost::bind(&FragmentScheduler::handle_accept, this,
83 boost::asio::placeholders::error, new_conn));
84 } else {
85 // send the static NoJob
86 conn->async_write(NoJob,
87 boost::bind(&FragmentScheduler::handle_write, this,
88 boost::asio::placeholders::error, conn));
89
90 // then there must be no read necesary
91
92 ELOG(2, "There is currently no job present in the queue.");
93 }
94 }
95 else
96 {
97 // An error occurred. Log it and return. Since we are not starting a new
98 // accept operation the io_service will run out of work to do and the
99 // server will exit.
100 ELOG(0, e.message());
101 }
102}
103
104/// Handle completion of a write operation.
105void FragmentScheduler::handle_write(const boost::system::error_code& e, connection_ptr conn)
106{
107 Info info(__FUNCTION__);
108 LOG(1, "INFO: Job sent.");
109 // obtain result
110 LOG(1, "INFO: Receiving result for a job ...");
111 conn->async_read(result,
112 boost::bind(&FragmentScheduler::handle_read, this,
113 boost::asio::placeholders::error, conn));
114}
115
116/// Handle completion of a read operation.
117void FragmentScheduler::handle_read(const boost::system::error_code& e, connection_ptr conn)
118{
119 Info info(__FUNCTION__);
120 // nothing to do
121 LOG(1, "INFO: Received result for job #" << result.getId() << " ...");
122 // and push into queue
123 ASSERT(result.getId() != JobId::NoJob,
124 "FragmentScheduler::handle_write() - result received has NoJob id.");
125 ASSERT(result.getId() != JobId::IllegalJob,
126 "FragmentScheduler::handle_write() - result received has IllegalJob id.");
127 if ((result.getId() != JobId::NoJob) && (result.getId() != JobId::IllegalJob))
128 JobsQueue.pushResult(result);
129 // erase result
130 result = FragmentResult(JobId::NoJob);
131}
132
Note: See TracBrowser for help on using the repository browser.