1 | /* |
1 | /* |
2 | * This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game. |
2 | * This file is part of Crossfire TRT, the Roguelike Realtime MORPG. |
3 | * |
3 | * |
4 | * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team |
4 | * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team |
5 | * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team |
5 | * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team |
6 | * Copyright (©) 1992,2007 Frank Tore Johansen |
6 | * Copyright (©) 1992,2007 Frank Tore Johansen |
7 | * |
7 | * |
8 | * Crossfire TRT is free software; you can redistribute it and/or modify it |
8 | * Crossfire TRT is free software: you can redistribute it and/or modify |
9 | * under the terms of the GNU General Public License as published by the Free |
9 | * it under the terms of the GNU General Public License as published by |
10 | * Software Foundation; either version 2 of the License, or (at your option) |
10 | * the Free Software Foundation, either version 3 of the License, or |
11 | * any later version. |
11 | * (at your option) any later version. |
12 | * |
12 | * |
13 | * This program is distributed in the hope that it will be useful, but |
13 | * This program is distributed in the hope that it will be useful, |
14 | * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
15 | * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16 | * for more details. |
16 | * GNU General Public License for more details. |
17 | * |
17 | * |
18 | * You should have received a copy of the GNU General Public License along |
18 | * You should have received a copy of the GNU General Public License |
19 | * with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51 |
19 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
20 | * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
|
|
21 | * |
20 | * |
22 | * The authors can be reached via e-mail to <crossfire@schmorp.de> |
21 | * The authors can be reached via e-mail to <crossfire@schmorp.de> |
23 | */ |
22 | */ |
24 | |
23 | |
25 | #ifndef CLIENT_H |
24 | #ifndef CLIENT_H |
26 | #define CLIENT_H |
25 | #define CLIENT_H |
27 | |
26 | |
28 | #include <deque> |
27 | #include <deque> |
29 | #include <bitset> |
28 | #include <bitset> |
30 | #include <tr1/unordered_set> |
29 | #include <tr1/unordered_set> |
|
|
30 | |
|
|
31 | #if HAVE_TCP_INFO |
|
|
32 | # include <netinet/tcp.h> |
|
|
33 | #else |
|
|
34 | struct tcpi_info { |
|
|
35 | // dummy |
|
|
36 | char tcpi_state; |
|
|
37 | char tcpi_ca_state; |
|
|
38 | char tcpi_retransmits; |
|
|
39 | char tcpi_probes; |
|
|
40 | char tcpi_backoff; |
|
|
41 | char tcpi_options; |
|
|
42 | char tcpi_snd_wscale; |
|
|
43 | char tcpi_rcv_wscale; |
|
|
44 | char tcpi_rto; |
|
|
45 | char tcpi_ato; |
|
|
46 | char tcpi_snd_mss; |
|
|
47 | char tcpi_rcv_mss; |
|
|
48 | char tcpi_unacked; |
|
|
49 | char tcpi_sacked; |
|
|
50 | char tcpi_lost; |
|
|
51 | char tcpi_retrans; |
|
|
52 | char tcpi_fackets; |
|
|
53 | char tcpi_last_data_sent; |
|
|
54 | char tcpi_last_ack_sent; |
|
|
55 | char tcpi_last_data_recv; |
|
|
56 | char tcpi_last_ack_recv; |
|
|
57 | char tcpi_pmtu; |
|
|
58 | char tcpi_rcv_ssthresh; |
|
|
59 | char tcpi_rtt; |
|
|
60 | char tcpi_rttvar; |
|
|
61 | char tcpi_snd_ssthresh; |
|
|
62 | char tcpi_snd_cwnd; |
|
|
63 | char tcpi_advmss; |
|
|
64 | char tcpi_reordering; |
|
|
65 | }; |
|
|
66 | #endif |
31 | |
67 | |
32 | // (possibly) max. number of objects "per page" in the ground container |
68 | // (possibly) max. number of objects "per page" in the ground container |
33 | #define FLOORBOX_PAGESIZE 50 |
69 | #define FLOORBOX_PAGESIZE 50 |
34 | |
70 | |
35 | struct MapCell |
71 | struct MapCell |
… | |
… | |
84 | enum { |
120 | enum { |
85 | PF_PLAYER = 0x01, // must have valid player / will by synchronised |
121 | PF_PLAYER = 0x01, // must have valid player / will by synchronised |
86 | PF_PLAYING = 0x02, // must be in playing state |
122 | PF_PLAYING = 0x02, // must be in playing state |
87 | PF_COMMAND0 = 0x04, // command starts at offset 0 |
123 | PF_COMMAND0 = 0x04, // command starts at offset 0 |
88 | PF_COMMAND6 = 0x08, // command starts at offset 6 |
124 | PF_COMMAND6 = 0x08, // command starts at offset 6 |
|
|
125 | }; |
|
|
126 | |
|
|
127 | // face type.s bit 0 means "has meta info prepended" |
|
|
128 | enum { |
|
|
129 | FT_FACE = 0 * 2 + 0, // faces (images) |
|
|
130 | FT_MUSIC = 1 * 2 + 1, // background music |
|
|
131 | FT_SOUND = 2 * 2 + 1, // effects |
|
|
132 | FT_RSRC = 3 * 2 + 0, // generic data files |
|
|
133 | FT_NUM, |
89 | }; |
134 | }; |
90 | |
135 | |
91 | struct packet_type |
136 | struct packet_type |
92 | { |
137 | { |
93 | const char *name; |
138 | const char *name; |
… | |
… | |
156 | bool ACC (RW, sent_scroll); |
201 | bool ACC (RW, sent_scroll); |
157 | bool ACC (RW, sound); /* does the client want sound */ |
202 | bool ACC (RW, sound); /* does the client want sound */ |
158 | bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
203 | bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
159 | bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ |
204 | bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ |
160 | bool ACC (RW, mapinfocmd); // return map info and send map change info |
205 | bool ACC (RW, mapinfocmd); // return map info and send map change info |
161 | bool ACC (RW, extcmd); // call into extensions/plugins |
206 | uint8_t ACC (RW, extcmd); // call into extensions/plugins |
162 | bool ACC (RW, extmap); // extend map comamnd with extra data |
207 | bool ACC (RW, extmap); // extend map comamnd with extra data |
163 | bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls |
208 | bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls |
164 | bool ACC (RW, darkness); /* True if client wants darkness information */ |
209 | bool ACC (RW, darkness); /* True if client wants darkness information */ |
165 | bool ACC (RW, image2); /* Client wants image2/face2 commands */ |
210 | bool ACC (RW, image2); /* Client wants image2/face2 commands */ |
166 | uint8_t ACC (RW, fxix); // client implements fx and ix (face|image extended) commands |
211 | uint8_t ACC (RW, fxix); // client implements fx and ix (face|image extended) commands |
… | |
… | |
190 | shstr ACC (RW, version); // CF+ client name/version |
235 | shstr ACC (RW, version); // CF+ client name/version |
191 | uint8 ACC (RW, faceset); // CF+ selected faceset |
236 | uint8 ACC (RW, faceset); // CF+ selected faceset |
192 | |
237 | |
193 | tstamp ACC (RW, last_send); // last data send on socket. |
238 | tstamp ACC (RW, last_send); // last data send on socket. |
194 | |
239 | |
195 | int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ |
|
|
196 | |
|
|
197 | int ACC (RW, rate_avail); // current rate balance |
240 | int ACC (RW, rate_avail); // current rate balance |
198 | int ACC (RW, max_rate); // max. # of bytes to send per tick |
241 | int ACC (RW, max_rate); // max. # of bytes to send per tick |
199 | faceidx ACC (RW, scrub_idx); // which face to send next |
242 | faceidx ACC (RW, scrub_idx); // which face to send next |
200 | int ACC (RW, bg_scrub); // how many ticks till the next background face send |
243 | int ACC (RW, bg_scrub); // how many ticks till the next background face send |
201 | |
244 | |
202 | faceidx partial_face; |
245 | struct tcp_info tcpi; |
203 | uint32 partial_face_ofs; // if != 0, need to send remaining bytes of partial_face |
246 | tstamp next_rate_adjust; |
|
|
247 | |
|
|
248 | unordered_vector<char *> mapinfo_queue; |
|
|
249 | void mapinfo_queue_clear (); |
|
|
250 | void mapinfo_queue_run (); |
|
|
251 | bool mapinfo_try (char *buf); |
|
|
252 | |
|
|
253 | struct ixsend { |
|
|
254 | int16_t pri; // unused |
|
|
255 | faceidx idx; |
|
|
256 | uint32_t ofs; // if != 0, need to send remaining bytes of partial_face |
|
|
257 | }; |
204 | std::vector<faceidx, slice_allocator<faceidx> > ixface; // which faces to send to the client using ix |
258 | std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix |
205 | |
259 | |
206 | std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx |
260 | std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx |
207 | MTH void flush_fx (); // send fx if required |
261 | MTH void flush_fx (); // send fx if required |
208 | |
262 | |
209 | void do_destroy (); |
263 | void do_destroy (); |
210 | void gather_callbacks (AV *&callbacks, event_type event) const; |
264 | void gather_callbacks (AV *&callbacks, event_type event) const; |
211 | |
265 | |
212 | iow socket_ev; void socket_cb (iow &w, int got); |
266 | iow socket_ev; void socket_cb (iow &w, int got); |
213 | iw cmd_ev; void cmd_cb (iw &w); |
|
|
214 | |
267 | |
215 | std::deque< command, slice_allocator<command> > cmd_queue; |
268 | std::deque< command, slice_allocator<command> > cmd_queue; |
216 | |
269 | |
217 | // large structures at the end please |
270 | // large structures at the end please |
218 | struct Map lastmap; |
271 | struct Map lastmap; |
219 | std::bitset<MAXANIMNUM> anims_sent; |
272 | std::bitset<MAXANIMNUM> anims_sent; |
220 | std::bitset<MAX_FACES> faces_sent; |
273 | std::bitset<MAX_FACES> faces_sent; |
|
|
274 | std::bitset<FT_NUM> fx_want; |
221 | |
275 | |
222 | // if we get an incomplete packet, this is used to hold the data. |
276 | // if we get an incomplete packet, this is used to hold the data. |
223 | // we add 2 byte for the header, one for the trailing 0 byte |
277 | // we add 2 byte for the header, one for the trailing 0 byte |
224 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
278 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
225 | |
279 | |
… | |
… | |
257 | void send_packet (const char *buf, int len); |
311 | void send_packet (const char *buf, int len); |
258 | void send_packet_printf (const char *format, ...); |
312 | void send_packet_printf (const char *format, ...); |
259 | void send_packet (packet &sl); |
313 | void send_packet (packet &sl); |
260 | |
314 | |
261 | void send_drawinfo (const char *msg, int flags = NDI_BLACK); |
315 | void send_drawinfo (const char *msg, int flags = NDI_BLACK); |
|
|
316 | |
262 | MTH void send_face (faceidx facenum); |
317 | MTH void send_face (faceidx facenum, int pri = 0); |
263 | MTH void send_image (faceidx facenum); |
318 | MTH void send_image (faceidx facenum); |
264 | MTH void send_faces (object *ob); |
319 | MTH void send_faces (object *ob); |
265 | MTH void send_animation (short anim_num); |
320 | MTH void send_animation (short anim_num); |
266 | void send_msg (int color, const char *type, const char *msg); |
321 | void send_msg (int color, const char *type, const char *msg); |
267 | |
322 | |
|
|
323 | MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); |
268 | // called when something under the player changes |
324 | // called when something under the player changes |
269 | MTH void floorbox_update () { update_look = 1; } |
325 | MTH void floorbox_update () { update_look = 1; } |
270 | // called when the player has been moved |
326 | // called when the player has been moved |
271 | MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
327 | MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
272 | |
328 | |
273 | MTH void tick (); // called every server tick to do housekeeping etc. |
329 | MTH void tick (); // called every server tick to do housekeeping etc. |
274 | |
330 | |
275 | MTH static client *create (int fd, const char *peername); |
331 | MTH static client *create (int fd, const char *peername); |
|
|
332 | MTH static void clock (); |
|
|
333 | MTH static void flush_sockets (); |
276 | |
334 | |
277 | protected: |
335 | protected: |
278 | client (int fd, const char *from_ip); |
336 | client (int fd, const char *from_ip); |
279 | ~client (); |
337 | ~client (); |
280 | }; |
338 | }; |
|
|
339 | |
|
|
340 | #if FOR_PERL |
|
|
341 | ACC (RW, tcpi.tcpi_state); |
|
|
342 | ACC (RW, tcpi.tcpi_ca_state); |
|
|
343 | ACC (RW, tcpi.tcpi_retransmits); |
|
|
344 | ACC (RW, tcpi.tcpi_probes); |
|
|
345 | ACC (RW, tcpi.tcpi_backoff); |
|
|
346 | ACC (RW, tcpi.tcpi_options); |
|
|
347 | ACC (RO, tcpi.tcpi_snd_wscale); |
|
|
348 | ACC (RO, tcpi.tcpi_rcv_wscale); |
|
|
349 | ACC (RW, tcpi.tcpi_rto); |
|
|
350 | ACC (RW, tcpi.tcpi_ato); |
|
|
351 | ACC (RW, tcpi.tcpi_snd_mss); |
|
|
352 | ACC (RW, tcpi.tcpi_rcv_mss); |
|
|
353 | ACC (RW, tcpi.tcpi_unacked); |
|
|
354 | ACC (RW, tcpi.tcpi_sacked); |
|
|
355 | ACC (RW, tcpi.tcpi_lost); |
|
|
356 | ACC (RW, tcpi.tcpi_retrans); |
|
|
357 | ACC (RW, tcpi.tcpi_fackets); |
|
|
358 | ACC (RW, tcpi.tcpi_last_data_sent); |
|
|
359 | ACC (RW, tcpi.tcpi_last_ack_sent); |
|
|
360 | ACC (RW, tcpi.tcpi_last_data_recv); |
|
|
361 | ACC (RW, tcpi.tcpi_last_ack_recv); |
|
|
362 | ACC (RW, tcpi.tcpi_pmtu); |
|
|
363 | ACC (RW, tcpi.tcpi_rcv_ssthresh); |
|
|
364 | ACC (RW, tcpi.tcpi_rtt); |
|
|
365 | ACC (RW, tcpi.tcpi_rttvar); |
|
|
366 | ACC (RW, tcpi.tcpi_snd_ssthresh); |
|
|
367 | ACC (RW, tcpi.tcpi_snd_cwnd); |
|
|
368 | ACC (RW, tcpi.tcpi_advmss); |
|
|
369 | ACC (RW, tcpi.tcpi_reordering); |
|
|
370 | #endif |
281 | |
371 | |
282 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
372 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
283 | ( ((__type)>0) &&\ |
373 | ( ((__type)>0) &&\ |
284 | ((__sockPtr)->has_readable_type) && \ |
374 | ((__sockPtr)->has_readable_type) && \ |
285 | ((__sockPtr)->supported_readables & (1<<(__type))) ) |
375 | ((__sockPtr)->supported_readables & (1<<(__type))) ) |