Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/network/MasterServerComm.h @ 11724

Last change on this file since 11724 was 11099, checked in by muemart, 9 years ago

Fix loads of doxygen warnings and other documentation issues

  • Property svn:eol-style set to native
File size: 3.0 KB
RevLine 
[7611]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
[7770]29#ifndef _MasterServerComm_H__
30#define _MasterServerComm_H__
[7745]31
[7801]32#include "NetworkPrereqs.h"
33
[7631]34#include <cstdlib>
35#include <cstdio>
[7650]36#include <string>
[7631]37#include <cstring>
38#include <enet/enet.h>
39
[7769]40
[7631]41namespace orxonox
[7611]42{
[7801]43  class _NetworkExport MasterServerComm
[7769]44  { 
[7631]45    public: 
46      /** constructor */
47      MasterServerComm();
[7611]48
[7631]49      /** destructor */
50      ~MasterServerComm();
[7611]51
[7631]52      /** \return 0 for success, other for error
53       *
54       * Initialize everything for the master server communication
55       */
56      int initialize();
[7801]57     
58      void update();
[7611]59
60
[7631]61      /** \param address Address to connect to (Host name or IP in text form)
62       * \param port Port to connect on
63       * \return 0 for success, other for error
64       *
65       * Connect to the master server with the given address on the given port.
66       */
[7725]67      int connect( const char *address, unsigned int port );
[7611]68
[7761]69      /** \return 0 for success, other for error
70       *
71       * Disconnect from master server.
72       */
[7763]73      int disconnect( void );
[7761]74
[7631]75      /** \param data The data to be sent.
76       * \return 0 for success, other for error.
77       *
78       * Send a request to the master server containing data specified in data
79       */
[7725]80      int sendRequest( const char *data );
[7611]81
[7650]82      /** \param data The data to be sent.
83       * \return 0 for success, other for error.
84       *
85       * Send a request to the master server containing data specified in data
86       * (string version)
87       */
88      int sendRequest( std::string data );
89
[11099]90      /** \param listener The listener to call with data received.
[8108]91       *  \param delayms Delay in milliseconds.
[7631]92       * \return 0 for success, other for error
93       *
94       * Poll the master server for new data and act accordingly */
[8858]95      int pollForReply( WANDiscovery* listener, int delayms );
[7611]96
[7631]97    private:
98      /** client handle */
[7801]99      ENetHost* client;
[7611]100
[7631]101      /** event data holder */
[7801]102      ENetEvent event;
[7631]103
104      /** address holder */
105      ENetAddress address;
106
107      /** peer data holder */
[7801]108      ENetPeer* peer;
[7769]109  }; 
[7631]110
[7769]111} 
[7745]112
[7770]113#endif /* _MasterServerComm_H__ */
Note: See TracBrowser for help on using the repository browser.