protocol.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 PROTOCOL_HPP
#define PROTOCOL_HPP
 
#include "utils/no_copy.hpp"
#include "utils/types.hpp"
 
#include <memory>
#include <stddef.h>
 
class Event;
class NetworkString;
class STKPeer;
 
 
enum ProtocolType
{
    PROTOCOL_NONE              = 0x00,  
    PROTOCOL_CONNECTION        = 0x01,  
    PROTOCOL_LOBBY_ROOM        = 0x02,  
    PROTOCOL_GAME_EVENTS       = 0x03,  
    PROTOCOL_CONTROLLER_EVENTS = 0x04,  
    PROTOCOL_SILENT            = 0x05,  
    PROTOCOL_MAX                     ,  
    PROTOCOL_SYNCHRONOUS       = 0x80,  
};   // ProtocolType
 
// ----------------------------------------------------------------------------
enum ProtocolState
{
    PROTOCOL_STATE_INITIALISING, 
    PROTOCOL_STATE_RUNNING,      
    PROTOCOL_STATE_PAUSED,       
    PROTOCOL_STATE_TERMINATED    
};   // ProtocolState
 
class Protocol;
 
// ============================================================================*
class CallbackObject
{
public:
             CallbackObject() {}
    virtual ~CallbackObject() {}
 
    virtual void callback(Protocol *protocol) = 0;
};   // CallbackObject
 
// ============================================================================
class Protocol : public std::enable_shared_from_this<Protocol>,
                 public NoCopy
{
protected:
    ProtocolType m_type;
 
    bool m_handle_connections;
 
    bool m_handle_disconnections;
public:
             Protocol(ProtocolType type);
    virtual ~Protocol();
 
    virtual void setup() = 0;
    // ------------------------------------------------------------------------
 
    virtual void update(int ticks) = 0;
 
    virtual void asynchronousUpdate() = 0;
 
    NetworkString* getNetworkString(size_t capacity = 16) const;
    bool checkDataSize(Event* event, unsigned int minimum_size);
    void sendMessageToPeers(NetworkString *message, bool reliable = true);
    void sendMessageToPeersInServer(NetworkString *message,
                                    bool reliable = true);
    void sendToServer(NetworkString *message, bool reliable = true);
    virtual void requestStart();
    virtual void requestTerminate();
    // ------------------------------------------------------------------------
    virtual bool notifyEvent(Event* event) { return false; }
    // ------------------------------------------------------------------------
    virtual bool notifyEventAsynchronous(Event* event) { return false; }
    // ------------------------------------------------------------------------
    ProtocolType getProtocolType() const { return m_type; }
    // ------------------------------------------------------------------------
    void setHandleConnections(bool b) { m_handle_connections = b; }
    // ------------------------------------------------------------------------
    void setHandleDisconnections(bool b) { m_handle_disconnections = b; }
    // ------------------------------------------------------------------------
    virtual bool handleConnects() const { return m_handle_connections; }
    // ------------------------------------------------------------------------
    virtual bool handleDisconnects() const { return m_handle_disconnections; }
 
};   // class Protocol
 
#endif // PROTOCOL_HPP