Salome HOME
updated copyright message
[modules/kernel.git] / idl / SALOME_Registry.idl
index b890429c458d44b40ea84db9cac13e8bafd5db66..dcd93dd9686bbb07c9a2be1bb5e500d2da4d3f2d 100644 (file)
@@ -1,31 +1,38 @@
-//  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
-//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
-// 
-//  This library is free software; you can redistribute it and/or 
-//  modify it under the terms of the GNU Lesser General Public 
-//  License as published by the Free Software Foundation; either 
-//  version 2.1 of the License. 
-// 
-//  This library is distributed in the hope that it will be useful, 
-//  but WITHOUT ANY WARRANTY; without even the implied warranty of 
-//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
-//  Lesser General Public License for more details. 
-// 
-//  You should have received a copy of the GNU Lesser General Public 
-//  License along with this library; if not, write to the Free Software 
-//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
-// 
-//  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org 
+// Copyright (C) 2007-2023  CEA, EDF, OPEN CASCADE
 //
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
 //
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
-//  File   : SALOME_Registry.idl
 
+//  File   : SALOME_Registry.idl
+//
 # ifndef __registry_idl__
 # define __registry_idl__
 
+/*! \file SALOME_Registry.idl \brief interfaces for %SALOME registry
+*/
+
+/*! \brief module that provides interface to %SALOME registry
+*/
 module Registry
 {
+  //! a struct to collect information about servers (processes)
        struct Infos
        {
                string  name;
@@ -43,18 +50,33 @@ module Registry
                string  ior;            //  client 
        };
 
+  //! a list of information
        typedef sequence<Infos> AllInfos;
 
+/*! \brief interface to use %SALOME registry
+*/
        interface Components
        {
+    //! check if registry is running
                void ping();
+    //! Get the pid of registry server
+         long getPID();
+    //! Add one information to the registry
                unsigned long add ( in Infos lesInfos ) ;
+    //! Remove an information from the registry
                void remove ( in unsigned long id ) ;
+    //! Get the size of the registry
                unsigned long size() ;
+    //! Get all information from registry
                AllInfos getall () ;
+    //! Get history information from registry
                AllInfos history () ;
+    //! Stop the registry (hard exit)
                oneway void end() ;
+    //! Say hello to registry from process id
                oneway void hello( in unsigned long id ) ;
+    //! Shutdown registry server (CORBA exit)
+         void Shutdown();
        } ;
 } ;