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.81 by root, Mon Sep 8 11:27:25 2008 UTC vs.
Revision 1.92 by root, Sat Jan 16 13:41:37 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 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
63 int tcpi_advmss; 62 int tcpi_advmss;
64 int tcpi_reordering; 63 int tcpi_reordering;
65 }; 64 };
66#endif 65#endif
67 66
67//+GPL
68
68// (possibly) max. number of objects "per page" in the ground container 69// (possibly) max. number of objects "per page" in the ground container
69#define FLOORBOX_PAGESIZE 50 70#define FLOORBOX_PAGESIZE 50
70 71
71struct MapCell 72struct MapCell
72{ 73{
146 const packet_type *handler; 147 const packet_type *handler;
147 char *data; 148 char *data;
148 int datalen; 149 int datalen;
149}; 150};
150 151
152//-GPL
153
151/* how many times we are allowed to give the wrong password before being kicked. */ 154/* how many times we are allowed to give the wrong password before being kicked. */
152#define MAX_PASSWORD_FAILURES 5 155#define MAX_PASSWORD_FAILURES 5
153 156
154INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player 157INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
155struct client : zero_initialised, attachable 158struct client : zero_initialised, attachable
157 int ACC (RW, fd); 160 int ACC (RW, fd);
158 unsigned int inbuf_len; // number of bytes valid in inbuf 161 unsigned int inbuf_len; // number of bytes valid in inbuf
159 statsinfo stats; 162 statsinfo stats;
160 object_vector_index ACC (RO, active); 163 object_vector_index ACC (RO, active);
161 player_ptr ACC (RO, pl); 164 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 165
173 char *ACC (RW, host); /* Which host it is connected from (ip address) */ 166 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 */ 167 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
175 168
176 sint8 ACC (RW, last_level); /* Last level we sent to client */ 169 sint8 ACC (RW, last_level); /* Last level we sent to client */
184 living ACC (RO, last_stats); /* Last stats as sent to client */ 177 living ACC (RO, last_stats); /* Last stats as sent to client */
185 float ACC (RW, last_speed); /* Last speed as sent to client */ 178 float ACC (RW, last_speed); /* Last speed as sent to client */
186 sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ 179 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 */ 180 sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */
188 181
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 */ 182 bool ACC (RW, afk); /* player is afk */
195 bool ACC (RW, facecache); /* If true, client is caching images */
196 bool ACC (RW, sent_scroll); 183 bool ACC (RW, sent_scroll);
197 bool ACC (RW, sound); /* does the client want sound */ 184 bool ACC (RW, sound); /* does the client want sound */
198 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ 185 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
199 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ 186 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
200 bool ACC (RW, mapinfocmd); // return map info and send map change info 187 bool ACC (RW, mapinfocmd); // return map info and send map change info
201 uint8_t ACC (RW, extcmd); // call into extensions/plugins 188 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 */ 189 bool ACC (RW, update_look); /* If true, we need to send the look window */
190 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 */ 191 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
209 /* used to arrange text in books, scrolls, or scripted dialogs */ 192 /* 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 */ 193 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 194 bool ACC (RW, smoothing); // deliantra-style smoothing
216 bool ACC (RW, can_msg); // trt-style text messages
217 195
218 bool ACC (RW, force_newmap); // force a newmap before next map update 196 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 */ 197 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 */ 198 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 */ 199 uint16 ACC (RW, look_position); /* start of drawing of look window */
230 shstr ACC (RW, version); // CF+ client name/version 208 shstr ACC (RW, version); // CF+ client name/version
231 uint8 ACC (RW, faceset); // CF+ selected faceset 209 uint8 ACC (RW, faceset); // CF+ selected faceset
232 210
233 tstamp ACC (RW, last_send); // last data send on socket. 211 tstamp ACC (RW, last_send); // last data send on socket.
234 212
213 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 214 int ACC (RW, rate_avail); // current rate balance
236 int ACC (RW, max_rate); // max. # of bytes to send per tick 215 int ACC (RW, max_rate); // max. # of bytes to send per tick
237 faceidx ACC (RW, scrub_idx); // which face to send next 216 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 217 int ACC (RW, bg_scrub); // how many ticks till the next background face send
239 218
279 int len; 258 int len;
280 int count; 259 int count;
281 char msg[MSG_BUF_SIZE]; 260 char msg[MSG_BUF_SIZE];
282 } msgbuf[MSG_BUF_COUNT]; 261 } msgbuf[MSG_BUF_COUNT];
283 262
284 MTH bool msg_suppressed (const char *msg); 263 MTH bool msg_suppressed (const_utf8_string msg);
264
265 /* The following is the setup for a ring buffer for storing output
266 * data that the OS can't handle right away.
267 * TODO: this member is enourmously large - optimise?
268 */
269 struct
270 {
271 char data[SOCKETBUFSIZE];
272 int start;
273 int len;
274 } outputbuffer;
285 275
286 bool may_execute (const packet_type *pkt) const; 276 bool may_execute (const packet_type *pkt) const;
287 void execute (const packet_type *pkt, char *data, int datalen); 277 void execute (const packet_type *pkt, char *data, int datalen);
288 278
289 void queue_command (packet_type *handler, char *data, int datalen); 279 void queue_command (packet_type *handler, char *data, int datalen);
300 MTH void flush (); 290 MTH void flush ();
301 MTH void write_outputbuffer (); 291 MTH void write_outputbuffer ();
302 MTH int outputbuffer_len () const { return outputbuffer.len; } 292 MTH int outputbuffer_len () const { return outputbuffer.len; }
303 void send (void *buf_, int len); 293 void send (void *buf_, int len);
304 294
305 void send_packet (const char *buf); 295 void send_packet (const_octet_string buf);
306 void send_packet (const char *buf, int len); 296 void send_packet (const_octet_string buf, int len);
307 void send_packet_printf (const char *format, ...); 297 void send_packet_printf (const_utf8_string format, ...) attribute ((format (printf, 2, 3)));
308 void send_packet (packet &sl); 298 void send_packet (packet &sl);
309 299
310 void send_drawinfo (const char *msg, int flags = NDI_BLACK); 300 void send_drawinfo (const_utf8_string msg, int flags = NDI_BLACK);
311 301
312 MTH void send_face (faceidx facenum, int pri = 0); 302 MTH void send_face (faceidx facenum, int pri = 0);
313 MTH void send_image (faceidx facenum);
314 MTH void send_faces (object *ob); 303 MTH void send_faces (object *ob);
315 MTH void send_animation (short anim_num); 304 MTH void send_animation (short anim_num);
316 void send_msg (int color, const char *type, const char *msg); 305 void send_msg (int color, const_utf8_string type, const_utf8_string msg);
317 306
318 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); 307 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
319 // called when something under the player changes 308 // called when something under the player changes
320 MTH void floorbox_update () { update_look = 1; } 309 MTH void floorbox_update () { update_look = 1; }
321 // called when the player has been moved 310 // called when the player has been moved
362 ACC (RW, tcpi.tcpi_snd_cwnd); 351 ACC (RW, tcpi.tcpi_snd_cwnd);
363 ACC (RW, tcpi.tcpi_advmss); 352 ACC (RW, tcpi.tcpi_advmss);
364 ACC (RW, tcpi.tcpi_reordering); 353 ACC (RW, tcpi.tcpi_reordering);
365#endif 354#endif
366 355
356//+GPL
357
367#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 358#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
368 ( ((__type)>0) &&\ 359 ( ((__type)>0) &&\
369 ((__sockPtr)->has_readable_type) && \ 360 ((__sockPtr)->has_readable_type) && \
370 ((__sockPtr)->supported_readables & (1<<(__type))) ) 361 ((__sockPtr)->supported_readables & (1<<(__type))) )
371 362
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 363#define FACE_TYPES 1
399#define PNG_FACE_INDEX 0 364#define PNG_FACE_INDEX 0
400 365
401#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 366#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
402#define VERSION_SC 1026 367#define VERSION_SC 1026
403//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible 368//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
404#define VERSION_INFO "Deliantra Server" 369#define VERSION_INFO "Deliantra Server"
405 370
371//-GPL
372
406typedef object_vector<client, &client::active> sockvec; 373typedef object_vector<client, &client::active> sockvec;
407 374
408extern sockvec clients; 375extern sockvec clients;
409 376
410#define for_all_clients(var) \ 377#define for_all_clients(var) \
411 for (int _i = 0; _i < clients.size (); ++_i) \ 378 for (int _i = 0; _i < clients.size (); ++_i) \
412 statementvar (client *, var, clients [_i]) 379 statementvar (client *, var, clients [_i])
413 380
414// returns true when the message needs special (read: perl) treatment 381// returns true when the message needs special (read: perl) treatment
415static inline bool 382static inline bool
416msg_is_special (const char *msg, bool nl_special = true) 383msg_is_special (const_any_string msg, bool nl_special = true)
417{ 384{
418 return msg [strcspn (msg, nl_special ? "<&\n" : "<&")]; 385 return msg [strcspn (msg, nl_special ? "<&\n" : "<&")];
419} 386}
420 387
421#endif 388#endif

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines