Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/network/ServerList.h @ 11177

Last change on this file since 11177 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.3 KB
RevLine 
[7565]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 _ServerList_
30#define _ServerList_
31
32#include <list>
33#include <string>
[7568]34#include <network/packet/ServerInformation.h>
[7565]35
36/* methods necessary */
[10622]37namespace orxonox
38{
[8937]39  /* HELPER STRUCTURES */
[10622]40  struct ServerListElem
[8937]41  {
42    /* server information (name, IP, etc) */
43    packet::ServerInformation ServerInfo;
44
45    /* peer pointer */
46    ENetPeer* peer;
47  };
48
49  struct ServerListSearchResult
50  {
51    /* list element found */
52    ServerListElem result;
53
54    /* successful search */
55    bool success;
56  };
57
58
59
60
61
[7565]62  /** This class is keeps a list of game servers
63   * and some info about them.
64   */
[10622]65  class ServerList
[7565]66  { public:
67      /** constructor */
68      ServerList();
69
70      /** destructor */
71      ~ServerList();
72
73
74      /* BASIC MANIPULATION */
75      /** \param toadd the server to add.
[11099]76       *  \param peer the peer
[10622]77       *
[7565]78       * Add server to the game server list
79       */
[8937]80      int addServer( packet::ServerInformation toadd,
81        ENetPeer *peer );
[7565]82
83      /** \param name Name of the server to remove
[10622]84       *
85       * Remove server by name
[7565]86       */
87      bool delServerByName( std::string name );
88
89      /** \param address IP address of the server to remove
[10622]90       *
[7565]91       * Remove server by address
92       */
93      bool delServerByAddress( std::string address );
94
[10622]95      bool setNameByAddress( std::string address, std::string name  );
[7565]96
[10622]97      bool setClientsByAddress( std::string address, int clientNumber );
[7565]98
[8937]99      /* SEARCHING */
[10622]100      /* \param address The address of the server that is to be
[8937]101       *  found
102       * \return A struct containing a result of the search and a boolean
103       *  that is only true if the search was successful
[10622]104       *
[8937]105       * Find and return the list handle of a given address.
106       */
107      ServerListSearchResult
108      findServerByAddress( std::string address );
109
110
[10622]111      /* \param name The name of the server that is to be
[8937]112       *  found
113       * \return The struct containing the list entry of the server
[10622]114       *
[8937]115       * Find and return the list handle of a given name.
116       */
117      ServerListSearchResult
118      findServerByName( std::string name );
119
120
121      /* SORTING */
[7565]122      /** sort by name  */
123      void sortByName();
[10622]124
[7565]125      /** sort by ping */
126      void sortByPing();
127
128      /** the list of servers for internal storage */
[8937]129      std::list<ServerListElem> serverlist;
[7651]130    private:
[7565]131  };
132}
133
134#endif /*_ServerList_*/
Note: See TracBrowser for help on using the repository browser.