Nla Sound Strips + Add Speaker
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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  */
29
30 /** \file NG_NetworkDeviceInterface.h
31  *  \ingroup bgenet
32  *  \brief Functions like (de)initialize network, get library version
33  * To be derived by loopback and network libraries
34  */
35
36 #ifndef NG_NETWORKDEVICEINTERFACE_H
37 #define NG_NETWORKDEVICEINTERFACE_H
38
39 #include "NG_NetworkMessage.h"
40 #include <vector>
41
42 class NG_NetworkDeviceInterface
43 {
44 private:
45         // candidates for shared/common implementation class
46         bool m_online;
47 public:
48         NG_NetworkDeviceInterface() {};
49         virtual ~NG_NetworkDeviceInterface() {};
50
51         virtual void NextFrame()=0;
52
53         /**
54           * Mark network connection online
55           */
56         void Online(void) { m_online = true; }
57         /**
58           * Mark network connection offline
59           */
60         void Offline(void) { m_online = false; }
61         /**
62           * Is the network connection established ?
63           */
64         bool IsOnline(void) { return m_online; }
65
66         virtual bool Connect(char *address, unsigned int port, char *password,
67                      unsigned int localport, unsigned int timeout)=0;
68         virtual bool Disconnect(void)=0;
69
70         virtual void SendNetworkMessage(NG_NetworkMessage* msg)=0;
71         /**
72           * read NG_NetworkMessage from library buffer, may be
73           * irrelevant for loopbackdevices
74           */
75         
76         virtual std::vector<NG_NetworkMessage*> RetrieveNetworkMessages()=0;
77         
78         
79 #ifdef WITH_CXX_GUARDEDALLOC
80 public:
81         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:NG_NetworkDeviceInterface"); }
82         void operator delete( void *mem ) { MEM_freeN(mem); }
83 #endif
84 };
85
86 #endif //NG_NETWORKDEVICEINTERFACE_H
87