1 // fg_io.cxx -- higher level I/O channel management routines
3 // Written by Curtis Olson, started November 1999.
5 // Copyright (C) 1999 Curtis L. Olson - http://www.flightgear.org/~curt
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 #include <simgear/compiler.h>
29 #include <cstdlib> // atoi()
34 #include <simgear/debug/logstream.hxx>
35 #include <simgear/io/iochannel.hxx>
36 #include <simgear/io/sg_file.hxx>
37 #include <simgear/io/sg_serial.hxx>
38 #include <simgear/io/sg_socket.hxx>
39 #include <simgear/io/sg_socket_udp.hxx>
40 #include <simgear/math/sg_types.hxx>
41 #include <simgear/timing/timestamp.hxx>
42 #include <simgear/misc/strutils.hxx>
44 #include <Network/protocol.hxx>
45 #include <Network/ATC-Main.hxx>
46 #include <Network/atlas.hxx>
47 #include <Network/AV400.hxx>
48 #include <Network/AV400Sim.hxx>
49 #include <Network/garmin.hxx>
50 #include <Network/httpd.hxx>
52 # include <Network/jpg-httpd.hxx>
54 #include <Network/joyclient.hxx>
55 #include <Network/jsclient.hxx>
56 #include <Network/native.hxx>
57 #include <Network/native_ctrls.hxx>
58 #include <Network/native_fdm.hxx>
59 #include <Network/native_gui.hxx>
60 #include <Network/opengc.hxx>
61 #include <Network/nmea.hxx>
62 #include <Network/props.hxx>
63 #include <Network/pve.hxx>
64 #include <Network/ray.hxx>
65 #include <Network/rul.hxx>
66 #include <Network/generic.hxx>
67 #include <Network/multiplay.hxx>
69 #include <Network/HLA/hla.hxx>
72 #include "globals.hxx"
93 // configure a port based on the config string
95 FGIO::parse_port_config( const string& config )
97 SG_LOG( SG_IO, SG_INFO, "Parse I/O channel request: " << config );
99 string_list tokens = simgear::strutils::split( config, "," );
102 SG_LOG( SG_IO, SG_ALERT,
103 "Port configuration error: empty config string" );
107 string protocol = tokens[0];
108 SG_LOG( SG_IO, SG_INFO, " protocol = " << protocol );
114 if ( protocol == "atcsim" ) {
115 FGATCMain *atcsim = new FGATCMain;
116 atcsim->set_hz( 30 );
117 if ( tokens.size() != 6 ) {
118 SG_LOG( SG_IO, SG_ALERT, "Usage: --atcsim=[no-]pedals,"
119 << "input0_config,input1_config,"
120 << "output0_config,output1_config,file.nas" );
124 if ( tokens[1] == "no-pedals" ) {
125 fgSetBool( "/input/atcsim/ignore-pedal-controls", true );
127 fgSetBool( "/input/atcsim/ignore-pedal-controls", false );
129 atcsim->set_path_names(tokens[2], tokens[3], tokens[4], tokens[5]);
131 } else if ( protocol == "atlas" ) {
132 FGAtlas *atlas = new FGAtlas;
134 } else if ( protocol == "opengc" ) {
136 // printf("Parsed opengc\n"); cin >> wait;
137 FGOpenGC *opengc = new FGOpenGC;
139 } else if ( protocol == "AV400" ) {
140 FGAV400 *av400 = new FGAV400;
142 } else if ( protocol == "AV400Sim" ) {
143 FGAV400Sim *av400sim = new FGAV400Sim;
145 } else if ( protocol == "garmin" ) {
146 FGGarmin *garmin = new FGGarmin;
148 } else if ( protocol == "httpd" ) {
150 string port = tokens[1];
151 return new FGHttpd( atoi(port.c_str()) );
152 #ifdef FG_JPEG_SERVER
153 } else if ( protocol == "jpg-httpd" ) {
155 string port = tokens[1];
156 return new FGJpegHttpd( atoi(port.c_str()) );
158 } else if ( protocol == "joyclient" ) {
159 FGJoyClient *joyclient = new FGJoyClient;
161 } else if ( protocol == "jsclient" ) {
162 FGJsClient *jsclient = new FGJsClient;
164 } else if ( protocol == "native" ) {
165 FGNative *native = new FGNative;
167 } else if ( protocol == "native-ctrls" ) {
168 FGNativeCtrls *native_ctrls = new FGNativeCtrls;
170 } else if ( protocol == "native-fdm" ) {
171 FGNativeFDM *native_fdm = new FGNativeFDM;
173 } else if ( protocol == "native-gui" ) {
174 FGNativeGUI *net_gui = new FGNativeGUI;
176 } else if ( protocol == "nmea" ) {
177 FGNMEA *nmea = new FGNMEA;
179 } else if ( protocol == "props" || protocol == "telnet" ) {
180 io = new FGProps( tokens );
182 } else if ( protocol == "pve" ) {
183 FGPVE *pve = new FGPVE;
185 } else if ( protocol == "ray" ) {
186 FGRAY *ray = new FGRAY;
188 } else if ( protocol == "rul" ) {
189 FGRUL *rul = new FGRUL;
191 } else if ( protocol == "generic" ) {
193 if (tokens[1] == "socket") {
195 } else if (tokens[1] == "file") {
201 if (configToken >= tokens.size()) {
202 SG_LOG( SG_IO, SG_ALERT, "Not enough tokens passed for the generic protocol.");
206 FGGeneric *generic = new FGGeneric( tokens );
208 } else if ( protocol == "multiplay" ) {
209 if ( tokens.size() != 5 ) {
210 SG_LOG( SG_IO, SG_ALERT, "Ignoring invalid --multiplay option "
211 "(4 arguments expected: --multiplay=dir,hz,hostname,port)" );
214 string dir = tokens[1];
215 string rate = tokens[2];
216 string host = tokens[3];
217 string port = tokens[4];
218 return new FGMultiplay(dir, atoi(rate.c_str()), host, atoi(port.c_str()));
220 } else if ( protocol == "hla" ) {
221 return new FGHLA(tokens);
227 catch (FGProtocolConfigError& err)
229 SG_LOG( SG_IO, SG_ALERT, "Port configuration error: " << err.what() );
234 if (tokens.size() < 3) {
235 SG_LOG( SG_IO, SG_ALERT, "Incompatible number of network arguments.");
238 string medium = tokens[1];
239 SG_LOG( SG_IO, SG_INFO, " medium = " << medium );
241 string direction = tokens[2];
242 io->set_direction( direction );
243 SG_LOG( SG_IO, SG_INFO, " direction = " << direction );
245 string hertz_str = tokens[3];
246 double hertz = atof( hertz_str.c_str() );
248 SG_LOG( SG_IO, SG_INFO, " hertz = " << hertz );
250 if ( medium == "serial" ) {
251 if ( tokens.size() < 5) {
252 SG_LOG( SG_IO, SG_ALERT, "Incompatible number of arguments for serial communications.");
256 string device = tokens[4];
257 SG_LOG( SG_IO, SG_INFO, " device = " << device );
260 string baud = tokens[5];
261 SG_LOG( SG_IO, SG_INFO, " baud = " << baud );
264 SGSerial *ch = new SGSerial( device, baud );
265 io->set_io_channel( ch );
266 } else if ( medium == "file" ) {
268 if ( tokens.size() < 4) {
269 SG_LOG( SG_IO, SG_ALERT, "Incompatible number of arguments for file I/O.");
273 string file = tokens[4];
274 SG_LOG( SG_IO, SG_INFO, " file name = " << file );
276 if (tokens.size() >= 7 && tokens[6] == "repeat") {
277 if (tokens.size() >= 8) {
278 repeat = atoi(tokens[7].c_str());
279 FGGeneric* generic = dynamic_cast<FGGeneric*>(io);
281 generic->setExitOnError(true);
286 SGFile *ch = new SGFile( file, repeat );
287 io->set_io_channel( ch );
288 } else if ( medium == "socket" ) {
289 if ( tokens.size() < 6) {
290 SG_LOG( SG_IO, SG_ALERT, "Incompatible number of arguments for socket communications.");
293 string hostname = tokens[4];
294 string port = tokens[5];
295 string style = tokens[6];
297 SG_LOG( SG_IO, SG_INFO, " hostname = " << hostname );
298 SG_LOG( SG_IO, SG_INFO, " port = " << port );
299 SG_LOG( SG_IO, SG_INFO, " style = " << style );
301 io->set_io_channel( new SGSocket( hostname, port, style ) );
308 // step through the port config streams (from fgOPTIONS) and setup
309 // serial port channels for each
313 // SG_LOG( SG_IO, SG_INFO, "I/O Channel initialization, " <<
314 // globals->get_channel_options_list()->size() << " requests." );
316 _realDeltaTime = fgGetNode("/sim/time/delta-realtime-sec");
320 // we could almost do this in a single step except pushing a valid
321 // port onto the port list copies the structure and destroys the
322 // original, which closes the port and frees up the fd ... doh!!!
324 // parse the configuration strings and store the results in the
325 // appropriate FGIOChannel structures
326 string_list::iterator i = globals->get_channel_options_list()->begin();
327 string_list::iterator end = globals->get_channel_options_list()->end();
328 for (; i != end; ++i )
330 p = parse_port_config( *i );
333 io_channels.push_back( p );
334 if ( !p->is_enabled() ) {
335 SG_LOG( SG_IO, SG_ALERT, "I/O Channel config failed." );
339 SG_LOG( SG_IO, SG_INFO, "I/O Channel parse failed." );
349 // process any IO channel work
351 FGIO::update( double /* delta_time_sec */ )
353 // use wall-clock, not simulation, delta time, so that network
354 // protocols update when the simulation is paused
355 // see http://code.google.com/p/flightgear-bugs/issues/detail?id=125
356 double delta_time_sec = _realDeltaTime->getDoubleValue();
358 ProtocolVec::iterator i = io_channels.begin();
359 ProtocolVec::iterator end = io_channels.end();
360 for (; i != end; ++i ) {
362 if (!p->is_enabled()) {
366 p->dec_count_down( delta_time_sec );
367 double dt = 1 / p->get_hz();
368 if ( p->get_count_down() < 0.33 * dt ) {
371 while ( p->get_count_down() < 0.33 * dt ) {
372 p->inc_count_down( dt );
374 } // of channel processing
375 } // of io_channels iteration
383 ProtocolVec::iterator i = io_channels.begin();
384 ProtocolVec::iterator end = io_channels.end();
385 for (; i != end; ++i )
388 if ( p->is_enabled() ) {