svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r22075:22099
[blender.git] / source / gameengine / Network / NG_NetworkDeviceInterface.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL 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.
10  *
11  * This program 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
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  * NetworkGameengine_NetworkDeviceInterface
29  * Functions like (de)initialize network, get library version
30  * To be derived by loopback and network libraries
31  */
32 #ifndef NG_NETWORKDEVICEINTERFACE_H
33 #define NG_NETWORKDEVICEINTERFACE_H
34
35 #include "NG_NetworkMessage.h"
36 #include <vector>
37
38 class NG_NetworkDeviceInterface
39 {
40 private:
41         // candidates for shared/common implementation class
42         bool m_online;
43 public:
44         NG_NetworkDeviceInterface() {};
45         virtual ~NG_NetworkDeviceInterface() {};
46
47         virtual void NextFrame()=0;
48
49         /**
50           * Mark network connection online
51           */
52         void Online(void) { m_online = true; }
53         /**
54           * Mark network connection offline
55           */
56         void Offline(void) { m_online = false; }
57         /**
58           * Is the network connection established ?
59           */
60         bool IsOnline(void) { return m_online; }
61
62         virtual bool Connect(char *address, unsigned int port, char *password,
63                      unsigned int localport, unsigned int timeout)=0;
64         virtual bool Disconnect(void)=0;
65
66         virtual void SendNetworkMessage(NG_NetworkMessage* msg)=0;
67         /**
68           * read NG_NetworkMessage from library buffer, may be
69           * irrelevant for loopbackdevices
70           */
71         
72         virtual std::vector<NG_NetworkMessage*> RetrieveNetworkMessages()=0;
73
74         /**
75           * number of messages in device hash for this frame
76           */
77
78         virtual STR_String GetNetworkVersion(void)=0;
79 };
80
81 #endif //NG_NETWORKDEVICEINTERFACE_H
82