stk-code_catmod/src/network/stk_peer.hpp

//
//  SuperTuxKart - a fun racing game with go-kart
//  Copyright (C) 2013 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/stk_host.hpp"
#include "network/network_string.hpp"
#include "network/game_setup.hpp"
#include <enet/enet.h>

/*! \class STKPeer
 *  \brief Represents a peer.
 *  This class is used to interface the ENetPeer structure.
 */
class STKPeer
{
    friend class Event;
    public:
        STKPeer();
        STKPeer(const STKPeer& peer);
        virtual ~STKPeer();

        virtual void sendPacket(const NetworkString& data, bool reliable = true);
        static bool connectToHost(STKHost* localhost, TransportAddress host, uint32_t channel_count, uint32_t data);
        void disconnect();

        void setClientServerToken(const uint32_t& token) { *m_client_server_token = token; *m_token_set = true; }
        void unsetClientServerToken() { *m_token_set = false; }
        void setPlayerProfile(NetworkPlayerProfile* profile) { *m_player_profile = profile; }
        void setPlayerProfilePtr(NetworkPlayerProfile** profile) { m_player_profile = profile; }

        bool isConnected() const;
        bool exists() const;
        uint32_t getAddress() const;
        uint16_t getPort() const;
        NetworkPlayerProfile* getPlayerProfile() { return (m_player_profile)?(*m_player_profile):NULL; }
        uint32_t getClientServerToken() const   { return *m_client_server_token; }
        bool     isClientServerTokenSet() const { return *m_token_set; }

        bool isSamePeer(const STKPeer* peer) const;

    protected:
        ENetPeer* m_peer;
        NetworkPlayerProfile** m_player_profile;
        uint32_t *m_client_server_token;
        bool *m_token_set;
};

#endif // STK_PEER_HPP