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