1 // Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 // Author : Anthony GEAY (EDF R&D)
21 #include "SALOME_GenericObj.idl"
22 #include "SALOME_Exception.idl"
26 typedef sequence<string> StringVec;
27 typedef sequence<octet> ByteVec;
28 typedef sequence<ByteVec> SeqOfByteVec;
30 interface DataScopeServer;
32 interface BasicDataServer : GenericObj
34 DataScopeServer getMyDataScopeServer();
36 string getScopeName();
40 interface PickelizedPyObjServer : BasicDataServer
42 ByteVec fetchSerializedContent() raises (SALOME::SALOME_Exception);
45 interface PickelizedPyObjRdOnlyServer : PickelizedPyObjServer
49 interface PickelizedPyObjRdExtBaseServer : PickelizedPyObjServer
53 interface PickelizedPyObjRdExtServer : PickelizedPyObjRdExtBaseServer
55 PickelizedPyObjRdExtServer invokePythonMethodOn(in string method, in ByteVec args) raises (SALOME::SALOME_Exception);
58 interface PickelizedPyObjRdExtInitServer : PickelizedPyObjRdExtBaseServer
62 interface PickelizedPyObjRdWrServer : PickelizedPyObjServer
64 void setSerializedContent(in ByteVec newValue) raises (SALOME::SALOME_Exception);
65 PickelizedPyObjRdWrServer invokePythonMethodOn(in string method, in ByteVec args) raises (SALOME::SALOME_Exception);
68 interface DataServerManager;
70 interface DataScopeKiller
75 interface RequestSwitcherBase
78 void activeRequests();
81 interface RequestSwitcher : RequestSwitcherBase
84 ByteVec fetchSerializedContent(in string varName) raises (SALOME::SALOME_Exception);
87 interface RequestSwitcherDSM : RequestSwitcherBase
89 StringVec listScopes();
92 interface DataScopeServerBase
95 string getScopeName();
97 boolean existVar(in string varName) raises (SALOME::SALOME_Exception);
98 void deleteVar(in string varName) raises (SALOME::SALOME_Exception);
99 boolean shutdownIfNotHostedByDSM(out DataScopeKiller killer) raises (SALOME::SALOME_Exception);
100 ByteVec fetchSerializedContent(in string varName) raises (SALOME::SALOME_Exception);
101 SeqOfByteVec getAllKeysOfVarWithTypeDict(in string varName) raises (SALOME::SALOME_Exception);
102 RequestSwitcher getRequestSwitcher();
103 void takeANap(in double napDurationInSec) raises (SALOME::SALOME_Exception);
106 interface DataScopeServer : DataScopeServerBase
108 BasicDataServer retrieveVar(in string varName) raises (SALOME::SALOME_Exception);
109 PickelizedPyObjRdOnlyServer createRdOnlyVar(in string varName, in ByteVec constValue) raises (SALOME::SALOME_Exception);
110 PickelizedPyObjRdExtServer createRdExtVar(in string varName, in ByteVec constValue) raises (SALOME::SALOME_Exception);
113 interface Transaction
117 interface TransactionRdWrAccess : Transaction
119 PickelizedPyObjRdWrServer getVar() raises (SALOME::SALOME_Exception);
122 interface TransactionMultiKeyAddSession : Transaction
124 void addKeyValueInVarErrorIfAlreadyExistingNow(in SALOME::ByteVec keyValue, in ByteVec constValue) raises (SALOME::SALOME_Exception);
127 typedef sequence<Transaction> ListOfTransaction;
131 void waitFor() raises (SALOME::SALOME_Exception);
134 interface DataScopeServerTransaction : DataScopeServerBase
136 string getAccessOfVar(in string varName) raises (SALOME::SALOME_Exception);
137 void fetchAndGetAccessOfVar(in string varName, out string access, out ByteVec data) raises (SALOME::SALOME_Exception);
138 Transaction createRdOnlyVarTransac(in string varName, in ByteVec constValue) raises (SALOME::SALOME_Exception);
139 Transaction createRdExtVarTransac(in string varName, in ByteVec constValue) raises (SALOME::SALOME_Exception);
140 Transaction createRdExtInitVarTransac(in string varName, in ByteVec constValue) raises (SALOME::SALOME_Exception);
141 Transaction createRdWrVarTransac(in string varName, in ByteVec constValue) raises (SALOME::SALOME_Exception);
142 Transaction addKeyValueInVarHard(in string varName, in ByteVec keyValue, in ByteVec constValue) raises (SALOME::SALOME_Exception);
143 Transaction addKeyValueInVarErrorIfAlreadyExisting(in string varName, in ByteVec keyValue, in ByteVec constValue) raises (SALOME::SALOME_Exception);
144 TransactionMultiKeyAddSession addMultiKeyValueSession(in string varName) raises (SALOME::SALOME_Exception);
145 Transaction removeKeyInVarErrorIfNotAlreadyExisting(in string varName, in ByteVec keyValue) raises (SALOME::SALOME_Exception);
146 TransactionRdWrAccess createWorkingVarTransac(in string varName, in ByteVec constValue) raises (SALOME::SALOME_Exception);
147 Transaction killVarTransac(in string varName) raises (SALOME::SALOME_Exception);
148 KeyWaiter waitForKeyInVar(in string varName, in ByteVec keyVal) raises (SALOME::SALOME_Exception);
149 KeyWaiter waitForKeyInVarAndKillIt(in string varName, in ByteVec keyVal, out Transaction transac) raises (SALOME::SALOME_Exception);
150 void atomicApply(in ListOfTransaction transactions) raises (SALOME::SALOME_Exception);
151 ByteVec waitForMonoThrRev(in KeyWaiter kw) raises (SALOME::SALOME_Exception);
152 ByteVec waitForAndKill(in KeyWaiter kw) raises (SALOME::SALOME_Exception);
155 interface DataServerManager
157 StringVec listScopes();
158 StringVec listAliveAndKickingScopes() raises (SALOME::SALOME_Exception);
159 DataScopeServer getDefaultScope() raises (SALOME::SALOME_Exception);
160 boolean isAliveAndKicking(in string scopeName) raises (SALOME::SALOME_Exception);
162 DataScopeServer createDataScope(in string scopeName) raises (SALOME::SALOME_Exception);
163 DataScopeServer giveADataScopeCalled(in string scopeName, out boolean isCreated) raises (SALOME::SALOME_Exception);
165 DataScopeServerTransaction createDataScopeTransaction(in string scopeName) raises (SALOME::SALOME_Exception);
166 DataScopeServerTransaction giveADataScopeTransactionCalled(in string scopeName, out boolean isCreated) raises (SALOME::SALOME_Exception);
168 DataScopeServerBase retriveDataScope(in string scopeName) raises (SALOME::SALOME_Exception);
169 void removeDataScope(in string scopeName) raises (SALOME::SALOME_Exception);
170 void cleanScopesInNS();
171 void shutdownScopes() raises (SALOME::SALOME_Exception);