Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/usability/src/libraries/network/PeerList.h @ 11948

Last change on this file since 11948 was 7801, checked in by dafrick, 14 years ago

Merging presentation2 branch back to trunk.

File size: 2.2 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 _PeerList_
30#define _PeerList_
31
32#include <list>
33#include <string>
34#include <enet/enet.h>
35
36/* peer list */
37namespace orxonox
38{
39  /** This class keeps a list of open connections
40   * and some info about them.
41   */
42  class PeerList
43  { public:
44      /** constructor */
45      PeerList();
46
47      /** destructor */
48      ~PeerList();
49
50      /** \param toadd The peer to add
51       * \return 0 for success, -1 for error.
52       *
53       * Add new peer to list
54       */
55      int addPeer( ENetPeer *toadd );
56
57      /** \param addr Address to look for
58       * \return if the peer was found or not
59       *
60       * Remove peer from list by address
61       */
62      bool remPeerByAddr( ENetAddress addr );
63
64      /** \param addr The address to find by
65       *
66       * Find a connection by address */
67      ENetPeer *findPeerByAddr( ENetAddress addr );
68
69      /* NOTE: making this list public so it can easily
70       * be iterated. This makes sense since iterating it
71       * will happen all the time, and using getter methods
72       * for the next in list would slow things down unnecessarily.
73       */
74      /** the list of servers for internal storage */
75      std::list<ENetPeer *> peerlist;
76    private:
77      /* nothing so far. */
78  };
79}
80
81
82
83#endif /* _PeerList_ */
Note: See TracBrowser for help on using the repository browser.