idl/SALOME_Comm.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 #ifndef _SALOME_COMM_IDL_
  24 #define _SALOME_COMM_IDL_
  25
  26 #include "SALOME_GenericObj.idl"
  27 #include "SALOME_Exception.idl"
  28
  29 /*!
  30   \file SALOME_Comm.idl \brief This file contains a set of interfaces used for communication
  31   between components
  32  */
  33
  34 module SALOME {
  35
  36   enum TypeOfDataTransmitted { _DOUBLE_,_INT_ };
  37
  38   enum TypeOfCommunication { CORBA_ , MPI_ , SOCKET_ };
  39
  40   typedef sequence<double> vectorOfDouble;
  41
  42   typedef sequence<long> vectorOfLong;
  43
  44   typedef sequence<octet> vectorOfByte;
  45
  46   interface MultiCommClass {
  47     void setProtocol(in TypeOfCommunication typ);
  48   };
  49
  50   interface ServantLifeCycle {
  51     void release();
  52   };
  53
  54   interface Sender {
  55     TypeOfDataTransmitted getTypeOfDataTransmitted();
  56     void release();
  57   };
  58
  59   interface SenderDouble : Sender {
  60     SenderDouble buildOtherWithProtocol(in TypeOfCommunication type);
  61   };
  62
  63   interface SenderInt : Sender {
  64     SenderInt buildOtherWithProtocol(in TypeOfCommunication type);
  65   };
  66
  67   //No compulsory copy between double and CORBA::Double
  68   interface CorbaDoubleNCSender : SenderDouble {
  69     unsigned long getSize();
  70     vectorOfDouble sendPart(in unsigned long n1,in unsigned long n2);
  71     vectorOfDouble send();
  72   };
  73
  74   //Compulsory copy between double and CORBA::Double
  75   interface CorbaDoubleCSender : SenderDouble {
  76     unsigned long getSize();
  77     //unsigned long getSize2();
  78     vectorOfDouble sendPart(in unsigned long n1,in unsigned long n2);
  79   };
  80
  81   //No compulsory copy between int and CORBA::Long
  82   interface CorbaLongNCSender : SenderInt {
  83     unsigned long getSize();
  84     vectorOfLong sendPart(in unsigned long n1,in unsigned long n2);
  85     vectorOfLong send();
  86   };
  87
  88   //Compulsory copy between int and CORBA::Long
  89   interface CorbaLongCSender : SenderInt {
  90     unsigned long getSize();
  91     vectorOfLong sendPart(in unsigned long n1,in unsigned long n2);
  92   };
  93
  94   interface MPISender : Sender {
  95     typedef struct Parameter {
  96       unsigned long myproc;
  97       unsigned long tag1;
  98       unsigned long tag2;
  99       string service;
 100     } param;
 101     param getParam();
 102     void send();
 103     void close(in param p);
 104   };
 105
 106   interface MPISenderDouble : SenderDouble,MPISender {
 107   };
 108
 109   interface MPISenderInt : SenderInt,MPISender {
 110   };
 111
 112   interface SocketSender : Sender {
 113     typedef struct Parameter {
 114       unsigned long lstart;
 115       unsigned long lend;
 116       unsigned long myport;
 117      string internet_address;
 118     } param;
 119     param getParam();
 120     void initCom() raises(SALOME_Exception);
 121     void acceptCom() raises(SALOME_Exception);
 122     void closeCom();
 123     void endOfCom() raises(SALOME_Exception);
 124     void send();
 125   };
 126
 127   interface SocketSenderDouble : SenderDouble,SocketSender {
 128   };
 129
 130   interface SocketSenderInt : SenderInt,SocketSender {
 131   };
 132
 133   interface Matrix {
 134     SenderDouble getData();
 135     long getSizeOfColumn();
 136     void release();
 137   };
 138
 139   interface SenderByte : GenericObj
 140   {
 141     unsigned long long getSize();
 142     vectorOfByte sendPart(in unsigned long long n1,in unsigned long long n2);
 143   };
 144
 145   typedef sequence<SenderByte> SenderByteSeq;
 146 };
 147
 148 #endif