ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/client.h
(Generate patch)

Comparing deliantra/server/include/client.h (file contents):
Revision 1.66 by root, Mon Jul 30 02:03:02 2007 UTC vs.
Revision 1.83 by root, Fri Dec 26 10:44:17 2008 UTC

1/* 1/*
2 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG. 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team 4 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra 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 8 * Deliantra is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by 9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or 10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) 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, 13 * This program is distributed in the hope that it will be useful,
16 * GNU General Public License 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 18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>. 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * 20 *
21 * The authors can be reached via e-mail to <crossfire@schmorp.de> 21 * The authors can be reached via e-mail to <support@deliantra.net>
22 */ 22 */
23 23
24#ifndef CLIENT_H 24#ifndef CLIENT_H
25#define CLIENT_H 25#define CLIENT_H
26 26
29#include <tr1/unordered_set> 29#include <tr1/unordered_set>
30 30
31#if HAVE_TCP_INFO 31#if HAVE_TCP_INFO
32# include <netinet/tcp.h> 32# include <netinet/tcp.h>
33#else 33#else
34 struct tcpi_info { 34 struct tcp_info {
35 // dummy 35 // dummy
36 char tcpi_state; 36 int tcpi_state;
37 char tcpi_ca_state; 37 int tcpi_ca_state;
38 char tcpi_retransmits; 38 int tcpi_retransmits;
39 char tcpi_probes; 39 int tcpi_probes;
40 char tcpi_backoff; 40 int tcpi_backoff;
41 char tcpi_options; 41 int tcpi_options;
42 char tcpi_snd_wscale; 42 int tcpi_snd_wscale;
43 char tcpi_rcv_wscale; 43 int tcpi_rcv_wscale;
44 char tcpi_rto; 44 int tcpi_rto;
45 char tcpi_ato; 45 int tcpi_ato;
46 char tcpi_snd_mss; 46 int tcpi_snd_mss;
47 char tcpi_rcv_mss; 47 int tcpi_rcv_mss;
48 char tcpi_unacked; 48 int tcpi_unacked;
49 char tcpi_sacked; 49 int tcpi_sacked;
50 char tcpi_lost; 50 int tcpi_lost;
51 char tcpi_retrans; 51 int tcpi_retrans;
52 char tcpi_fackets; 52 int tcpi_fackets;
53 char tcpi_last_data_sent; 53 int tcpi_last_data_sent;
54 char tcpi_last_ack_sent; 54 int tcpi_last_ack_sent;
55 char tcpi_last_data_recv; 55 int tcpi_last_data_recv;
56 char tcpi_last_ack_recv; 56 int tcpi_last_ack_recv;
57 char tcpi_pmtu; 57 int tcpi_pmtu;
58 char tcpi_rcv_ssthresh; 58 int tcpi_rcv_ssthresh;
59 char tcpi_rtt; 59 int tcpi_rtt;
60 char tcpi_rttvar; 60 int tcpi_rttvar;
61 char tcpi_snd_ssthresh; 61 int tcpi_snd_ssthresh;
62 char tcpi_snd_cwnd; 62 int tcpi_snd_cwnd;
63 char tcpi_advmss; 63 int tcpi_advmss;
64 char tcpi_reordering; 64 int tcpi_reordering;
65 }; 65 };
66#endif 66#endif
67 67
68// (possibly) max. number of objects "per page" in the ground container 68// (possibly) max. number of objects "per page" in the ground container
69#define FLOORBOX_PAGESIZE 50 69#define FLOORBOX_PAGESIZE 50
70 70
71struct MapCell 71struct MapCell
72{ 72{
73 tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient 73 tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
74 int count; /* This is really darkness in the map1 command */ 74 int count; /* This is really darkness in the map1 command */
75 faceidx faces[MAP_LAYERS]; 75 faceidx faces[MAP_LAYERS];
76 unsigned char stat_hp; // health of something in this space, or 0 76 unsigned char stat_hp; // health of something in this space, or 0
77 unsigned char flags; 77 unsigned char flags;
78 uint8_t smooth[MAP_LAYERS]; 78 uint8_t smooth[MAP_LAYERS];
144{ 144{
145 tstamp stamp; 145 tstamp stamp;
146 const packet_type *handler; 146 const packet_type *handler;
147 char *data; 147 char *data;
148 int datalen; 148 int datalen;
149
150 ~command ()
151 {
152 sfree<char> (data, datalen + 1);
153 }
154}; 149};
155 150
156/* how many times we are allowed to give the wrong password before being kicked. */ 151/* how many times we are allowed to give the wrong password before being kicked. */
157#define MAX_PASSWORD_FAILURES 5 152#define MAX_PASSWORD_FAILURES 5
158 153
162 int ACC (RW, fd); 157 int ACC (RW, fd);
163 unsigned int inbuf_len; // number of bytes valid in inbuf 158 unsigned int inbuf_len; // number of bytes valid in inbuf
164 statsinfo stats; 159 statsinfo stats;
165 object_vector_index ACC (RO, active); 160 object_vector_index ACC (RO, active);
166 player_ptr ACC (RO, pl); 161 player_ptr ACC (RO, pl);
167
168 /* The following is the setup for a ring buffer for storing output
169 * data that the OS can't handle right away.
170 */
171 struct
172 {
173 char data[SOCKETBUFSIZE];
174 int start;
175 int len;
176 } outputbuffer;
177 162
178 char *ACC (RW, host); /* Which host it is connected from (ip address) */ 163 char *ACC (RW, host); /* Which host it is connected from (ip address) */
179 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ 164 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
180 165
181 sint8 ACC (RW, last_level); /* Last level we sent to client */ 166 sint8 ACC (RW, last_level); /* Last level we sent to client */
211 uint8_t ACC (RW, fxix); // client implements fx and ix (face|image extended) commands 196 uint8_t ACC (RW, fxix); // client implements fx and ix (face|image extended) commands
212 bool ACC (RW, update_look); /* If true, we need to send the look window */ 197 bool ACC (RW, update_look); /* If true, we need to send the look window */
213 bool ACC (RW, has_readable_type); /* If true client accept additional text information */ 198 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
214 /* used to arrange text in books, scrolls, or scripted dialogs */ 199 /* used to arrange text in books, scrolls, or scripted dialogs */
215 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ 200 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
216 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
217 /* Below are flags for extedend infos to pass to client
218 * with S->C mapextended command */
219 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
220 bool ACC (RW, smoothing); // trt-style smoothing 201 bool ACC (RW, smoothing); // trt-style smoothing
221 bool ACC (RW, can_msg); // trt-style text messages 202 bool ACC (RW, can_msg); // trt-style text messages
222 203
223 bool ACC (RW, force_newmap); // force a newmap before next map update 204 bool ACC (RW, force_newmap); // force a newmap before next map update
224 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ 205 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
227 uint16 ACC (RW, mss); // likely tcp maximum segment size 208 uint16 ACC (RW, mss); // likely tcp maximum segment size
228 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */ 209 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
229 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ 210 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
230 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ 211 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
231 212
232 maptile *ACC (RW, current_map); // CF+ last/current player map 213 maptile_ptr ACC (RW, current_map); // CF+ last/current player map
233 region *ACC (RW, current_region); // CF+ last/current player region 214 region_ptr ACC (RW, current_region); // CF+ last/current player region
234 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position 215 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
235 shstr ACC (RW, version); // CF+ client name/version 216 shstr ACC (RW, version); // CF+ client name/version
236 uint8 ACC (RW, faceset); // CF+ selected faceset 217 uint8 ACC (RW, faceset); // CF+ selected faceset
237 218
238 tstamp ACC (RW, last_send); // last data send on socket. 219 tstamp ACC (RW, last_send); // last data send on socket.
242 faceidx ACC (RW, scrub_idx); // which face to send next 223 faceidx ACC (RW, scrub_idx); // which face to send next
243 int ACC (RW, bg_scrub); // how many ticks till the next background face send 224 int ACC (RW, bg_scrub); // how many ticks till the next background face send
244 225
245 struct tcp_info tcpi; 226 struct tcp_info tcpi;
246 tstamp next_rate_adjust; 227 tstamp next_rate_adjust;
228
229 unordered_vector<char *> mapinfo_queue;
230 void mapinfo_queue_clear ();
231 void mapinfo_queue_run ();
232 bool mapinfo_try (char *buf);
233
234 struct ixsend {
235 int16_t pri; // unused
236 faceidx idx;
237 uint32_t ofs; // if != 0, need to send remaining bytes of partial_face
238 };
239 std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix
240
241 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
242 MTH void flush_fx (); // send fx if required
243
244 void do_destroy ();
245 void gather_callbacks (AV *&callbacks, event_type event) const;
246
247 iow socket_ev; void socket_cb (iow &w, int revents);
248
249 std::deque< command, slice_allocator<command> > cmd_queue;
250
251 // large structures at the end please
252 struct Map lastmap;
253 std::bitset<MAXANIMNUM> anims_sent;
254 std::bitset<MAX_FACES> faces_sent;
255 std::bitset<FT_NUM> fx_want;
256
257 // if we get an incomplete packet, this is used to hold the data.
258 // we add 2 byte for the header, one for the trailing 0 byte
259 uint8 inbuf[MAXSOCKBUF + 2 + 1];
260
261 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
262 struct msg_buf
263 {
264 tick_t expire;
265 int len;
266 int count;
267 char msg[MSG_BUF_SIZE];
268 } msgbuf[MSG_BUF_COUNT];
269
270 MTH bool msg_suppressed (const char *msg);
271
272 /* The following is the setup for a ring buffer for storing output
273 * data that the OS can't handle right away.
274 * TODO: this member is enourmously large - optimise?
275 */
276 struct
277 {
278 char data[SOCKETBUFSIZE];
279 int start;
280 int len;
281 } outputbuffer;
282
283 bool may_execute (const packet_type *pkt) const;
284 void execute (const packet_type *pkt, char *data, int datalen);
285
286 void queue_command (packet_type *handler, char *data, int datalen);
287 MTH bool handle_command ();
288 // resets movement state
289 MTH void reset_state ();
290 // resets variable data used to send stat diffs
291 MTH void reset_stats ();
292
293 MTH bool handle_packet ();
294 int next_packet (); // returns length of packet or 0
295 void skip_packet (int len); // we have processed the packet, skip it
296
297 MTH void flush ();
298 MTH void write_outputbuffer ();
299 MTH int outputbuffer_len () const { return outputbuffer.len; }
300 void send (void *buf_, int len);
301
302 void send_packet (const char *buf);
303 void send_packet (const char *buf, int len);
304 void send_packet_printf (const char *format, ...);
305 void send_packet (packet &sl);
306
307 void send_drawinfo (const char *msg, int flags = NDI_BLACK);
308
309 MTH void send_face (faceidx facenum, int pri = 0);
310 MTH void send_image (faceidx facenum);
311 MTH void send_faces (object *ob);
312 MTH void send_animation (short anim_num);
313 void send_msg (int color, const char *type, const char *msg);
314
315 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
316 // called when something under the player changes
317 MTH void floorbox_update () { update_look = 1; }
318 // called when the player has been moved
319 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
320
321 MTH void tick (); // called every server tick to do housekeeping etc.
322
323 MTH static client *create (int fd, const char *peername);
324 MTH static void clock ();
325 MTH static void flush_sockets ();
326
327protected:
328 client (int fd, const char *from_ip);
329 ~client ();
330};
331
247#if FOR_PERL 332#if FOR_PERL
248 // unfortunately, this emans that we *require* tcp_info now...
249 ACC (RW, tcpi.tcpi_state); 333 ACC (RW, tcpi.tcpi_state);
250 ACC (RW, tcpi.tcpi_ca_state); 334 ACC (RW, tcpi.tcpi_ca_state);
251 ACC (RW, tcpi.tcpi_retransmits); 335 ACC (RW, tcpi.tcpi_retransmits);
252 ACC (RW, tcpi.tcpi_probes); 336 ACC (RW, tcpi.tcpi_probes);
253 ACC (RW, tcpi.tcpi_backoff); 337 ACC (RW, tcpi.tcpi_backoff);
275 ACC (RW, tcpi.tcpi_snd_cwnd); 359 ACC (RW, tcpi.tcpi_snd_cwnd);
276 ACC (RW, tcpi.tcpi_advmss); 360 ACC (RW, tcpi.tcpi_advmss);
277 ACC (RW, tcpi.tcpi_reordering); 361 ACC (RW, tcpi.tcpi_reordering);
278#endif 362#endif
279 363
280 struct ixsend {
281 int16_t pri; // unused
282 faceidx idx;
283 uint32_t ofs; // if != 0, need to send remaining bytes of partial_face
284 };
285 std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix
286
287 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
288 MTH void flush_fx (); // send fx if required
289
290 void do_destroy ();
291 void gather_callbacks (AV *&callbacks, event_type event) const;
292
293 iow socket_ev; void socket_cb (iow &w, int got);
294 iw cmd_ev; void cmd_cb (iw &w);
295
296 std::deque< command, slice_allocator<command> > cmd_queue;
297
298 // large structures at the end please
299 struct Map lastmap;
300 std::bitset<MAXANIMNUM> anims_sent;
301 std::bitset<MAX_FACES> faces_sent;
302 std::bitset<FT_NUM> fx_want;
303
304 // if we get an incomplete packet, this is used to hold the data.
305 // we add 2 byte for the header, one for the trailing 0 byte
306 uint8 inbuf[MAXSOCKBUF + 2 + 1];
307
308 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
309 struct msg_buf
310 {
311 tick_t expire;
312 int len;
313 int count;
314 char msg[MSG_BUF_SIZE];
315 } msgbuf[MSG_BUF_COUNT];
316
317 MTH bool msg_suppressed (const char *msg);
318
319 bool may_execute (const packet_type *pkt) const;
320 void execute (const packet_type *pkt, char *data, int datalen);
321
322 void queue_command (packet_type *handler, char *data, int datalen);
323 MTH bool handle_command ();
324 // resets movement state
325 MTH void reset_state ();
326 // resets variable data used to send stat diffs
327 MTH void reset_stats ();
328
329 MTH bool handle_packet ();
330 int next_packet (); // returns length of packet or 0
331 void skip_packet (int len); // we have processed the packet, skip it
332
333 MTH void flush ();
334 MTH void write_outputbuffer ();
335 MTH int outputbuffer_len () const { return outputbuffer.len; }
336 void send (void *buf_, int len);
337
338 void send_packet (const char *buf);
339 void send_packet (const char *buf, int len);
340 void send_packet_printf (const char *format, ...);
341 void send_packet (packet &sl);
342
343 void send_drawinfo (const char *msg, int flags = NDI_BLACK);
344
345 MTH void send_face (faceidx facenum, int pri = 0);
346 MTH void send_image (faceidx facenum);
347 MTH void send_faces (object *ob);
348 MTH void send_animation (short anim_num);
349 void send_msg (int color, const char *type, const char *msg);
350
351 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
352 // called when something under the player changes
353 MTH void floorbox_update () { update_look = 1; }
354 // called when the player has been moved
355 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
356
357 MTH void tick (); // called every server tick to do housekeeping etc.
358
359 MTH static client *create (int fd, const char *peername);
360 MTH static void clock ();
361 MTH static void flush_sockets ();
362
363protected:
364 client (int fd, const char *from_ip);
365 ~client ();
366};
367
368#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 364#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
369 ( ((__type)>0) &&\ 365 ( ((__type)>0) &&\
370 ((__sockPtr)->has_readable_type) && \ 366 ((__sockPtr)->has_readable_type) && \
371 ((__sockPtr)->supported_readables & (1<<(__type))) ) 367 ((__sockPtr)->supported_readables & (1<<(__type))) )
372 368
373/* Constants in the form EMI_ is for extended map infos.
374 * Even if the client select the additionnal infos it wants
375 * on the map, there may exist cases where this whole info
376 * is not given in one buch but in separate bunches. This
377 * is done performance reasons (imagine some info related to
378 * a visible object and another info related to a 4 square
379 * width and height area). At the begin of an extended info packet
380 * is a bit field. A bit is activated for each extended info
381 * present in the data
382 */
383
384/* Meanings:
385 * EMI_NOREDRAW Take extended infos into account but don't redraw,
386 * some additionnal datas will follow in a new packet
387 * EMI_SMOOTH Datas about smoothing
388 */
389#define EMI_NOREDRAW 0x01
390#define EMI_SMOOTH 0x02
391
392/* this last one says the bitfield continue un next byte
393 * There may be several on contiguous bytes. So there is 7
394 * actual bits used per byte, and the number of bytes
395 * is not fixed in protocol
396 */
397#define EMI_HASMOREBITS 0x80
398
399#define FACE_TYPES 1 369#define FACE_TYPES 1
400#define PNG_FACE_INDEX 0 370#define PNG_FACE_INDEX 0
401 371
402#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 372#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
403#define VERSION_SC 1026 373#define VERSION_SC 1026
404//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible 374//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
405#define VERSION_INFO "Crossfire TRT Server" 375#define VERSION_INFO "Deliantra Server"
406 376
407typedef object_vector<client, &client::active> sockvec; 377typedef object_vector<client, &client::active> sockvec;
408 378
409extern sockvec clients; 379extern sockvec clients;
410 380
411#define for_all_clients(var) \ 381#define for_all_clients(var) \
412 for (int _i = 0; _i < clients.size (); ++_i) \ 382 for (int _i = 0; _i < clients.size (); ++_i) \
413 statementvar (client *, var, clients [_i]) 383 statementvar (client *, var, clients [_i])
414 384
385// returns true when the message needs special (read: perl) treatment
386static inline bool
387msg_is_special (const char *msg, bool nl_special = true)
388{
389 return msg [strcspn (msg, nl_special ? "<&\n" : "<&")];
390}
391
415#endif 392#endif
416 393

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines