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.3 by root, Fri Dec 15 20:08:45 2006 UTC vs.
Revision 1.42 by root, Mon Apr 2 18:04:46 2007 UTC

1
2/* 1/*
3 CrossFire, A Multiplayer game for the X Window System 2 * CrossFire, A Multiplayer game for the X Window System
4 3 *
4 * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team
5 Copyright (C) 2002 Mark Wedel & Crossfire Development Team 5 * Copyright (C) 2002 Mark Wedel & Crossfire Development Team
6 Copyright (C) 1992 Frank Tore Johansen 6 * Copyright (C) 1992 Frank Tore Johansen
7 7 *
8 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
9 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
10 the Free Software Foundation; either version 2 of the License, or 10 * the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version. 11 * (at your option) any later version.
12 12 *
13 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,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details. 16 * GNU General Public License for more details.
17 17 *
18 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
19 along with this program; if not, write to the Free Software 19 * along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 21 *
22 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
23*/ 23 */
24
25/*
26 newserver.h defines various structures and values that are use for the
27 new client server communication method. Values defined here are only
28 used on the server side code. For shared client/server values, see
29 newclient.h
30*/
31 24
32#ifndef CLIENT_H 25#ifndef CLIENT_H
33#define CLIENT_H 26#define CLIENT_H
34 27
35/* Reduce this from 50 to 5 - as it is now, there will never be more 28#include <deque>
36 * than 3 anyways. 29#include <bitset>
37 */ 30#include <tr1/unordered_set>
38 31
39#define NUM_LOOK_OBJECTS 50 32// (possibly) max. number of objects "per page" in the ground container
33#define FLOORBOX_PAGESIZE 50
40 34
41struct MapCell 35struct MapCell
42{ 36{
43 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
44 int count; /* This is really darkness in the map1 command */ 38 int count; /* This is really darkness in the map1 command */
45 uint16 faces[MAP_LAYERS]; 39 faceidx faces[MAP_LAYERS];
46 uint16 smooth[MAP_LAYERS];
47 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
48 unsigned char flags; 41 unsigned char flags;
42 uint8_t smooth[MAP_LAYERS];
49}; 43};
50 44
51/* This basically defines the largest size an
52 * archetype may be - it is used for allocation of
53 * some structures, as well as determining how far
54 * we should look for the heads of big images.
55 */
56#define MAX_HEAD_OFFSET 8
57
58#define MAX_CLIENT_X (MAP_CLIENT_X + MAX_HEAD_OFFSET) 45#define MAX_CLIENT_X MAP_CLIENT_X
59#define MAX_CLIENT_Y (MAP_CLIENT_Y + MAX_HEAD_OFFSET) 46#define MAX_CLIENT_Y MAP_CLIENT_Y
60 47
61struct Map 48struct Map
62{ 49{
63 struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y]; 50 struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y];
64}; 51};
65 52
66/* True max is 16383 given current map compaction method */ 53/* True max is 16383 given current map compaction method */
67# define MAXANIMNUM 2000 54#define MAXANIMNUM 10000
68 55
69struct statsinfo 56struct statsinfo
70{ 57{
71 char *range, *title; 58 char *range, *title;
72}; 59};
… …
75 * 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
76 * 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
77 * are using. 64 * are using.
78 */ 65 */
79 66
80enum Sock_Status { Ns_Add, Ns_Dead };
81
82/* 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
83 * instead of having a bunch of different fields that needed to 68 * instead of having a bunch of different fields that needed to
84 * get toggled. 69 * get toggled.
85 */ 70 */
86enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; 71enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
87 72
88/* 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
89 * data that the OS can't handle right away. 74 * data that the OS can't handle right away.
90 */ 75 */
91
92struct Buffer 76struct Buffer
93{ 77{
94 char data[SOCKETBUFSIZE]; 78 char data[SOCKETBUFSIZE];
95 int start; 79 int start;
96 int len; 80 int len;
97}; 81};
98 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
94// a handler for a specific type of packet
95enum {
96 PF_PLAYER = 0x01, // must have valid player / will by synchronised
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
100};
101
102struct packet_type
103{
104 const char *name;
105 void *cb;
106 int flags;
107};
108
109struct command
110{
111 tstamp stamp;
112 const packet_type *handler;
113 char *data;
114 int datalen;
115
116 ~command ()
117 {
118 sfree<char> (data, datalen + 1);
119 }
120};
121
122struct refitem
123{
124 object_ptr op;
125};
126
127// this represents a container on the client side.
128// right now, there are only ever two of them:
129// the inventory and the floor/open container
130//TODO: unused as of yet
131struct client_container : vector< refitem, slice_allocator<refitem> >
132{
133 client *ns;
134 enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type;
135
136 bool item_changed; // one of the items in here possibly changed
137
138 // for mapspace and container
139 int x, y;
140 maptile *map;
141
142 // for container
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);
157};
158
99/* 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. */
100#define MAX_PASSWORD_FAILURES 5 160#define MAX_PASSWORD_FAILURES 5
101 161
102ACC_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
103struct client : zero_initialised, attachable_base 163struct client : zero_initialised, attachable
104{ 164{
105 enum Sock_Status status;
106 int ACC (RW, fd); 165 int ACC (RW, fd);
107 unsigned int inbuf_len; // number of bytes valid in inbuf 166 unsigned int inbuf_len; // number of bytes valid in inbuf
108 struct Map lastmap;
109 size_t faces_sent_len; /* This is the number of elements allocated in faces_sent[] */
110 uint8 *faces_sent; /* This is a bitmap on sent face status */
111 uint8 anims_sent[MAXANIMNUM];
112 struct statsinfo stats; 167 statsinfo stats;
168 int ACC (RO, active);
169
170 Buffer outputbuffer;
113 171
114 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) */
115 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 */
116 Buffer outputbuffer; /* For undeliverable data */
117 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 */
118 bool ACC (RW, facecache); /* If true, client is caching images */ 194 bool ACC (RW, facecache); /* If true, client is caching images */
119 bool ACC (RW, sent_scroll); 195 bool ACC (RW, sent_scroll);
120 bool ACC (RW, sound); /* does the client want sound */ 196 bool ACC (RW, sound); /* does the client want sound */
121 bool ACC (RW, exp64); /* Client wants 64 bit exp data, as well as skill data */
122 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 */
123 bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ 198 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
124 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
125 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ 200 bool ACC (RW, extcmd); // call into extensions/plugins
126 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ 201 bool ACC (RW, extmap); // extend map comamnd with extra data
127 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ 202 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls
128 bool ACC (RW, darkness); /* True if client wants darkness information */ 203 bool ACC (RW, darkness); /* True if client wants darkness information */
129 bool ACC (RW, image2); /* Client wants image2/face2 commands */ 204 bool ACC (RW, image2); /* Client wants image2/face2 commands */
130 bool ACC (RW, update_look); /* If true, we need to send the look window */ 205 bool ACC (RW, update_look); /* If true, we need to send the look window */
131 bool ACC (RW, has_readable_type); /* If true client accept additional text information */ 206 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
132 /* used to arrange text in books, scrolls, or scripted dialogs */ 207 /* used to arrange text in books, scrolls, or scripted dialogs */
133 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ 208 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
134 bool ACC (RW, ext_mapinfos); /* If true client accept additionnal info on maps */ 209 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
135 /* Below are flags for extedend infos to pass to client 210 /* Below are flags for extedend infos to pass to client
136 * with S->C mapextended command */ 211 * with S->C mapextended command */
137 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ 212 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
138 213
214 bool ACC (RW, force_newmap); // force a newmap before next map update
139 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ 215 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
140 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ 216 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
141 enum MapMode mapmode; /* Type of map commands the client wants. */
142 uint16 ACC (RW, look_position); /* start of drawing of look window */ 217 uint16 ACC (RW, look_position); /* start of drawing of look window */
218 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
143 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ 219 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
144 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ 220 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
145 uint8 ACC (RW, faceset); /* Set the client is using, default 0 */
146 221
147 maptile *ACC (RW, current_map); // CF+ last/current player map 222 maptile *ACC (RW, current_map); // CF+ last/current player map
223 region *ACC (RW, current_region); // CF+ last/current player region
148 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position 224 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
149 char ACC (RW, version)[64]; // CF+ client name/version 225 char ACC (RW, version)[64]; // CF+ client name/version
226 uint8 ACC (RW, faceset); // CF+ selected faceset
150 227
151 /* If we get an incomplete packet, this is used to hold the data. */ 228 player_ptr ACC (RO, pl);
152 uint8 inbuf[MAXSOCKBUF];
153 player *ACC (RO, pl);//TODO should not be here, preferably
154 229
155 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ 230 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
231
232 int ACC (RW, max_rate); // max. # of bytes to send per tick
233 faceidx ACC (RW, scrub_idx); // which face to send next
234 int ACC (RW, bg_scrub); // how many ticks till the next background face send
235 std::vector<faceidx> askface; // which faces have been requested by the client
236
237 void do_destroy ();
238 void gather_callbacks (AV *&callbacks, event_type event) const;
156 239
157 iow socket_ev; void socket_cb (iow &w, int got); 240 iow socket_ev; void socket_cb (iow &w, int got);
241 iw cmd_ev; void cmd_cb (iw &w);
242 client_container cc_inv, cc_other;
158 243
244 std::deque< command, slice_allocator<command> > cmd_queue;
245
246 // large structures at the end please
247 struct Map lastmap;
248 std::bitset<MAXANIMNUM> anims_sent;
249 std::bitset<MAX_FACES> faces_sent;
250
251 // if we get an incomplete packet, this is used to hold the data.
252 // we add 2 byte for the header, one for the trailing 0 byte
253 uint8 inbuf[MAXSOCKBUF + 2 + 1];
254
255 bool may_execute (const packet_type *pkt) const;
256 void execute (const packet_type *pkt, char *data, int datalen);
257
258 void queue_command (packet_type *handler, char *data, int datalen);
259 MTH bool handle_command ();
260 // resets movement state
261 MTH void reset_state ();
262 // resets variable data used to send stat diffs
263 MTH void reset_stats ();
264
265 MTH bool handle_packet ();
266 int next_packet (); // returns length of packet or 0
267 void skip_packet (int len); // we have processed the packet, skip it
268
269 MTH void flush ();
270 MTH void write_outputbuffer ();
271 MTH int outputbuffer_len () const { return outputbuffer.len; }
272 void send (void *buf_, int len);
273
274 void send_packet (const char *buf);
275 void send_packet (const char *buf, int len);
276 void send_packet_printf (const char *format, ...);
277 void send_packet (packet &sl);
278
279 void send_drawinfo (const char *msg, int flags = NDI_BLACK);
280 MTH void send_face (faceidx facenum);
281 MTH void send_image (faceidx facenum);
282 MTH void send_faces (object *ob);
283 MTH void send_animation (short anim_num);
284
285 // called when something under the player changes
286 MTH void floorbox_update () { update_look = 1; }
287 // called when the player has been moved
288 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
289
290 MTH void tick (); // called every server tick to do housekeeping etc.
291
292 MTH static client *create (int fd, const char *peername);
293
294protected:
159 client (int fd, const char *from_ip); 295 client (int fd, const char *from_ip);
160 ~client (); 296 ~client ();
161
162 int read_packet (); // returns length of packet or 0
163 void skip_packet (int len); // we have processed the packet, skip it
164
165 void flush ();
166 void write_outputbuffer ();
167 void send (void *buf_, int len);
168
169 void send_packet (const char *buf);
170 void send_packet (const char *buf, int len);
171 void send_packet (packet &sl);
172}; 297};
173 298
174#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 299#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
175 ( ((__type)>0) &&\ 300 ( ((__type)>0) &&\
176 ((__sockPtr)->has_readable_type) && \ 301 ((__sockPtr)->has_readable_type) && \
177 ((__sockPtr)->supported_readables & (1<<(__type))) ) 302 ((__sockPtr)->supported_readables & (1<<(__type))) )
178
179/* Bitmask for the faces_sent[] array - what
180 * portion of the face have we sent?
181 */
182#define NS_FACESENT_FACE 0x1
183#define NS_FACESENT_SMOOTH 0x2
184 303
185/* Constants in the form EMI_ is for extended map infos. 304/* Constants in the form EMI_ is for extended map infos.
186 * Even if the client select the additionnal infos it wants 305 * Even if the client select the additionnal infos it wants
187 * on the map, there may exist cases where this whole info 306 * on the map, there may exist cases where this whole info
188 * is not given in one buch but in separate bunches. This 307 * is not given in one buch but in separate bunches. This
… …
210 329
211#define FACE_TYPES 1 330#define FACE_TYPES 1
212#define PNG_FACE_INDEX 0 331#define PNG_FACE_INDEX 0
213 332
214#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 333#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
215#define VERSION_SC 1027 334#define VERSION_SC 1026
335//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
216#define VERSION_INFO "Crossfire+ Server" 336#define VERSION_INFO "Crossfire+ Server"
217 337
218typedef unordered_vector<client *> sockvec; 338typedef object_vector<client, &client::active> sockvec;
219 339
220extern sockvec clients; 340extern sockvec clients;
221extern int nrofpixmaps; //TODO: hrmpf, should go 341
342#define for_all_clients(var) \
343 for (int _i = 0; _i < clients.size (); ++_i) \
344 declvar (client *, var, clients [_i])
222 345
223#endif 346#endif
224 347

Diff Legend

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