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