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.14 by root, Thu Dec 21 06:12:36 2006 UTC vs.
Revision 1.45 by root, Tue Apr 3 00:21:37 2007 UTC

1/* 1/*
2 CrossFire, A Multiplayer game for the X Window System 2 * CrossFire, A Multiplayer game for the X Window System
3 3 *
4 * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team
4 Copyright (C) 2002 Mark Wedel & Crossfire Development Team 5 * Copyright (C) 2002 Mark Wedel & Crossfire Development Team
5 Copyright (C) 1992 Frank Tore Johansen 6 * Copyright (C) 1992 Frank Tore Johansen
6 7 *
7 This program is free software; you can redistribute it and/or modify 8 * This program is free software; you can redistribute it and/or modify
8 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
9 the Free Software Foundation; either version 2 of the License, or 10 * the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version. 11 * (at your option) any later version.
11 12 *
12 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,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details. 16 * GNU General Public License for more details.
16 17 *
17 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
18 along with this program; if not, write to the Free Software 19 * along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 21 *
21 The author can be reached via e-mail to crossfire@schmorp.de 22 * The author can be reached via e-mail to crossfire@schmorp.de
22*/ 23 */
23 24
24#ifndef CLIENT_H 25#ifndef CLIENT_H
25#define CLIENT_H 26#define CLIENT_H
26 27
27#include <deque> 28#include <deque>
… …
32#define FLOORBOX_PAGESIZE 50 33#define FLOORBOX_PAGESIZE 50
33 34
34struct MapCell 35struct MapCell
35{ 36{
36 UUID player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient 37 UUID player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
37 int count; /* This is really darkness in the map1 command */ 38 int count; /* This is really darkness in the map1 command */
38 uint16 faces[MAP_LAYERS]; 39 faceidx faces[MAP_LAYERS];
39 uint16 smooth[MAP_LAYERS];
40 unsigned char stat_hp; // health of something in this space, or 0 40 unsigned char stat_hp; // health of something in this space, or 0
41 unsigned char flags; 41 unsigned char flags;
42 uint8_t smooth[MAP_LAYERS];
42}; 43};
43 44
44/* This basically defines the largest size an
45 * archetype may be - it is used for allocation of
46 * some structures, as well as determining how far
47 * we should look for the heads of big images.
48 */
49#define MAX_HEAD_OFFSET 8
50
51#define MAX_CLIENT_X (MAP_CLIENT_X + MAX_HEAD_OFFSET) 45#define MAX_CLIENT_X MAP_CLIENT_X
52#define MAX_CLIENT_Y (MAP_CLIENT_Y + MAX_HEAD_OFFSET) 46#define MAX_CLIENT_Y MAP_CLIENT_Y
53 47
54struct Map 48struct Map
55{ 49{
56 struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y]; 50 struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y];
57}; 51};
58 52
59/* True max is 16383 given current map compaction method */ 53/* True max is 16383 given current map compaction method */
60# define MAXANIMNUM 2000 54#define MAXANIMNUM 10000
61 55
62struct statsinfo 56struct statsinfo
63{ 57{
64 char *range, *title; 58 char *range, *title;
65}; 59};
… …
72 66
73/* Only one map mode can actually be used, so lets make it a switch 67/* Only one map mode can actually be used, so lets make it a switch
74 * instead of having a bunch of different fields that needed to 68 * instead of having a bunch of different fields that needed to
75 * get toggled. 69 * get toggled.
76 */ 70 */
77enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; 71enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
78 72
79/* The following is the setup for a ring buffer for storing output 73/* The following is the setup for a ring buffer for storing output
80 * data that the OS can't handle right away. 74 * data that the OS can't handle right away.
81 */ 75 */
82
83struct Buffer 76struct Buffer
84{ 77{
85 char data[SOCKETBUFSIZE]; 78 char data[SOCKETBUFSIZE];
86 int start; 79 int start;
87 int len; 80 int len;
88}; 81};
89 82
83// states the socket can be in
84enum {
85 ST_DEAD, // socket is dead
86 ST_SETUP, // initial handshake / setup / login
87 ST_PLAYING, // logged in an playing
88 ST_CUSTOM, // waiting for custom reply
89
90 ST_CHANGE_CLASS,
91 ST_GET_PARTY_PASSWORD,
92};
93
90// a handler for a specific type of packet 94// a handler for a specific type of packet
91enum { 95enum {
92 PF_PLAYER = 0x01, // must have valid player / will by synchronised 96 PF_PLAYER = 0x01, // must have valid player / will by synchronised
93 PF_PLAYING = 0x02, // must be in playing state 97 PF_PLAYING = 0x02, // must be in playing state
98 PF_COMMAND0 = 0x04, // command starts at offset 0
99 PF_COMMAND6 = 0x08, // command starts at offset 6
94}; 100};
95 101
96struct packet_type 102struct packet_type
97{ 103{
98 const char *name; 104 const char *name;
… …
151}; 157};
152 158
153/* how many times we are allowed to give the wrong password before being kicked. */ 159/* how many times we are allowed to give the wrong password before being kicked. */
154#define MAX_PASSWORD_FAILURES 5 160#define MAX_PASSWORD_FAILURES 5
155 161
156ACC_CLASS (client) // should become player when newsocket is a baseclass of player 162INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
157struct client : zero_initialised, attachable<client> 163struct client : zero_initialised, attachable
158{ 164{
159 int ACC (RW, fd); 165 int ACC (RW, fd);
160 unsigned int inbuf_len; // number of bytes valid in inbuf 166 unsigned int inbuf_len; // number of bytes valid in inbuf
161 uint8 *faces_sent; // This is a bitmap on sent face status 167 statsinfo stats;
162 statsinfo stats; 168 int ACC (RO, active);
163 169
164 client_container cc_inv, cc_other; 170 Buffer outputbuffer;
165 171
166 char *ACC (RW, host); /* Which host it is connected from (ip address) */ 172 char *ACC (RW, host); /* Which host it is connected from (ip address) */
167 uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */ 173 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
168 bool destroyed; // set when this socket is to be destroyed
169 Buffer outputbuffer;
170 174
175 sint8 ACC (RW, last_level); /* Last level we sent to client */
176 uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */
177 float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */
178 sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */
179 sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */
180 uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */
181 uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */
182 uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */
183 living ACC (RO, last_stats); /* Last stats as sent to client */
184 float ACC (RW, last_speed); /* Last speed as sent to client */
185 sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
186 sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */
187
188 bool ACC (RW, force_face0); // client workaround for buggy checksum calculation in gcfclient
189 bool ACC (RW, force_bad_checksum); // client workaround for buggy checksum calculation in gcfclient
190 bool ACC (RW, force_image_newmap); // client workaround for client not redrawing map on image upload
191 bool ACC (RW, enable_bg_scrub); // client workaround, gcfclient becomes unusable if you send it images
192
193 bool ACC (RW, afk); /* player is afk */
171 bool ACC (RW, facecache); /* If true, client is caching images */ 194 bool ACC (RW, facecache); /* If true, client is caching images */
172 bool ACC (RW, sent_scroll); 195 bool ACC (RW, sent_scroll);
173 bool ACC (RW, sound); /* does the client want sound */ 196 bool ACC (RW, sound); /* does the client want sound */
174 bool ACC (RW, exp64); /* Client wants 64 bit exp data, as well as skill data */
175 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ 197 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
176 bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ 198 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
177 bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ 199 bool ACC (RW, mapinfocmd); // return map info and send map change info
178 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ 200 bool ACC (RW, extcmd); // call into extensions/plugins
179 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ 201 bool ACC (RW, extmap); // extend map comamnd with extra data
180 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ 202 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls
181 bool ACC (RW, darkness); /* True if client wants darkness information */ 203 bool ACC (RW, darkness); /* True if client wants darkness information */
182 bool ACC (RW, image2); /* Client wants image2/face2 commands */ 204 bool ACC (RW, image2); /* Client wants image2/face2 commands */
205 bool ACC (RW, fxix); // client implements fx and ix (face|image extended) commands
183 bool ACC (RW, update_look); /* If true, we need to send the look window */ 206 bool ACC (RW, update_look); /* If true, we need to send the look window */
184 bool ACC (RW, has_readable_type); /* If true client accept additional text information */ 207 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
185 /* used to arrange text in books, scrolls, or scripted dialogs */ 208 /* used to arrange text in books, scrolls, or scripted dialogs */
186 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ 209 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
187 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ 210 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
188 /* Below are flags for extedend infos to pass to client 211 /* Below are flags for extedend infos to pass to client
189 * with S->C mapextended command */ 212 * with S->C mapextended command */
190 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ 213 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
191 214
215 bool ACC (RW, force_newmap); // force a newmap before next map update
192 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ 216 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
193 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ 217 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
194 enum MapMode mapmode; /* Type of map commands the client wants. */
195 uint16 ACC (RW, look_position); /* start of drawing of look window */ 218 uint16 ACC (RW, look_position); /* start of drawing of look window */
219 uint16 ACC (RW, mss); // likely tcp maximum segment size
220 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
196 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ 221 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
197 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ 222 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
198 uint8 ACC (RW, faceset); /* Set the client is using, default 0 */
199 223
200 maptile *ACC (RW, current_map); // CF+ last/current player map 224 maptile *ACC (RW, current_map); // CF+ last/current player map
225 region *ACC (RW, current_region); // CF+ last/current player region
201 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position 226 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
202 char ACC (RW, version)[64]; // CF+ client name/version 227 char ACC (RW, version)[64]; // CF+ client name/version
228 uint8 ACC (RW, faceset); // CF+ selected faceset
203 229
204 player *ACC (RO, pl);//TODO should not be here, preferably 230 player_ptr ACC (RO, pl);
205 231
206 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ 232 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
207 233
208 client (int fd, const char *from_ip); 234 int ACC (RW, rate_avail); // current rate balance
209 ~client (); 235 int ACC (RW, max_rate); // max. # of bytes to send per tick
236 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
238
239 faceidx partial_face;
240 uint32 partial_face_ofs; // if != 0, need to send remaining bytes of partial_face
241 std::vector<faceidx, slice_allocator<faceidx> > askface; // which faces have been requested by the client
242
243 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
244 MTH void flush_fx (); // send fx if required
245
210 void destroy (); 246 void do_destroy ();
247 void gather_callbacks (AV *&callbacks, event_type event) const;
211 248
249 iow socket_ev; void socket_cb (iow &w, int got);
212 iw cmd_ev; void cmd_cb (iw &w); 250 iw cmd_ev; void cmd_cb (iw &w);
213 iow socket_ev; void socket_cb (iow &w, int got); 251 client_container cc_inv, cc_other;
214 252
215 std::deque< command, slice_allocator<command> > cmd_queue; 253 std::deque< command, slice_allocator<command> > cmd_queue;
216 254
217 // large structures at the end please 255 // large structures at the end please
218 struct Map lastmap; 256 struct Map lastmap;
219 std::bitset<MAXANIMNUM> anims_sent; 257 std::bitset<MAXANIMNUM> anims_sent;
258 std::bitset<MAX_FACES> faces_sent;
259
220 // if we get an incomplete packet, this is used to hold the data. 260 // if we get an incomplete packet, this is used to hold the data.
221 // we add 2 byte for the header, one for the trailing 0 byte 261 // we add 2 byte for the header, one for the trailing 0 byte
222 uint8 inbuf[MAXSOCKBUF + 2 + 1]; 262 uint8 inbuf[MAXSOCKBUF + 2 + 1];
223 263
224 bool may_execute (const packet_type *pkt) const; 264 bool may_execute (const packet_type *pkt) const;
225 void execute (const packet_type *pkt, char *data, int datalen); 265 void execute (const packet_type *pkt, char *data, int datalen);
226 266
227 void queue_command (packet_type *handler, char *data, int datalen); 267 void queue_command (packet_type *handler, char *data, int datalen);
228 bool handle_command (); 268 MTH bool handle_command ();
229 // resets movement state 269 // resets movement state
230 void reset_state (); 270 MTH void reset_state ();
271 // resets variable data used to send stat diffs
272 MTH void reset_stats ();
231 273
232 bool handle_packet (); 274 MTH bool handle_packet ();
233 int next_packet (); // returns length of packet or 0 275 int next_packet (); // returns length of packet or 0
234 void skip_packet (int len); // we have processed the packet, skip it 276 void skip_packet (int len); // we have processed the packet, skip it
235 277
236 void flush (); 278 MTH void flush ();
237 void write_outputbuffer (); 279 MTH void write_outputbuffer ();
280 MTH int outputbuffer_len () const { return outputbuffer.len; }
238 void send (void *buf_, int len); 281 void send (void *buf_, int len);
239 282
240 void send_packet (const char *buf); 283 void send_packet (const char *buf);
241 void send_packet (const char *buf, int len); 284 void send_packet (const char *buf, int len);
242 void send_packet_printf (const char *format, ...); 285 void send_packet_printf (const char *format, ...);
243 void send_packet (packet &sl); 286 void send_packet (packet &sl);
244 287
288 void send_drawinfo (const char *msg, int flags = NDI_BLACK);
289 MTH void send_face (faceidx facenum);
290 MTH void send_image (faceidx facenum);
291 MTH void send_faces (object *ob);
292 MTH void send_animation (short anim_num);
293
245 // called when something under the player changes 294 // called when something under the player changes
246 void floorbox_update () { update_look = 1; } 295 MTH void floorbox_update () { update_look = 1; }
247 // called when the player has been moved 296 // called when the player has been moved
248 void floorbox_reset () { look_position = 0; floorbox_update (); } 297 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
249 298
299 MTH void tick (); // called every server tick to do housekeeping etc.
300
250 static client *create (int fd, const char *peername); 301 MTH static client *create (int fd, const char *peername);
302
303protected:
304 client (int fd, const char *from_ip);
305 ~client ();
251}; 306};
252 307
253#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 308#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
254 ( ((__type)>0) &&\ 309 ( ((__type)>0) &&\
255 ((__sockPtr)->has_readable_type) && \ 310 ((__sockPtr)->has_readable_type) && \
256 ((__sockPtr)->supported_readables & (1<<(__type))) ) 311 ((__sockPtr)->supported_readables & (1<<(__type))) )
257
258/* Bitmask for the faces_sent[] array - what
259 * portion of the face have we sent?
260 */
261#define NS_FACESENT_FACE 0x1
262#define NS_FACESENT_SMOOTH 0x2
263 312
264/* Constants in the form EMI_ is for extended map infos. 313/* Constants in the form EMI_ is for extended map infos.
265 * Even if the client select the additionnal infos it wants 314 * Even if the client select the additionnal infos it wants
266 * on the map, there may exist cases where this whole info 315 * on the map, there may exist cases where this whole info
267 * is not given in one buch but in separate bunches. This 316 * is not given in one buch but in separate bunches. This
… …
289 338
290#define FACE_TYPES 1 339#define FACE_TYPES 1
291#define PNG_FACE_INDEX 0 340#define PNG_FACE_INDEX 0
292 341
293#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 342#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
294#define VERSION_SC 1027 343#define VERSION_SC 1026
344//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
295#define VERSION_INFO "Crossfire+ Server" 345#define VERSION_INFO "Crossfire+ Server"
296 346
297typedef unordered_vector<client *> sockvec; 347typedef object_vector<client, &client::active> sockvec;
298 348
299extern sockvec clients; 349extern sockvec clients;
300extern int nrofpixmaps; //TODO: hrmpf, should go 350
351#define for_all_clients(var) \
352 for (int _i = 0; _i < clients.size (); ++_i) \
353 declvar (client *, var, clients [_i])
301 354
302#endif 355#endif
303 356

Diff Legend

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