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.48 by root, Tue Apr 24 00:42:02 2007 UTC vs.
Revision 1.82 by root, Tue Dec 23 22:03:06 2008 UTC

1/* 1/*
2 * CrossFire, A Multiplayer game for the X Window System 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team 4 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (C) 2002 Mark Wedel & Crossfire Development Team 5 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
6 * Copyright (C) 1992 Frank Tore Johansen 6 * Copyright (©) 1992,2007 Frank Tore Johansen
7 * 7 *
8 * This program 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 2 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,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
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, write to the Free Software 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * 20 *
22 * The author can be reached via e-mail to crossfire@schmorp.de 21 * The authors can be reached via e-mail to <support@deliantra.net>
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>
31 30
31#if HAVE_TCP_INFO
32# include <netinet/tcp.h>
33#else
34 struct tcp_info {
35 // dummy
36 int tcpi_state;
37 int tcpi_ca_state;
38 int tcpi_retransmits;
39 int tcpi_probes;
40 int tcpi_backoff;
41 int tcpi_options;
42 int tcpi_snd_wscale;
43 int tcpi_rcv_wscale;
44 int tcpi_rto;
45 int tcpi_ato;
46 int tcpi_snd_mss;
47 int tcpi_rcv_mss;
48 int tcpi_unacked;
49 int tcpi_sacked;
50 int tcpi_lost;
51 int tcpi_retrans;
52 int tcpi_fackets;
53 int tcpi_last_data_sent;
54 int tcpi_last_ack_sent;
55 int tcpi_last_data_recv;
56 int tcpi_last_ack_recv;
57 int tcpi_pmtu;
58 int tcpi_rcv_ssthresh;
59 int tcpi_rtt;
60 int tcpi_rttvar;
61 int tcpi_snd_ssthresh;
62 int tcpi_snd_cwnd;
63 int tcpi_advmss;
64 int tcpi_reordering;
65 };
66#endif
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
35struct MapCell 71struct MapCell
36{ 72{
37 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
38 int count; /* This is really darkness in the map1 command */ 74 int count; /* This is really darkness in the map1 command */
39 faceidx faces[MAP_LAYERS]; 75 faceidx faces[MAP_LAYERS];
40 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
41 unsigned char flags; 77 unsigned char flags;
42 uint8_t smooth[MAP_LAYERS]; 78 uint8_t smooth[MAP_LAYERS];
… …
67/* Only one map mode can actually be used, so lets make it a switch 103/* Only one map mode can actually be used, so lets make it a switch
68 * instead of having a bunch of different fields that needed to 104 * instead of having a bunch of different fields that needed to
69 * get toggled. 105 * get toggled.
70 */ 106 */
71enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; 107enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
72
73/* The following is the setup for a ring buffer for storing output
74 * data that the OS can't handle right away.
75 */
76struct Buffer
77{
78 char data[SOCKETBUFSIZE];
79 int start;
80 int len;
81};
82 108
83// states the socket can be in 109// states the socket can be in
84enum { 110enum {
85 ST_DEAD, // socket is dead 111 ST_DEAD, // socket is dead
86 ST_SETUP, // initial handshake / setup / login 112 ST_SETUP, // initial handshake / setup / login
… …
96 PF_PLAYING = 0x02, // must be in playing state 122 PF_PLAYING = 0x02, // must be in playing state
97 PF_COMMAND0 = 0x04, // command starts at offset 0 123 PF_COMMAND0 = 0x04, // command starts at offset 0
98 PF_COMMAND6 = 0x08, // command starts at offset 6 124 PF_COMMAND6 = 0x08, // command starts at offset 6
99}; 125};
100 126
127// face type.s bit 0 means "has meta info prepended"
128enum {
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,
134};
135
101struct packet_type 136struct packet_type
102{ 137{
103 const char *name; 138 const char *name;
104 void *cb; 139 void *cb;
105 int flags; 140 int flags;
… …
109{ 144{
110 tstamp stamp; 145 tstamp stamp;
111 const packet_type *handler; 146 const packet_type *handler;
112 char *data; 147 char *data;
113 int datalen; 148 int datalen;
114
115 ~command ()
116 {
117 sfree<char> (data, datalen + 1);
118 }
119};
120
121struct refitem
122{
123 object_ptr op;
124};
125
126// this represents a container on the client side.
127// right now, there are only ever two of them:
128// the inventory and the floor/open container
129//TODO: unused as of yet
130struct client_container : vector< refitem, slice_allocator<refitem> >
131{
132 client *ns;
133 enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type;
134
135 bool item_changed; // one of the items in here possibly changed
136
137 // for mapspace and container
138 int x, y;
139 maptile *map;
140
141 // for container
142 object *env;
143
144 client_container (client *ns)
145 : ns (ns), type (CC_NONE) { }
146
147 tag_t tag () const;
148
149 inline iterator merge_item (iterator i, object *op);
150
151 void clear ();
152 void update ();
153
154 void set_mapspace (maptile *map, int x, int y);
155 void set_container (object *env);
156}; 149};
157 150
158/* 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. */
159#define MAX_PASSWORD_FAILURES 5 152#define MAX_PASSWORD_FAILURES 5
160 153
… …
162struct client : zero_initialised, attachable 155struct client : zero_initialised, attachable
163{ 156{
164 int ACC (RW, fd); 157 int ACC (RW, fd);
165 unsigned int inbuf_len; // number of bytes valid in inbuf 158 unsigned int inbuf_len; // number of bytes valid in inbuf
166 statsinfo stats; 159 statsinfo stats;
167 int ACC (RO, active); 160 object_vector_index ACC (RO, active);
168 161 player_ptr ACC (RO, pl);
169 Buffer outputbuffer;
170 162
171 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) */
172 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 */
173 165
174 sint8 ACC (RW, last_level); /* Last level we sent to client */ 166 sint8 ACC (RW, last_level); /* Last level we sent to client */
… …
194 bool ACC (RW, sent_scroll); 186 bool ACC (RW, sent_scroll);
195 bool ACC (RW, sound); /* does the client want sound */ 187 bool ACC (RW, sound); /* does the client want sound */
196 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ 188 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
197 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ 189 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
198 bool ACC (RW, mapinfocmd); // return map info and send map change info 190 bool ACC (RW, mapinfocmd); // return map info and send map change info
199 bool ACC (RW, extcmd); // call into extensions/plugins 191 uint8_t ACC (RW, extcmd); // call into extensions/plugins
200 bool ACC (RW, extmap); // extend map comamnd with extra data 192 bool ACC (RW, extmap); // extend map comamnd with extra data
201 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls 193 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls
202 bool ACC (RW, darkness); /* True if client wants darkness information */ 194 bool ACC (RW, darkness); /* True if client wants darkness information */
203 bool ACC (RW, image2); /* Client wants image2/face2 commands */ 195 bool ACC (RW, image2); /* Client wants image2/face2 commands */
204 bool 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
205 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 */
206 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 */
207 /* used to arrange text in books, scrolls, or scripted dialogs */ 199 /* used to arrange text in books, scrolls, or scripted dialogs */
208 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 */
209 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ 201 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
… …
220 uint16 ACC (RW, mss); // likely tcp maximum segment size 212 uint16 ACC (RW, mss); // likely tcp maximum segment size
221 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */ 213 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
222 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ 214 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
223 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ 215 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
224 216
225 maptile *ACC (RW, current_map); // CF+ last/current player map 217 maptile_ptr ACC (RW, current_map); // CF+ last/current player map
226 region *ACC (RW, current_region); // CF+ last/current player region 218 region_ptr ACC (RW, current_region); // CF+ last/current player region
227 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position 219 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
228 char ACC (RW, version)[64]; // CF+ client name/version 220 shstr ACC (RW, version); // CF+ client name/version
229 uint8 ACC (RW, faceset); // CF+ selected faceset 221 uint8 ACC (RW, faceset); // CF+ selected faceset
230 222
231 player_ptr ACC (RO, pl); 223 tstamp ACC (RW, last_send); // last data send on socket.
232
233 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
234 224
235 int ACC (RW, rate_avail); // current rate balance 225 int ACC (RW, rate_avail); // current rate balance
236 int ACC (RW, max_rate); // max. # of bytes to send per tick 226 int ACC (RW, max_rate); // max. # of bytes to send per tick
237 faceidx ACC (RW, scrub_idx); // which face to send next 227 faceidx ACC (RW, scrub_idx); // which face to send next
238 int ACC (RW, bg_scrub); // how many ticks till the next background face send 228 int ACC (RW, bg_scrub); // how many ticks till the next background face send
239 229
240 faceidx partial_face; 230 struct tcp_info tcpi;
241 uint32 partial_face_ofs; // if != 0, need to send remaining bytes of partial_face 231 tstamp next_rate_adjust;
242 std::vector<faceidx, slice_allocator<faceidx> > askface; // which faces have been requested by the client
243 232
233 unordered_vector<char *> mapinfo_queue;
234 void mapinfo_queue_clear ();
235 void mapinfo_queue_run ();
236 bool mapinfo_try (char *buf);
237
238 struct ixsend {
239 int16_t pri; // unused
240 faceidx idx;
241 uint32_t ofs; // if != 0, need to send remaining bytes of partial_face
242 };
243 std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix
244
244 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx 245 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
245 MTH void flush_fx (); // send fx if required 246 MTH void flush_fx (); // send fx if required
246 247
247 void do_destroy (); 248 void do_destroy ();
248 void gather_callbacks (AV *&callbacks, event_type event) const; 249 void gather_callbacks (AV *&callbacks, event_type event) const;
249 250
250 iow socket_ev; void socket_cb (iow &w, int got); 251 iow socket_ev; void socket_cb (iow &w, int revents);
251 iw cmd_ev; void cmd_cb (iw &w);
252 client_container cc_inv, cc_other;
253 252
254 std::deque< command, slice_allocator<command> > cmd_queue; 253 std::deque< command, slice_allocator<command> > cmd_queue;
255 254
256 // large structures at the end please 255 // large structures at the end please
257 struct Map lastmap; 256 struct Map lastmap;
258 std::bitset<MAXANIMNUM> anims_sent; 257 std::bitset<MAXANIMNUM> anims_sent;
259 std::bitset<MAX_FACES> faces_sent; 258 std::bitset<MAX_FACES> faces_sent;
259 std::bitset<FT_NUM> fx_want;
260 260
261 // if we get an incomplete packet, this is used to hold the data. 261 // if we get an incomplete packet, this is used to hold the data.
262 // we add 2 byte for the header, one for the trailing 0 byte 262 // we add 2 byte for the header, one for the trailing 0 byte
263 uint8 inbuf[MAXSOCKBUF + 2 + 1]; 263 uint8 inbuf[MAXSOCKBUF + 2 + 1];
264
265 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
266 struct msg_buf
267 {
268 tick_t expire;
269 int len;
270 int count;
271 char msg[MSG_BUF_SIZE];
272 } msgbuf[MSG_BUF_COUNT];
273
274 MTH bool msg_suppressed (const char *msg);
275
276 /* The following is the setup for a ring buffer for storing output
277 * data that the OS can't handle right away.
278 * TODO: this member is enourmously large - optimise?
279 */
280 struct
281 {
282 char data[SOCKETBUFSIZE];
283 int start;
284 int len;
285 } outputbuffer;
264 286
265 bool may_execute (const packet_type *pkt) const; 287 bool may_execute (const packet_type *pkt) const;
266 void execute (const packet_type *pkt, char *data, int datalen); 288 void execute (const packet_type *pkt, char *data, int datalen);
267 289
268 void queue_command (packet_type *handler, char *data, int datalen); 290 void queue_command (packet_type *handler, char *data, int datalen);
… …
285 void send_packet (const char *buf, int len); 307 void send_packet (const char *buf, int len);
286 void send_packet_printf (const char *format, ...); 308 void send_packet_printf (const char *format, ...);
287 void send_packet (packet &sl); 309 void send_packet (packet &sl);
288 310
289 void send_drawinfo (const char *msg, int flags = NDI_BLACK); 311 void send_drawinfo (const char *msg, int flags = NDI_BLACK);
312
290 MTH void send_face (faceidx facenum); 313 MTH void send_face (faceidx facenum, int pri = 0);
291 MTH void send_image (faceidx facenum); 314 MTH void send_image (faceidx facenum);
292 MTH void send_faces (object *ob); 315 MTH void send_faces (object *ob);
293 MTH void send_animation (short anim_num); 316 MTH void send_animation (short anim_num);
294 MTH void send_msg (int color, const char *type, const char *msg); 317 void send_msg (int color, const char *type, const char *msg);
295 318
319 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
296 // called when something under the player changes 320 // called when something under the player changes
297 MTH void floorbox_update () { update_look = 1; } 321 MTH void floorbox_update () { update_look = 1; }
298 // called when the player has been moved 322 // called when the player has been moved
299 MTH void floorbox_reset () { look_position = 0; floorbox_update (); } 323 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
300 324
301 MTH void tick (); // called every server tick to do housekeeping etc. 325 MTH void tick (); // called every server tick to do housekeeping etc.
302 326
303 MTH static client *create (int fd, const char *peername); 327 MTH static client *create (int fd, const char *peername);
328 MTH static void clock ();
329 MTH static void flush_sockets ();
304 330
305protected: 331protected:
306 client (int fd, const char *from_ip); 332 client (int fd, const char *from_ip);
307 ~client (); 333 ~client ();
308}; 334};
335
336#if FOR_PERL
337 ACC (RW, tcpi.tcpi_state);
338 ACC (RW, tcpi.tcpi_ca_state);
339 ACC (RW, tcpi.tcpi_retransmits);
340 ACC (RW, tcpi.tcpi_probes);
341 ACC (RW, tcpi.tcpi_backoff);
342 ACC (RW, tcpi.tcpi_options);
343 ACC (RO, tcpi.tcpi_snd_wscale);
344 ACC (RO, tcpi.tcpi_rcv_wscale);
345 ACC (RW, tcpi.tcpi_rto);
346 ACC (RW, tcpi.tcpi_ato);
347 ACC (RW, tcpi.tcpi_snd_mss);
348 ACC (RW, tcpi.tcpi_rcv_mss);
349 ACC (RW, tcpi.tcpi_unacked);
350 ACC (RW, tcpi.tcpi_sacked);
351 ACC (RW, tcpi.tcpi_lost);
352 ACC (RW, tcpi.tcpi_retrans);
353 ACC (RW, tcpi.tcpi_fackets);
354 ACC (RW, tcpi.tcpi_last_data_sent);
355 ACC (RW, tcpi.tcpi_last_ack_sent);
356 ACC (RW, tcpi.tcpi_last_data_recv);
357 ACC (RW, tcpi.tcpi_last_ack_recv);
358 ACC (RW, tcpi.tcpi_pmtu);
359 ACC (RW, tcpi.tcpi_rcv_ssthresh);
360 ACC (RW, tcpi.tcpi_rtt);
361 ACC (RW, tcpi.tcpi_rttvar);
362 ACC (RW, tcpi.tcpi_snd_ssthresh);
363 ACC (RW, tcpi.tcpi_snd_cwnd);
364 ACC (RW, tcpi.tcpi_advmss);
365 ACC (RW, tcpi.tcpi_reordering);
366#endif
309 367
310#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 368#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
311 ( ((__type)>0) &&\ 369 ( ((__type)>0) &&\
312 ((__sockPtr)->has_readable_type) && \ 370 ((__sockPtr)->has_readable_type) && \
313 ((__sockPtr)->supported_readables & (1<<(__type))) ) 371 ((__sockPtr)->supported_readables & (1<<(__type))) )
… …
342#define PNG_FACE_INDEX 0 400#define PNG_FACE_INDEX 0
343 401
344#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 402#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
345#define VERSION_SC 1026 403#define VERSION_SC 1026
346//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible 404//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
347#define VERSION_INFO "Crossfire+ Server" 405#define VERSION_INFO "Deliantra Server"
348 406
349typedef object_vector<client, &client::active> sockvec; 407typedef object_vector<client, &client::active> sockvec;
350 408
351extern sockvec clients; 409extern sockvec clients;
352 410
353#define for_all_clients(var) \ 411#define for_all_clients(var) \
354 for (int _i = 0; _i < clients.size (); ++_i) \ 412 for (int _i = 0; _i < clients.size (); ++_i) \
355 declvar (client *, var, clients [_i]) 413 statementvar (client *, var, clients [_i])
414
415// returns true when the message needs special (read: perl) treatment
416static inline bool
417msg_is_special (const char *msg, bool nl_special = true)
418{
419 return msg [strcspn (msg, nl_special ? "<&\n" : "<&")];
420}
356 421
357#endif 422#endif
358 423

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines