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.50 by root, Fri Apr 27 02:43:04 2007 UTC vs.
Revision 1.96 by root, Thu Apr 8 19:31:22 2010 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,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (C) 2002 Mark Wedel & Crossfire Development Team
6 * Copyright (C) 1992 Frank Tore Johansen
7 * 5 *
8 * This program is free software; you can redistribute it and/or modify 6 * Deliantra is free software: you can redistribute it and/or modify it under
9 * it under the terms of the GNU General Public License as published by 7 * the terms of the Affero GNU General Public License as published by the
10 * the Free Software Foundation; either version 2 of the License, or 8 * Free Software Foundation, either version 3 of the License, or (at your
11 * (at your option) any later version. 9 * option) any later version.
12 * 10 *
13 * 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,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details. 14 * GNU General Public License for more details.
17 * 15 *
18 * You should have received a copy of the GNU General Public License 16 * You should have received a copy of the Affero GNU General Public License
19 * along with this program; if not, write to the Free Software 17 * and the GNU General Public License along with this program. If not, see
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 18 * <http://www.gnu.org/licenses/>.
21 * 19 *
22 * The author can be reached via e-mail to crossfire@schmorp.de 20 * The authors can be reached via e-mail to <support@deliantra.net>
23 */ 21 */
24 22
25#ifndef CLIENT_H 23#ifndef CLIENT_H
26#define CLIENT_H 24#define CLIENT_H
27 25
28#include <deque> 26#if HAVE_TCP_INFO
29#include <bitset> 27# include <netinet/tcp.h>
30#include <tr1/unordered_set> 28#else
29 struct tcp_info {
30 // dummy
31 int tcpi_state;
32 int tcpi_ca_state;
33 int tcpi_retransmits;
34 int tcpi_probes;
35 int tcpi_backoff;
36 int tcpi_options;
37 int tcpi_snd_wscale;
38 int tcpi_rcv_wscale;
39 int tcpi_rto;
40 int tcpi_ato;
41 int tcpi_snd_mss;
42 int tcpi_rcv_mss;
43 int tcpi_unacked;
44 int tcpi_sacked;
45 int tcpi_lost;
46 int tcpi_retrans;
47 int tcpi_fackets;
48 int tcpi_last_data_sent;
49 int tcpi_last_ack_sent;
50 int tcpi_last_data_recv;
51 int tcpi_last_ack_recv;
52 int tcpi_pmtu;
53 int tcpi_rcv_ssthresh;
54 int tcpi_rtt;
55 int tcpi_rttvar;
56 int tcpi_snd_ssthresh;
57 int tcpi_snd_cwnd;
58 int tcpi_advmss;
59 int tcpi_reordering;
60 };
61#endif
62
63//+GPL
31 64
32// (possibly) max. number of objects "per page" in the ground container 65// (possibly) max. number of objects "per page" in the ground container
33#define FLOORBOX_PAGESIZE 50 66#define FLOORBOX_PAGESIZE 50
34 67
35struct MapCell 68struct MapCell
36{ 69{
37 tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient 70 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 */ 71 int count; /* This is really darkness in the map1 command */
39 faceidx faces[MAP_LAYERS]; 72 faceidx faces[MAP_LAYERS];
40 unsigned char stat_hp; // health of something in this space, or 0 73 unsigned char stat_hp; // health of something in this space, or 0
41 unsigned char flags; 74 unsigned char flags;
42 uint8_t smooth[MAP_LAYERS]; 75 uint8_t smooth[MAP_LAYERS];
… …
86 PF_PLAYING = 0x02, // must be in playing state 119 PF_PLAYING = 0x02, // must be in playing state
87 PF_COMMAND0 = 0x04, // command starts at offset 0 120 PF_COMMAND0 = 0x04, // command starts at offset 0
88 PF_COMMAND6 = 0x08, // command starts at offset 6 121 PF_COMMAND6 = 0x08, // command starts at offset 6
89}; 122};
90 123
124// face type.s bit 0 means "has meta info prepended"
125enum {
126 FT_FACE = 0 * 2 + 0, // faces (images)
127 FT_MUSIC = 1 * 2 + 1, // background music
128 FT_SOUND = 2 * 2 + 1, // effects
129 FT_RSRC = 3 * 2 + 0, // generic data files
130 FT_NUM,
131};
132
91struct packet_type 133struct packet_type
92{ 134{
93 const char *name; 135 const char *name;
94 void *cb; 136 void *cb;
95 int flags; 137 int flags;
… …
99{ 141{
100 tstamp stamp; 142 tstamp stamp;
101 const packet_type *handler; 143 const packet_type *handler;
102 char *data; 144 char *data;
103 int datalen; 145 int datalen;
104
105 ~command ()
106 {
107 sfree<char> (data, datalen + 1);
108 }
109}; 146};
147
148//-GPL
110 149
111/* how many times we are allowed to give the wrong password before being kicked. */ 150/* how many times we are allowed to give the wrong password before being kicked. */
112#define MAX_PASSWORD_FAILURES 5 151#define MAX_PASSWORD_FAILURES 5
113 152
114INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player 153INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
115struct client : zero_initialised, attachable 154struct client : zero_initialised, attachable
116{ 155{
117 int ACC (RW, fd); 156 int ACC (RW, fd);
118 unsigned int inbuf_len; // number of bytes valid in inbuf 157 unsigned int inbuf_len; // number of bytes valid in inbuf
119 statsinfo stats; 158 statsinfo stats;
120 int ACC (RO, active); 159 object_vector_index ACC (RO, active);
121 160 player_ptr ACC (RO, pl);
122 /* The following is the setup for a ring buffer for storing output
123 * data that the OS can't handle right away.
124 */
125 struct
126 {
127 char data[SOCKETBUFSIZE];
128 int start;
129 int len;
130 } outputbuffer;
131 161
132 char *ACC (RW, host); /* Which host it is connected from (ip address) */ 162 char *ACC (RW, host); /* Which host it is connected from (ip address) */
133 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ 163 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
134 164
135 sint8 ACC (RW, last_level); /* Last level we sent to client */ 165 sint8 ACC (RW, last_level); /* Last level we sent to client */
… …
143 living ACC (RO, last_stats); /* Last stats as sent to client */ 173 living ACC (RO, last_stats); /* Last stats as sent to client */
144 float ACC (RW, last_speed); /* Last speed as sent to client */ 174 float ACC (RW, last_speed); /* Last speed as sent to client */
145 sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ 175 sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
146 sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */ 176 sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */
147 177
148 bool ACC (RW, force_face0); // client workaround for buggy checksum calculation in gcfclient
149 bool ACC (RW, force_bad_checksum); // client workaround for buggy checksum calculation in gcfclient
150 bool ACC (RW, force_image_newmap); // client workaround for client not redrawing map on image upload
151 bool ACC (RW, enable_bg_scrub); // client workaround, gcfclient becomes unusable if you send it images
152
153 bool ACC (RW, afk); /* player is afk */ 178 bool ACC (RW, afk); /* player is afk */
154 bool ACC (RW, facecache); /* If true, client is caching images */
155 bool ACC (RW, sent_scroll); 179 bool ACC (RW, sent_scroll);
156 bool ACC (RW, sound); /* does the client want sound */ 180 bool ACC (RW, sound); /* does the client want sound */
157 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ 181 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
158 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ 182 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
159 bool ACC (RW, mapinfocmd); // return map info and send map change info 183 bool ACC (RW, mapinfocmd); // return map info and send map change info
160 bool ACC (RW, extcmd); // call into extensions/plugins 184 uint8_t ACC (RW, extcmd); // call into extensions/plugins
161 bool ACC (RW, extmap); // extend map comamnd with extra data
162 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls
163 bool ACC (RW, darkness); /* True if client wants darkness information */
164 bool ACC (RW, image2); /* Client wants image2/face2 commands */
165 bool ACC (RW, fxix); // client implements fx and ix (face|image extended) commands
166 bool ACC (RW, update_look); /* If true, we need to send the look window */ 185 bool ACC (RW, update_look); /* If true, we need to send the look window */
186 bool ACC (RW, update_spells); // If true, we need to esrv_update_spells
167 bool ACC (RW, has_readable_type); /* If true client accept additional text information */ 187 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
168 /* used to arrange text in books, scrolls, or scripted dialogs */ 188 /* used to arrange text in books, scrolls, or scripted dialogs */
169 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ 189 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
170 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
171 /* Below are flags for extedend infos to pass to client
172 * with S->C mapextended command */
173 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
174 bool ACC (RW, smoothing); // trt-style smoothing 190 bool ACC (RW, smoothing); // deliantra-style smoothing
175 bool ACC (RW, can_msg); // trt-style text messages
176 191
177 bool ACC (RW, force_newmap); // force a newmap before next map update 192 bool ACC (RW, force_newmap); // force a newmap before next map update
178 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ 193 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
179 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
180 uint16 ACC (RW, look_position); /* start of drawing of look window */ 194 uint16 ACC (RW, look_position); /* start of drawing of look window */
181 uint16 ACC (RW, mss); // likely tcp maximum segment size 195 uint16 ACC (RW, mss); // likely tcp maximum segment size
182 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */ 196 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
183 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ 197 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
184 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ 198 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
185 199
186 maptile *ACC (RW, current_map); // CF+ last/current player map 200 maptile_ptr ACC (RW, current_map); // CF+ last/current player map
187 region *ACC (RW, current_region); // CF+ last/current player region 201 region_ptr ACC (RW, current_region); // CF+ last/current player region
188 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position 202 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
189 shstr ACC (RW, version); // CF+ client name/version
190 uint8 ACC (RW, faceset); // CF+ selected faceset 203 uint8 ACC (RW, faceset); // CF+ selected faceset
191 204
192 player_ptr ACC (RO, pl); 205 tstamp ACC (RW, last_send); // last data send on socket.
193 206
194 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ 207 float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */
195
196 int ACC (RW, rate_avail); // current rate balance 208 int ACC (RW, rate_avail); // current rate balance
197 int ACC (RW, max_rate); // max. # of bytes to send per tick 209 int ACC (RW, max_rate); // max. # of bytes to send per tick
198 faceidx ACC (RW, scrub_idx); // which face to send next 210 faceidx ACC (RW, scrub_idx); // which face to send next
199 int ACC (RW, bg_scrub); // how many ticks till the next background face send 211 int ACC (RW, bg_scrub); // how many ticks till the next background face send
200 212
201 faceidx partial_face; 213 struct tcp_info tcpi;
202 uint32 partial_face_ofs; // if != 0, need to send remaining bytes of partial_face 214 tstamp next_rate_adjust;
203 std::vector<faceidx, slice_allocator<faceidx> > askface; // which faces have been requested by the client
204 215
216 unordered_vector<char *> mapinfo_queue;
217 void mapinfo_queue_clear ();
218 void mapinfo_queue_run ();
219 bool mapinfo_try (char *buf);
220
221 struct ixsend {
222 int16_t pri; // unused
223 faceidx idx;
224 uint32_t ofs; // if != 0, need to send remaining bytes of partial_face
225 };
226 std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix
227
205 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx 228 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
206 MTH void flush_fx (); // send fx if required 229 MTH void flush_fx (); // send fx if required
207 230
208 void do_destroy (); 231 void do_destroy ();
209 void gather_callbacks (AV *&callbacks, event_type event) const; 232 void gather_callbacks (AV *&callbacks, event_type event) const;
210 233
211 iow socket_ev; void socket_cb (iow &w, int got); 234 iow socket_ev; void socket_cb (iow &w, int revents);
212 iw cmd_ev; void cmd_cb (iw &w);
213 235
214 std::deque< command, slice_allocator<command> > cmd_queue; 236 std::deque< command, slice_allocator<command> > cmd_queue;
215 237
216 // large structures at the end please 238 // large structures at the end please
217 struct Map lastmap; 239 struct Map lastmap;
218 std::bitset<MAXANIMNUM> anims_sent; 240 std::bitset<MAXANIMNUM> anims_sent;
219 std::bitset<MAX_FACES> faces_sent; 241 std::bitset<MAX_FACES> faces_sent;
242 std::bitset<FT_NUM> fx_want;
220 243
221 // if we get an incomplete packet, this is used to hold the data. 244 // if we get an incomplete packet, this is used to hold the data.
222 // we add 2 byte for the header, one for the trailing 0 byte 245 // we add 2 byte for the header, one for the trailing 0 byte
223 uint8 inbuf[MAXSOCKBUF + 2 + 1]; 246 uint8 inbuf[MAXSOCKBUF + 2 + 1];
224 247
… …
229 int len; 252 int len;
230 int count; 253 int count;
231 char msg[MSG_BUF_SIZE]; 254 char msg[MSG_BUF_SIZE];
232 } msgbuf[MSG_BUF_COUNT]; 255 } msgbuf[MSG_BUF_COUNT];
233 256
234 MTH bool msg_suppressed (const char *msg); 257 MTH bool msg_suppressed (const_utf8_string msg);
258
259 /* The following is the setup for a ring buffer for storing output
260 * data that the OS can't handle right away.
261 * TODO: this member is enourmously large - optimise?
262 */
263 struct
264 {
265 char data[SOCKETBUFSIZE];
266 int start;
267 int len;
268 } outputbuffer;
235 269
236 bool may_execute (const packet_type *pkt) const; 270 bool may_execute (const packet_type *pkt) const;
237 void execute (const packet_type *pkt, char *data, int datalen); 271 void execute (const packet_type *pkt, char *data, int datalen);
238 272
239 void queue_command (packet_type *handler, char *data, int datalen); 273 void queue_command (packet_type *handler, char *data, int datalen);
… …
250 MTH void flush (); 284 MTH void flush ();
251 MTH void write_outputbuffer (); 285 MTH void write_outputbuffer ();
252 MTH int outputbuffer_len () const { return outputbuffer.len; } 286 MTH int outputbuffer_len () const { return outputbuffer.len; }
253 void send (void *buf_, int len); 287 void send (void *buf_, int len);
254 288
255 void send_packet (const char *buf); 289 void send_packet (const_octet_string buf);
256 void send_packet (const char *buf, int len); 290 void send_packet (const_octet_string buf, int len);
257 void send_packet_printf (const char *format, ...); 291 void send_packet_printf (const_utf8_string format, ...) attribute ((format (printf, 2, 3)));
258 void send_packet (packet &sl); 292 void send_packet (packet &sl);
259 293
260 void send_drawinfo (const char *msg, int flags = NDI_BLACK); 294 void send_drawinfo (const_utf8_string msg, int flags = NDI_BLACK);
295
261 MTH void send_face (faceidx facenum); 296 MTH void send_face (faceidx facenum, int pri = 0);
262 MTH void send_image (faceidx facenum);
263 MTH void send_faces (object *ob); 297 MTH void send_faces (object *ob);
264 MTH void send_animation (short anim_num); 298 MTH void send_animation (short anim_num);
265 MTH void send_msg (int color, const char *type, const char *msg); 299 void send_msg (int color, const_utf8_string type, const_utf8_string msg);
266 300
301 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
267 // called when something under the player changes 302 // called when something under the player changes
268 MTH void floorbox_update () { update_look = 1; } 303 MTH void floorbox_update () { update_look = 1; }
269 // called when the player has been moved 304 // called when the player has been moved
270 MTH void floorbox_reset () { look_position = 0; floorbox_update (); } 305 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
271 306
272 MTH void tick (); // called every server tick to do housekeeping etc. 307 MTH void tick (); // called every server tick to do housekeeping etc.
273 308
274 MTH static client *create (int fd, const char *peername); 309 MTH static client *create (int fd, const char *peername);
310 MTH static void clock ();
311 MTH static void flush_sockets ();
275 312
276protected: 313protected:
277 client (int fd, const char *from_ip); 314 client (int fd, const char *from_ip);
278 ~client (); 315 ~client ();
279}; 316};
317
318#if FOR_PERL
319 ACC (RW, tcpi.tcpi_state);
320 ACC (RW, tcpi.tcpi_ca_state);
321 ACC (RW, tcpi.tcpi_retransmits);
322 ACC (RW, tcpi.tcpi_probes);
323 ACC (RW, tcpi.tcpi_backoff);
324 ACC (RW, tcpi.tcpi_options);
325 ACC (RO, tcpi.tcpi_snd_wscale);
326 ACC (RO, tcpi.tcpi_rcv_wscale);
327 ACC (RW, tcpi.tcpi_rto);
328 ACC (RW, tcpi.tcpi_ato);
329 ACC (RW, tcpi.tcpi_snd_mss);
330 ACC (RW, tcpi.tcpi_rcv_mss);
331 ACC (RW, tcpi.tcpi_unacked);
332 ACC (RW, tcpi.tcpi_sacked);
333 ACC (RW, tcpi.tcpi_lost);
334 ACC (RW, tcpi.tcpi_retrans);
335 ACC (RW, tcpi.tcpi_fackets);
336 ACC (RW, tcpi.tcpi_last_data_sent);
337 ACC (RW, tcpi.tcpi_last_ack_sent);
338 ACC (RW, tcpi.tcpi_last_data_recv);
339 ACC (RW, tcpi.tcpi_last_ack_recv);
340 ACC (RW, tcpi.tcpi_pmtu);
341 ACC (RW, tcpi.tcpi_rcv_ssthresh);
342 ACC (RW, tcpi.tcpi_rtt);
343 ACC (RW, tcpi.tcpi_rttvar);
344 ACC (RW, tcpi.tcpi_snd_ssthresh);
345 ACC (RW, tcpi.tcpi_snd_cwnd);
346 ACC (RW, tcpi.tcpi_advmss);
347 ACC (RW, tcpi.tcpi_reordering);
348#endif
349
350//+GPL
280 351
281#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 352#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
282 ( ((__type)>0) &&\ 353 ( ((__type)>0) &&\
283 ((__sockPtr)->has_readable_type) && \ 354 ((__sockPtr)->has_readable_type) && \
284 ((__sockPtr)->supported_readables & (1<<(__type))) ) 355 ((__sockPtr)->supported_readables & (1<<(__type))) )
285 356
286/* Constants in the form EMI_ is for extended map infos.
287 * Even if the client select the additionnal infos it wants
288 * on the map, there may exist cases where this whole info
289 * is not given in one buch but in separate bunches. This
290 * is done performance reasons (imagine some info related to
291 * a visible object and another info related to a 4 square
292 * width and height area). At the begin of an extended info packet
293 * is a bit field. A bit is activated for each extended info
294 * present in the data
295 */
296
297/* Meanings:
298 * EMI_NOREDRAW Take extended infos into account but don't redraw,
299 * some additionnal datas will follow in a new packet
300 * EMI_SMOOTH Datas about smoothing
301 */
302#define EMI_NOREDRAW 0x01
303#define EMI_SMOOTH 0x02
304
305/* this last one says the bitfield continue un next byte
306 * There may be several on contiguous bytes. So there is 7
307 * actual bits used per byte, and the number of bytes
308 * is not fixed in protocol
309 */
310#define EMI_HASMOREBITS 0x80
311
312#define FACE_TYPES 1 357#define FACE_TYPES 1
313#define PNG_FACE_INDEX 0 358#define PNG_FACE_INDEX 0
314 359
315#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 360//-GPL
316#define VERSION_SC 1026
317//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
318#define VERSION_INFO "Crossfire+ Server"
319 361
320typedef object_vector<client, &client::active> sockvec; 362typedef object_vector<client, &client::active> sockvec;
321 363
322extern sockvec clients; 364extern sockvec clients;
323 365
324#define for_all_clients(var) \ 366#define for_all_clients(var) \
325 for (int _i = 0; _i < clients.size (); ++_i) \ 367 for (int _i = 0; _i < clients.size (); ++_i) \
326 declvar (client *, var, clients [_i]) 368 statementvar (client *, var, clients [_i])
369
370// returns true when the message needs special (read: perl) treatment
371static inline bool
372msg_is_special (const_any_string msg, bool nl_special = true)
373{
374 return msg [strcspn (msg, nl_special ? "<&\n" : "<&")];
375}
327 376
328#endif 377#endif
329 378

Diff Legend

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