tron@2186: /* $Id$ */
tron@2186: 
truelight@543: #ifndef NETWORK_DATA_H
truelight@543: #define NETWORK_DATA_H
truelight@543: 
truelight@543: // Is the network enabled?
truelight@543: #ifdef ENABLE_NETWORK
truelight@543: 
rubidium@5720: #include "../openttd.h"
rubidium@5720: #include "network.h"
rubidium@5720: #include "core/os_abstraction.h"
rubidium@5875: #include "core/core.h"
rubidium@5720: #include "core/config.h"
rubidium@5720: #include "core/packet.h"
rubidium@5875: #include "core/tcp.h"
rubidium@5720: 
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: 
celestar@9895: enum MapPacket {
truelight@543: 	MAP_PACKET_START,
truelight@543: 	MAP_PACKET_NORMAL,
truelight@543: 	MAP_PACKET_END,
celestar@9895: };
truelight@543: 
celestar@9895: enum NetworkErrorCode {
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,
rubidium@6123: 	NETWORK_ERROR_NEWGRF_MISMATCH,
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,
celestar@9895: };
truelight@543: 
truelight@543: // Actions that can be used for NetworkTextMessage
celestar@9895: enum NetworkAction {
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,
celestar@9895: };
truelight@543: 
celestar@9895: enum NetworkPasswordType {
truelight@543: 	NETWORK_GAME_PASSWORD,
truelight@543: 	NETWORK_COMPANY_PASSWORD,
celestar@9895: };
truelight@543: 
celestar@9895: enum DestType {
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)
celestar@9895: };
truelight@543: 
rubidium@5838: // following externs are instantiated at network.cpp
rubidium@5838: extern CommandPacket *_local_command_queue;
truelight@543: 
truelight@543: // Here we keep track of the clients
truelight@543: //  (and the client uses [0] for his own communication)
rubidium@5875: extern NetworkTCPSocketHandler _clients[MAX_CLIENTS];
rubidium@5838: 
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)
celestar@9895: #define DEF_CLIENT_SEND_COMMAND(type) void NetworkPacketSend_ ## type ## _command()
truelight@543: #define DEF_CLIENT_SEND_COMMAND_PARAM(type) void NetworkPacketSend_ ## type ## _command
rubidium@5875: #define DEF_SERVER_RECEIVE_COMMAND(type) void NetworkPacketReceive_ ## type ## _command(NetworkTCPSocketHandler *cs, Packet *p)
rubidium@5875: #define DEF_SERVER_SEND_COMMAND(type) void NetworkPacketSend_ ## type ## _command(NetworkTCPSocketHandler *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: 
rubidium@5875: #define FOR_ALL_CLIENTS(cs) for (cs = _clients; cs != endof(_clients) && cs->IsConnected(); 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: void NetworkExecuteCommand(CommandPacket *cp);
rubidium@5875: void NetworkAddCommandQueue(NetworkTCPSocketHandler *cs, CommandPacket *cp);
truelight@543: 
truelight@543: // from network.c
rubidium@5875: void NetworkCloseClient(NetworkTCPSocketHandler *cs);
truelight@722: void CDECL NetworkTextMessage(NetworkAction action, uint16 color, bool self_send, const char *name, const char *str, ...);
rubidium@5875: void NetworkGetClientName(char *clientname, size_t size, const NetworkTCPSocketHandler *cs);
rubidium@5875: uint NetworkCalculateLag(const NetworkTCPSocketHandler *cs);
celestar@9895: byte NetworkGetCurrentLanguageIndex();
truelight@543: NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index);
Darkvater@2859: NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip);
rubidium@5875: NetworkTCPSocketHandler *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 */