1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 Module: FGfdmSocket.cpp
6 Purpose: Encapsulates a socket
7 Called by: FGOutput, et. al.
9 ------------- Copyright (C) 1999 Jon S. Berndt (jsb@hal-pc.org) -------------
11 This program is free software; you can redistribute it and/or modify it under
12 the terms of the GNU Lesser General Public License as published by the Free Software
13 Foundation; either version 2 of the License, or (at your option) any later
16 This program is distributed in the hope that it will be useful, but WITHOUT
17 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
21 You should have received a copy of the GNU Lesser General Public License along with
22 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
23 Place - Suite 330, Boston, MA 02111-1307, USA.
25 Further information about the GNU Lesser General Public License can also be found on
26 the world wide web at http://www.gnu.org.
28 FUNCTIONAL DESCRIPTION
29 --------------------------------------------------------------------------------
30 This class excapsulates a socket for simple data writing
33 --------------------------------------------------------------------------------
36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
42 #include "FGfdmSocket.h"
46 static const char *IdSrc = "$Id$";
47 static const char *IdHdr = ID_FDMSOCKET;
49 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
51 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
53 FGfdmSocket::FGfdmSocket(string address, int port)
55 sckt = sckt_in = size = 0;
58 #if defined(__BORLANDC__) || defined(_MSC_VER) || defined(__MINGW32__)
61 wsaReturnCode = WSAStartup(MAKEWORD(1,1), &wsaData);
62 if (wsaReturnCode == 0) cout << "Winsock DLL loaded ..." << endl;
63 else cout << "Winsock DLL not initialized ..." << endl;
66 if (address.find_first_not_of("0123456789.",0) != address.npos) {
67 if ((host = gethostbyname(address.c_str())) == NULL) {
68 cout << "Could not get host net address by name..." << endl;
71 if ((host = gethostbyaddr(address.c_str(), address.size(), PF_INET)) == NULL) {
72 cout << "Could not get host net address by number..." << endl;
77 cout << "Got host net address..." << endl;
78 sckt = socket(AF_INET, SOCK_STREAM, 0);
80 if (sckt >= 0) { // successful
81 memset(&scktName, 0, sizeof(struct sockaddr_in));
82 scktName.sin_family = AF_INET;
83 scktName.sin_port = htons(port);
84 std::memcpy(&scktName.sin_addr, host->h_addr_list[0], host->h_length);
85 int len = sizeof(struct sockaddr_in);
86 if (connect(sckt, (struct sockaddr*)&scktName, len) == 0) { // successful
87 cout << "Successfully connected to socket for output ..." << endl;
89 } else { // unsuccessful
90 cout << "Could not connect to socket for output ..." << endl;
92 } else { // unsuccessful
93 cout << "Could not create socket for FDM output, error = " << errno << endl;
99 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
101 FGfdmSocket::FGfdmSocket(int port)
105 unsigned long NoBlock = true;
107 #if defined(__BORLANDC__) || defined(_MSC_VER) || defined(__MINGW32__)
110 wsaReturnCode = WSAStartup(MAKEWORD(1,1), &wsaData);
111 if (wsaReturnCode == 0) cout << "Winsock DLL loaded ..." << endl;
112 else cerr << "Winsock DLL not initialized ..." << endl;
115 sckt = socket(AF_INET, SOCK_STREAM, 0);
117 if (sckt >= 0) { // successful
118 std::memset(&scktName, 0, sizeof(struct sockaddr_in));
119 scktName.sin_family = AF_INET;
120 scktName.sin_port = htons(port);
121 int len = sizeof(struct sockaddr_in);
122 if (bind(sckt, (struct sockaddr*)&scktName, len) == 0) { // successful
123 cout << "Successfully bound to socket for input on port " << port << endl;
124 if (listen(sckt, 5) >= 0) { // successful listen()
125 #if defined(__BORLANDC__) || defined(_MSC_VER) || defined(__MINGW32__)
126 ioctlsocket(sckt, FIONBIO, &NoBlock);
127 sckt_in = accept(sckt, (struct sockaddr*)&scktName, &len);
129 ioctl(sckt, FIONBIO, &NoBlock);
130 sckt_in = accept(sckt, (struct sockaddr*)&scktName, (socklen_t*)&len);
133 cerr << "Could not listen ..." << endl;
136 } else { // unsuccessful
137 cerr << "Could not bind to socket for input ..." << endl;
139 } else { // unsuccessful
140 cerr << "Could not create socket for FDM input, error = " << errno << endl;
146 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
148 FGfdmSocket::~FGfdmSocket()
151 if (sckt) shutdown(sckt,2);
152 if (sckt_in) shutdown(sckt_in,2);
161 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
163 string FGfdmSocket::Receive(void)
166 int len = sizeof(struct sockaddr_in);
169 unsigned long NoBlock = true;
170 string data = ""; // todo: should allocate this with a standard size as a
171 // class attribute and pass as a reference?
174 #if defined(__BORLANDC__) || defined(_MSC_VER) || defined(__MINGW32__)
175 sckt_in = accept(sckt, (struct sockaddr*)&scktName, &len);
177 sckt_in = accept(sckt, (struct sockaddr*)&scktName, (socklen_t*)&len);
180 #if defined(__BORLANDC__) || defined(_MSC_VER) || defined(__MINGW32__)
181 ioctlsocket(sckt_in, FIONBIO,&NoBlock);
183 ioctl(sckt_in, FIONBIO, &NoBlock);
185 send(sckt_in, "Connected to JSBSim server\nJSBSim> ", 35, 0);
190 while ((num_chars = recv(sckt_in, buf, 1024, 0)) > 0) {
191 data += string(buf).substr(0,num_chars);
192 total_chars += num_chars;
195 #if defined(_MSC_VER)
196 // when nothing received and the error isn't "would block"
197 // then assume that the client has closed the socket.
198 if (num_chars == 0) {
199 DWORD err = WSAGetLastError ();
200 if (err != WSAEWOULDBLOCK) {
201 printf ("Socket Closed. back to listening\n");
202 closesocket (sckt_in);
209 return data.substr(0, total_chars);
212 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
214 int FGfdmSocket::Reply(string text)
216 int num_chars_sent=0;
219 num_chars_sent = send(sckt_in, text.c_str(), text.size(), 0);
220 send(sckt_in, "JSBSim> ", 8, 0);
222 cerr << "Socket reply must be to a valid socket" << endl;
225 return num_chars_sent;
228 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
230 void FGfdmSocket::Close(void)
235 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
237 void FGfdmSocket::Clear(void)
243 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
245 void FGfdmSocket::Clear(string s)
248 size = buffer.size();
251 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
253 void FGfdmSocket::Append(const char* item)
255 if (size == 0) buffer += string(item);
256 else buffer += string(",") + string(item);
260 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
262 void FGfdmSocket::Append(double item)
266 sprintf(s,"%12.7f",item);
268 if (size == 0) buffer += string(s);
269 else buffer += string(",") + string(s);
273 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
275 void FGfdmSocket::Append(long item)
279 sprintf(s,"%12ld",item);
281 if (size == 0) buffer += string(s);
282 else buffer += string(",") + string(s);
286 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
288 void FGfdmSocket::Send(void)
290 buffer += string("\n");
291 if ((send(sckt,buffer.c_str(),buffer.size(),0)) <= 0) {
297 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
298 // The bitmasked value choices are as follows:
299 // unset: In this case (the default) JSBSim would only print
300 // out the normally expected messages, essentially echoing
301 // the config files as they are read. If the environment
302 // variable is not set, debug_lvl is set to 1 internally
303 // 0: This requests JSBSim not to output any messages
305 // 1: This value explicity requests the normal JSBSim
307 // 2: This value asks for a message to be printed out when
308 // a class is instantiated
309 // 4: When this value is set, a message is displayed when a
310 // FGModel object executes its Run() method
311 // 8: When this value is set, various runtime state variables
312 // are printed out periodically
313 // 16: When set various parameters are sanity checked and
314 // a message is printed out when they go out of bounds
316 void FGfdmSocket::Debug(int from)
318 if (debug_lvl <= 0) return;
320 if (debug_lvl & 1) { // Standard console startup message output
321 if (from == 0) { // Constructor
324 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
325 if (from == 0) cout << "Instantiated: FGfdmSocket" << endl;
326 if (from == 1) cout << "Destroyed: FGfdmSocket" << endl;
328 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
330 if (debug_lvl & 8 ) { // Runtime state variables
332 if (debug_lvl & 16) { // Sanity checking
334 if (debug_lvl & 64) {
335 if (from == 0) { // Constructor
336 cout << IdSrc << endl;
337 cout << IdHdr << endl;