Salome HOME
Updated copyright comment
[modules/kernel.git] / src / Communication / SALOME_Comm_i.hxx
1 // Copyright (C) 2007-2024  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_I_HXX_
24 #define _SALOME_COMM_I_HXX_
25
26 #include "SALOME_Communication.hxx"
27
28 #ifdef HAVE_MPI2
29 #include "mpi.h"
30 #endif
31 #include <string>
32 #include <SALOMEconfig.h>
33 #include CORBA_SERVER_HEADER(SALOME_Comm)
34
35 #define TIMEOUT 20
36
37
38 /*!
39   Generic servant class for senders that factorizes all the common methods and attributes necessary to senders.
40   All servant classes for senders have to inheritate from it.
41  */
42 class COMMUNICATION_EXPORT SALOME_Sender_i : public virtual POA_SALOME::Sender
43 {
44 protected:
45   /*! Pointer to the generic array to transmit*/
46   const void *_tabToSend;
47   /*! Length of the generic array to transmit*/
48   long _lgrTabToSend;
49   /*! it represents the sizeof() of each component of the generic array:\n
50     Practically in terms of bytes the size to be transmitted is _lgrTabToSend*_sizeOf
51   */
52   int _sizeOf;
53   /*! Indicates if _tabToSend has to be deallocated */ 
54   bool _ownTabToSend;
55
56   SALOME_Sender_i(const void *tabToSend,long lgrTabToSend,int sizeOf,bool ownTabToSend=false);
57 public:
58   const void *getData(long &size) const;
59   int getSizeOf() const;
60   void setOwnerShip(bool own);
61   bool getOwnerShip() const { return _ownTabToSend; }
62   void release();
63   virtual ~SALOME_Sender_i() {}
64 };
65
66 class COMMUNICATION_EXPORT SALOME_SenderDouble_i : public virtual POA_SALOME::SenderDouble,
67                               public virtual SALOME_Sender_i
68 {
69 public:
70   SALOME_SenderDouble_i(const double *tabToSend,long lgrTabToSend,bool ownTabToSend=false);
71   SALOME::TypeOfDataTransmitted getTypeOfDataTransmitted() { return SALOME::DOUBLE_; }
72   SALOME::SenderDouble_ptr buildOtherWithProtocol(SALOME::TypeOfCommunication type);
73   virtual ~SALOME_SenderDouble_i();
74   static SALOME_SenderDouble_i *find(SALOME::SenderDouble_ptr pCorba);
75 };
76
77 class COMMUNICATION_EXPORT SALOME_SenderInt_i : public virtual POA_SALOME::SenderInt,
78                            public virtual SALOME_Sender_i
79 {
80 public:
81   SALOME_SenderInt_i(const int *tabToSend,long lgrTabToSend,bool ownTabToSend=false);
82   SALOME::TypeOfDataTransmitted getTypeOfDataTransmitted() { return SALOME::INT_; }
83   SALOME::SenderInt_ptr buildOtherWithProtocol(SALOME::TypeOfCommunication type);
84   virtual ~SALOME_SenderInt_i();
85   static SALOME_SenderInt_i *find(SALOME::SenderInt_ptr pCorba);
86 };
87
88 /*! Servant class for CORBA sender for double* when no copy of array _tabToSend is required, that is to say double and CORBA::Double are binary equal.
89  */
90 class COMMUNICATION_EXPORT SALOME_CorbaDoubleNCSender_i : public POA_SALOME::CorbaDoubleNCSender,
91                                      public SALOME_SenderDouble_i
92 {
93 public:
94   SALOME_CorbaDoubleNCSender_i(const double *tabToSend,long lgrTabToSend,bool ownTabToSend=false);
95   ~SALOME_CorbaDoubleNCSender_i();
96   CORBA::ULong getSize();
97   SALOME::vectorOfDouble* sendPart(CORBA::ULong offset, CORBA::ULong length);
98   SALOME::vectorOfDouble* send();
99 };
100
101 /*! Servant class for CORBA sender for double* when copy of array _tabToSend is required, that is to say double and CORBA::Double are NOT binary equal.
102  */
103 class COMMUNICATION_EXPORT SALOME_CorbaDoubleCSender_i : public POA_SALOME::CorbaDoubleCSender,
104                                     public SALOME_SenderDouble_i
105 {
106 public:
107   SALOME_CorbaDoubleCSender_i(const double *tabToSend,long lgrTabToSend,bool ownTabToSend=false);
108   ~SALOME_CorbaDoubleCSender_i();
109   CORBA::ULong getSize();
110   SALOME::vectorOfDouble* sendPart(CORBA::ULong offset, CORBA::ULong length);
111 };
112
113 /*! Servant class for CORBA sender for int* when no copy of array _tabToSend is required, that is to say int and CORBA::Long are binary equal.
114  */
115 class COMMUNICATION_EXPORT SALOME_CorbaLongNCSender_i : public POA_SALOME::CorbaLongNCSender,
116                                    public SALOME_SenderInt_i
117 {
118 public:
119   SALOME_CorbaLongNCSender_i(const int *tabToSend,long lgrTabToSend,bool ownTabToSend=false);
120   ~SALOME_CorbaLongNCSender_i();
121   CORBA::ULong getSize();
122   SALOME::vectorOfLong* sendPart(CORBA::ULong offset, CORBA::ULong length);
123   SALOME::vectorOfLong* send();
124 };
125
126 /*! Servant class for CORBA sender for int* when copy of array _tabToSend is required, that is to say int and CORBA::Long are NOT binary equal.
127  */
128 class COMMUNICATION_EXPORT SALOME_CorbaLongCSender_i : public POA_SALOME::CorbaLongCSender,
129                                   public SALOME_SenderInt_i
130 {
131 public:
132   SALOME_CorbaLongCSender_i(const int *tabToSend,long lgrTabToSend,bool ownTabToSend=false);
133   ~SALOME_CorbaLongCSender_i();
134   CORBA::ULong getSize();
135   SALOME::vectorOfLong* sendPart(CORBA::ULong offset, CORBA::ULong length);
136 };
137
138 #ifdef HAVE_MPI2
139
140 /*! Servant class of sender using MPI2.
141  */
142 class COMMUNICATION_EXPORT SALOME_MPISender_i : public virtual POA_SALOME::MPISender,
143                            public virtual SALOME_Sender_i
144 {
145 private:
146   static unsigned long _tag1;
147   static unsigned long _tag2;
148   /*! Name of the port opened*/
149   char *_portName;
150   int _cproc;
151   /*! Tag 1 that identifies the transfert*/
152   int _tag1Inst;
153   /*! Tag 2 that identifies the transfert*/
154   int _tag2Inst;
155   /*! MPI communicator*/
156   MPI_Comm _com;
157   /*! Array of pointer for asynchronous invocation with omnithread*/
158   void **_argsForThr;
159   /*! Pointer to thread created on asynchronous invocation*/
160   omni_thread *_newThr;
161   /*! Type the component of the array*/
162   SALOME::TypeOfDataTransmitted _type;
163 public:
164   SALOME_MPISender_i(const void *tabToSend,long lgrTabToSend,int sizeOf,bool ownTabToSend=false);
165   ~SALOME_MPISender_i();
166   SALOME::MPISender::param* getParam();
167   void send();
168   void close(const SALOME::MPISender::param& p);
169 private:
170   static void* myThread(void *args);
171 };
172
173 class COMMUNICATION_EXPORT SALOME_MPISenderDouble_i : public POA_SALOME::MPISenderDouble,
174                                  public SALOME_SenderDouble_i,
175                                  public SALOME_MPISender_i
176 {
177 public:
178   SALOME_MPISenderDouble_i(const double *tabToSend,long lgrTabToSend,bool ownTabToSend=false);
179 };
180
181 class COMMUNICATION_EXPORT SALOME_MPISenderInt_i : public POA_SALOME::MPISenderInt,
182                               public SALOME_SenderInt_i,
183                               public SALOME_MPISender_i
184 {
185 public:
186   SALOME_MPISenderInt_i(const int *tabToSend,long lgrTabToSend,bool ownTabToSend=false);
187 };
188
189 #endif
190
191 #ifdef HAVE_SOCKET
192
193 /*! Servant class of sender using Sockets.
194  */
195 class COMMUNICATION_EXPORT SALOME_SocketSender_i : public virtual POA_SALOME::SocketSender,
196                               public virtual SALOME_Sender_i
197 {
198 private:
199   int _serverSockfd;
200   int _clientSockfd;
201   int _port;
202   std::string _IPAddress;
203   void **_argsForThr;
204   omni_thread *_newThr;
205   bool _errorFlag;
206   /*! Type the component of the array*/
207   SALOME::TypeOfDataTransmitted _type;
208 public:
209   SALOME_SocketSender_i(const void *tabToSend,long lgrTabToSend,int sizeOf,bool ownTabToSend=false);
210   ~SALOME_SocketSender_i();
211   SALOME::SocketSender::param* getParam();
212   void send();
213   void initCom();
214   void acceptCom();
215   void endOfCom();
216   void closeCom();
217 private:
218   static void* myThread(void *args);
219   std::string inetAddress();
220 };
221
222 class COMMUNICATION_EXPORT SALOME_SocketSenderDouble_i : public POA_SALOME::SocketSenderDouble,
223                                     public SALOME_SenderDouble_i,
224                                     public SALOME_SocketSender_i
225 {
226 public:
227   SALOME_SocketSenderDouble_i(const double *tabToSend,long lgrTabToSend,bool ownTabToSend=false);
228 };
229
230 class COMMUNICATION_EXPORT SALOME_SocketSenderInt_i : public POA_SALOME::SocketSenderInt,
231                                  public SALOME_SenderInt_i,
232                                  public SALOME_SocketSender_i
233 {
234 public:
235   SALOME_SocketSenderInt_i(const int *tabToSend,long lgrTabToSend,bool ownTabToSend=false);
236 };
237
238 #endif
239
240 #endif
241