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   typedef sequence<ByteVec> SeqOfByteVec;
  29
  30   interface DataScopeServer;
  31
  32   interface BasicDataServer : GenericObj
  33   {
  34     DataScopeServer getMyDataScopeServer();
  35     string getVarName();
  36     string getScopeName();
  37   };
  38
  39   interface PickelizedPyObjServer : BasicDataServer
  40   {
  41     ByteVec fetchSerializedContent() raises (SALOME::SALOME_Exception);
  42   };
  43
  44   interface PickelizedPyObjRdOnlyServer : PickelizedPyObjServer
  45   {
  46   };
  47
  48   interface PickelizedPyObjRdExtServer : PickelizedPyObjServer
  49   {
  50     PickelizedPyObjRdExtServer invokePythonMethodOn(in string method, in ByteVec args) raises (SALOME::SALOME_Exception);
  51   };
  52
  53   interface PickelizedPyObjRdWrServer : PickelizedPyObjServer
  54   {
  55     void setSerializedContent(in ByteVec newValue) raises (SALOME::SALOME_Exception);
  56     PickelizedPyObjRdWrServer invokePythonMethodOn(in string method, in ByteVec args) raises (SALOME::SALOME_Exception);
  57   };
  58
  59   interface DataServerManager;
  60
  61   interface DataScopeServerBase
  62   {
  63     void ping();
  64     string getScopeName();
  65     StringVec listVars();
  66     boolean existVar(in string varName) raises (SALOME::SALOME_Exception);
  67     void deleteVar(in string varName) raises (SALOME::SALOME_Exception);
  68     void shutdownIfNotHostedByDSM();
  69     ByteVec fetchSerializedContent(in string varName) raises (SALOME::SALOME_Exception);
  70     SeqOfByteVec getAllKeysOfVarWithTypeDict(in string varName) raises (SALOME::SALOME_Exception);
  71   };
  72
  73   interface DataScopeServer : DataScopeServerBase
  74   {
  75     BasicDataServer retrieveVar(in string varName) raises (SALOME::SALOME_Exception);
  76     PickelizedPyObjRdOnlyServer createRdOnlyVar(in string varName, in ByteVec constValue) raises (SALOME::SALOME_Exception);
  77     PickelizedPyObjRdExtServer createRdExtVar(in string varName, in ByteVec constValue) raises (SALOME::SALOME_Exception);
  78     //PickelizedPyObjRdWrServer createRdWrVar(in string typeName, in string varName) raises (SALOME::SALOME_Exception);
  79   };
  80
  81   interface Transaction
  82   {
  83   };
  84
  85   typedef sequence<Transaction> ListOfTransaction;
  86
  87   interface KeyWaiter
  88   {
  89     ByteVec waitFor() raises (SALOME::SALOME_Exception);
  90   };
  91
  92   interface DataScopeServerTransaction : DataScopeServerBase
  93   {
  94     Transaction createRdOnlyVarTransac(in string varName, in ByteVec constValue) raises (SALOME::SALOME_Exception);
  95     Transaction createRdExtVarTransac(in string varName, in ByteVec constValue) raises (SALOME::SALOME_Exception);
  96     Transaction createRdWrVarTransac(in string varName, in ByteVec constValue) raises (SALOME::SALOME_Exception);
  97     Transaction addKeyValueInVarHard(in string varName, in ByteVec keyValue, in ByteVec constValue) raises (SALOME::SALOME_Exception);
  98     Transaction addKeyValueInVarErrorIfAlreadyExisting(in string varName, in ByteVec keyValue, in ByteVec constValue) raises (SALOME::SALOME_Exception);
  99     void addKeyValueInVarErrorIfAlreadyExistingNow(in string varName, in ByteVec keyValue, in ByteVec constValue) raises (SALOME::SALOME_Exception);
 100     Transaction removeKeyInVarErrorIfNotAlreadyExisting(in string varName, in ByteVec keyValue) raises (SALOME::SALOME_Exception);
 101     KeyWaiter waitForKeyInVar(in string varName, in ByteVec keyVal) raises (SALOME::SALOME_Exception);
 102     KeyWaiter waitForKeyInVarAndKillIt(in string varName, in ByteVec keyVal, out Transaction transac) raises (SALOME::SALOME_Exception);
 103     void atomicApply(in ListOfTransaction transactions) raises (SALOME::SALOME_Exception);
 104     ByteVec waitForMonoThrRev(in KeyWaiter kw) raises (SALOME::SALOME_Exception);
 105   };
 106
 107   interface DataServerManager
 108   {
 109     StringVec listScopes();
 110     StringVec listAliveAndKickingScopes() raises (SALOME::SALOME_Exception);
 111     DataScopeServer getDefaultScope() raises (SALOME::SALOME_Exception);
 112     boolean isAliveAndKicking(in string scopeName) raises (SALOME::SALOME_Exception);
 113     //
 114     DataScopeServer createDataScope(in string scopeName) raises (SALOME::SALOME_Exception);
 115     DataScopeServer giveADataScopeCalled(in string scopeName, out boolean isCreated);
 116     //
 117     DataScopeServerTransaction createDataScopeTransaction(in string scopeName) raises (SALOME::SALOME_Exception);
 118     DataScopeServerTransaction giveADataScopeTransactionCalled(in string scopeName, out boolean isCreated);
 119     //
 120     DataScopeServerBase retriveDataScope(in string scopeName) raises (SALOME::SALOME_Exception);
 121     void removeDataScope(in string scopeName) raises (SALOME::SALOME_Exception);
 122     void cleanScopesInNS();
 123     void shutdownScopes() raises (SALOME::SALOME_Exception);
 124   };
 125 };