event.hpp

Go to the documentation of this file.

//
//  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.
 
#ifndef EVENT_HPP
#define EVENT_HPP
 
#include "network/network_string.hpp"
#include "utils/leak_check.hpp"
#include "utils/types.hpp"
 
#include "enet/enet.h"
 
#include <memory>
 
class STKPeer;
 
enum EVENT_TYPE
{
    EVENT_TYPE_CONNECTED,   
    EVENT_TYPE_DISCONNECTED,
    EVENT_TYPE_MESSAGE      
};
 
enum EVENT_CHANNEL : uint8_t
{
    EVENT_CHANNEL_NORMAL = 0,   
    EVENT_CHANNEL_UNENCRYPTED = 1,
    EVENT_CHANNEL_DATA_TRANSFER = 2,
    EVENT_CHANNEL_COUNT = 3
};
 
enum PeerDisconnectInfo : unsigned int;
 
class Event
{
private:
    LEAK_CHECK()
 
    
    NetworkString *m_data;
 
    EVENT_TYPE m_type;
 
    std::shared_ptr<STKPeer> m_peer;
 
    uint64_t m_arrival_time;
 
    PeerDisconnectInfo m_pdi;
 
public:
         Event(ENetEvent* event, std::shared_ptr<STKPeer> peer);
        ~Event();
 
    // ------------------------------------------------------------------------
    EVENT_TYPE getType() const { return m_type; }
    // ------------------------------------------------------------------------
    std::shared_ptr<STKPeer> getPeerSP() const { return m_peer; }
    // ------------------------------------------------------------------------
    STKPeer* getPeer() const { return m_peer.get(); }
    // ------------------------------------------------------------------------
    const NetworkString& data() const { return *m_data; }
    // ------------------------------------------------------------------------
    NetworkString& data() { return *m_data; }
    // ------------------------------------------------------------------------
    bool isSynchronous() const { return m_type==EVENT_TYPE_MESSAGE &&
                                        m_data->isSynchronous();     }
    // ------------------------------------------------------------------------
    uint64_t getArrivalTime() const { return m_arrival_time; }
    // ------------------------------------------------------------------------
    PeerDisconnectInfo getPeerDisconnectInfo() const { return m_pdi; }
    // ------------------------------------------------------------------------
 
};   // class Event
 
#endif // EVENT_HPP