Packet.hh

/*
** TowBowlTactics, a turn-based strategy football game.
**
** Copyright (C) 2006-2010 The TBT 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 2
** of the License, or (at your option) any later version.
**
** The complete GNU General Public Licence Notice can be found as the
** `NOTICE' file in the root directory.
**
** The TBT Team consists of people listed in the `AUTHORS' file.
*/

#ifndef PACKET_HH_
# define PACKET_HH_

# include <sstream>

const unsigned CX_TOKEN_START = 0x8000;

enum eCxToken {
  CX_INIT = CX_TOKEN_START,
  CX_ACCEPT,
  CX_DENY,
  CX_QUERYLIST,
  CX_LIST,
  CX_JOIN,
  CX_READY,
  CX_ABORT,
  CX_ERROR,
  CX_TOKEN_LAST,
};

const unsigned PACKET_SIZE_MAX  = 2048;

struct Packet
{
  unsigned      token;
  int           client_id;
  unsigned      data_size;

  Packet(int token = 0, int client_id = -1);
  friend std::ostream& operator<< (std::ostream& os, const Packet& pkt);
};


inline Packet::Packet(int token, int client_id)
  : token(token), client_id(client_id)
{
  data_size = sizeof(*this);
}

inline std::ostream& operator<< (std::ostream& os, const Packet& pkt)
{
  os << "*** Packet dump ***" << std::endl;
  os << "  - token : " << pkt.token << std::endl;
  os << "  - player_id : " << pkt.client_id << std::endl;
  os << "  - data_size : " << pkt.data_size << std::endl;
  return os;
}


void          stringToPacket(int* dst, const std::string& src, unsigned max_size);

std::string   packetToString(const int* src);



//
// Cx packets, managed by clients and server, not by rules.
//

struct CxInit : public Packet
{
  CxInit()
   : Packet(CX_INIT, -1) { data_size = sizeof(*this); }
  int binary_version;
};

struct CxDeny : public Packet
{
  CxDeny()
   : Packet(CX_DENY, -1) { data_size = sizeof(*this); }
  int reason[16];
};

struct CxError : public Packet
{
  CxError(int player_id = -1)
    : Packet(CX_ERROR, player_id) { data_size = sizeof(*this); }
  int msg[16];
};


#endif /* !PACKET_HH_ */