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.33 by root, Mon Mar 12 01:13:10 2007 UTC vs.
Revision 1.52 by root, Mon Jun 4 12:19:08 2007 UTC

1/* 1/*
2 * CrossFire, A Multiplayer game for the X Window System 2 * This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game.
3 * 3 *
4 * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team 4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
5 * Copyright (C) 2002 Mark Wedel & Crossfire Development Team 5 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
6 * Copyright (C) 1992 Frank Tore Johansen 6 * Copyright (©) 1992,2007 Frank Tore Johansen
7 * 7 *
8 * This program is free software; you can redistribute it and/or modify 8 * Crossfire TRT is free software; you can redistribute it and/or modify it
9 * it under the terms of the GNU General Public License as published by 9 * under the terms of the GNU General Public License as published by the Free
10 * the Free Software Foundation; either version 2 of the License, or 10 * Software Foundation; either version 2 of the License, or (at your option)
11 * (at your option) any later version. 11 * 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, but
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 * GNU General Public License for more details. 16 * 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 along
19 * along with this program; if not, write to the Free Software 19 * with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 20 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 * 21 *
22 * The author can be reached via e-mail to crossfire@schmorp.de 22 * The authors can be reached via e-mail to <crossfire@schmorp.de>
23 */ 23 */
24 24
25#ifndef CLIENT_H 25#ifndef CLIENT_H
26#define CLIENT_H 26#define CLIENT_H
27 27
… …
32// (possibly) max. number of objects "per page" in the ground container 32// (possibly) max. number of objects "per page" in the ground container
33#define FLOORBOX_PAGESIZE 50 33#define FLOORBOX_PAGESIZE 50
34 34
35struct MapCell 35struct MapCell
36{ 36{
37 UUID player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient 37 tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
38 int count; /* This is really darkness in the map1 command */ 38 int count; /* This is really darkness in the map1 command */
39 faceidx faces[MAP_LAYERS]; 39 faceidx faces[MAP_LAYERS];
40 uint16 smooth[MAP_LAYERS];
41 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
42 unsigned char flags; 41 unsigned char flags;
42 uint8_t smooth[MAP_LAYERS];
43}; 43};
44 44
45#define MAX_CLIENT_X MAP_CLIENT_X 45#define MAX_CLIENT_X MAP_CLIENT_X
46#define MAX_CLIENT_Y MAP_CLIENT_Y 46#define MAX_CLIENT_Y MAP_CLIENT_Y
47 47
… …
66 66
67/* 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
68 * instead of having a bunch of different fields that needed to 68 * instead of having a bunch of different fields that needed to
69 * get toggled. 69 * get toggled.
70 */ 70 */
71enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; 71enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
72
73/* The following is the setup for a ring buffer for storing output
74 * data that the OS can't handle right away.
75 */
76struct Buffer
77{
78 char data[SOCKETBUFSIZE];
79 int start;
80 int len;
81};
82 72
83// states the socket can be in 73// states the socket can be in
84enum { 74enum {
85 ST_DEAD, // socket is dead 75 ST_DEAD, // socket is dead
86 ST_SETUP, // initial handshake / setup / login 76 ST_SETUP, // initial handshake / setup / login
87 ST_PLAYING, // logged in an playing 77 ST_PLAYING, // logged in an playing
88 ST_CUSTOM, // waiting for custom reply 78 ST_CUSTOM, // waiting for custom reply
89 79
90 ST_CHANGE_CLASS,
91 ST_GET_PARTY_PASSWORD, 80 ST_GET_PARTY_PASSWORD,
92}; 81};
93 82
94// a handler for a specific type of packet 83// a handler for a specific type of packet
95enum { 84enum {
… …
117 { 106 {
118 sfree<char> (data, datalen + 1); 107 sfree<char> (data, datalen + 1);
119 } 108 }
120}; 109};
121 110
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
159/* how many times we are allowed to give the wrong password before being kicked. */ 111/* how many times we are allowed to give the wrong password before being kicked. */
160#define MAX_PASSWORD_FAILURES 5 112#define MAX_PASSWORD_FAILURES 5
161 113
162INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player 114INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
163struct client : zero_initialised, attachable 115struct client : zero_initialised, attachable
… …
165 int ACC (RW, fd); 117 int ACC (RW, fd);
166 unsigned int inbuf_len; // number of bytes valid in inbuf 118 unsigned int inbuf_len; // number of bytes valid in inbuf
167 statsinfo stats; 119 statsinfo stats;
168 int ACC (RO, active); 120 int ACC (RO, active);
169 121
170 Buffer outputbuffer; 122 /* The following is the setup for a ring buffer for storing output
123 * data that the OS can't handle right away.
124 */
125 struct
126 {
127 char data[SOCKETBUFSIZE];
128 int start;
129 int len;
130 } outputbuffer;
171 131
172 char *ACC (RW, host); /* Which host it is connected from (ip address) */ 132 char *ACC (RW, host); /* Which host it is connected from (ip address) */
173 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ 133 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
174 134
175 sint8 ACC (RW, last_level); /* Last level we sent to client */ 135 sint8 ACC (RW, last_level); /* Last level we sent to client */
… …
183 living ACC (RO, last_stats); /* Last stats as sent to client */ 143 living ACC (RO, last_stats); /* Last stats as sent to client */
184 float ACC (RW, last_speed); /* Last speed as sent to client */ 144 float ACC (RW, last_speed); /* Last speed as sent to client */
185 sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ 145 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 */ 146 sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */
187 147
148 bool ACC (RW, force_face0); // client workaround for buggy checksum calculation in gcfclient
149 bool ACC (RW, force_bad_checksum); // client workaround for buggy checksum calculation in gcfclient
150 bool ACC (RW, force_image_newmap); // client workaround for client not redrawing map on image upload
151 bool ACC (RW, enable_bg_scrub); // client workaround, gcfclient becomes unusable if you send it images
152
188 bool ACC (RW, afk); /* player is afk */ 153 bool ACC (RW, afk); /* player is afk */
189 bool ACC (RW, facecache); /* If true, client is caching images */ 154 bool ACC (RW, facecache); /* If true, client is caching images */
190 bool ACC (RW, sent_scroll); 155 bool ACC (RW, sent_scroll);
191 bool ACC (RW, sound); /* does the client want sound */ 156 bool ACC (RW, sound); /* does the client want sound */
192 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ 157 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
193 bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ 158 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
194 bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ 159 bool ACC (RW, mapinfocmd); // return map info and send map change info
195 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ 160 bool ACC (RW, extcmd); // call into extensions/plugins
196 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ 161 bool ACC (RW, extmap); // extend map comamnd with extra data
197 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ 162 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls
198 bool ACC (RW, darkness); /* True if client wants darkness information */ 163 bool ACC (RW, darkness); /* True if client wants darkness information */
199 bool ACC (RW, image2); /* Client wants image2/face2 commands */ 164 bool ACC (RW, image2); /* Client wants image2/face2 commands */
165 bool ACC (RW, fxix); // client implements fx and ix (face|image extended) commands
200 bool ACC (RW, update_look); /* If true, we need to send the look window */ 166 bool ACC (RW, update_look); /* If true, we need to send the look window */
201 bool ACC (RW, has_readable_type); /* If true client accept additional text information */ 167 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
202 /* used to arrange text in books, scrolls, or scripted dialogs */ 168 /* used to arrange text in books, scrolls, or scripted dialogs */
203 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ 169 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
204 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ 170 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
205 /* Below are flags for extedend infos to pass to client 171 /* Below are flags for extedend infos to pass to client
206 * with S->C mapextended command */ 172 * with S->C mapextended command */
207 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ 173 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
174 bool ACC (RW, smoothing); // trt-style smoothing
175 bool ACC (RW, can_msg); // trt-style text messages
208 176
177 bool ACC (RW, force_newmap); // force a newmap before next map update
209 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ 178 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
210 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ 179 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
211 enum MapMode mapmode; /* Type of map commands the client wants. */
212 uint16 ACC (RW, look_position); /* start of drawing of look window */ 180 uint16 ACC (RW, look_position); /* start of drawing of look window */
181 uint16 ACC (RW, mss); // likely tcp maximum segment size
182 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
213 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ 183 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
214 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ 184 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
215 185
216 maptile *ACC (RW, current_map); // CF+ last/current player map 186 maptile *ACC (RW, current_map); // CF+ last/current player map
217 region *ACC (RW, current_region); // CF+ last/current player region 187 region *ACC (RW, current_region); // CF+ last/current player region
218 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position 188 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
219 char ACC (RW, version)[64]; // CF+ client name/version 189 shstr ACC (RW, version); // CF+ client name/version
220 uint8 ACC (RW, faceset); // CF+ selected faceset 190 uint8 ACC (RW, faceset); // CF+ selected faceset
221 191
222 player_ptr ACC (RO, pl); 192 player_ptr ACC (RO, pl);
223 193
224 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ 194 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
195
196 int ACC (RW, rate_avail); // current rate balance
197 int ACC (RW, max_rate); // max. # of bytes to send per tick
198 faceidx ACC (RW, scrub_idx); // which face to send next
199 int ACC (RW, bg_scrub); // how many ticks till the next background face send
200
201 faceidx partial_face;
202 uint32 partial_face_ofs; // if != 0, need to send remaining bytes of partial_face
203 std::vector<faceidx, slice_allocator<faceidx> > askface; // which faces have been requested by the client
204
205 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
206 MTH void flush_fx (); // send fx if required
225 207
226 void do_destroy (); 208 void do_destroy ();
227 void gather_callbacks (AV *&callbacks, event_type event) const; 209 void gather_callbacks (AV *&callbacks, event_type event) const;
228 210
229 iow socket_ev; void socket_cb (iow &w, int got); 211 iow socket_ev; void socket_cb (iow &w, int got);
230 iw cmd_ev; void cmd_cb (iw &w); 212 iw cmd_ev; void cmd_cb (iw &w);
231 client_container cc_inv, cc_other;
232 213
233 std::deque< command, slice_allocator<command> > cmd_queue; 214 std::deque< command, slice_allocator<command> > cmd_queue;
234 215
235 // large structures at the end please 216 // large structures at the end please
236 struct Map lastmap; 217 struct Map lastmap;
237 std::bitset<MAXANIMNUM> anims_sent; 218 std::bitset<MAXANIMNUM> anims_sent;
238 uint8 ACC (RW, faces_sent[MAX_FACES]); // This is a bitmap on sent face status 219 std::bitset<MAX_FACES> faces_sent;
220
239 // if we get an incomplete packet, this is used to hold the data. 221 // if we get an incomplete packet, this is used to hold the data.
240 // we add 2 byte for the header, one for the trailing 0 byte 222 // we add 2 byte for the header, one for the trailing 0 byte
241 uint8 inbuf[MAXSOCKBUF + 2 + 1]; 223 uint8 inbuf[MAXSOCKBUF + 2 + 1];
224
225 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
226 struct msg_buf
227 {
228 tick_t expire;
229 int len;
230 int count;
231 char msg[MSG_BUF_SIZE];
232 } msgbuf[MSG_BUF_COUNT];
233
234 MTH bool msg_suppressed (const char *msg);
242 235
243 bool may_execute (const packet_type *pkt) const; 236 bool may_execute (const packet_type *pkt) const;
244 void execute (const packet_type *pkt, char *data, int datalen); 237 void execute (const packet_type *pkt, char *data, int datalen);
245 238
246 void queue_command (packet_type *handler, char *data, int datalen); 239 void queue_command (packet_type *handler, char *data, int datalen);
… …
254 int next_packet (); // returns length of packet or 0 247 int next_packet (); // returns length of packet or 0
255 void skip_packet (int len); // we have processed the packet, skip it 248 void skip_packet (int len); // we have processed the packet, skip it
256 249
257 MTH void flush (); 250 MTH void flush ();
258 MTH void write_outputbuffer (); 251 MTH void write_outputbuffer ();
252 MTH int outputbuffer_len () const { return outputbuffer.len; }
259 void send (void *buf_, int len); 253 void send (void *buf_, int len);
260 254
261 void send_packet (const char *buf); 255 void send_packet (const char *buf);
262 void send_packet (const char *buf, int len); 256 void send_packet (const char *buf, int len);
263 void send_packet_printf (const char *format, ...); 257 void send_packet_printf (const char *format, ...);
264 void send_packet (packet &sl); 258 void send_packet (packet &sl);
265 259
260 void send_drawinfo (const char *msg, int flags = NDI_BLACK);
261 MTH void send_face (faceidx facenum);
262 MTH void send_image (faceidx facenum);
263 MTH void send_faces (object *ob);
264 MTH void send_animation (short anim_num);
265 MTH void send_msg (int color, const char *type, const char *msg);
266
266 // called when something under the player changes 267 // called when something under the player changes
267 MTH void floorbox_update () { update_look = 1; } 268 MTH void floorbox_update () { update_look = 1; }
268 // called when the player has been moved 269 // called when the player has been moved
269 MTH void floorbox_reset () { look_position = 0; floorbox_update (); } 270 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
270 271
272 MTH void tick (); // called every server tick to do housekeeping etc.
273
271 MTH static client *create (int fd, const char *peername); 274 MTH static client *create (int fd, const char *peername);
272 275
273protected: 276protected:
274 client (int fd, const char *from_ip); 277 client (int fd, const char *from_ip);
275 ~client (); 278 ~client ();
… …
277 280
278#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 281#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
279 ( ((__type)>0) &&\ 282 ( ((__type)>0) &&\
280 ((__sockPtr)->has_readable_type) && \ 283 ((__sockPtr)->has_readable_type) && \
281 ((__sockPtr)->supported_readables & (1<<(__type))) ) 284 ((__sockPtr)->supported_readables & (1<<(__type))) )
282
283/* Bitmask for the faces_sent[] array - what
284 * portion of the face have we sent?
285 */
286#define NS_FACESENT_FACE 0x1
287#define NS_FACESENT_SMOOTH 0x2
288 285
289/* Constants in the form EMI_ is for extended map infos. 286/* Constants in the form EMI_ is for extended map infos.
290 * Even if the client select the additionnal infos it wants 287 * Even if the client select the additionnal infos it wants
291 * on the map, there may exist cases where this whole info 288 * on the map, there may exist cases where this whole info
292 * is not given in one buch but in separate bunches. This 289 * is not given in one buch but in separate bunches. This
… …
324 321
325extern sockvec clients; 322extern sockvec clients;
326 323
327#define for_all_clients(var) \ 324#define for_all_clients(var) \
328 for (int _i = 0; _i < clients.size (); ++_i) \ 325 for (int _i = 0; _i < clients.size (); ++_i) \
329 declvar (client *, var, clients [_i]) 326 statementvar (client *, var, clients [_i])
330 327
331#endif 328#endif
332 329

Diff Legend

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