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.79 by root, Mon Jul 14 23:47:06 2008 UTC vs.
Revision 1.97 by root, Thu Apr 8 20:05:35 2010 UTC

1/* 1/*
2 * This file is part of Deliantra, the Roguelike Realtime MMORPG. 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra 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 * Deliantra 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 <support@deliantra.net> 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
27#include <deque>
28#include <bitset>
29#include <tr1/unordered_set>
30 25
31#if HAVE_TCP_INFO 26#if HAVE_TCP_INFO
32# include <netinet/tcp.h> 27# include <netinet/tcp.h>
33#else 28#else
34 struct tcp_info { 29 struct tcp_info {
63 int tcpi_advmss; 58 int tcpi_advmss;
64 int tcpi_reordering; 59 int tcpi_reordering;
65 }; 60 };
66#endif 61#endif
67 62
63//+GPL
64
68// (possibly) max. number of objects "per page" in the ground container 65// (possibly) max. number of objects "per page" in the ground container
69#define FLOORBOX_PAGESIZE 50 66#define FLOORBOX_PAGESIZE 50
70 67
71struct MapCell 68struct MapCell
72{ 69{
146 const packet_type *handler; 143 const packet_type *handler;
147 char *data; 144 char *data;
148 int datalen; 145 int datalen;
149}; 146};
150 147
148//-GPL
149
151/* 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. */
152#define MAX_PASSWORD_FAILURES 5 151#define MAX_PASSWORD_FAILURES 5
153 152
154INTERFACE_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
155struct client : zero_initialised, attachable 154struct client : zero_initialised, attachable
157 int ACC (RW, fd); 156 int ACC (RW, fd);
158 unsigned int inbuf_len; // number of bytes valid in inbuf 157 unsigned int inbuf_len; // number of bytes valid in inbuf
159 statsinfo stats; 158 statsinfo stats;
160 object_vector_index ACC (RO, active); 159 object_vector_index ACC (RO, active);
161 player_ptr ACC (RO, pl); 160 player_ptr ACC (RO, pl);
162
163 /* The following is the setup for a ring buffer for storing output
164 * data that the OS can't handle right away.
165 */
166 struct
167 {
168 char data[SOCKETBUFSIZE];
169 int start;
170 int len;
171 } outputbuffer;
172 161
173 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) */
174 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 */
175 164
176 sint8 ACC (RW, last_level); /* Last level we sent to client */ 165 sint8 ACC (RW, last_level); /* Last level we sent to client */
184 living ACC (RO, last_stats); /* Last stats as sent to client */ 173 living ACC (RO, last_stats); /* Last stats as sent to client */
185 float ACC (RW, last_speed); /* Last speed as sent to client */ 174 float ACC (RW, last_speed); /* Last speed as sent to client */
186 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 */
187 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 */
188 177
189 bool ACC (RW, force_face0); // client workaround for buggy checksum calculation in gcfclient
190 bool ACC (RW, force_bad_checksum); // client workaround for buggy checksum calculation in gcfclient
191 bool ACC (RW, force_image_newmap); // client workaround for client not redrawing map on image upload
192 bool ACC (RW, enable_bg_scrub); // client workaround, gcfclient becomes unusable if you send it images
193
194 bool ACC (RW, afk); /* player is afk */ 178 bool ACC (RW, afk); /* player is afk */
195 bool ACC (RW, facecache); /* If true, client is caching images */
196 bool ACC (RW, sent_scroll); 179 bool ACC (RW, sent_scroll);
197 bool ACC (RW, sound); /* does the client want sound */ 180 bool ACC (RW, sound); /* does the client want sound */
198 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 */
199 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ 182 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
200 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
201 uint8_t ACC (RW, extcmd); // call into extensions/plugins 184 uint8_t ACC (RW, extcmd); // call into extensions/plugins
202 bool ACC (RW, extmap); // extend map comamnd with extra data
203 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls
204 bool ACC (RW, darkness); /* True if client wants darkness information */
205 bool ACC (RW, image2); /* Client wants image2/face2 commands */
206 uint8_t ACC (RW, fxix); // client implements fx and ix (face|image extended) commands
207 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
208 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 */
209 /* used to arrange text in books, scrolls, or scripted dialogs */ 188 /* used to arrange text in books, scrolls, or scripted dialogs */
210 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 */
211 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
212 /* Below are flags for extedend infos to pass to client
213 * with S->C mapextended command */
214 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
215 bool ACC (RW, smoothing); // trt-style smoothing 190 bool ACC (RW, smoothing); // deliantra-style smoothing
216 bool ACC (RW, can_msg); // trt-style text messages
217 191
218 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
219 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
220 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
221 uint16 ACC (RW, look_position); /* start of drawing of look window */ 193 uint16 ACC (RW, look_position); /* start of drawing of look window */
222 uint16 ACC (RW, mss); // likely tcp maximum segment size 194 uint16 ACC (RW, mss); // likely tcp maximum segment size
223 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */ 195 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
224 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ 196 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
225 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ 197 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
226 198
227 maptile *ACC (RW, current_map); // CF+ last/current player map 199 maptile_ptr ACC (RW, current_map); // CF+ last/current player map
228 region *ACC (RW, current_region); // CF+ last/current player region 200 region_ptr ACC (RW, current_region); // CF+ last/current player region
229 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position 201 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
230 shstr ACC (RW, version); // CF+ client name/version
231 uint8 ACC (RW, faceset); // CF+ selected faceset 202 uint8 ACC (RW, faceset); // CF+ selected faceset
232 203
233 tstamp ACC (RW, last_send); // last data send on socket. 204 tstamp ACC (RW, last_send); // last data send on socket.
234 205
206 float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */
235 int ACC (RW, rate_avail); // current rate balance 207 int ACC (RW, rate_avail); // current rate balance
236 int ACC (RW, max_rate); // max. # of bytes to send per tick 208 int ACC (RW, max_rate); // max. # of bytes to send per tick
237 faceidx ACC (RW, scrub_idx); // which face to send next 209 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 210 int ACC (RW, bg_scrub); // how many ticks till the next background face send
239 211
279 int len; 251 int len;
280 int count; 252 int count;
281 char msg[MSG_BUF_SIZE]; 253 char msg[MSG_BUF_SIZE];
282 } msgbuf[MSG_BUF_COUNT]; 254 } msgbuf[MSG_BUF_COUNT];
283 255
284 MTH bool msg_suppressed (const char *msg); 256 MTH bool msg_suppressed (const_utf8_string msg);
257
258 /* The following is the setup for a ring buffer for storing output
259 * data that the OS can't handle right away.
260 * TODO: this member is enourmously large - optimise?
261 */
262 struct
263 {
264 char data[SOCKETBUFSIZE];
265 int start;
266 int len;
267 } outputbuffer;
285 268
286 bool may_execute (const packet_type *pkt) const; 269 bool may_execute (const packet_type *pkt) const;
287 void execute (const packet_type *pkt, char *data, int datalen); 270 void execute (const packet_type *pkt, char *data, int datalen);
288 271
289 void queue_command (packet_type *handler, char *data, int datalen); 272 void queue_command (packet_type *handler, char *data, int datalen);
300 MTH void flush (); 283 MTH void flush ();
301 MTH void write_outputbuffer (); 284 MTH void write_outputbuffer ();
302 MTH int outputbuffer_len () const { return outputbuffer.len; } 285 MTH int outputbuffer_len () const { return outputbuffer.len; }
303 void send (void *buf_, int len); 286 void send (void *buf_, int len);
304 287
305 void send_packet (const char *buf); 288 void send_packet (const_octet_string buf);
306 void send_packet (const char *buf, int len); 289 void send_packet (const_octet_string buf, int len);
307 void send_packet_printf (const char *format, ...); 290 void send_packet_printf (const_utf8_string format, ...) attribute ((format (printf, 2, 3)));
308 void send_packet (packet &sl); 291 void send_packet (packet &sl);
309 292
310 void send_drawinfo (const char *msg, int flags = NDI_BLACK); 293 void send_drawinfo (const_utf8_string msg, int flags = NDI_BLACK);
311 294
312 MTH void send_face (faceidx facenum, int pri = 0); 295 MTH void send_face (faceidx facenum, int pri = 0);
313 MTH void send_image (faceidx facenum);
314 MTH void send_faces (object *ob); 296 MTH void send_faces (object *ob);
315 MTH void send_animation (short anim_num); 297 MTH void send_animation (short anim_num);
316 void send_msg (int color, const char *type, const char *msg); 298 void send_msg (int color, const_utf8_string type, const_utf8_string msg);
317 299
318 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); 300 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
319 // called when something under the player changes 301 // called when something under the player changes
320 MTH void floorbox_update () { update_look = 1; } 302 MTH void floorbox_update () { update_look = 1; }
321 // called when the player has been moved 303 // called when the player has been moved
362 ACC (RW, tcpi.tcpi_snd_cwnd); 344 ACC (RW, tcpi.tcpi_snd_cwnd);
363 ACC (RW, tcpi.tcpi_advmss); 345 ACC (RW, tcpi.tcpi_advmss);
364 ACC (RW, tcpi.tcpi_reordering); 346 ACC (RW, tcpi.tcpi_reordering);
365#endif 347#endif
366 348
349//+GPL
350
367#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 351#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
368 ( ((__type)>0) &&\ 352 ( ((__type)>0) &&\
369 ((__sockPtr)->has_readable_type) && \ 353 ((__sockPtr)->has_readable_type) && \
370 ((__sockPtr)->supported_readables & (1<<(__type))) ) 354 ((__sockPtr)->supported_readables & (1<<(__type))) )
371 355
372/* Constants in the form EMI_ is for extended map infos.
373 * Even if the client select the additionnal infos it wants
374 * on the map, there may exist cases where this whole info
375 * is not given in one buch but in separate bunches. This
376 * is done performance reasons (imagine some info related to
377 * a visible object and another info related to a 4 square
378 * width and height area). At the begin of an extended info packet
379 * is a bit field. A bit is activated for each extended info
380 * present in the data
381 */
382
383/* Meanings:
384 * EMI_NOREDRAW Take extended infos into account but don't redraw,
385 * some additionnal datas will follow in a new packet
386 * EMI_SMOOTH Datas about smoothing
387 */
388#define EMI_NOREDRAW 0x01
389#define EMI_SMOOTH 0x02
390
391/* this last one says the bitfield continue un next byte
392 * There may be several on contiguous bytes. So there is 7
393 * actual bits used per byte, and the number of bytes
394 * is not fixed in protocol
395 */
396#define EMI_HASMOREBITS 0x80
397
398#define FACE_TYPES 1 356#define FACE_TYPES 1
399#define PNG_FACE_INDEX 0 357#define PNG_FACE_INDEX 0
400 358
401#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 359//-GPL
402#define VERSION_SC 1026
403//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
404#define VERSION_INFO "Deliantra Server"
405 360
406typedef object_vector<client, &client::active> sockvec; 361typedef object_vector<client, &client::active> sockvec;
407 362
408extern sockvec clients; 363extern sockvec clients;
409 364
411 for (int _i = 0; _i < clients.size (); ++_i) \ 366 for (int _i = 0; _i < clients.size (); ++_i) \
412 statementvar (client *, var, clients [_i]) 367 statementvar (client *, var, clients [_i])
413 368
414// returns true when the message needs special (read: perl) treatment 369// returns true when the message needs special (read: perl) treatment
415static inline bool 370static inline bool
416msg_is_special (const char *msg, bool nl_special = true) 371msg_is_special (const_any_string msg, bool nl_special = true)
417{ 372{
418 return msg [strcspn (msg, nl_special ? "<[&\n" : "<[&")]; 373 return msg [strcspn (msg, nl_special ? "<&\n" : "<&")];
419} 374}
420 375
421#endif 376#endif
422 377

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines