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.64 by root, Thu Jul 26 00:27:08 2007 UTC vs.
Revision 1.96 by root, Thu Apr 8 19:31:22 2010 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,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
6 * Copyright (©) 1992,2007 Frank Tore Johansen
7 * 5 *
8 * Crossfire TRT 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 3 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, see <http://www.gnu.org/licenses/>. 17 * and the GNU General Public License along with this program. If not, see
18 * <http://www.gnu.org/licenses/>.
20 * 19 *
21 * The authors can be reached via e-mail to <crossfire@schmorp.de> 20 * The authors can be reached via e-mail to <support@deliantra.net>
22 */ 21 */
23 22
24#ifndef CLIENT_H 23#ifndef CLIENT_H
25#define CLIENT_H 24#define CLIENT_H
26 25
27#include <deque> 26#if HAVE_TCP_INFO
28#include <bitset> 27# include <netinet/tcp.h>
29#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
30 64
31// (possibly) max. number of objects "per page" in the ground container 65// (possibly) max. number of objects "per page" in the ground container
32#define FLOORBOX_PAGESIZE 50 66#define FLOORBOX_PAGESIZE 50
33 67
34struct MapCell 68struct MapCell
35{ 69{
36 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
37 int count; /* This is really darkness in the map1 command */ 71 int count; /* This is really darkness in the map1 command */
38 faceidx faces[MAP_LAYERS]; 72 faceidx faces[MAP_LAYERS];
39 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
40 unsigned char flags; 74 unsigned char flags;
41 uint8_t smooth[MAP_LAYERS]; 75 uint8_t smooth[MAP_LAYERS];
… …
107{ 141{
108 tstamp stamp; 142 tstamp stamp;
109 const packet_type *handler; 143 const packet_type *handler;
110 char *data; 144 char *data;
111 int datalen; 145 int datalen;
112
113 ~command ()
114 {
115 sfree<char> (data, datalen + 1);
116 }
117}; 146};
147
148//-GPL
118 149
119/* 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. */
120#define MAX_PASSWORD_FAILURES 5 151#define MAX_PASSWORD_FAILURES 5
121 152
122INTERFACE_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
… …
125 int ACC (RW, fd); 156 int ACC (RW, fd);
126 unsigned int inbuf_len; // number of bytes valid in inbuf 157 unsigned int inbuf_len; // number of bytes valid in inbuf
127 statsinfo stats; 158 statsinfo stats;
128 object_vector_index ACC (RO, active); 159 object_vector_index ACC (RO, active);
129 player_ptr ACC (RO, pl); 160 player_ptr ACC (RO, pl);
130
131 /* The following is the setup for a ring buffer for storing output
132 * data that the OS can't handle right away.
133 */
134 struct
135 {
136 char data[SOCKETBUFSIZE];
137 int start;
138 int len;
139 } outputbuffer;
140 161
141 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) */
142 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 */
143 164
144 sint8 ACC (RW, last_level); /* Last level we sent to client */ 165 sint8 ACC (RW, last_level); /* Last level we sent to client */
… …
152 living ACC (RO, last_stats); /* Last stats as sent to client */ 173 living ACC (RO, last_stats); /* Last stats as sent to client */
153 float ACC (RW, last_speed); /* Last speed as sent to client */ 174 float ACC (RW, last_speed); /* Last speed as sent to client */
154 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 */
155 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 */
156 177
157 bool ACC (RW, force_face0); // client workaround for buggy checksum calculation in gcfclient
158 bool ACC (RW, force_bad_checksum); // client workaround for buggy checksum calculation in gcfclient
159 bool ACC (RW, force_image_newmap); // client workaround for client not redrawing map on image upload
160 bool ACC (RW, enable_bg_scrub); // client workaround, gcfclient becomes unusable if you send it images
161
162 bool ACC (RW, afk); /* player is afk */ 178 bool ACC (RW, afk); /* player is afk */
163 bool ACC (RW, facecache); /* If true, client is caching images */
164 bool ACC (RW, sent_scroll); 179 bool ACC (RW, sent_scroll);
165 bool ACC (RW, sound); /* does the client want sound */ 180 bool ACC (RW, sound); /* does the client want sound */
166 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 */
167 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ 182 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
168 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
169 uint8_t ACC (RW, extcmd); // call into extensions/plugins 184 uint8_t ACC (RW, extcmd); // call into extensions/plugins
170 bool ACC (RW, extmap); // extend map comamnd with extra data
171 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls
172 bool ACC (RW, darkness); /* True if client wants darkness information */
173 bool ACC (RW, image2); /* Client wants image2/face2 commands */
174 uint8_t ACC (RW, fxix); // client implements fx and ix (face|image extended) commands
175 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
176 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 */
177 /* used to arrange text in books, scrolls, or scripted dialogs */ 188 /* used to arrange text in books, scrolls, or scripted dialogs */
178 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 */
179 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
180 /* Below are flags for extedend infos to pass to client
181 * with S->C mapextended command */
182 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
183 bool ACC (RW, smoothing); // trt-style smoothing 190 bool ACC (RW, smoothing); // deliantra-style smoothing
184 bool ACC (RW, can_msg); // trt-style text messages
185 191
186 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
187 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 */
188 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
189 uint16 ACC (RW, look_position); /* start of drawing of look window */ 194 uint16 ACC (RW, look_position); /* start of drawing of look window */
190 uint16 ACC (RW, mss); // likely tcp maximum segment size 195 uint16 ACC (RW, mss); // likely tcp maximum segment size
191 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */ 196 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
192 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 */
193 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 */
194 199
195 maptile *ACC (RW, current_map); // CF+ last/current player map 200 maptile_ptr ACC (RW, current_map); // CF+ last/current player map
196 region *ACC (RW, current_region); // CF+ last/current player region 201 region_ptr ACC (RW, current_region); // CF+ last/current player region
197 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
198 shstr ACC (RW, version); // CF+ client name/version
199 uint8 ACC (RW, faceset); // CF+ selected faceset 203 uint8 ACC (RW, faceset); // CF+ selected faceset
200 204
201 tstamp ACC (RW, last_send); // last data send on socket. 205 tstamp ACC (RW, last_send); // last data send on socket.
202 206
203 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 */
204 int ACC (RW, outq); // current socket outq length, or 0 if indeterminable
205
206 int ACC (RW, rate_avail); // current rate balance 208 int ACC (RW, rate_avail); // current rate balance
207 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
208 faceidx ACC (RW, scrub_idx); // which face to send next 210 faceidx ACC (RW, scrub_idx); // which face to send next
209 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
212
213 struct tcp_info tcpi;
214 tstamp next_rate_adjust;
215
216 unordered_vector<char *> mapinfo_queue;
217 void mapinfo_queue_clear ();
218 void mapinfo_queue_run ();
219 bool mapinfo_try (char *buf);
210 220
211 struct ixsend { 221 struct ixsend {
212 int16_t pri; // unused 222 int16_t pri; // unused
213 faceidx idx; 223 faceidx idx;
214 uint32_t ofs; // if != 0, need to send remaining bytes of partial_face 224 uint32_t ofs; // if != 0, need to send remaining bytes of partial_face
… …
219 MTH void flush_fx (); // send fx if required 229 MTH void flush_fx (); // send fx if required
220 230
221 void do_destroy (); 231 void do_destroy ();
222 void gather_callbacks (AV *&callbacks, event_type event) const; 232 void gather_callbacks (AV *&callbacks, event_type event) const;
223 233
224 iow socket_ev; void socket_cb (iow &w, int got); 234 iow socket_ev; void socket_cb (iow &w, int revents);
225 iw cmd_ev; void cmd_cb (iw &w);
226 235
227 std::deque< command, slice_allocator<command> > cmd_queue; 236 std::deque< command, slice_allocator<command> > cmd_queue;
228 237
229 // large structures at the end please 238 // large structures at the end please
230 struct Map lastmap; 239 struct Map lastmap;
… …
243 int len; 252 int len;
244 int count; 253 int count;
245 char msg[MSG_BUF_SIZE]; 254 char msg[MSG_BUF_SIZE];
246 } msgbuf[MSG_BUF_COUNT]; 255 } msgbuf[MSG_BUF_COUNT];
247 256
248 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;
249 269
250 bool may_execute (const packet_type *pkt) const; 270 bool may_execute (const packet_type *pkt) const;
251 void execute (const packet_type *pkt, char *data, int datalen); 271 void execute (const packet_type *pkt, char *data, int datalen);
252 272
253 void queue_command (packet_type *handler, char *data, int datalen); 273 void queue_command (packet_type *handler, char *data, int datalen);
… …
264 MTH void flush (); 284 MTH void flush ();
265 MTH void write_outputbuffer (); 285 MTH void write_outputbuffer ();
266 MTH int outputbuffer_len () const { return outputbuffer.len; } 286 MTH int outputbuffer_len () const { return outputbuffer.len; }
267 void send (void *buf_, int len); 287 void send (void *buf_, int len);
268 288
269 void send_packet (const char *buf); 289 void send_packet (const_octet_string buf);
270 void send_packet (const char *buf, int len); 290 void send_packet (const_octet_string buf, int len);
271 void send_packet_printf (const char *format, ...); 291 void send_packet_printf (const_utf8_string format, ...) attribute ((format (printf, 2, 3)));
272 void send_packet (packet &sl); 292 void send_packet (packet &sl);
273 293
274 void send_drawinfo (const char *msg, int flags = NDI_BLACK); 294 void send_drawinfo (const_utf8_string msg, int flags = NDI_BLACK);
275 295
276 MTH void send_face (faceidx facenum, int pri = 0); 296 MTH void send_face (faceidx facenum, int pri = 0);
277 MTH void send_image (faceidx facenum);
278 MTH void send_faces (object *ob); 297 MTH void send_faces (object *ob);
279 MTH void send_animation (short anim_num); 298 MTH void send_animation (short anim_num);
280 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);
281 300
282 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); 301 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
283 // called when something under the player changes 302 // called when something under the player changes
284 MTH void floorbox_update () { update_look = 1; } 303 MTH void floorbox_update () { update_look = 1; }
285 // called when the player has been moved 304 // called when the player has been moved
286 MTH void floorbox_reset () { look_position = 0; floorbox_update (); } 305 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
287 306
288 MTH void tick (); // called every server tick to do housekeeping etc. 307 MTH void tick (); // called every server tick to do housekeeping etc.
289 308
290 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 ();
291 312
292protected: 313protected:
293 client (int fd, const char *from_ip); 314 client (int fd, const char *from_ip);
294 ~client (); 315 ~client ();
295}; 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
296 351
297#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 352#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
298 ( ((__type)>0) &&\ 353 ( ((__type)>0) &&\
299 ((__sockPtr)->has_readable_type) && \ 354 ((__sockPtr)->has_readable_type) && \
300 ((__sockPtr)->supported_readables & (1<<(__type))) ) 355 ((__sockPtr)->supported_readables & (1<<(__type))) )
301 356
302/* Constants in the form EMI_ is for extended map infos.
303 * Even if the client select the additionnal infos it wants
304 * on the map, there may exist cases where this whole info
305 * is not given in one buch but in separate bunches. This
306 * is done performance reasons (imagine some info related to
307 * a visible object and another info related to a 4 square
308 * width and height area). At the begin of an extended info packet
309 * is a bit field. A bit is activated for each extended info
310 * present in the data
311 */
312
313/* Meanings:
314 * EMI_NOREDRAW Take extended infos into account but don't redraw,
315 * some additionnal datas will follow in a new packet
316 * EMI_SMOOTH Datas about smoothing
317 */
318#define EMI_NOREDRAW 0x01
319#define EMI_SMOOTH 0x02
320
321/* this last one says the bitfield continue un next byte
322 * There may be several on contiguous bytes. So there is 7
323 * actual bits used per byte, and the number of bytes
324 * is not fixed in protocol
325 */
326#define EMI_HASMOREBITS 0x80
327
328#define FACE_TYPES 1 357#define FACE_TYPES 1
329#define PNG_FACE_INDEX 0 358#define PNG_FACE_INDEX 0
330 359
331#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 360//-GPL
332#define VERSION_SC 1026
333//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
334#define VERSION_INFO "Crossfire TRT Server"
335 361
336typedef object_vector<client, &client::active> sockvec; 362typedef object_vector<client, &client::active> sockvec;
337 363
338extern sockvec clients; 364extern sockvec clients;
339 365
340#define for_all_clients(var) \ 366#define for_all_clients(var) \
341 for (int _i = 0; _i < clients.size (); ++_i) \ 367 for (int _i = 0; _i < clients.size (); ++_i) \
342 statementvar (client *, var, clients [_i]) 368 statementvar (client *, var, clients [_i])
343 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}
376
344#endif 377#endif
345 378

Diff Legend

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