|
1 /* $Id$ */ |
|
2 |
|
3 #ifndef NETWORK_DATA_H |
|
4 #define NETWORK_DATA_H |
|
5 |
|
6 // Is the network enabled? |
|
7 #ifdef ENABLE_NETWORK |
|
8 |
|
9 #include "../openttd.h" |
|
10 #include "network.h" |
|
11 #include "core/os_abstraction.h" |
|
12 #include "core/config.h" |
|
13 #include "core/packet.h" |
|
14 |
|
15 #define MAX_TEXT_MSG_LEN 1024 /* long long long long sentences :-) */ |
|
16 |
|
17 // The client-info-server-index is always 1 |
|
18 #define NETWORK_SERVER_INDEX 1 |
|
19 #define NETWORK_EMPTY_INDEX 0 |
|
20 |
|
21 typedef struct CommandPacket { |
|
22 struct CommandPacket *next; |
|
23 PlayerID player; /// player that is executing the command |
|
24 uint32 cmd; /// command being executed |
|
25 uint32 p1; /// parameter p1 |
|
26 uint32 p2; /// parameter p2 |
|
27 TileIndex tile; /// tile command being executed on |
|
28 char text[80]; |
|
29 uint32 frame; /// the frame in which this packet is executed |
|
30 byte callback; /// any callback function executed upon successful completion of the command |
|
31 } CommandPacket; |
|
32 |
|
33 typedef enum { |
|
34 STATUS_INACTIVE, |
|
35 STATUS_AUTH, // This means that the client is authorized |
|
36 STATUS_MAP_WAIT, // This means that the client is put on hold because someone else is getting the map |
|
37 STATUS_MAP, |
|
38 STATUS_DONE_MAP, |
|
39 STATUS_PRE_ACTIVE, |
|
40 STATUS_ACTIVE, |
|
41 } ClientStatus; |
|
42 |
|
43 typedef enum { |
|
44 MAP_PACKET_START, |
|
45 MAP_PACKET_NORMAL, |
|
46 MAP_PACKET_END, |
|
47 } MapPacket; |
|
48 |
|
49 typedef enum { |
|
50 NETWORK_RECV_STATUS_OKAY, |
|
51 NETWORK_RECV_STATUS_DESYNC, |
|
52 NETWORK_RECV_STATUS_SAVEGAME, |
|
53 NETWORK_RECV_STATUS_CONN_LOST, |
|
54 NETWORK_RECV_STATUS_MALFORMED_PACKET, |
|
55 NETWORK_RECV_STATUS_SERVER_ERROR, // The server told us we made an error |
|
56 NETWORK_RECV_STATUS_SERVER_FULL, |
|
57 NETWORK_RECV_STATUS_SERVER_BANNED, |
|
58 NETWORK_RECV_STATUS_CLOSE_QUERY, // Done quering the server |
|
59 } NetworkRecvStatus; |
|
60 |
|
61 typedef enum { |
|
62 NETWORK_ERROR_GENERAL, // Try to use thisone like never |
|
63 |
|
64 // Signals from clients |
|
65 NETWORK_ERROR_DESYNC, |
|
66 NETWORK_ERROR_SAVEGAME_FAILED, |
|
67 NETWORK_ERROR_CONNECTION_LOST, |
|
68 NETWORK_ERROR_ILLEGAL_PACKET, |
|
69 |
|
70 // Signals from servers |
|
71 NETWORK_ERROR_NOT_AUTHORIZED, |
|
72 NETWORK_ERROR_NOT_EXPECTED, |
|
73 NETWORK_ERROR_WRONG_REVISION, |
|
74 NETWORK_ERROR_NAME_IN_USE, |
|
75 NETWORK_ERROR_WRONG_PASSWORD, |
|
76 NETWORK_ERROR_PLAYER_MISMATCH, // Happens in CLIENT_COMMAND |
|
77 NETWORK_ERROR_KICKED, |
|
78 NETWORK_ERROR_CHEATER, |
|
79 NETWORK_ERROR_FULL, |
|
80 } NetworkErrorCode; |
|
81 |
|
82 // Actions that can be used for NetworkTextMessage |
|
83 typedef enum { |
|
84 NETWORK_ACTION_JOIN, |
|
85 NETWORK_ACTION_LEAVE, |
|
86 NETWORK_ACTION_SERVER_MESSAGE, |
|
87 NETWORK_ACTION_CHAT, |
|
88 NETWORK_ACTION_CHAT_COMPANY, |
|
89 NETWORK_ACTION_CHAT_CLIENT, |
|
90 NETWORK_ACTION_GIVE_MONEY, |
|
91 NETWORK_ACTION_NAME_CHANGE, |
|
92 } NetworkAction; |
|
93 |
|
94 typedef enum { |
|
95 NETWORK_GAME_PASSWORD, |
|
96 NETWORK_COMPANY_PASSWORD, |
|
97 } NetworkPasswordType; |
|
98 |
|
99 // To keep the clients all together |
|
100 struct NetworkClientState { // Typedeffed in network_core/packet.h |
|
101 SOCKET socket; |
|
102 uint16 index; |
|
103 uint32 last_frame; |
|
104 uint32 last_frame_server; |
|
105 byte lag_test; // This byte is used for lag-testing the client |
|
106 |
|
107 ClientStatus status; |
|
108 bool writable; // is client ready to write to? |
|
109 bool has_quit; |
|
110 |
|
111 Packet *packet_queue; // Packets that are awaiting delivery |
|
112 Packet *packet_recv; // Partially received packet |
|
113 |
|
114 CommandPacket *command_queue; // The command-queue awaiting delivery |
|
115 }; |
|
116 |
|
117 typedef enum { |
|
118 DESTTYPE_BROADCAST, ///< Send message/notice to all players (All) |
|
119 DESTTYPE_TEAM, ///< Send message/notice to everyone playing the same company (Team) |
|
120 DESTTYPE_CLIENT, ///< Send message/notice to only a certain player (Private) |
|
121 } DestType; |
|
122 |
|
123 CommandPacket *_local_command_queue; |
|
124 |
|
125 SOCKET _udp_client_socket; // udp client socket |
|
126 SOCKET _udp_server_socket; // udp server socket |
|
127 SOCKET _udp_master_socket; // udp master socket |
|
128 |
|
129 // Here we keep track of the clients |
|
130 // (and the client uses [0] for his own communication) |
|
131 NetworkClientState _clients[MAX_CLIENTS]; |
|
132 #define DEREF_CLIENT(i) (&_clients[i]) |
|
133 // This returns the NetworkClientInfo from a NetworkClientState |
|
134 #define DEREF_CLIENT_INFO(cs) (&_network_client_info[cs - _clients]) |
|
135 |
|
136 // Macros to make life a bit more easier |
|
137 #define DEF_CLIENT_RECEIVE_COMMAND(type) NetworkRecvStatus NetworkPacketReceive_ ## type ## _command(Packet *p) |
|
138 #define DEF_CLIENT_SEND_COMMAND(type) void NetworkPacketSend_ ## type ## _command(void) |
|
139 #define DEF_CLIENT_SEND_COMMAND_PARAM(type) void NetworkPacketSend_ ## type ## _command |
|
140 #define DEF_SERVER_RECEIVE_COMMAND(type) void NetworkPacketReceive_ ## type ## _command(NetworkClientState *cs, Packet *p) |
|
141 #define DEF_SERVER_SEND_COMMAND(type) void NetworkPacketSend_ ## type ## _command(NetworkClientState *cs) |
|
142 #define DEF_SERVER_SEND_COMMAND_PARAM(type) void NetworkPacketSend_ ## type ## _command |
|
143 |
|
144 #define SEND_COMMAND(type) NetworkPacketSend_ ## type ## _command |
|
145 #define RECEIVE_COMMAND(type) NetworkPacketReceive_ ## type ## _command |
|
146 |
|
147 #define FOR_ALL_CLIENTS(cs) for (cs = _clients; cs != endof(_clients) && cs->socket != INVALID_SOCKET; cs++) |
|
148 #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) |
|
149 |
|
150 void NetworkExecuteCommand(CommandPacket *cp); |
|
151 void NetworkAddCommandQueue(NetworkClientState *cs, CommandPacket *cp); |
|
152 |
|
153 // from network.c |
|
154 void NetworkCloseClient(NetworkClientState *cs); |
|
155 void CDECL NetworkTextMessage(NetworkAction action, uint16 color, bool self_send, const char *name, const char *str, ...); |
|
156 void NetworkGetClientName(char *clientname, size_t size, const NetworkClientState *cs); |
|
157 uint NetworkCalculateLag(const NetworkClientState *cs); |
|
158 byte NetworkGetCurrentLanguageIndex(void); |
|
159 NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index); |
|
160 NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip); |
|
161 NetworkClientState *NetworkFindClientStateFromIndex(uint16 client_index); |
|
162 unsigned long NetworkResolveHost(const char *hostname); |
|
163 char* GetNetworkErrorMsg(char* buf, NetworkErrorCode err, const char* last); |
|
164 |
|
165 #endif /* ENABLE_NETWORK */ |
|
166 |
|
167 #endif /* NETWORK_DATA_H */ |