1 | /* |
1 | /* |
2 | * This file is part of Deliantra, the Roguelike Realtime MMORPG. |
2 | * This file is part of Deliantra, the Roguelike Realtime MMORPG. |
3 | * |
3 | * |
4 | * Copyright (©) 2005,2006,2007,2008,2009,2010,2011 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
4 | * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
5 | * |
5 | * |
6 | * Deliantra is free software: you can redistribute it and/or modify it under |
6 | * Deliantra is free software: you can redistribute it and/or modify it under |
7 | * the terms of the Affero GNU General Public License as published by the |
7 | * the terms of the Affero GNU General Public License as published by the |
8 | * Free Software Foundation, either version 3 of the License, or (at your |
8 | * Free Software Foundation, either version 3 of the License, or (at your |
9 | * option) any later version. |
9 | * option) any later version. |
10 | * |
10 | * |
11 | * This program is distributed in the hope that it will be useful, |
11 | * This program is distributed in the hope that it will be useful, |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
14 | * GNU General Public License for more details. |
14 | * GNU General Public License for more details. |
15 | * |
15 | * |
16 | * You should have received a copy of the Affero GNU General Public License |
16 | * You should have received a copy of the Affero GNU General Public License |
17 | * and the GNU General Public License along with this program. If not, see |
17 | * and the GNU General Public License along with this program. If not, see |
18 | * <http://www.gnu.org/licenses/>. |
18 | * <http://www.gnu.org/licenses/>. |
19 | * |
19 | * |
20 | * The authors can be reached via e-mail to <support@deliantra.net> |
20 | * The authors can be reached via e-mail to <support@deliantra.net> |
21 | */ |
21 | */ |
22 | |
22 | |
23 | #ifndef CLIENT_H |
23 | #ifndef CLIENT_H |
24 | #define CLIENT_H |
24 | #define CLIENT_H |
… | |
… | |
89 | struct statsinfo |
89 | struct statsinfo |
90 | { |
90 | { |
91 | char *range, *title; |
91 | char *range, *title; |
92 | }; |
92 | }; |
93 | |
93 | |
94 | /* This contains basic information on the socket structure. status is its |
|
|
95 | * current state. we set up our on buffers for sending/receiving, so we can |
|
|
96 | * handle some higher level functions. fd is the actual file descriptor we |
|
|
97 | * are using. |
|
|
98 | */ |
|
|
99 | |
|
|
100 | // states the socket can be in |
94 | // states the socket can be in |
101 | enum { |
95 | enum { |
102 | ST_DEAD, // socket is dead |
96 | ST_DEAD, // socket is dead |
103 | ST_SETUP, // initial handshake / setup / login |
97 | ST_SETUP, // initial handshake / setup / login |
104 | ST_PLAYING, // logged in an playing |
98 | ST_PLAYING, // logged in an playing |
… | |
… | |
113 | PF_PLAYING = 0x02, // must be in playing state |
107 | PF_PLAYING = 0x02, // must be in playing state |
114 | PF_COMMAND0 = 0x04, // command starts at offset 0 |
108 | PF_COMMAND0 = 0x04, // command starts at offset 0 |
115 | PF_COMMAND6 = 0x08, // command starts at offset 6 |
109 | PF_COMMAND6 = 0x08, // command starts at offset 6 |
116 | }; |
110 | }; |
117 | |
111 | |
118 | // face type.s bit 0 means "has meta info prepended" |
112 | // face types. bit 0 means "has meta info prepended" |
119 | enum { |
113 | enum { |
120 | FT_FACE = 0 * 2 + 0, // faces (images) |
114 | FT_FACE = 0 * 2 + 0, // faces (images) |
121 | FT_MUSIC = 1 * 2 + 1, // background music |
115 | FT_MUSIC = 1 * 2 + 1, // background music |
122 | FT_SOUND = 2 * 2 + 1, // effects |
116 | FT_SOUND = 2 * 2 + 1, // effects |
123 | FT_RSRC = 3 * 2 + 0, // generic data files |
117 | FT_RSRC = 3 * 2 + 0, // generic data files |
… | |
… | |
142 | //-GPL |
136 | //-GPL |
143 | |
137 | |
144 | /* how many times we are allowed to give the wrong password before being kicked. */ |
138 | /* how many times we are allowed to give the wrong password before being kicked. */ |
145 | #define MAX_PASSWORD_FAILURES 5 |
139 | #define MAX_PASSWORD_FAILURES 5 |
146 | |
140 | |
|
|
141 | /* This contains basic information on the socket connection. status is its |
|
|
142 | * current state. we set up our on buffers for sending/receiving, so we can |
|
|
143 | * handle some higher level functions. fd is the actual file descriptor we |
|
|
144 | * are using. |
|
|
145 | */ |
147 | INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player |
146 | INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player |
148 | struct client : zero_initialised, attachable |
147 | struct client : zero_initialised, attachable |
149 | { |
148 | { |
150 | int ACC (RW, fd); |
149 | int ACC (RW, fd); |
151 | unsigned int inbuf_len; // number of bytes valid in inbuf |
150 | unsigned int inbuf_len; // number of bytes valid in inbuf |
… | |
… | |
189 | uint16 ACC (RW, look_position); /* start of drawing of look window */ |
188 | uint16 ACC (RW, look_position); /* start of drawing of look window */ |
190 | uint16 ACC (RW, mss); // likely tcp maximum segment size |
189 | uint16 ACC (RW, mss); // likely tcp maximum segment size |
191 | uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
190 | uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
192 | uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
191 | uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
193 | uint8 ACC (RW, faceset); // CF+ selected faceset |
192 | uint8 ACC (RW, faceset); // CF+ selected faceset |
|
|
193 | uint8 ACC (RW, ws_version); // websocket protocol versio for framing |
194 | |
194 | |
195 | maptile_ptr ACC (RW, current_map); // CF+ last/current player map |
195 | maptile_ptr ACC (RW, current_map); // CF+ last/current player map |
196 | region_ptr ACC (RW, current_region); // CF+ last/current player region |
196 | region_ptr ACC (RW, current_region); // CF+ last/current player region |
197 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
197 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
198 | |
198 | |
… | |
… | |
205 | int ACC (RW, bg_scrub); // how many ticks till the next background face send |
205 | int ACC (RW, bg_scrub); // how many ticks till the next background face send |
206 | |
206 | |
207 | struct tcp_info tcpi; |
207 | struct tcp_info tcpi; |
208 | tstamp next_rate_adjust; |
208 | tstamp next_rate_adjust; |
209 | |
209 | |
|
|
210 | // websocket frame buffer |
|
|
211 | uint8 ws_inbuf_type; // current frame type |
|
|
212 | uint8 *ws_inbuf; |
|
|
213 | uint32 ws_inbuf_len; |
|
|
214 | uint32 ws_inbuf_alloc; |
|
|
215 | |
210 | unordered_vector<char *> mapinfo_queue; |
216 | unordered_vector<char *> mapinfo_queue; |
211 | void mapinfo_queue_clear (); |
217 | void mapinfo_queue_clear (); |
212 | void mapinfo_queue_run (); |
218 | void mapinfo_queue_run (); |
213 | bool mapinfo_try (char *buf); |
219 | bool mapinfo_try (char *buf); |
214 | |
220 | |
215 | struct ixsend { |
221 | struct ixsend { |
216 | int16_t pri; // unused |
222 | int16_t pri; // higher means faces are sent earlier, default 0 |
217 | faceidx idx; |
223 | faceidx idx; |
218 | uint32_t ofs; // if != 0, need to send remaining bytes of partial_face |
224 | uint32_t ofs; // if != 0, need to send remaining bytes of partial_face |
|
|
225 | refcnt_buf data; |
219 | }; |
226 | }; |
220 | std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix |
227 | std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix |
221 | |
228 | |
222 | std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx |
229 | std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx |
223 | MTH void flush_fx (); // send fx if required |
230 | MTH void flush_fx (); // send fx if required |
|
|
231 | |
|
|
232 | MTH void invalidate_face (faceidx idx); |
|
|
233 | MTH void invalidate_all_faces (); |
224 | |
234 | |
225 | void do_destroy (); |
235 | void do_destroy (); |
226 | void gather_callbacks (AV *&callbacks, event_type event) const; |
236 | void gather_callbacks (AV *&callbacks, event_type event) const; |
227 | |
237 | |
228 | iow socket_ev; void socket_cb (iow &w, int revents); |
238 | iow socket_ev; void socket_cb (iow &w, int revents); |
… | |
… | |
236 | std::bitset<FT_NUM> fx_want; |
246 | std::bitset<FT_NUM> fx_want; |
237 | |
247 | |
238 | // if we get an incomplete packet, this is used to hold the data. |
248 | // if we get an incomplete packet, this is used to hold the data. |
239 | // we add 2 byte for the header, one for the trailing 0 byte |
249 | // we add 2 byte for the header, one for the trailing 0 byte |
240 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
250 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
|
|
251 | void inbuf_handle (); |
241 | |
252 | |
242 | enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 }; |
253 | enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 }; |
243 | struct msg_buf |
254 | struct msg_buf |
244 | { |
255 | { |
245 | tick_t expire; |
256 | tick_t expire; |
… | |
… | |
276 | void skip_packet (int len); // we have processed the packet, skip it |
287 | void skip_packet (int len); // we have processed the packet, skip it |
277 | |
288 | |
278 | MTH void flush (); |
289 | MTH void flush (); |
279 | MTH void write_outputbuffer (); |
290 | MTH void write_outputbuffer (); |
280 | MTH int outputbuffer_len () const { return outputbuffer.len; } |
291 | MTH int outputbuffer_len () const { return outputbuffer.len; } |
|
|
292 | void send_raw (void *buf_, int len); |
|
|
293 | |
281 | void send (void *buf_, int len); |
294 | void send (void *buf_, int len); |
282 | |
|
|
283 | void send_packet (const_octet_string buf); |
295 | void send_packet (const_octet_string buf); |
284 | void send_packet (const_octet_string buf, int len); |
296 | void send_packet (const_octet_string buf, int len); |
285 | void send_packet_printf (const_utf8_string format, ...) attribute ((format (printf, 2, 3))); |
297 | void send_packet_printf (const_utf8_string format, ...) attribute ((format (printf, 2, 3))); |
286 | void send_packet (packet &sl); |
298 | void send_packet (packet &sl); |
287 | |
299 | |
… | |
… | |
301 | MTH void tick (); // called every server tick to do housekeeping etc. |
313 | MTH void tick (); // called every server tick to do housekeeping etc. |
302 | |
314 | |
303 | MTH static client *create (int fd, const char *peername); |
315 | MTH static client *create (int fd, const char *peername); |
304 | MTH static void clock (); |
316 | MTH static void clock (); |
305 | MTH static void flush_sockets (); |
317 | MTH static void flush_sockets (); |
|
|
318 | |
|
|
319 | MTH void run (); // start handshake after init |
306 | |
320 | |
307 | protected: |
321 | protected: |
308 | client (int fd, const char *from_ip); |
322 | client (int fd, const char *from_ip); |
309 | ~client (); |
323 | ~client (); |
310 | }; |
324 | }; |
… | |
… | |
339 | ACC (RW, tcpi.tcpi_snd_cwnd); |
353 | ACC (RW, tcpi.tcpi_snd_cwnd); |
340 | ACC (RW, tcpi.tcpi_advmss); |
354 | ACC (RW, tcpi.tcpi_advmss); |
341 | ACC (RW, tcpi.tcpi_reordering); |
355 | ACC (RW, tcpi.tcpi_reordering); |
342 | #endif |
356 | #endif |
343 | |
357 | |
344 | //+GPL |
|
|
345 | |
|
|
346 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
|
|
347 | ( ((__type)>0) &&\ |
|
|
348 | ((__sockPtr)->has_readable_type) && \ |
|
|
349 | ((__sockPtr)->supported_readables & (1<<(__type))) ) |
|
|
350 | |
|
|
351 | #define FACE_TYPES 1 |
|
|
352 | #define PNG_FACE_INDEX 0 |
|
|
353 | |
|
|
354 | //-GPL |
|
|
355 | |
|
|
356 | typedef object_vector<client, &client::active> sockvec; |
358 | typedef object_vector<client, &client::active> sockvec; |
357 | |
359 | |
358 | extern sockvec clients; |
360 | extern sockvec clients; |
359 | |
361 | |
360 | #define for_all_clients(var) \ |
362 | #define for_all_clients(var) \ |