Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/masterserver/src/modules/masterserver/MasterServerComm.h @ 7611

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

Communication channel now working both ways, doxygen documentation added, renamed files to convention, re-wrote the client part object-oriented and non-blocking

File size: 2.0 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
29class MasterServerComm
30{
31  public: 
32    /** constructor */
33    MasterServerComm();
34
35    /** destructor */
36    ~MasterServerComm();
37
38   
39    /** \param address Address to connect to (Host name or IP in text form)
40     * \param port Port to connect on
41     * \return 0 for success, other for error
42     *
43     * Connect to the master server with the given address on the given port.
44     */
45    int connect( char *address, unsigned int port );
46
47    /** \param data The data to be sent.
48     * \return 0 for success, other for error.
49     *
50     * Send a request to the master server containing data specified in data
51     */
52    int sendRequest( char *data );
53
54    /** \param callback The callback function to call with data receivced.
55     * \return 0 for success, other for error
56     *
57     * Poll the master server for new data and act accordingly */
58    int pollForReply( int (*callback)( char*, ENetEvent* ) );
59
60  private:
61    /* client handle */
62    ENetHost *client;
63    ENetEvent event;
64
65    ENetAddress address;
66    ENetPeer *peer;
67
68
69};
Note: See TracBrowser for help on using the repository browser.