Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/network5/src/libraries/network/MasterServerComm.h @ 7773

Last change on this file since 7773 was 7756, checked in by smerkli, 14 years ago

started implementing server pings, but need a change to masterservercomm soon.

File size: 2.8 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
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
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Sandro 'smerkli' Merkli
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#ifndef MASTERSERVERCOMM_H
30#define MASTERSERVERCOMM_H
31
32#include <cstdlib>
33#include <cstdio>
34#include <string>
35#include <cstring>
36#include <enet/enet.h>
37
38namespace orxonox
39{
40  class MasterServerComm
41  {
42    public: 
43      /** constructor */
44      MasterServerComm();
45
46      /** destructor */
47      ~MasterServerComm();
48
49      /** \return 0 for success, other for error
50       *
51       * Initialize everything for the master server communication
52       */
53      int initialize();
54
55
56      /** \param address Address to connect to (Host name or IP in text form)
57       * \param port Port to connect on
58       * \return 0 for success, other for error
59       *
60       * Connect to the master server with the given address on the given port.
61       */
62      int connect( const char *address, unsigned int port );
63
64      /** \param data The data to be sent.
65       * \return 0 for success, other for error.
66       *
67       * Send a request to the master server containing data specified in data
68       */
69      int sendRequest( const char *data );
70
71      /** \param data The data to be sent.
72       * \return 0 for success, other for error.
73       *
74       * Send a request to the master server containing data specified in data
75       * (string version)
76       */
77      int sendRequest( std::string data );
78
79      /** \param callback The callback function to call with data receivced.
80       * \return 0 for success, other for error
81       *
82       * Poll the master server for new data and act accordingly */
83      int pollForReply( int (*callback)( char*, ENetEvent* ), int delayms );
84
85    private:
86      /** client handle */
87      ENetHost *client;
88
89      /** event data holder */
90      ENetEvent *event;
91
92      /** address holder */
93      ENetAddress address;
94
95      /** peer data holder */
96      ENetPeer *peer;
97  };
98
99}
100
101#endif /* MASTERSERVERCOMM_H */
Note: See TracBrowser for help on using the repository browser.