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.49 by root, Wed Apr 25 18:47:50 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];
… …
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
89}; 125};
90 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
91struct packet_type 136struct packet_type
92{ 137{
93 const char *name; 138 const char *name;
94 void *cb; 139 void *cb;
95 int flags; 140 int flags;
… …
99{ 144{
100 tstamp stamp; 145 tstamp stamp;
101 const packet_type *handler; 146 const packet_type *handler;
102 char *data; 147 char *data;
103 int datalen; 148 int datalen;
104
105 ~command ()
106 {
107 sfree<char> (data, datalen + 1);
108 }
109};
110
111struct refitem
112{
113 object_ptr op;
114};
115
116// this represents a container on the client side.
117// right now, there are only ever two of them:
118// the inventory and the floor/open container
119//TODO: unused as of yet
120struct client_container : vector< refitem, slice_allocator<refitem> >
121{
122 client *ns;
123 enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type;
124
125 bool item_changed; // one of the items in here possibly changed
126
127 // for mapspace and container
128 int x, y;
129 maptile *map;
130
131 // for container
132 object *env;
133
134 client_container (client *ns)
135 : ns (ns), type (CC_NONE) { }
136
137 tag_t tag () const;
138
139 inline iterator merge_item (iterator i, object *op);
140
141 void clear ();
142 void update ();
143
144 void set_mapspace (maptile *map, int x, int y);
145 void set_container (object *env);
146}; 149};
147 150
148/* 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. */
149#define MAX_PASSWORD_FAILURES 5 152#define MAX_PASSWORD_FAILURES 5
150 153
… …
152struct client : zero_initialised, attachable 155struct client : zero_initialised, attachable
153{ 156{
154 int ACC (RW, fd); 157 int ACC (RW, fd);
155 unsigned int inbuf_len; // number of bytes valid in inbuf 158 unsigned int inbuf_len; // number of bytes valid in inbuf
156 statsinfo stats; 159 statsinfo stats;
157 int ACC (RO, active); 160 object_vector_index ACC (RO, active);
158 161 player_ptr ACC (RO, pl);
159 /* The following is the setup for a ring buffer for storing output
160 * data that the OS can't handle right away.
161 */
162 struct
163 {
164 char data[SOCKETBUFSIZE];
165 int start;
166 int len;
167 } outputbuffer;
168 162
169 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) */
170 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 */
171 165
172 sint8 ACC (RW, last_level); /* Last level we sent to client */ 166 sint8 ACC (RW, last_level); /* Last level we sent to client */
… …
192 bool ACC (RW, sent_scroll); 186 bool ACC (RW, sent_scroll);
193 bool ACC (RW, sound); /* does the client want sound */ 187 bool ACC (RW, sound); /* does the client want sound */
194 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 */
195 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ 189 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
196 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
197 bool ACC (RW, extcmd); // call into extensions/plugins 191 uint8_t ACC (RW, extcmd); // call into extensions/plugins
198 bool ACC (RW, extmap); // extend map comamnd with extra data 192 bool ACC (RW, extmap); // extend map comamnd with extra data
199 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls 193 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls
200 bool ACC (RW, darkness); /* True if client wants darkness information */ 194 bool ACC (RW, darkness); /* True if client wants darkness information */
201 bool ACC (RW, image2); /* Client wants image2/face2 commands */ 195 bool ACC (RW, image2); /* Client wants image2/face2 commands */
202 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
203 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 */
204 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 */
205 /* used to arrange text in books, scrolls, or scripted dialogs */ 199 /* used to arrange text in books, scrolls, or scripted dialogs */
206 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 */
207 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 */
… …
218 uint16 ACC (RW, mss); // likely tcp maximum segment size 212 uint16 ACC (RW, mss); // likely tcp maximum segment size
219 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */ 213 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
220 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 */
221 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 */
222 216
223 maptile *ACC (RW, current_map); // CF+ last/current player map 217 maptile_ptr ACC (RW, current_map); // CF+ last/current player map
224 region *ACC (RW, current_region); // CF+ last/current player region 218 region_ptr ACC (RW, current_region); // CF+ last/current player region
225 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
226 shstr ACC (RW, version); // CF+ client name/version 220 shstr ACC (RW, version); // CF+ client name/version
227 uint8 ACC (RW, faceset); // CF+ selected faceset 221 uint8 ACC (RW, faceset); // CF+ selected faceset
228 222
229 player_ptr ACC (RO, pl); 223 tstamp ACC (RW, last_send); // last data send on socket.
230
231 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
232 224
233 int ACC (RW, rate_avail); // current rate balance 225 int ACC (RW, rate_avail); // current rate balance
234 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
235 faceidx ACC (RW, scrub_idx); // which face to send next 227 faceidx ACC (RW, scrub_idx); // which face to send next
236 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
237 229
238 faceidx partial_face; 230 struct tcp_info tcpi;
239 uint32 partial_face_ofs; // if != 0, need to send remaining bytes of partial_face 231 tstamp next_rate_adjust;
240 std::vector<faceidx, slice_allocator<faceidx> > askface; // which faces have been requested by the client
241 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
242 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
243 MTH void flush_fx (); // send fx if required 246 MTH void flush_fx (); // send fx if required
244 247
245 void do_destroy (); 248 void do_destroy ();
246 void gather_callbacks (AV *&callbacks, event_type event) const; 249 void gather_callbacks (AV *&callbacks, event_type event) const;
247 250
248 iow socket_ev; void socket_cb (iow &w, int got); 251 iow socket_ev; void socket_cb (iow &w, int revents);
249 iw cmd_ev; void cmd_cb (iw &w);
250 client_container cc_inv, cc_other;
251 252
252 std::deque< command, slice_allocator<command> > cmd_queue; 253 std::deque< command, slice_allocator<command> > cmd_queue;
253 254
254 // large structures at the end please 255 // large structures at the end please
255 struct Map lastmap; 256 struct Map lastmap;
256 std::bitset<MAXANIMNUM> anims_sent; 257 std::bitset<MAXANIMNUM> anims_sent;
257 std::bitset<MAX_FACES> faces_sent; 258 std::bitset<MAX_FACES> faces_sent;
259 std::bitset<FT_NUM> fx_want;
258 260
259 // 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.
260 // 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
261 uint8 inbuf[MAXSOCKBUF + 2 + 1]; 263 uint8 inbuf[MAXSOCKBUF + 2 + 1];
262 264
… …
269 char msg[MSG_BUF_SIZE]; 271 char msg[MSG_BUF_SIZE];
270 } msgbuf[MSG_BUF_COUNT]; 272 } msgbuf[MSG_BUF_COUNT];
271 273
272 MTH bool msg_suppressed (const char *msg); 274 MTH bool msg_suppressed (const char *msg);
273 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;
286
274 bool may_execute (const packet_type *pkt) const; 287 bool may_execute (const packet_type *pkt) const;
275 void execute (const packet_type *pkt, char *data, int datalen); 288 void execute (const packet_type *pkt, char *data, int datalen);
276 289
277 void queue_command (packet_type *handler, char *data, int datalen); 290 void queue_command (packet_type *handler, char *data, int datalen);
278 MTH bool handle_command (); 291 MTH bool handle_command ();
… …
294 void send_packet (const char *buf, int len); 307 void send_packet (const char *buf, int len);
295 void send_packet_printf (const char *format, ...); 308 void send_packet_printf (const char *format, ...);
296 void send_packet (packet &sl); 309 void send_packet (packet &sl);
297 310
298 void send_drawinfo (const char *msg, int flags = NDI_BLACK); 311 void send_drawinfo (const char *msg, int flags = NDI_BLACK);
312
299 MTH void send_face (faceidx facenum); 313 MTH void send_face (faceidx facenum, int pri = 0);
300 MTH void send_image (faceidx facenum); 314 MTH void send_image (faceidx facenum);
301 MTH void send_faces (object *ob); 315 MTH void send_faces (object *ob);
302 MTH void send_animation (short anim_num); 316 MTH void send_animation (short anim_num);
303 MTH void send_msg (int color, const char *type, const char *msg); 317 void send_msg (int color, const char *type, const char *msg);
304 318
319 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
305 // called when something under the player changes 320 // called when something under the player changes
306 MTH void floorbox_update () { update_look = 1; } 321 MTH void floorbox_update () { update_look = 1; }
307 // called when the player has been moved 322 // called when the player has been moved
308 MTH void floorbox_reset () { look_position = 0; floorbox_update (); } 323 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
309 324
310 MTH void tick (); // called every server tick to do housekeeping etc. 325 MTH void tick (); // called every server tick to do housekeeping etc.
311 326
312 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 ();
313 330
314protected: 331protected:
315 client (int fd, const char *from_ip); 332 client (int fd, const char *from_ip);
316 ~client (); 333 ~client ();
317}; 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
318 367
319#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 368#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
320 ( ((__type)>0) &&\ 369 ( ((__type)>0) &&\
321 ((__sockPtr)->has_readable_type) && \ 370 ((__sockPtr)->has_readable_type) && \
322 ((__sockPtr)->supported_readables & (1<<(__type))) ) 371 ((__sockPtr)->supported_readables & (1<<(__type))) )
… …
351#define PNG_FACE_INDEX 0 400#define PNG_FACE_INDEX 0
352 401
353#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 402#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
354#define VERSION_SC 1026 403#define VERSION_SC 1026
355//#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
356#define VERSION_INFO "Crossfire+ Server" 405#define VERSION_INFO "Deliantra Server"
357 406
358typedef object_vector<client, &client::active> sockvec; 407typedef object_vector<client, &client::active> sockvec;
359 408
360extern sockvec clients; 409extern sockvec clients;
361 410
362#define for_all_clients(var) \ 411#define for_all_clients(var) \
363 for (int _i = 0; _i < clients.size (); ++_i) \ 412 for (int _i = 0; _i < clients.size (); ++_i) \
364 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}
365 421
366#endif 422#endif
367 423

Diff Legend

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