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.12 by root, Wed Dec 20 01:19:11 2006 UTC vs.
Revision 1.37 by root, Wed Mar 14 04:12:28 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>
28#include <bitset> 29#include <bitset>
29#include <list> 30#include <tr1/unordered_set>
30 31
31// (possibly) max. number of objects "per page" in the ground container 32// (possibly) max. number of objects "per page" in the ground container
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};
… …
68 * current state. we set up our on buffers for sending/receiving, so we can 62 * current state. we set up our on buffers for sending/receiving, so we can
69 * handle some higher level functions. fd is the actual file descriptor we 63 * handle some higher level functions. fd is the actual file descriptor we
70 * are using. 64 * are using.
71 */ 65 */
72 66
73enum Sock_Status { Ns_Add, Ns_Dead };
74
75/* 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
76 * instead of having a bunch of different fields that needed to 68 * instead of having a bunch of different fields that needed to
77 * get toggled. 69 * get toggled.
78 */ 70 */
79enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; 71enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
80 72
81/* The following is the setup for a ring buffer for storing outbut 73/* The following is the setup for a ring buffer for storing output
82 * data that the OS can't handle right away. 74 * data that the OS can't handle right away.
83 */ 75 */
84
85struct Buffer 76struct Buffer
86{ 77{
87 char data[SOCKETBUFSIZE]; 78 char data[SOCKETBUFSIZE];
88 int start; 79 int start;
89 int len; 80 int len;
90}; 81};
91 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
92// a handler for a specific type of packet 94// a handler for a specific type of packet
93enum { 95enum {
94 PF_PLAYER = 0x01, // must have valid player / will by synchronised 96 PF_PLAYER = 0x01, // must have valid player / will by synchronised
95 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
96}; 100};
97 101
98struct packet_type 102struct packet_type
99{ 103{
100 const char *name; 104 const char *name;
… …
113 { 117 {
114 sfree<char> (data, datalen + 1); 118 sfree<char> (data, datalen + 1);
115 } 119 }
116}; 120};
117 121
122struct refitem
123{
124 object_ptr op;
125};
126
118// this represents a container on the client side. 127// this represents a container on the client side.
119// right now, there are only ever two of them: 128// right now, there are only ever two of them:
120// the inventory and the floor/open container 129// the inventory and the floor/open container
121//TODO: unused as of yet 130//TODO: unused as of yet
122struct client_container 131struct client_container : vector< refitem, slice_allocator<refitem> >
123{ 132{
133 client *ns;
124 enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type; 134 enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type;
125 135
136 bool item_changed; // one of the items in here possibly changed
137
126 // for mapspace and container 138 // for mapspace and container
127 sint16 x, y; 139 int x, y;
128 maptile *map; 140 maptile *map;
129 141
130 // for container 142 // for container
131 object *env; 143 object *env;
144
145 client_container (client *ns)
146 : ns (ns), type (CC_NONE) { }
147
148 tag_t tag () const;
149
150 inline iterator merge_item (iterator i, object *op);
151
152 void clear ();
153 void update ();
154
155 void set_mapspace (maptile *map, int x, int y);
156 void set_container (object *env);
132}; 157};
133 158
134/* 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. */
135#define MAX_PASSWORD_FAILURES 5 160#define MAX_PASSWORD_FAILURES 5
136 161
137ACC_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
138struct client : zero_initialised, attachable_base 163struct client : zero_initialised, attachable
139{ 164{
140 enum Sock_Status status;
141 int ACC (RW, fd); 165 int ACC (RW, fd);
142 unsigned int inbuf_len; // number of bytes valid in inbuf 166 unsigned int inbuf_len; // number of bytes valid in inbuf
143 uint8 *faces_sent; // This is a bitmap on sent face status 167 statsinfo stats;
144 statsinfo stats; 168 int ACC (RO, active);
145 169
146 client_container cc_inv, cc_other; 170 Buffer outputbuffer;
147 171
148 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) */
149 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 */
150 Buffer outputbuffer;
151 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, afk); /* player is afk */
152 bool ACC (RW, facecache); /* If true, client is caching images */ 189 bool ACC (RW, facecache); /* If true, client is caching images */
153 bool ACC (RW, sent_scroll); 190 bool ACC (RW, sent_scroll);
154 bool ACC (RW, sound); /* does the client want sound */ 191 bool ACC (RW, sound); /* does the client want sound */
155 bool ACC (RW, exp64); /* Client wants 64 bit exp data, as well as skill data */
156 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ 192 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
157 bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ 193 bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */
158 bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ 194 bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */
159 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ 195 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */
160 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ 196 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */
161 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ 197 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */
198 bool ACC (RW, force_face0); /* CF+ client workaround for buggy checksum calculation in gcfclient */
199 bool ACC (RW, force_bad_checksum); /* CF+ client workaround for buggy checksum calculation in gcfclient */
162 bool ACC (RW, darkness); /* True if client wants darkness information */ 200 bool ACC (RW, darkness); /* True if client wants darkness information */
163 bool ACC (RW, image2); /* Client wants image2/face2 commands */ 201 bool ACC (RW, image2); /* Client wants image2/face2 commands */
164 bool ACC (RW, update_look); /* If true, we need to send the look window */ 202 bool ACC (RW, update_look); /* If true, we need to send the look window */
165 bool ACC (RW, has_readable_type); /* If true client accept additional text information */ 203 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
166 /* used to arrange text in books, scrolls, or scripted dialogs */ 204 /* used to arrange text in books, scrolls, or scripted dialogs */
… …
174 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ 212 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
175 enum MapMode mapmode; /* Type of map commands the client wants. */ 213 enum MapMode mapmode; /* Type of map commands the client wants. */
176 uint16 ACC (RW, look_position); /* start of drawing of look window */ 214 uint16 ACC (RW, look_position); /* start of drawing of look window */
177 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ 215 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
178 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ 216 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
179 uint8 ACC (RW, faceset); /* Set the client is using, default 0 */
180 217
181 maptile *ACC (RW, current_map); // CF+ last/current player map 218 maptile *ACC (RW, current_map); // CF+ last/current player map
219 region *ACC (RW, current_region); // CF+ last/current player region
182 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position 220 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
183 char ACC (RW, version)[64]; // CF+ client name/version 221 char ACC (RW, version)[64]; // CF+ client name/version
222 uint8 ACC (RW, faceset); // CF+ selected faceset
184 223
185 player *ACC (RO, pl);//TODO should not be here, preferably 224 player_ptr ACC (RO, pl);
186 225
187 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ 226 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
188 227
189 client (int fd, const char *from_ip);
190 ~client ();
191 void destroy (); 228 void do_destroy ();
229 void gather_callbacks (AV *&callbacks, event_type event) const;
192 230
231 iow socket_ev; void socket_cb (iow &w, int got);
193 iw cmd_ev; void cmd_cb (iw &w); 232 iw cmd_ev; void cmd_cb (iw &w);
194 iow socket_ev; void socket_cb (iow &w, int got); 233 client_container cc_inv, cc_other;
195 234
196 std::deque< command, slice_allocator<command> > cmd_queue; 235 std::deque< command, slice_allocator<command> > cmd_queue;
197 236
198 // resets movement state 237 // large structures at the end please
238 struct Map lastmap;
239 std::bitset<MAXANIMNUM> anims_sent;
240 std::bitset<MAX_FACES> faces_sent;
241
242 // if we get an incomplete packet, this is used to hold the data.
243 // we add 2 byte for the header, one for the trailing 0 byte
244 uint8 inbuf[MAXSOCKBUF + 2 + 1];
245
199 bool may_execute (const packet_type *pkt) const; 246 bool may_execute (const packet_type *pkt) const;
200 void execute (const packet_type *pkt, char *data, int datalen); 247 void execute (const packet_type *pkt, char *data, int datalen);
201 248
202 void queue_command (packet_type *handler, char *data, int datalen); 249 void queue_command (packet_type *handler, char *data, int datalen);
203 bool handle_command (); 250 MTH bool handle_command ();
251 // resets movement state
204 void reset_state (); 252 MTH void reset_state ();
253 // resets variable data used to send stat diffs
254 MTH void reset_stats ();
205 255
206 bool handle_packet (); 256 MTH bool handle_packet ();
207 int next_packet (); // returns length of packet or 0 257 int next_packet (); // returns length of packet or 0
208 void skip_packet (int len); // we have processed the packet, skip it 258 void skip_packet (int len); // we have processed the packet, skip it
209 259
210 void flush (); 260 MTH void flush ();
211 void write_outputbuffer (); 261 MTH void write_outputbuffer ();
212 void send (void *buf_, int len); 262 void send (void *buf_, int len);
213 263
214 void send_packet (const char *buf); 264 void send_packet (const char *buf);
215 void send_packet (const char *buf, int len); 265 void send_packet (const char *buf, int len);
216 void send_packet_printf (const char *format, ...); 266 void send_packet_printf (const char *format, ...);
217 void send_packet (packet &sl); 267 void send_packet (packet &sl);
218 268
269 void send_drawinfo (const char *msg, int flags = NDI_BLACK);
270 MTH void send_face (faceidx facenum, bool nocache = false);
271 MTH void send_faces (object *ob);
272 MTH void send_animation (short anim_num);
273
219 // called when something under the player changes 274 // called when something under the player changes
220 void floorbox_update () { update_look = 1; } 275 MTH void floorbox_update () { update_look = 1; }
221 // called when the player has been moved 276 // called when the player has been moved
222 void floorbox_reset () { look_position = 0; floorbox_update (); } 277 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
223 278
224 // large structures at the end please 279 MTH static client *create (int fd, const char *peername);
225 struct Map lastmap; 280
226 std::bitset<MAXANIMNUM> anims_sent; 281protected:
227 // if we get an incomplete packet, this is used to hold the data. 282 client (int fd, const char *from_ip);
228 // we add 2 byte for the header, one for the trailing 0 byte 283 ~client ();
229 uint8 inbuf[MAXSOCKBUF + 2 + 1];
230}; 284};
231 285
232#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 286#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
233 ( ((__type)>0) &&\ 287 ( ((__type)>0) &&\
234 ((__sockPtr)->has_readable_type) && \ 288 ((__sockPtr)->has_readable_type) && \
235 ((__sockPtr)->supported_readables & (1<<(__type))) ) 289 ((__sockPtr)->supported_readables & (1<<(__type))) )
236
237/* Bitmask for the faces_sent[] array - what
238 * portion of the face have we sent?
239 */
240#define NS_FACESENT_FACE 0x1
241#define NS_FACESENT_SMOOTH 0x2
242 290
243/* Constants in the form EMI_ is for extended map infos. 291/* Constants in the form EMI_ is for extended map infos.
244 * Even if the client select the additionnal infos it wants 292 * Even if the client select the additionnal infos it wants
245 * on the map, there may exist cases where this whole info 293 * on the map, there may exist cases where this whole info
246 * is not given in one buch but in separate bunches. This 294 * is not given in one buch but in separate bunches. This
… …
268 316
269#define FACE_TYPES 1 317#define FACE_TYPES 1
270#define PNG_FACE_INDEX 0 318#define PNG_FACE_INDEX 0
271 319
272#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 320#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
273#define VERSION_SC 1027 321#define VERSION_SC 1026
322//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
274#define VERSION_INFO "Crossfire+ Server" 323#define VERSION_INFO "Crossfire+ Server"
275 324
276typedef unordered_vector<client *> sockvec; 325typedef object_vector<client, &client::active> sockvec;
277 326
278extern sockvec clients; 327extern sockvec clients;
279extern int nrofpixmaps; //TODO: hrmpf, should go 328
329#define for_all_clients(var) \
330 for (int _i = 0; _i < clients.size (); ++_i) \
331 declvar (client *, var, clients [_i])
280 332
281#endif 333#endif
282 334

Diff Legend

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