]> git.mxchange.org Git - flightgear.git/blob - src/Network/multiplay.hxx
MSVC fix from Frederic Bouvier
[flightgear.git] / src / Network / multiplay.hxx
1 // multiplay.hxx -- protocol object for multiplay in Flightgear
2 //
3 // Written by Diarmuid Tyson, started February 2003.
4 // diarmuid.tyson@airservicesaustralia.com
5 //
6 // Copyright (C) 2003  Airservices Australia
7 //
8 // This program is free software; you can redistribute it and/or
9 // modify it under the terms of the GNU General Public License as
10 // published by the Free Software Foundation; either version 2 of the
11 // License, or (at your option) any later version.
12 //
13 // This program is distributed in the hope that it will be useful, but
14 // WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16 // General Public License for more details.
17 //
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 //
22
23 #ifndef _FG_MULTIPLAY_HXX
24 #define _FG_MULTIPLAY_HXX
25
26 #define FG_MULTIPLAY_HID "$Id$"
27
28 #include STL_STRING
29 SG_USING_STD(string);
30
31 #include "protocol.hxx"
32 #include <simgear/compiler.h>
33 #include <Main/globals.hxx>
34 #include <Main/fg_props.hxx>
35 #include <Model/acmodel.hxx>
36 #include <Model/model.hxx>
37 #include <MultiPlayer/multiplaytxmgr.hxx>
38 #include <MultiPlayer/multiplayrxmgr.hxx>
39
40 /****************************************************************
41 * @version $Id$
42 *
43 * Description: FGMultiplay is an FGProtocol object used as the basic
44 * interface for the multiplayer code into FlightGears generic IO
45 * subsystem.  It only implements the basic FGProtocol methods: open(),
46 * process() and close().  It does not use Sim Gear's IO channels, as
47 * the MultiplayMgrs creates their own sockets through plib.
48 *
49 * It will set up it's direction and rate protocol properties when
50 * created.  Subsequent calls to process will prompt the
51 * MultiplayMgr to either send or receive data over the network.
52 *
53 ******************************************************************/
54
55 class FGMultiplay : public FGProtocol {
56 public:
57
58     /** Constructor */
59     FGMultiplay (const string &dir, const int rate, const string &host, const int port);
60
61     /** Destructor. */
62     ~FGMultiplay ();
63
64     /** Enables the FGMultiplay object
65     */
66     bool open();
67
68     /** Tells the multiplayer_mgr to send/receive data.
69     */
70     bool process();
71
72     /** Closes the multiplayer_mgr.
73     */
74     bool close();
75
76 private:
77
78 };
79
80
81 #endif // _FG_MULTIPLAY_HXX