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.77 by root, Tue May 6 16:55:25 2008 UTC vs.
Revision 1.87 by root, Mon Oct 12 14:00:58 2009 UTC

3 * 3 *
4 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team 4 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team 5 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
6 * Copyright (©) 1992,2007 Frank Tore Johansen 6 * Copyright (©) 1992,2007 Frank Tore Johansen
7 * 7 *
8 * Deliantra is free software: you can redistribute it and/or modify 8 * Deliantra is free software: you can redistribute it and/or modify it under
9 * it under the terms of the GNU General Public License as published by 9 * the terms of the Affero GNU General Public License as published by the
10 * the Free Software Foundation, either version 3 of the License, or 10 * Free Software Foundation, either version 3 of the License, or (at your
11 * (at your option) any later version. 11 * 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 Affero GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>. 19 * and the GNU General Public License along with this program. If not, see
20 * <http://www.gnu.org/licenses/>.
20 * 21 *
21 * The authors can be reached via e-mail to <support@deliantra.net> 22 * The authors can be reached via e-mail to <support@deliantra.net>
22 */ 23 */
23 24
24#ifndef CLIENT_H 25#ifndef CLIENT_H
68// (possibly) max. number of objects "per page" in the ground container 69// (possibly) max. number of objects "per page" in the ground container
69#define FLOORBOX_PAGESIZE 50 70#define FLOORBOX_PAGESIZE 50
70 71
71struct MapCell 72struct MapCell
72{ 73{
73 tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient 74 tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
74 int count; /* This is really darkness in the map1 command */ 75 int count; /* This is really darkness in the map1 command */
75 faceidx faces[MAP_LAYERS]; 76 faceidx faces[MAP_LAYERS];
76 unsigned char stat_hp; // health of something in this space, or 0 77 unsigned char stat_hp; // health of something in this space, or 0
77 unsigned char flags; 78 unsigned char flags;
78 uint8_t smooth[MAP_LAYERS]; 79 uint8_t smooth[MAP_LAYERS];
157 int ACC (RW, fd); 158 int ACC (RW, fd);
158 unsigned int inbuf_len; // number of bytes valid in inbuf 159 unsigned int inbuf_len; // number of bytes valid in inbuf
159 statsinfo stats; 160 statsinfo stats;
160 object_vector_index ACC (RO, active); 161 object_vector_index ACC (RO, active);
161 player_ptr ACC (RO, pl); 162 player_ptr ACC (RO, pl);
162
163 /* The following is the setup for a ring buffer for storing output
164 * data that the OS can't handle right away.
165 */
166 struct
167 {
168 char data[SOCKETBUFSIZE];
169 int start;
170 int len;
171 } outputbuffer;
172 163
173 char *ACC (RW, host); /* Which host it is connected from (ip address) */ 164 char *ACC (RW, host); /* Which host it is connected from (ip address) */
174 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ 165 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
175 166
176 sint8 ACC (RW, last_level); /* Last level we sent to client */ 167 sint8 ACC (RW, last_level); /* Last level we sent to client */
184 living ACC (RO, last_stats); /* Last stats as sent to client */ 175 living ACC (RO, last_stats); /* Last stats as sent to client */
185 float ACC (RW, last_speed); /* Last speed as sent to client */ 176 float ACC (RW, last_speed); /* Last speed as sent to client */
186 sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ 177 sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
187 sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */ 178 sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */
188 179
189 bool ACC (RW, force_face0); // client workaround for buggy checksum calculation in gcfclient
190 bool ACC (RW, force_bad_checksum); // client workaround for buggy checksum calculation in gcfclient
191 bool ACC (RW, force_image_newmap); // client workaround for client not redrawing map on image upload
192 bool ACC (RW, enable_bg_scrub); // client workaround, gcfclient becomes unusable if you send it images
193
194 bool ACC (RW, afk); /* player is afk */ 180 bool ACC (RW, afk); /* player is afk */
195 bool ACC (RW, facecache); /* If true, client is caching images */
196 bool ACC (RW, sent_scroll); 181 bool ACC (RW, sent_scroll);
197 bool ACC (RW, sound); /* does the client want sound */ 182 bool ACC (RW, sound); /* does the client want sound */
198 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ 183 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
199 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ 184 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
200 bool ACC (RW, mapinfocmd); // return map info and send map change info 185 bool ACC (RW, mapinfocmd); // return map info and send map change info
201 uint8_t ACC (RW, extcmd); // call into extensions/plugins 186 uint8_t ACC (RW, extcmd); // call into extensions/plugins
202 bool ACC (RW, extmap); // extend map comamnd with extra data
203 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls
204 bool ACC (RW, darkness); /* True if client wants darkness information */
205 bool ACC (RW, image2); /* Client wants image2/face2 commands */
206 uint8_t ACC (RW, fxix); // client implements fx and ix (face|image extended) commands
207 bool ACC (RW, update_look); /* If true, we need to send the look window */ 187 bool ACC (RW, update_look); /* If true, we need to send the look window */
208 bool ACC (RW, has_readable_type); /* If true client accept additional text information */ 188 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
209 /* used to arrange text in books, scrolls, or scripted dialogs */ 189 /* used to arrange text in books, scrolls, or scripted dialogs */
210 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ 190 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
211 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
212 /* Below are flags for extedend infos to pass to client
213 * with S->C mapextended command */
214 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
215 bool ACC (RW, smoothing); // trt-style smoothing 191 bool ACC (RW, smoothing); // deliantra-style smoothing
216 bool ACC (RW, can_msg); // trt-style text messages
217 192
218 bool ACC (RW, force_newmap); // force a newmap before next map update 193 bool ACC (RW, force_newmap); // force a newmap before next map update
219 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ 194 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
220 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ 195 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
221 uint16 ACC (RW, look_position); /* start of drawing of look window */ 196 uint16 ACC (RW, look_position); /* start of drawing of look window */
222 uint16 ACC (RW, mss); // likely tcp maximum segment size 197 uint16 ACC (RW, mss); // likely tcp maximum segment size
223 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */ 198 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
224 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ 199 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
225 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ 200 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
226 201
227 maptile *ACC (RW, current_map); // CF+ last/current player map 202 maptile_ptr ACC (RW, current_map); // CF+ last/current player map
228 region *ACC (RW, current_region); // CF+ last/current player region 203 region_ptr ACC (RW, current_region); // CF+ last/current player region
229 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position 204 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
230 shstr ACC (RW, version); // CF+ client name/version 205 shstr ACC (RW, version); // CF+ client name/version
231 uint8 ACC (RW, faceset); // CF+ selected faceset 206 uint8 ACC (RW, faceset); // CF+ selected faceset
232 207
233 tstamp ACC (RW, last_send); // last data send on socket. 208 tstamp ACC (RW, last_send); // last data send on socket.
234 209
210 float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */
235 int ACC (RW, rate_avail); // current rate balance 211 int ACC (RW, rate_avail); // current rate balance
236 int ACC (RW, max_rate); // max. # of bytes to send per tick 212 int ACC (RW, max_rate); // max. # of bytes to send per tick
237 faceidx ACC (RW, scrub_idx); // which face to send next 213 faceidx ACC (RW, scrub_idx); // which face to send next
238 int ACC (RW, bg_scrub); // how many ticks till the next background face send 214 int ACC (RW, bg_scrub); // how many ticks till the next background face send
239 215
281 char msg[MSG_BUF_SIZE]; 257 char msg[MSG_BUF_SIZE];
282 } msgbuf[MSG_BUF_COUNT]; 258 } msgbuf[MSG_BUF_COUNT];
283 259
284 MTH bool msg_suppressed (const char *msg); 260 MTH bool msg_suppressed (const char *msg);
285 261
262 /* The following is the setup for a ring buffer for storing output
263 * data that the OS can't handle right away.
264 * TODO: this member is enourmously large - optimise?
265 */
266 struct
267 {
268 char data[SOCKETBUFSIZE];
269 int start;
270 int len;
271 } outputbuffer;
272
286 bool may_execute (const packet_type *pkt) const; 273 bool may_execute (const packet_type *pkt) const;
287 void execute (const packet_type *pkt, char *data, int datalen); 274 void execute (const packet_type *pkt, char *data, int datalen);
288 275
289 void queue_command (packet_type *handler, char *data, int datalen); 276 void queue_command (packet_type *handler, char *data, int datalen);
290 MTH bool handle_command (); 277 MTH bool handle_command ();
308 void send_packet (packet &sl); 295 void send_packet (packet &sl);
309 296
310 void send_drawinfo (const char *msg, int flags = NDI_BLACK); 297 void send_drawinfo (const char *msg, int flags = NDI_BLACK);
311 298
312 MTH void send_face (faceidx facenum, int pri = 0); 299 MTH void send_face (faceidx facenum, int pri = 0);
313 MTH void send_image (faceidx facenum);
314 MTH void send_faces (object *ob); 300 MTH void send_faces (object *ob);
315 MTH void send_animation (short anim_num); 301 MTH void send_animation (short anim_num);
316 void send_msg (int color, const char *type, const char *msg); 302 void send_msg (int color, const char *type, const char *msg);
317 303
318 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); 304 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
367#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 353#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
368 ( ((__type)>0) &&\ 354 ( ((__type)>0) &&\
369 ((__sockPtr)->has_readable_type) && \ 355 ((__sockPtr)->has_readable_type) && \
370 ((__sockPtr)->supported_readables & (1<<(__type))) ) 356 ((__sockPtr)->supported_readables & (1<<(__type))) )
371 357
372/* Constants in the form EMI_ is for extended map infos.
373 * Even if the client select the additionnal infos it wants
374 * on the map, there may exist cases where this whole info
375 * is not given in one buch but in separate bunches. This
376 * is done performance reasons (imagine some info related to
377 * a visible object and another info related to a 4 square
378 * width and height area). At the begin of an extended info packet
379 * is a bit field. A bit is activated for each extended info
380 * present in the data
381 */
382
383/* Meanings:
384 * EMI_NOREDRAW Take extended infos into account but don't redraw,
385 * some additionnal datas will follow in a new packet
386 * EMI_SMOOTH Datas about smoothing
387 */
388#define EMI_NOREDRAW 0x01
389#define EMI_SMOOTH 0x02
390
391/* this last one says the bitfield continue un next byte
392 * There may be several on contiguous bytes. So there is 7
393 * actual bits used per byte, and the number of bytes
394 * is not fixed in protocol
395 */
396#define EMI_HASMOREBITS 0x80
397
398#define FACE_TYPES 1 358#define FACE_TYPES 1
399#define PNG_FACE_INDEX 0 359#define PNG_FACE_INDEX 0
400 360
401#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 361#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
402#define VERSION_SC 1026 362#define VERSION_SC 1026
409 369
410#define for_all_clients(var) \ 370#define for_all_clients(var) \
411 for (int _i = 0; _i < clients.size (); ++_i) \ 371 for (int _i = 0; _i < clients.size (); ++_i) \
412 statementvar (client *, var, clients [_i]) 372 statementvar (client *, var, clients [_i])
413 373
374// returns true when the message needs special (read: perl) treatment
375static inline bool
376msg_is_special (const char *msg, bool nl_special = true)
377{
378 return msg [strcspn (msg, nl_special ? "<&\n" : "<&")];
379}
380
414#endif 381#endif
415 382

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines