src/Launcher/SALOME_Launcher.hxx

   1 // Copyright (C) 2007-2021  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 #ifndef __SALOME_LAUNCHER_HXX__
  24 #define __SALOME_LAUNCHER_HXX__
  25
  26 #include "SALOME_Launcher_defs.hxx"
  27
  28 #include "SALOME_NamingService.hxx"
  29 #include "SALOMEconfig.h"
  30 #include CORBA_CLIENT_HEADER(SALOME_Launcher)
  31 #include "Launcher.hxx"
  32
  33 #include <string>
  34 #include <list>
  35
  36 class SALOME_ContainerManager;
  37 class SALOME_ResourcesManager;
  38
  39 class SALOMELAUNCHER_EXPORT SALOME_Launcher:
  40   public POA_Engines::SalomeLauncher,
  41   public PortableServer::RefCountServantBase
  42 {
  43
  44 public:
  45   SALOME_Launcher(CORBA::ORB_ptr orb, PortableServer::POA_var poa);
  46   SALOME_Launcher(CORBA::ORB_ptr orb, PortableServer::POA_var poa, SALOME_NamingService_Abstract *externalNS);
  47   virtual ~SALOME_Launcher();
  48   // Main methods
  49   CORBA::Long createJob    (const Engines::JobParameters & job_parameters);
  50   void        launchJob    (CORBA::Long job_id);
  51   char *      getJobState  (CORBA::Long job_id);
  52   char *      getAssignedHostnames  (CORBA::Long job_id); // Get names or ids of hosts assigned to the job
  53   void        exportInputFiles(CORBA::Long job_id);
  54   void        getJobResults(CORBA::Long job_id, const char * directory);
  55   void        clearJobWorkingDir(CORBA::Long job_id);
  56   CORBA::Boolean getJobDumpState(CORBA::Long job_id, const char * directory);
  57   CORBA::Boolean getJobWorkFile(CORBA::Long job_id, const char * work_file, const char * directory);
  58   void        stopJob      (CORBA::Long job_id);
  59   void        removeJob    (CORBA::Long job_id);
  60   char * dumpJob(CORBA::Long job_id);
  61   CORBA::Long restoreJob(const char * dumpedJob);
  62
  63   // Useful methods
  64   CORBA::Long    createJobWithFile(const char * xmlExecuteFile, const char * clusterName);
  65   CORBA::Boolean testBatch        (const Engines::ResourceParameters& params);
  66
  67   // SALOME Kernel service methods
  68   void Shutdown();
  69   CORBA::Long getPID();
  70
  71   // Observer and introspection methods
  72   virtual void addObserver(Engines::SalomeLauncherObserver_ptr observer);
  73   virtual void removeObserver(Engines::SalomeLauncherObserver_ptr observer);
  74   virtual Engines::JobsList * getJobsList();
  75   virtual Engines::JobParameters * getJobParameters(CORBA::Long job_id);
  76
  77   // Save and load methods
  78   virtual void loadJobs(const char* jobs_file);
  79   virtual void saveJobs(const char* jobs_file);
  80
  81   void DeclareUsingSalomeSession();
  82
  83   static const char *_LauncherNameInNS;
  84
  85   static JobParameters_cpp
  86     JobParameters_CORBA2CPP(const Engines::JobParameters& job_parameters);
  87
  88   static Engines::JobParameters_var
  89     JobParameters_CPP2CORBA(const JobParameters_cpp& job_parameters);
  90
  91 protected:
  92   // Internal methods
  93   virtual void notifyObservers(const std::string & event_name, const std::string & event_data);
  94   void init(CORBA::ORB_ptr orb, PortableServer::POA_var poa);
  95 protected:
  96   CORBA::ORB_var _orb;
  97   PortableServer::POA_var _poa;
  98   SALOME_ContainerManager *_ContManager;
  99   SALOME_ResourcesManager *_ResManager;
 100   SALOME_NamingService_Abstract *_NS = nullptr;
 101
 102   std::list<Engines::SalomeLauncherObserver_var> _observers;
 103
 104   Launcher_cpp _l;
 105 };
 106
 107 /*!
 108  * Methods to be used in SSL mode to skip NS.
 109  */
 110 namespace KERNEL
 111 {
 112   SALOMELAUNCHER_EXPORT SALOME_Launcher *getLauncherSA();
 113 }
 114
 115 #endif