idl/SALOME_SDS.idl

   1 // Copyright (C) 2007-2015  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19 // Author : Anthony GEAY (EDF R&D)
  20
  21 #include "SALOME_GenericObj.idl"
  22 #include "SALOME_Exception.idl"
  23
  24 module SALOME
  25 {
  26   typedef sequence<string> StringVec;
  27   typedef sequence<octet> ByteVec;
  28
  29   interface DataScopeServer;
  30
  31   interface BasicDataServer : GenericObj
  32   {
  33     DataScopeServer getMyDataScopeServer();
  34     string getVarName();
  35     string getScopeName();
  36   };
  37
  38   interface PickelizedPyObjServer : BasicDataServer
  39   {
  40     ByteVec fetchSerializedContent() raises (SALOME::SALOME_Exception);
  41   };
  42
  43   interface PickelizedPyObjRdOnlyServer : PickelizedPyObjServer
  44   {
  45   };
  46
  47   interface PickelizedPyObjRdExtServer : PickelizedPyObjServer
  48   {
  49     PickelizedPyObjRdExtServer invokePythonMethodOn(in string method, in ByteVec args) raises (SALOME::SALOME_Exception);
  50   };
  51
  52   interface PickelizedPyObjRdWrServer : PickelizedPyObjServer
  53   {
  54     void setSerializedContent(in ByteVec newValue) raises (SALOME::SALOME_Exception);
  55     PickelizedPyObjRdWrServer invokePythonMethodOn(in string method, in ByteVec args) raises (SALOME::SALOME_Exception);
  56   };
  57
  58   interface DataServerManager;
  59
  60   interface DataScopeServerBase
  61   {
  62     void ping();
  63     string getScopeName();
  64     StringVec listVars();
  65     boolean existVar(in string varName) raises (SALOME::SALOME_Exception);
  66     void deleteVar(in string varName) raises (SALOME::SALOME_Exception);
  67     void shutdownIfNotHostedByDSM();
  68   };
  69
  70   interface DataScopeServer : DataScopeServerBase
  71   {
  72     BasicDataServer retrieveVar(in string varName) raises (SALOME::SALOME_Exception);
  73     PickelizedPyObjRdOnlyServer createRdOnlyVar(in string varName, in ByteVec constValue) raises (SALOME::SALOME_Exception);
  74     PickelizedPyObjRdExtServer createRdExtVar(in string varName, in ByteVec constValue) raises (SALOME::SALOME_Exception);
  75     //PickelizedPyObjRdWrServer createRdWrVar(in string typeName, in string varName) raises (SALOME::SALOME_Exception);
  76   };
  77
  78   interface Transaction
  79   {
  80   };
  81
  82   typedef sequence<Transaction> ListOfTransaction;
  83
  84   interface KeyWaiter
  85   {
  86     ByteVec waitFor() raises (SALOME::SALOME_Exception);
  87   };
  88
  89   interface DataScopeServerTransaction : DataScopeServerBase
  90   {
  91     ByteVec fetchSerializedContent(in string varName) raises (SALOME::SALOME_Exception);
  92     Transaction createRdOnlyVarTransac(in string varName, in ByteVec constValue) raises (SALOME::SALOME_Exception);
  93     Transaction createRdExtVarTransac(in string varName, in ByteVec constValue) raises (SALOME::SALOME_Exception);
  94     Transaction createRdWrVarTransac(in string varName, in ByteVec constValue) raises (SALOME::SALOME_Exception);
  95     Transaction addKeyValueInVarHard(in string varName, in ByteVec keyValue, in ByteVec constValue) raises (SALOME::SALOME_Exception);
  96     Transaction addKeyValueInVarErrorIfAlreadyExisting(in string varName, in ByteVec keyValue, in ByteVec constValue) raises (SALOME::SALOME_Exception);
  97     Transaction removeKeyInVarErrorIfNotAlreadyExisting(in string varName, in ByteVec keyValue) raises (SALOME::SALOME_Exception);
  98     KeyWaiter waitForKeyInVar(in string varName, in ByteVec keyVal) raises (SALOME::SALOME_Exception);
  99     KeyWaiter waitForKeyInVarAndKillIt(in string varName, in ByteVec keyVal, out Transaction transac) raises (SALOME::SALOME_Exception);
 100     void atomicApply(in ListOfTransaction transactions) raises (SALOME::SALOME_Exception);
 101     ByteVec waitForMonoThrRev(in KeyWaiter kw) raises (SALOME::SALOME_Exception);
 102   };
 103
 104   interface DataServerManager
 105   {
 106     StringVec listScopes();
 107     StringVec listAliveAndKickingScopes() raises (SALOME::SALOME_Exception);
 108     DataScopeServer getDefaultScope() raises (SALOME::SALOME_Exception);
 109     boolean isAliveAndKicking(in string scopeName) raises (SALOME::SALOME_Exception);
 110     //
 111     DataScopeServer createDataScope(in string scopeName) raises (SALOME::SALOME_Exception);
 112     DataScopeServer giveADataScopeCalled(in string scopeName, out boolean isCreated);
 113     //
 114     DataScopeServerTransaction createDataScopeTransaction(in string scopeName) raises (SALOME::SALOME_Exception);
 115     DataScopeServerTransaction giveADataScopeTransactionCalled(in string scopeName, out boolean isCreated);
 116     //
 117     DataScopeServerBase retriveDataScope(in string scopeName) raises (SALOME::SALOME_Exception);
 118     void removeDataScope(in string scopeName) raises (SALOME::SALOME_Exception);
 119     void cleanScopesInNS();
 120     void shutdownScopes() raises (SALOME::SALOME_Exception);
 121   };
 122 };