idl/SALOME_Registry.idl

   1 //  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, 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.
  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 //  File   : SALOME_Registry.idl
  23 //
  24 # ifndef __registry_idl__
  25 # define __registry_idl__
  26
  27 /*! \file SALOME_Registry.idl \brief interfaces for %SALOME registry
  28 */
  29
  30 /*! \brief module that provides interface to %SALOME registry
  31 */
  32 module Registry
  33 {
  34   //! a struct to collect informations about servers (processes)
  35         struct Infos
  36         {
  37                 string  name;
  38                 long    pid;
  39                 string  machine;
  40                 string  adip;
  41                 long    uid;
  42                 string  pwname;
  43                 long    tc_start;
  44                 long    tc_hello;
  45                 long    tc_end;
  46                 long    difftime;
  47                 string  cdir;
  48                 long    status;
  49                 string  ior;            //  client
  50         };
  51
  52   //! a list of informations
  53         typedef sequence<Infos> AllInfos;
  54
  55 /*! \brief interface to use %SALOME registry
  56 */
  57         interface Components
  58         {
  59     //! check if registry is running
  60                 void ping();
  61     //! Get the pid of registry server
  62           long getPID();
  63     //! Add one information to the registry
  64                 unsigned long add ( in Infos lesInfos ) ;
  65     //! Remove an information from the registry
  66                 void remove ( in unsigned long id ) ;
  67     //! Get the size of the registry
  68                 unsigned long size() ;
  69     //! Get all informations from registry
  70                 AllInfos getall () ;
  71     //! Get history information from registry
  72                 AllInfos history () ;
  73     //! Stop the registry (hard exit)
  74                 oneway void end() ;
  75     //! Say hello to registry from process id
  76                 oneway void hello( in unsigned long id ) ;
  77     //! Shutdown registry server (CORBA exit)
  78           void Shutdown();
  79         } ;
  80 } ;
  81
  82 # endif