128 lines
4.8 KiB
C++
128 lines
4.8 KiB
C++
//
|
|
// SuperTuxKart - a fun racing game with go-kart
|
|
// Copyright (C) 2013-2015 SuperTuxKart-Team
|
|
//
|
|
// This program is free software; you can redistribute it and/or
|
|
// modify it under the terms of the GNU General Public License
|
|
// as published by the Free Software Foundation; either version 3
|
|
// of the License, or (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program; if not, write to the Free Software
|
|
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
|
|
/*! \file stk_peer.hpp
|
|
* \brief Defines functions to easily manipulate 8-bit network destinated strings.
|
|
*/
|
|
|
|
#ifndef STK_PEER_HPP
|
|
#define STK_PEER_HPP
|
|
|
|
#include "network/transport_address.hpp"
|
|
#include "utils/no_copy.hpp"
|
|
#include "utils/types.hpp"
|
|
|
|
#include <enet/enet.h>
|
|
|
|
#include <memory>
|
|
#include <vector>
|
|
|
|
class NetworkPlayerProfile;
|
|
class NetworkString;
|
|
class STKHost;
|
|
class TransportAddress;
|
|
|
|
enum PeerDisconnectInfo : unsigned int
|
|
{
|
|
PDI_TIMEOUT = 0, //!< Timeout disconnected (default in enet).
|
|
PDI_NORMAL = 1, //!< Normal disconnction with acknowledgement
|
|
PDI_KICK = 2, //!< Kick disconnection
|
|
}; // PeerDisconnectInfo
|
|
|
|
/*! \class STKPeer
|
|
* \brief Represents a peer.
|
|
* This class is used to interface the ENetPeer structure.
|
|
*/
|
|
class STKPeer : public NoCopy
|
|
{
|
|
protected:
|
|
/** Pointer to the corresponding ENet peer data structure. */
|
|
ENetPeer* m_enet_peer;
|
|
|
|
/** The token of this client. */
|
|
uint32_t m_client_server_token;
|
|
|
|
/** True if the token for this peer has been set. */
|
|
bool m_token_set;
|
|
|
|
/** Host id of this peer. */
|
|
int m_host_id;
|
|
|
|
TransportAddress m_peer_address;
|
|
|
|
STKHost* m_host;
|
|
|
|
std::vector<std::shared_ptr<NetworkPlayerProfile> > m_players;
|
|
|
|
float m_connected_time;
|
|
|
|
public:
|
|
STKPeer(ENetPeer *enet_peer, STKHost* host, uint32_t host_id);
|
|
~STKPeer() {}
|
|
// ------------------------------------------------------------------------
|
|
void sendPacket(NetworkString *data, bool reliable = true);
|
|
// ------------------------------------------------------------------------
|
|
void disconnect();
|
|
// ------------------------------------------------------------------------
|
|
void kick();
|
|
// ------------------------------------------------------------------------
|
|
void reset();
|
|
// ------------------------------------------------------------------------
|
|
bool isConnected() const;
|
|
const TransportAddress& getAddress() const { return m_peer_address; }
|
|
bool isSamePeer(const STKPeer* peer) const;
|
|
bool isSamePeer(const ENetPeer* peer) const;
|
|
// ------------------------------------------------------------------------
|
|
std::vector<std::shared_ptr<NetworkPlayerProfile> >& getPlayerProfiles()
|
|
{ return m_players; }
|
|
// ------------------------------------------------------------------------
|
|
bool hasPlayerProfiles() const { return !m_players.empty(); }
|
|
// ------------------------------------------------------------------------
|
|
void cleanPlayerProfiles() { m_players.clear(); }
|
|
// ------------------------------------------------------------------------
|
|
void addPlayer(std::shared_ptr<NetworkPlayerProfile> p)
|
|
{ m_players.push_back(p); }
|
|
// ------------------------------------------------------------------------
|
|
/** Sets the token for this client. */
|
|
void setClientServerToken(const uint32_t& token)
|
|
{
|
|
m_client_server_token = token;
|
|
m_token_set = true;
|
|
} // setClientServerToken
|
|
// ------------------------------------------------------------------------
|
|
void unsetClientServerToken()
|
|
{
|
|
m_token_set = false;
|
|
m_client_server_token = 0;
|
|
}
|
|
// ------------------------------------------------------------------------
|
|
/** Returns the token of this client. */
|
|
uint32_t getClientServerToken() const { return m_client_server_token; }
|
|
// ------------------------------------------------------------------------
|
|
/** Returns if the token for this client is known. */
|
|
bool isClientServerTokenSet() const { return m_token_set; }
|
|
// ------------------------------------------------------------------------
|
|
/** Returns the host id of this peer. */
|
|
uint32_t getHostId() const { return m_host_id; }
|
|
// ------------------------------------------------------------------------
|
|
uint32_t getPing() const;
|
|
|
|
}; // STKPeer
|
|
|
|
#endif // STK_PEER_HPP
|