idl/SALOME_LogManager.idl

   1 // Copyright (C) 2024  CEA, EDF
   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
  20 #ifndef __SALOME_LOGMANAGER_IDL__
  21 #define __SALOME_LOGMANAGER_IDL__
  22
  23 #include "SALOME_Exception.idl"
  24 #include "SALOME_Comm.idl"
  25
  26 module Engines
  27 {
  28   interface ContainerScriptExecPerfLog
  29   {
  30     void assign(in SALOME::vectorOfByte value);
  31     SALOME::vectorOfByte getObj();
  32   };
  33
  34   typedef sequence<ContainerScriptExecPerfLog> ListOfContainerScriptExecPerfLog;
  35
  36   interface ContainerScriptPerfLog
  37   {
  38     string getCode();
  39     string getName();
  40     ContainerScriptExecPerfLog addExecutionSession();
  41     ListOfContainerScriptExecPerfLog listOfExecs();
  42   };
  43
  44   typedef sequence<ContainerScriptPerfLog> ListOfContainerScriptPerfLog;
  45
  46   interface ContainerPerfLog
  47   {
  48     string getLogFile();
  49     string getContainerEntryInNS();
  50     ContainerScriptPerfLog addScript(in string name, in string code);
  51     ListOfContainerScriptPerfLog listOfScripts();
  52   };
  53
  54   typedef sequence<ContainerPerfLog> ListOfContainerPerfLog;
  55
  56   interface LogManager
  57   {
  58     ContainerPerfLog declareContainer(in string contInNS, in string logfile);
  59     ListOfContainerPerfLog listOfContainerLogs();
  60     SALOME::vectorOfByte getAllStruct( in boolean clearMemory );
  61     void putStructInFileAtomic(in boolean clearMemory, in string fileName);
  62     /* Part of methods dedicated of management of performance log file in the most safety manner */
  63     void setFileNamePairOfLogger(in string loggerFileNameA, in string loggerFileNameB);
  64     void getFileNamePairOfLogger(out string loggerFileNameA, out string loggerFileNameB);
  65     void versionA_IsTheLatestValidVersion();
  66     void versionB_IsTheLatestValidVersion();
  67     string getLastVersionOfFileNameLogger();
  68   };
  69 };
  70
  71 #endif