tron@2186: /* $Id$ */
tron@2186: 
truelight@543: #ifndef NETWORK_DATA_H
truelight@543: #define NETWORK_DATA_H
truelight@543: 
Darkvater@1891: #include "openttd.h"
truelight@543: #include "network.h"
darkvater@1441: #include "network_core.h"
truelight@543: 
truelight@543: // Is the network enabled?
truelight@543: #ifdef ENABLE_NETWORK
truelight@543: 
truelight@543: #define SEND_MTU 1460
truelight@543: #define MAX_TEXT_MSG_LEN 1024 /* long long long long sentences :-) */
truelight@543: 
truelight@543: // The client-info-server-index is always 1
truelight@543: #define NETWORK_SERVER_INDEX 1
truelight@543: #define NETWORK_EMPTY_INDEX 0
truelight@543: 
truelight@543: // What version of game-info do we use?
rubidium@5339: #define NETWORK_GAME_INFO_VERSION 4
truelight@543: // What version of company info is this?
rubidium@4326: #define NETWORK_COMPANY_INFO_VERSION 4
truelight@668: // What version of master-server-protocol do we use?
truelight@668: #define NETWORK_MASTER_SERVER_VERSION 1
truelight@543: 
truelight@543: typedef uint16 PacketSize;
truelight@543: 
truelight@543: typedef struct Packet {
truelight@543: 	struct Packet *next;
truelight@543: 	PacketSize size;
truelight@543: 	PacketSize pos;
truelight@543: 	byte buffer[SEND_MTU];
truelight@543: } Packet;
truelight@543: 
truelight@543: typedef struct CommandPacket {
truelight@543: 	struct CommandPacket *next;
tron@2498: 	PlayerID player; /// player that is executing the command
Darkvater@1804: 	uint32 cmd;    /// command being executed
Darkvater@1804: 	uint32 p1;     /// parameter p1
Darkvater@1804: 	uint32 p2;     /// parameter p2
tron@1977: 	TileIndex tile; /// tile command being executed on
tron@1820: 	char text[80];
Darkvater@1804: 	uint32 frame;  /// the frame in which this packet is executed
Darkvater@1804: 	byte callback; /// any callback function executed upon successful completion of the command
truelight@543: } CommandPacket;
truelight@543: 
truelight@543: typedef enum {
truelight@543: 	STATUS_INACTIVE,
truelight@543: 	STATUS_AUTH, // This means that the client is authorized
truelight@543: 	STATUS_MAP_WAIT, // This means that the client is put on hold because someone else is getting the map
truelight@543: 	STATUS_MAP,
truelight@543: 	STATUS_DONE_MAP,
truelight@543: 	STATUS_PRE_ACTIVE,
truelight@543: 	STATUS_ACTIVE,
truelight@543: } ClientStatus;
truelight@543: 
truelight@543: typedef enum {
truelight@543: 	MAP_PACKET_START,
truelight@543: 	MAP_PACKET_NORMAL,
truelight@543: 	MAP_PACKET_END,
truelight@543: } MapPacket;
truelight@543: 
truelight@543: typedef enum {
truelight@543: 	NETWORK_RECV_STATUS_OKAY,
truelight@543: 	NETWORK_RECV_STATUS_DESYNC,
truelight@543: 	NETWORK_RECV_STATUS_SAVEGAME,
truelight@543: 	NETWORK_RECV_STATUS_CONN_LOST,
truelight@543: 	NETWORK_RECV_STATUS_MALFORMED_PACKET,
truelight@543: 	NETWORK_RECV_STATUS_SERVER_ERROR, // The server told us we made an error
truelight@543: 	NETWORK_RECV_STATUS_SERVER_FULL,
truelight@841: 	NETWORK_RECV_STATUS_SERVER_BANNED,
truelight@543: 	NETWORK_RECV_STATUS_CLOSE_QUERY, // Done quering the server
truelight@543: } NetworkRecvStatus;
truelight@543: 
truelight@543: typedef enum {
truelight@543: 	NETWORK_ERROR_GENERAL, // Try to use thisone like never
truelight@543: 
truelight@543: 	// Signals from clients
truelight@543: 	NETWORK_ERROR_DESYNC,
truelight@543: 	NETWORK_ERROR_SAVEGAME_FAILED,
truelight@543: 	NETWORK_ERROR_CONNECTION_LOST,
truelight@543: 	NETWORK_ERROR_ILLEGAL_PACKET,
truelight@543: 
truelight@543: 	// Signals from servers
truelight@543: 	NETWORK_ERROR_NOT_AUTHORIZED,
truelight@543: 	NETWORK_ERROR_NOT_EXPECTED,
truelight@543: 	NETWORK_ERROR_WRONG_REVISION,
truelight@543: 	NETWORK_ERROR_NAME_IN_USE,
truelight@543: 	NETWORK_ERROR_WRONG_PASSWORD,
truelight@543: 	NETWORK_ERROR_PLAYER_MISMATCH, // Happens in CLIENT_COMMAND
truelight@543: 	NETWORK_ERROR_KICKED,
truelight@748: 	NETWORK_ERROR_CHEATER,
Darkvater@2879: 	NETWORK_ERROR_FULL,
truelight@543: } NetworkErrorCode;
truelight@543: 
truelight@543: // Actions that can be used for NetworkTextMessage
truelight@543: typedef enum {
truelight@722: 	NETWORK_ACTION_JOIN,
truelight@722: 	NETWORK_ACTION_LEAVE,
Darkvater@4944: 	NETWORK_ACTION_SERVER_MESSAGE,
truelight@543: 	NETWORK_ACTION_CHAT,
Darkvater@4906: 	NETWORK_ACTION_CHAT_COMPANY,
truelight@543: 	NETWORK_ACTION_CHAT_CLIENT,
truelight@543: 	NETWORK_ACTION_GIVE_MONEY,
truelight@543: 	NETWORK_ACTION_NAME_CHANGE,
truelight@543: } NetworkAction;
truelight@543: 
truelight@543: typedef enum {
truelight@543: 	NETWORK_GAME_PASSWORD,
truelight@543: 	NETWORK_COMPANY_PASSWORD,
truelight@543: } NetworkPasswordType;
truelight@543: 
truelight@543: // To keep the clients all together
truelight@716: typedef struct NetworkClientState {
tron@1466: 	SOCKET socket;
truelight@543: 	uint16 index;
truelight@543: 	uint32 last_frame;
truelight@543: 	uint32 last_frame_server;
truelight@543: 	byte lag_test; // This byte is used for lag-testing the client
truelight@543: 
truelight@543: 	ClientStatus status;
truelight@543: 	bool writable; // is client ready to write to?
Darkvater@4880: 	bool has_quit;
truelight@543: 
truelight@543: 	Packet *packet_queue; // Packets that are awaiting delivery
truelight@543: 	Packet *packet_recv; // Partially received packet
truelight@543: 
truelight@543: 	CommandPacket *command_queue; // The command-queue awaiting delivery
truelight@716: } NetworkClientState;
truelight@543: 
truelight@543: // What packet types are there
truelight@543: // WARNING: The first 3 packets can NEVER change order again
truelight@543: //   it protects old clients from joining newer servers (because SERVER_ERROR
truelight@543: //   is the respond to a wrong revision)
truelight@543: typedef enum {
truelight@543: 	PACKET_SERVER_FULL,
truelight@841: 	PACKET_SERVER_BANNED,
truelight@543: 	PACKET_CLIENT_JOIN,
truelight@543: 	PACKET_SERVER_ERROR,
truelight@543: 	PACKET_CLIENT_COMPANY_INFO,
truelight@543: 	PACKET_SERVER_COMPANY_INFO,
truelight@543: 	PACKET_SERVER_CLIENT_INFO,
truelight@543: 	PACKET_SERVER_NEED_PASSWORD,
truelight@543: 	PACKET_CLIENT_PASSWORD,
truelight@543: 	PACKET_SERVER_WELCOME,
truelight@543: 	PACKET_CLIENT_GETMAP,
truelight@543: 	PACKET_SERVER_WAIT,
truelight@543: 	PACKET_SERVER_MAP,
truelight@543: 	PACKET_CLIENT_MAP_OK,
truelight@543: 	PACKET_SERVER_JOIN,
truelight@543: 	PACKET_SERVER_FRAME,
truelight@543: 	PACKET_SERVER_SYNC,
truelight@543: 	PACKET_CLIENT_ACK,
truelight@543: 	PACKET_CLIENT_COMMAND,
truelight@543: 	PACKET_SERVER_COMMAND,
truelight@543: 	PACKET_CLIENT_CHAT,
truelight@543: 	PACKET_SERVER_CHAT,
truelight@543: 	PACKET_CLIENT_SET_PASSWORD,
truelight@543: 	PACKET_CLIENT_SET_NAME,
truelight@543: 	PACKET_CLIENT_QUIT,
truelight@543: 	PACKET_CLIENT_ERROR,
truelight@543: 	PACKET_SERVER_QUIT,
truelight@543: 	PACKET_SERVER_ERROR_QUIT,
truelight@543: 	PACKET_SERVER_SHUTDOWN,
truelight@543: 	PACKET_SERVER_NEWGAME,
truelight@1026: 	PACKET_SERVER_RCON,
truelight@1026: 	PACKET_CLIENT_RCON,
truelight@543: 	PACKET_END // Should ALWAYS be on the end of this list!! (period)
truelight@543: } PacketType;
truelight@543: 
truelight@543: typedef enum {
Darkvater@4887: 	DESTTYPE_BROADCAST, ///< Send message/notice to all players (All)
Darkvater@4906: 	DESTTYPE_TEAM,    ///< Send message/notice to everyone playing the same company (Team)
Darkvater@4887: 	DESTTYPE_CLIENT,    ///< Send message/notice to only a certain player (Private)
truelight@543: } DestType;
truelight@543: 
truelight@543: CommandPacket *_local_command_queue;
truelight@543: 
truelight@543: SOCKET _udp_client_socket; // udp client socket
truelight@764: SOCKET _udp_server_socket; // udp server socket
truelight@764: SOCKET _udp_master_socket; // udp master socket
truelight@543: 
truelight@543: // Here we keep track of the clients
truelight@543: //  (and the client uses [0] for his own communication)
truelight@716: NetworkClientState _clients[MAX_CLIENTS];
truelight@543: #define DEREF_CLIENT(i) (&_clients[i])
truelight@716: // This returns the NetworkClientInfo from a NetworkClientState
truelight@543: #define DEREF_CLIENT_INFO(cs) (&_network_client_info[cs - _clients])
truelight@543: 
truelight@543: // Macros to make life a bit more easier
truelight@543: #define DEF_CLIENT_RECEIVE_COMMAND(type) NetworkRecvStatus NetworkPacketReceive_ ## type ## _command(Packet *p)
truelight@543: #define DEF_CLIENT_SEND_COMMAND(type) void NetworkPacketSend_ ## type ## _command(void)
truelight@543: #define DEF_CLIENT_SEND_COMMAND_PARAM(type) void NetworkPacketSend_ ## type ## _command
truelight@716: #define DEF_SERVER_RECEIVE_COMMAND(type) void NetworkPacketReceive_ ## type ## _command(NetworkClientState *cs, Packet *p)
truelight@716: #define DEF_SERVER_SEND_COMMAND(type) void NetworkPacketSend_ ## type ## _command(NetworkClientState *cs)
truelight@543: #define DEF_SERVER_SEND_COMMAND_PARAM(type) void NetworkPacketSend_ ## type ## _command
truelight@543: 
truelight@543: #define SEND_COMMAND(type) NetworkPacketSend_ ## type ## _command
truelight@543: #define RECEIVE_COMMAND(type) NetworkPacketReceive_ ## type ## _command
truelight@543: 
Darkvater@4883: #define FOR_ALL_CLIENTS(cs) for (cs = _clients; cs != endof(_clients) && cs->socket != INVALID_SOCKET; cs++)
Darkvater@4883: #define FOR_ALL_ACTIVE_CLIENT_INFOS(ci) for (ci = _network_client_info; ci != endof(_network_client_info); ci++) if (ci->client_index != NETWORK_EMPTY_INDEX)
truelight@543: 
truelight@543: Packet *NetworkSend_Init(PacketType type);
truelight@543: void NetworkSend_uint8(Packet *packet, uint8 data);
truelight@543: void NetworkSend_uint16(Packet *packet, uint16 data);
truelight@543: void NetworkSend_uint32(Packet *packet, uint32 data);
truelight@543: void NetworkSend_uint64(Packet *packet, uint64 data);
truelight@543: void NetworkSend_string(Packet *packet, const char* data);
truelight@716: void NetworkSend_Packet(Packet *packet, NetworkClientState *cs);
truelight@543: 
truelight@903: uint8 NetworkRecv_uint8(NetworkClientState *cs, Packet *packet);
truelight@903: uint16 NetworkRecv_uint16(NetworkClientState *cs, Packet *packet);
truelight@903: uint32 NetworkRecv_uint32(NetworkClientState *cs, Packet *packet);
truelight@903: uint64 NetworkRecv_uint64(NetworkClientState *cs, Packet *packet);
truelight@903: void NetworkRecv_string(NetworkClientState *cs, Packet *packet, char* buffer, size_t size);
truelight@716: Packet *NetworkRecv_Packet(NetworkClientState *cs, NetworkRecvStatus *status);
truelight@543: 
truelight@716: bool NetworkSend_Packets(NetworkClientState *cs);
truelight@543: void NetworkExecuteCommand(CommandPacket *cp);
truelight@716: void NetworkAddCommandQueue(NetworkClientState *cs, CommandPacket *cp);
truelight@543: 
truelight@543: // from network.c
truelight@716: void NetworkCloseClient(NetworkClientState *cs);
truelight@722: void CDECL NetworkTextMessage(NetworkAction action, uint16 color, bool self_send, const char *name, const char *str, ...);
truelight@716: void NetworkGetClientName(char *clientname, size_t size, const NetworkClientState *cs);
truelight@716: uint NetworkCalculateLag(const NetworkClientState *cs);
tron@1093: byte NetworkGetCurrentLanguageIndex(void);
truelight@543: NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index);
Darkvater@2859: NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip);
truelight@716: NetworkClientState *NetworkFindClientStateFromIndex(uint16 client_index);
truelight@543: unsigned long NetworkResolveHost(const char *hostname);
Darkvater@4912: char* GetNetworkErrorMsg(char* buf, NetworkErrorCode err, const char* last);
truelight@543: 
truelight@543: #endif /* ENABLE_NETWORK */
truelight@543: 
Darkvater@2436: #endif /* NETWORK_DATA_H */