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.32 by root, Sun Mar 11 02:12:44 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]; 40 uint16 smooth[MAP_LAYERS];
47 unsigned char stat_hp; // health of something in this space, or 0 41 unsigned char stat_hp; // health of something in this space, or 0
48 unsigned char flags; 42 unsigned char flags;
49}; 43};
50 44
… …
75 * current state. we set up our on buffers for sending/receiving, so we can 69 * 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 70 * handle some higher level functions. fd is the actual file descriptor we
77 * are using. 71 * are using.
78 */ 72 */
79 73
80enum Sock_Status { Ns_Add, Ns_Dead };
81
82/* Only one map mode can actually be used, so lets make it a switch 74/* 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 75 * instead of having a bunch of different fields that needed to
84 * get toggled. 76 * get toggled.
85 */ 77 */
86enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; 78enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
87 79
88/* The following is the setup for a ring buffer for storing outbut 80/* The following is the setup for a ring buffer for storing output
89 * data that the OS can't handle right away. 81 * data that the OS can't handle right away.
90 */ 82 */
91
92struct Buffer 83struct Buffer
93{ 84{
94 char data[SOCKETBUFSIZE]; 85 char data[SOCKETBUFSIZE];
95 int start; 86 int start;
96 int len; 87 int len;
97}; 88};
98 89
90// states the socket can be in
91enum {
92 ST_DEAD, // socket is dead
93 ST_SETUP, // initial handshake / setup / login
94 ST_PLAYING, // logged in an playing
95 ST_CUSTOM, // waiting for custom reply
96
97 ST_CHANGE_CLASS,
98 ST_GET_PARTY_PASSWORD,
99};
100
101// a handler for a specific type of packet
102enum {
103 PF_PLAYER = 0x01, // must have valid player / will by synchronised
104 PF_PLAYING = 0x02, // must be in playing state
105 PF_COMMAND0 = 0x04, // command starts at offset 0
106 PF_COMMAND6 = 0x08, // command starts at offset 6
107};
108
109struct packet_type
110{
111 const char *name;
112 void *cb;
113 int flags;
114};
115
116struct command
117{
118 tstamp stamp;
119 const packet_type *handler;
120 char *data;
121 int datalen;
122
123 ~command ()
124 {
125 sfree<char> (data, datalen + 1);
126 }
127};
128
129struct refitem
130{
131 object_ptr op;
132};
133
134// this represents a container on the client side.
135// right now, there are only ever two of them:
136// the inventory and the floor/open container
137//TODO: unused as of yet
138struct client_container : vector< refitem, slice_allocator<refitem> >
139{
140 client *ns;
141 enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type;
142
143 bool item_changed; // one of the items in here possibly changed
144
145 // for mapspace and container
146 int x, y;
147 maptile *map;
148
149 // for container
150 object *env;
151
152 client_container (client *ns)
153 : ns (ns), type (CC_NONE) { }
154
155 tag_t tag () const;
156
157 inline iterator merge_item (iterator i, object *op);
158
159 void clear ();
160 void update ();
161
162 void set_mapspace (maptile *map, int x, int y);
163 void set_container (object *env);
164};
165
99/* how many times we are allowed to give the wrong password before being kicked. */ 166/* how many times we are allowed to give the wrong password before being kicked. */
100#define MAX_PASSWORD_FAILURES 5 167#define MAX_PASSWORD_FAILURES 5
101 168
102ACC_CLASS (client) // should become player when newsocket is a baseclass of player 169INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
103struct client : zero_initialised, attachable_base 170struct client : zero_initialised, attachable
104{ 171{
105 enum Sock_Status status;
106 int ACC (RW, fd); 172 int ACC (RW, fd);
107 unsigned int inbuf_len; // number of bytes valid in inbuf 173 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; 174 statsinfo stats;
175 int ACC (RO, active);
176
177 Buffer outputbuffer;
113 178
114 char *ACC (RW, host); /* Which host it is connected from (ip address) */ 179 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 */ 180 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
116 Buffer outputbuffer; /* For undeliverable data */
117 181
182 sint8 ACC (RW, last_level); /* Last level we sent to client */
183 uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */
184 float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */
185 sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */
186 sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */
187 uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */
188 uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */
189 uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */
190 living ACC (RO, last_stats); /* Last stats as sent to client */
191 float ACC (RW, last_speed); /* Last speed as sent to client */
192 sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
193 sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */
194
195 bool ACC (RW, afk); /* player is afk */
118 bool ACC (RW, facecache); /* If true, client is caching images */ 196 bool ACC (RW, facecache); /* If true, client is caching images */
119 bool ACC (RW, sent_scroll); 197 bool ACC (RW, sent_scroll);
120 bool ACC (RW, sound); /* does the client want sound */ 198 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 */ 199 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 */ 200 bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */
124 bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ 201 bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */
125 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ 202 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */
126 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ 203 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */
127 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ 204 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */
128 bool ACC (RW, darkness); /* True if client wants darkness information */ 205 bool ACC (RW, darkness); /* True if client wants darkness information */
129 bool ACC (RW, image2); /* Client wants image2/face2 commands */ 206 bool ACC (RW, image2); /* Client wants image2/face2 commands */
130 bool ACC (RW, update_look); /* If true, we need to send the look window */ 207 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 */ 208 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
132 /* used to arrange text in books, scrolls, or scripted dialogs */ 209 /* 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 */ 210 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 */ 211 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
135 /* Below are flags for extedend infos to pass to client 212 /* Below are flags for extedend infos to pass to client
136 * with S->C mapextended command */ 213 * with S->C mapextended command */
137 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ 214 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
138 215
139 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 */
140 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 */
141 enum MapMode mapmode; /* Type of map commands the client wants. */ 218 enum MapMode mapmode; /* Type of map commands the client wants. */
142 uint16 ACC (RW, look_position); /* start of drawing of look window */ 219 uint16 ACC (RW, look_position); /* start of drawing of look window */
143 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ 220 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 */ 221 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 222
147 maptile *ACC (RW, current_map); // CF+ last/current player map 223 maptile *ACC (RW, current_map); // CF+ last/current player map
224 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 225 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
149 char ACC (RW, version)[64]; // CF+ client name/version 226 char ACC (RW, version)[64]; // CF+ client name/version
227 uint8 ACC (RW, faceset); // CF+ selected faceset
150 228
151 /* If we get an incomplete packet, this is used to hold the data. */ 229 player_ptr ACC (RO, pl);
152 uint8 inbuf[MAXSOCKBUF];
153 player *ACC (RO, pl);//TODO should not be here, preferably
154 230
155 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ 231 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
156 232
233 void do_destroy ();
234 void gather_callbacks (AV *&callbacks, event_type event) const;
235
157 iow socket_ev; void socket_cb (iow &w, int got); 236 iow socket_ev; void socket_cb (iow &w, int got);
237 iw cmd_ev; void cmd_cb (iw &w);
238 client_container cc_inv, cc_other;
158 239
240 std::deque< command, slice_allocator<command> > cmd_queue;
241
242 // large structures at the end please
243 struct Map lastmap;
244 std::bitset<MAXANIMNUM> anims_sent;
245 uint8 ACC (RW, faces_sent[MAX_FACES]); // This is a bitmap on sent face status
246 // if we get an incomplete packet, this is used to hold the data.
247 // we add 2 byte for the header, one for the trailing 0 byte
248 uint8 inbuf[MAXSOCKBUF + 2 + 1];
249
250 bool may_execute (const packet_type *pkt) const;
251 void execute (const packet_type *pkt, char *data, int datalen);
252
253 void queue_command (packet_type *handler, char *data, int datalen);
254 MTH bool handle_command ();
255 // resets movement state
256 MTH void reset_state ();
257 // resets variable data used to send stat diffs
258 MTH void reset_stats ();
259
260 MTH bool handle_packet ();
261 int next_packet (); // returns length of packet or 0
262 void skip_packet (int len); // we have processed the packet, skip it
263
264 MTH void flush ();
265 MTH void write_outputbuffer ();
266 void send (void *buf_, int len);
267
268 void send_packet (const char *buf);
269 void send_packet (const char *buf, int len);
270 void send_packet_printf (const char *format, ...);
271 void send_packet (packet &sl);
272
273 // called when something under the player changes
274 MTH void floorbox_update () { update_look = 1; }
275 // called when the player has been moved
276 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
277
278 MTH static client *create (int fd, const char *peername);
279
280protected:
159 client (int fd, const char *from_ip); 281 client (int fd, const char *from_ip);
160 ~client (); 282 ~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}; 283};
173 284
174#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 285#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
175 ( ((__type)>0) &&\ 286 ( ((__type)>0) &&\
176 ((__sockPtr)->has_readable_type) && \ 287 ((__sockPtr)->has_readable_type) && \
… …
210 321
211#define FACE_TYPES 1 322#define FACE_TYPES 1
212#define PNG_FACE_INDEX 0 323#define PNG_FACE_INDEX 0
213 324
214#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 325#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
215#define VERSION_SC 1027 326#define VERSION_SC 1026
327//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
216#define VERSION_INFO "Crossfire+ Server" 328#define VERSION_INFO "Crossfire+ Server"
217 329
218typedef unordered_vector<client *> sockvec; 330typedef object_vector<client, &client::active> sockvec;
219 331
220extern sockvec clients; 332extern sockvec clients;
221extern int nrofpixmaps; //TODO: hrmpf, should go 333
334#define for_all_clients(var) \
335 for (int _i = 0; _i < clients.size (); ++_i) \
336 declvar (client *, var, clients [_i])
222 337
223#endif 338#endif
224 339

Diff Legend

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