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