2005-07-24 16:12:37 +02:00
/* $Id$ */
2004-12-04 18:54:56 +01:00
# ifndef NETWORK_DATA_H
# define NETWORK_DATA_H
// Is the network enabled?
# ifdef ENABLE_NETWORK
2007-01-02 18:34:03 +01:00
# include "../openttd.h"
# include "network.h"
# include "core/os_abstraction.h"
2007-01-12 21:19:49 +01:00
# include "core/core.h"
2007-01-02 18:34:03 +01:00
# include "core/config.h"
# include "core/packet.h"
2007-01-12 21:19:49 +01:00
# include "core/tcp.h"
2007-01-02 18:34:03 +01:00
2004-12-04 18:54:56 +01:00
# define MAX_TEXT_MSG_LEN 1024 /* long long long long sentences :-) */
// The client-info-server-index is always 1
# define NETWORK_SERVER_INDEX 1
# define NETWORK_EMPTY_INDEX 0
2007-03-07 13:11:48 +01:00
enum MapPacket {
2004-12-04 18:54:56 +01:00
MAP_PACKET_START ,
MAP_PACKET_NORMAL ,
MAP_PACKET_END ,
2007-03-07 13:11:48 +01:00
} ;
2004-12-04 18:54:56 +01:00
2007-03-07 13:11:48 +01:00
enum NetworkErrorCode {
2004-12-04 18:54:56 +01:00
NETWORK_ERROR_GENERAL , // Try to use thisone like never
// Signals from clients
NETWORK_ERROR_DESYNC ,
NETWORK_ERROR_SAVEGAME_FAILED ,
NETWORK_ERROR_CONNECTION_LOST ,
NETWORK_ERROR_ILLEGAL_PACKET ,
2007-01-30 18:22:56 +01:00
NETWORK_ERROR_NEWGRF_MISMATCH ,
2004-12-04 18:54:56 +01:00
// Signals from servers
NETWORK_ERROR_NOT_AUTHORIZED ,
NETWORK_ERROR_NOT_EXPECTED ,
NETWORK_ERROR_WRONG_REVISION ,
NETWORK_ERROR_NAME_IN_USE ,
NETWORK_ERROR_WRONG_PASSWORD ,
NETWORK_ERROR_PLAYER_MISMATCH , // Happens in CLIENT_COMMAND
NETWORK_ERROR_KICKED ,
2004-12-21 18:31:10 +01:00
NETWORK_ERROR_CHEATER ,
2006-01-25 19:11:06 +01:00
NETWORK_ERROR_FULL ,
2007-03-07 13:11:48 +01:00
} ;
2004-12-04 18:54:56 +01:00
// Actions that can be used for NetworkTextMessage
2007-03-07 13:11:48 +01:00
enum NetworkAction {
2004-12-19 16:14:55 +01:00
NETWORK_ACTION_JOIN ,
NETWORK_ACTION_LEAVE ,
2006-10-25 00:23:08 +02:00
NETWORK_ACTION_SERVER_MESSAGE ,
2004-12-04 18:54:56 +01:00
NETWORK_ACTION_CHAT ,
2006-10-22 00:29:14 +02:00
NETWORK_ACTION_CHAT_COMPANY ,
2004-12-04 18:54:56 +01:00
NETWORK_ACTION_CHAT_CLIENT ,
NETWORK_ACTION_GIVE_MONEY ,
NETWORK_ACTION_NAME_CHANGE ,
2007-03-07 13:11:48 +01:00
} ;
2004-12-04 18:54:56 +01:00
2007-03-07 13:11:48 +01:00
enum NetworkPasswordType {
2004-12-04 18:54:56 +01:00
NETWORK_GAME_PASSWORD ,
NETWORK_COMPANY_PASSWORD ,
2007-03-07 13:11:48 +01:00
} ;
2004-12-04 18:54:56 +01:00
2007-03-07 13:11:48 +01:00
enum DestType {
2006-10-18 23:07:36 +02:00
DESTTYPE_BROADCAST , ///< Send message/notice to all players (All)
2006-10-22 00:29:14 +02:00
DESTTYPE_TEAM , ///< Send message/notice to everyone playing the same company (Team)
2006-10-18 23:07:36 +02:00
DESTTYPE_CLIENT , ///< Send message/notice to only a certain player (Private)
2007-03-07 13:11:48 +01:00
} ;
2004-12-04 18:54:56 +01:00
2007-01-10 19:56:51 +01:00
// following externs are instantiated at network.cpp
extern CommandPacket * _local_command_queue ;
2004-12-04 18:54:56 +01:00
// Here we keep track of the clients
// (and the client uses [0] for his own communication)
2007-01-12 21:19:49 +01:00
extern NetworkTCPSocketHandler _clients [ MAX_CLIENTS ] ;
2007-01-10 19:56:51 +01:00
2004-12-04 18:54:56 +01:00
# define DEREF_CLIENT(i) (&_clients[i])
2004-12-19 11:17:26 +01:00
// This returns the NetworkClientInfo from a NetworkClientState
2004-12-04 18:54:56 +01:00
# define DEREF_CLIENT_INFO(cs) (&_network_client_info[cs - _clients])
// Macros to make life a bit more easier
# define DEF_CLIENT_RECEIVE_COMMAND(type) NetworkRecvStatus NetworkPacketReceive_ ## type ## _command(Packet *p)
2007-03-07 12:47:46 +01:00
# define DEF_CLIENT_SEND_COMMAND(type) void NetworkPacketSend_ ## type ## _command()
2004-12-04 18:54:56 +01:00
# define DEF_CLIENT_SEND_COMMAND_PARAM(type) void NetworkPacketSend_ ## type ## _command
2007-01-12 21:19:49 +01:00
# define DEF_SERVER_RECEIVE_COMMAND(type) void NetworkPacketReceive_ ## type ## _command(NetworkTCPSocketHandler *cs, Packet *p)
# define DEF_SERVER_SEND_COMMAND(type) void NetworkPacketSend_ ## type ## _command(NetworkTCPSocketHandler *cs)
2004-12-04 18:54:56 +01:00
# define DEF_SERVER_SEND_COMMAND_PARAM(type) void NetworkPacketSend_ ## type ## _command
# define SEND_COMMAND(type) NetworkPacketSend_ ## type ## _command
# define RECEIVE_COMMAND(type) NetworkPacketReceive_ ## type ## _command
2007-01-12 21:19:49 +01:00
# define FOR_ALL_CLIENTS(cs) for (cs = _clients; cs != endof(_clients) && cs->IsConnected(); cs++)
2006-10-18 15:17:46 +02:00
# 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)
2004-12-04 18:54:56 +01:00
void NetworkExecuteCommand ( CommandPacket * cp ) ;
2007-01-12 21:19:49 +01:00
void NetworkAddCommandQueue ( NetworkTCPSocketHandler * cs , CommandPacket * cp ) ;
2004-12-04 18:54:56 +01:00
// from network.c
2007-01-12 21:19:49 +01:00
void NetworkCloseClient ( NetworkTCPSocketHandler * cs ) ;
2004-12-19 16:14:55 +01:00
void CDECL NetworkTextMessage ( NetworkAction action , uint16 color , bool self_send , const char * name , const char * str , . . . ) ;
2007-01-12 21:19:49 +01:00
void NetworkGetClientName ( char * clientname , size_t size , const NetworkTCPSocketHandler * cs ) ;
uint NetworkCalculateLag ( const NetworkTCPSocketHandler * cs ) ;
2007-03-07 12:47:46 +01:00
byte NetworkGetCurrentLanguageIndex ( ) ;
2004-12-04 18:54:56 +01:00
NetworkClientInfo * NetworkFindClientInfoFromIndex ( uint16 client_index ) ;
2006-01-19 16:58:57 +01:00
NetworkClientInfo * NetworkFindClientInfoFromIP ( const char * ip ) ;
2007-01-12 21:19:49 +01:00
NetworkTCPSocketHandler * NetworkFindClientStateFromIndex ( uint16 client_index ) ;
2004-12-04 18:54:56 +01:00
unsigned long NetworkResolveHost ( const char * hostname ) ;
2006-10-22 01:31:34 +02:00
char * GetNetworkErrorMsg ( char * buf , NetworkErrorCode err , const char * last ) ;
2004-12-04 18:54:56 +01:00
# endif /* ENABLE_NETWORK */
2005-09-18 22:56:44 +02:00
# endif /* NETWORK_DATA_H */