updated SConstruct and Makefile so that if you compile the gameengine, is always...
[blender.git] / source / gameengine / Network / NG_NetworkDeviceInterface.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  * NetworkGameengine_NetworkDeviceInterface
32  * Functions like (de)initialize network, get library version
33  * To be derived by loopback and network libraries
34  */
35 #ifndef NG_NETWORKDEVICEINTERFACE_H
36 #define NG_NETWORKDEVICEINTERFACE_H
37
38 #include "NG_NetworkMessage.h"
39 #include <vector>
40
41 class NG_NetworkDeviceInterface
42 {
43 private:
44         // candidates for shared/common implementation class
45         bool m_online;
46 public:
47         NG_NetworkDeviceInterface() {};
48         virtual ~NG_NetworkDeviceInterface() {};
49
50         virtual void NextFrame()=0;
51
52         /**
53           * Mark network connection online
54           */
55         void Online(void) { m_online = true; }
56         /**
57           * Mark network connection offline
58           */
59         void Offline(void) { m_online = false; }
60         /**
61           * Is the network connection established ?
62           */
63         bool IsOnline(void) { return m_online; }
64
65         virtual bool Connect(char *address, unsigned int port, char *password,
66                      unsigned int localport, unsigned int timeout)=0;
67         virtual bool Disconnect(void)=0;
68
69         virtual void SendNetworkMessage(NG_NetworkMessage* msg)=0;
70         /**
71           * read NG_NetworkMessage from library buffer, may be
72           * irrelevant for loopbackdevices
73           */
74         
75         virtual std::vector<NG_NetworkMessage*> RetrieveNetworkMessages()=0;
76
77         /**
78           * number of messages in device hash for this frame
79           */
80
81         virtual STR_String GetNetworkVersion(void)=0;
82 };
83
84 #endif //NG_NETWORKDEVICEINTERFACE_H
85