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.44 by root, Mon Apr 2 19:56:11 2007 UTC vs.
Revision 1.68 by root, Mon Oct 1 01:09:10 2007 UTC

1/* 1/*
2 * CrossFire, A Multiplayer game for the X Window System 2 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
3 * 3 *
4 * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team 4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT 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 * Crossfire TRT 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 <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>
31 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
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 UUID 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
87 ST_PLAYING, // logged in an playing 113 ST_PLAYING, // logged in an playing
88 ST_CUSTOM, // waiting for custom reply 114 ST_CUSTOM, // waiting for custom reply
89 115
90 ST_CHANGE_CLASS,
91 ST_GET_PARTY_PASSWORD, 116 ST_GET_PARTY_PASSWORD,
92}; 117};
93 118
94// a handler for a specific type of packet 119// a handler for a specific type of packet
95enum { 120enum {
… …
97 PF_PLAYING = 0x02, // must be in playing state 122 PF_PLAYING = 0x02, // must be in playing state
98 PF_COMMAND0 = 0x04, // command starts at offset 0 123 PF_COMMAND0 = 0x04, // command starts at offset 0
99 PF_COMMAND6 = 0x08, // command starts at offset 6 124 PF_COMMAND6 = 0x08, // command starts at offset 6
100}; 125};
101 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
102struct packet_type 136struct packet_type
103{ 137{
104 const char *name; 138 const char *name;
105 void *cb; 139 void *cb;
106 int flags; 140 int flags;
… …
117 { 151 {
118 sfree<char> (data, datalen + 1); 152 sfree<char> (data, datalen + 1);
119 } 153 }
120}; 154};
121 155
122struct refitem
123{
124 object_ptr op;
125};
126
127// this represents a container on the client side.
128// right now, there are only ever two of them:
129// the inventory and the floor/open container
130//TODO: unused as of yet
131struct client_container : vector< refitem, slice_allocator<refitem> >
132{
133 client *ns;
134 enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type;
135
136 bool item_changed; // one of the items in here possibly changed
137
138 // for mapspace and container
139 int x, y;
140 maptile *map;
141
142 // for container
143 object *env;
144
145 client_container (client *ns)
146 : ns (ns), type (CC_NONE) { }
147
148 tag_t tag () const;
149
150 inline iterator merge_item (iterator i, object *op);
151
152 void clear ();
153 void update ();
154
155 void set_mapspace (maptile *map, int x, int y);
156 void set_container (object *env);
157};
158
159/* how many times we are allowed to give the wrong password before being kicked. */ 156/* how many times we are allowed to give the wrong password before being kicked. */
160#define MAX_PASSWORD_FAILURES 5 157#define MAX_PASSWORD_FAILURES 5
161 158
162INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player 159INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
163struct client : zero_initialised, attachable 160struct client : zero_initialised, attachable
164{ 161{
165 int ACC (RW, fd); 162 int ACC (RW, fd);
166 unsigned int inbuf_len; // number of bytes valid in inbuf 163 unsigned int inbuf_len; // number of bytes valid in inbuf
167 statsinfo stats; 164 statsinfo stats;
168 int ACC (RO, active); 165 object_vector_index ACC (RO, active);
166 player_ptr ACC (RO, pl);
169 167
170 Buffer outputbuffer; 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;
171 177
172 char *ACC (RW, host); /* Which host it is connected from (ip address) */ 178 char *ACC (RW, host); /* Which host it is connected from (ip address) */
173 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ 179 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
174 180
175 sint8 ACC (RW, last_level); /* Last level we sent to client */ 181 sint8 ACC (RW, last_level); /* Last level we sent to client */
… …
195 bool ACC (RW, sent_scroll); 201 bool ACC (RW, sent_scroll);
196 bool ACC (RW, sound); /* does the client want sound */ 202 bool ACC (RW, sound); /* does the client want sound */
197 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 */
198 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ 204 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
199 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
200 bool ACC (RW, extcmd); // call into extensions/plugins 206 uint8_t ACC (RW, extcmd); // call into extensions/plugins
201 bool ACC (RW, extmap); // extend map comamnd with extra data 207 bool ACC (RW, extmap); // extend map comamnd with extra data
202 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls 208 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls
203 bool ACC (RW, darkness); /* True if client wants darkness information */ 209 bool ACC (RW, darkness); /* True if client wants darkness information */
204 bool ACC (RW, image2); /* Client wants image2/face2 commands */ 210 bool ACC (RW, image2); /* Client wants image2/face2 commands */
205 bool 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
206 bool ACC (RW, update_look); /* If true, we need to send the look window */ 212 bool ACC (RW, update_look); /* If true, we need to send the look window */
207 bool ACC (RW, has_readable_type); /* If true client accept additional text information */ 213 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
208 /* used to arrange text in books, scrolls, or scripted dialogs */ 214 /* used to arrange text in books, scrolls, or scripted dialogs */
209 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ 215 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
210 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ 216 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
211 /* Below are flags for extedend infos to pass to client 217 /* Below are flags for extedend infos to pass to client
212 * with S->C mapextended command */ 218 * with S->C mapextended command */
213 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ 219 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
220 bool ACC (RW, smoothing); // trt-style smoothing
221 bool ACC (RW, can_msg); // trt-style text messages
214 222
215 bool ACC (RW, force_newmap); // force a newmap before next map update 223 bool ACC (RW, force_newmap); // force a newmap before next map update
216 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ 224 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
217 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ 225 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
218 uint16 ACC (RW, look_position); /* start of drawing of look window */ 226 uint16 ACC (RW, look_position); /* start of drawing of look window */
… …
222 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ 230 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
223 231
224 maptile *ACC (RW, current_map); // CF+ last/current player map 232 maptile *ACC (RW, current_map); // CF+ last/current player map
225 region *ACC (RW, current_region); // CF+ last/current player region 233 region *ACC (RW, current_region); // CF+ last/current player region
226 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position 234 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
227 char ACC (RW, version)[64]; // CF+ client name/version 235 shstr ACC (RW, version); // CF+ client name/version
228 uint8 ACC (RW, faceset); // CF+ selected faceset 236 uint8 ACC (RW, faceset); // CF+ selected faceset
229 237
230 player_ptr ACC (RO, pl); 238 tstamp ACC (RW, last_send); // last data send on socket.
231
232 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
233 239
234 int ACC (RW, rate_avail); // current rate balance 240 int ACC (RW, rate_avail); // current rate balance
235 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
236 faceidx ACC (RW, scrub_idx); // which face to send next 242 faceidx ACC (RW, scrub_idx); // which face to send next
237 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
238 std::vector<faceidx> askface; // which faces have been requested by the client 244
245 struct tcp_info tcpi;
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 };
258 std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix
259
260 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
261 MTH void flush_fx (); // send fx if required
239 262
240 void do_destroy (); 263 void do_destroy ();
241 void gather_callbacks (AV *&callbacks, event_type event) const; 264 void gather_callbacks (AV *&callbacks, event_type event) const;
242 265
243 iow socket_ev; void socket_cb (iow &w, int got); 266 iow socket_ev; void socket_cb (iow &w, int got);
244 iw cmd_ev; void cmd_cb (iw &w);
245 client_container cc_inv, cc_other;
246 267
247 std::deque< command, slice_allocator<command> > cmd_queue; 268 std::deque< command, slice_allocator<command> > cmd_queue;
248 269
249 // large structures at the end please 270 // large structures at the end please
250 struct Map lastmap; 271 struct Map lastmap;
251 std::bitset<MAXANIMNUM> anims_sent; 272 std::bitset<MAXANIMNUM> anims_sent;
252 std::bitset<MAX_FACES> faces_sent; 273 std::bitset<MAX_FACES> faces_sent;
274 std::bitset<FT_NUM> fx_want;
253 275
254 // 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.
255 // 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
256 uint8 inbuf[MAXSOCKBUF + 2 + 1]; 278 uint8 inbuf[MAXSOCKBUF + 2 + 1];
279
280 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
281 struct msg_buf
282 {
283 tick_t expire;
284 int len;
285 int count;
286 char msg[MSG_BUF_SIZE];
287 } msgbuf[MSG_BUF_COUNT];
288
289 MTH bool msg_suppressed (const char *msg);
257 290
258 bool may_execute (const packet_type *pkt) const; 291 bool may_execute (const packet_type *pkt) const;
259 void execute (const packet_type *pkt, char *data, int datalen); 292 void execute (const packet_type *pkt, char *data, int datalen);
260 293
261 void queue_command (packet_type *handler, char *data, int datalen); 294 void queue_command (packet_type *handler, char *data, int datalen);
… …
278 void send_packet (const char *buf, int len); 311 void send_packet (const char *buf, int len);
279 void send_packet_printf (const char *format, ...); 312 void send_packet_printf (const char *format, ...);
280 void send_packet (packet &sl); 313 void send_packet (packet &sl);
281 314
282 void send_drawinfo (const char *msg, int flags = NDI_BLACK); 315 void send_drawinfo (const char *msg, int flags = NDI_BLACK);
316
283 MTH void send_face (faceidx facenum); 317 MTH void send_face (faceidx facenum, int pri = 0);
284 MTH void send_image (faceidx facenum); 318 MTH void send_image (faceidx facenum);
285 MTH void send_faces (object *ob); 319 MTH void send_faces (object *ob);
286 MTH void send_animation (short anim_num); 320 MTH void send_animation (short anim_num);
321 void send_msg (int color, const char *type, const char *msg);
287 322
323 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
288 // called when something under the player changes 324 // called when something under the player changes
289 MTH void floorbox_update () { update_look = 1; } 325 MTH void floorbox_update () { update_look = 1; }
290 // called when the player has been moved 326 // called when the player has been moved
291 MTH void floorbox_reset () { look_position = 0; floorbox_update (); } 327 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
292 328
293 MTH void tick (); // called every server tick to do housekeeping etc. 329 MTH void tick (); // called every server tick to do housekeeping etc.
294 330
295 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 ();
296 334
297protected: 335protected:
298 client (int fd, const char *from_ip); 336 client (int fd, const char *from_ip);
299 ~client (); 337 ~client ();
300}; 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
301 371
302#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 372#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
303 ( ((__type)>0) &&\ 373 ( ((__type)>0) &&\
304 ((__sockPtr)->has_readable_type) && \ 374 ((__sockPtr)->has_readable_type) && \
305 ((__sockPtr)->supported_readables & (1<<(__type))) ) 375 ((__sockPtr)->supported_readables & (1<<(__type))) )
… …
334#define PNG_FACE_INDEX 0 404#define PNG_FACE_INDEX 0
335 405
336#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 406#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
337#define VERSION_SC 1026 407#define VERSION_SC 1026
338//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible 408//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
339#define VERSION_INFO "Crossfire+ Server" 409#define VERSION_INFO "Crossfire TRT Server"
340 410
341typedef object_vector<client, &client::active> sockvec; 411typedef object_vector<client, &client::active> sockvec;
342 412
343extern sockvec clients; 413extern sockvec clients;
344 414
345#define for_all_clients(var) \ 415#define for_all_clients(var) \
346 for (int _i = 0; _i < clients.size (); ++_i) \ 416 for (int _i = 0; _i < clients.size (); ++_i) \
347 declvar (client *, var, clients [_i]) 417 statementvar (client *, var, clients [_i])
348 418
349#endif 419#endif
350 420

Diff Legend

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