idl/SALOME_Registry.idl

   1 // Copyright (C) 2007-2023  CEA, EDF, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 //  File   : SALOME_Registry.idl
  24 //
  25 # ifndef __registry_idl__
  26 # define __registry_idl__
  27
  28 /*! \file SALOME_Registry.idl \brief interfaces for %SALOME registry
  29 */
  30
  31 /*! \brief module that provides interface to %SALOME registry
  32 */
  33 module Registry
  34 {
  35   //! a struct to collect information about servers (processes)
  36         struct Infos
  37         {
  38                 string  name;
  39                 long    pid;
  40                 string  machine;
  41                 string  adip;
  42                 long    uid;
  43                 string  pwname;
  44                 long    tc_start;
  45                 long    tc_hello;
  46                 long    tc_end;
  47                 long    difftime;
  48                 string  cdir;
  49                 long    status;
  50                 string  ior;            //  client
  51         };
  52
  53   //! a list of information
  54         typedef sequence<Infos> AllInfos;
  55
  56 /*! \brief interface to use %SALOME registry
  57 */
  58         interface Components
  59         {
  60     //! check if registry is running
  61                 void ping();
  62     //! Get the pid of registry server
  63           long getPID();
  64     //! Add one information to the registry
  65                 unsigned long add ( in Infos lesInfos ) ;
  66     //! Remove an information from the registry
  67                 void remove ( in unsigned long id ) ;
  68     //! Get the size of the registry
  69                 unsigned long size() ;
  70     //! Get all information from registry
  71                 AllInfos getall () ;
  72     //! Get history information from registry
  73                 AllInfos history () ;
  74     //! Stop the registry (hard exit)
  75                 oneway void end() ;
  76     //! Say hello to registry from process id
  77                 oneway void hello( in unsigned long id ) ;
  78     //! Shutdown registry server (CORBA exit)
  79           void Shutdown();
  80         } ;
  81 } ;
  82
  83 # endif