idl/SALOME_ContainerManager.idl

   1 // Copyright (C) 2005  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   3 //
   4 // This library is free software; you can redistribute it and/or
   5 // modify it under the terms of the GNU Lesser General Public
   6 // License as published by the Free Software Foundation; either
   7 // version 2.1 of the License.
   8 //
   9 // This library is distributed in the hope that it will be useful
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 // Lesser General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Lesser General Public
  15 // License along with this library; if not, write to the Free Software
  16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 //
  18 // See http://www.salome-platform.org/
  19 //
  20 #ifndef _SALOME_CONTAINERMANAGER_IDL_
  21 #define _SALOME_CONTAINERMANAGER_IDL_
  22
  23 #include "SALOME_Exception.idl"
  24 #include "SALOME_Component.idl"
  25
  26 module Engines
  27 {
  28
  29 /*!
  30     Type to describe properties of wanted resource.
  31 */
  32 struct MachineParameters
  33 {
  34   string container_name;
  35   string hostname;
  36   string OS;
  37   long mem_mb;
  38   long cpu_clock;
  39   long nb_proc_per_node;
  40   long nb_node;
  41   boolean isMPI;
  42 };
  43
  44 /*!
  45     Type to transmit list of machines.
  46 */
  47   typedef sequence<string> MachineList;
  48
  49 /*!
  50     exception thrown if a computer is not found in the catalog
  51 */
  52   exception NotFound {};
  53
  54
  55 /*! \brief Interface of the %containerManager
  56     This interface is used for interaction with the unique instance
  57     of ContainerManager
  58 */
  59   interface ContainerManager
  60   {
  61     Container FindOrStartContainer( in MachineParameters params,
  62                                     in MachineList possibleComputers);
  63
  64     string FindBest(in MachineList possibleComputers);
  65
  66     MachineList GetFittingResources( in MachineParameters params,
  67                                      in string componentName )
  68       raises (SALOME::SALOME_Exception);
  69
  70     void Shutdown();
  71
  72     void ShutdownContainers();
  73   } ;
  74 };
  75
  76 #endif