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.49 by root, Wed Apr 25 18:47:50 2007 UTC vs.
Revision 1.63 by root, Tue Jul 24 04:55:34 2007 UTC

1/* 1/*
2 * CrossFire, A Multiplayer game for the X Window System 2 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
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
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 3 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, see <http://www.gnu.org/licenses/>.
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * 20 *
22 * The author can be reached via e-mail to crossfire@schmorp.de 21 * The authors can be reached via e-mail to <crossfire@schmorp.de>
23 */ 22 */
24 23
25#ifndef CLIENT_H 24#ifndef CLIENT_H
26#define CLIENT_H 25#define CLIENT_H
27 26
86 PF_PLAYING = 0x02, // must be in playing state 85 PF_PLAYING = 0x02, // must be in playing state
87 PF_COMMAND0 = 0x04, // command starts at offset 0 86 PF_COMMAND0 = 0x04, // command starts at offset 0
88 PF_COMMAND6 = 0x08, // command starts at offset 6 87 PF_COMMAND6 = 0x08, // command starts at offset 6
89}; 88};
90 89
90// face type.s bit 0 means "has meta info prepended"
91enum {
92 FT_FACE = 0 * 2 + 0, // faces (images)
93 FT_MUSIC = 1 * 2 + 1, // background music
94 FT_SOUND = 2 * 2 + 1, // effects
95 FT_RSRC = 3 * 2 + 0, // generic data files
96 FT_NUM,
97};
98
91struct packet_type 99struct packet_type
92{ 100{
93 const char *name; 101 const char *name;
94 void *cb; 102 void *cb;
95 int flags; 103 int flags;
106 { 114 {
107 sfree<char> (data, datalen + 1); 115 sfree<char> (data, datalen + 1);
108 } 116 }
109}; 117};
110 118
111struct refitem
112{
113 object_ptr op;
114};
115
116// this represents a container on the client side.
117// right now, there are only ever two of them:
118// the inventory and the floor/open container
119//TODO: unused as of yet
120struct client_container : vector< refitem, slice_allocator<refitem> >
121{
122 client *ns;
123 enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type;
124
125 bool item_changed; // one of the items in here possibly changed
126
127 // for mapspace and container
128 int x, y;
129 maptile *map;
130
131 // for container
132 object *env;
133
134 client_container (client *ns)
135 : ns (ns), type (CC_NONE) { }
136
137 tag_t tag () const;
138
139 inline iterator merge_item (iterator i, object *op);
140
141 void clear ();
142 void update ();
143
144 void set_mapspace (maptile *map, int x, int y);
145 void set_container (object *env);
146};
147
148/* how many times we are allowed to give the wrong password before being kicked. */ 119/* how many times we are allowed to give the wrong password before being kicked. */
149#define MAX_PASSWORD_FAILURES 5 120#define MAX_PASSWORD_FAILURES 5
150 121
151INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player 122INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
152struct client : zero_initialised, attachable 123struct client : zero_initialised, attachable
153{ 124{
154 int ACC (RW, fd); 125 int ACC (RW, fd);
155 unsigned int inbuf_len; // number of bytes valid in inbuf 126 unsigned int inbuf_len; // number of bytes valid in inbuf
156 statsinfo stats; 127 statsinfo stats;
157 int ACC (RO, active); 128 object_vector_index ACC (RO, active);
129 player_ptr ACC (RO, pl);
158 130
159 /* The following is the setup for a ring buffer for storing output 131 /* The following is the setup for a ring buffer for storing output
160 * data that the OS can't handle right away. 132 * data that the OS can't handle right away.
161 */ 133 */
162 struct 134 struct
192 bool ACC (RW, sent_scroll); 164 bool ACC (RW, sent_scroll);
193 bool ACC (RW, sound); /* does the client want sound */ 165 bool ACC (RW, sound); /* does the client want sound */
194 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ 166 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
195 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ 167 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
196 bool ACC (RW, mapinfocmd); // return map info and send map change info 168 bool ACC (RW, mapinfocmd); // return map info and send map change info
197 bool ACC (RW, extcmd); // call into extensions/plugins 169 uint8_t ACC (RW, extcmd); // call into extensions/plugins
198 bool ACC (RW, extmap); // extend map comamnd with extra data 170 bool ACC (RW, extmap); // extend map comamnd with extra data
199 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls 171 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls
200 bool ACC (RW, darkness); /* True if client wants darkness information */ 172 bool ACC (RW, darkness); /* True if client wants darkness information */
201 bool ACC (RW, image2); /* Client wants image2/face2 commands */ 173 bool ACC (RW, image2); /* Client wants image2/face2 commands */
202 bool ACC (RW, fxix); // client implements fx and ix (face|image extended) commands 174 uint8_t ACC (RW, fxix); // client implements fx and ix (face|image extended) commands
203 bool ACC (RW, update_look); /* If true, we need to send the look window */ 175 bool ACC (RW, update_look); /* If true, we need to send the look window */
204 bool ACC (RW, has_readable_type); /* If true client accept additional text information */ 176 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
205 /* used to arrange text in books, scrolls, or scripted dialogs */ 177 /* used to arrange text in books, scrolls, or scripted dialogs */
206 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ 178 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
207 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ 179 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
224 region *ACC (RW, current_region); // CF+ last/current player region 196 region *ACC (RW, current_region); // CF+ last/current player region
225 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position 197 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
226 shstr ACC (RW, version); // CF+ client name/version 198 shstr ACC (RW, version); // CF+ client name/version
227 uint8 ACC (RW, faceset); // CF+ selected faceset 199 uint8 ACC (RW, faceset); // CF+ selected faceset
228 200
229 player_ptr ACC (RO, pl); 201 tstamp ACC (RW, last_send); // last data send on socket.
230 202
231 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ 203 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
204 int ACC (RW, outq); // current socket outq length, or 0 if indeterminable
232 205
233 int ACC (RW, rate_avail); // current rate balance 206 int ACC (RW, rate_avail); // current rate balance
234 int ACC (RW, max_rate); // max. # of bytes to send per tick 207 int ACC (RW, max_rate); // max. # of bytes to send per tick
235 faceidx ACC (RW, scrub_idx); // which face to send next 208 faceidx ACC (RW, scrub_idx); // which face to send next
236 int ACC (RW, bg_scrub); // how many ticks till the next background face send 209 int ACC (RW, bg_scrub); // how many ticks till the next background face send
237 210
238 faceidx partial_face; 211 struct ixsend {
239 uint32 partial_face_ofs; // if != 0, need to send remaining bytes of partial_face 212 int16_t pri; // unused
240 std::vector<faceidx, slice_allocator<faceidx> > askface; // which faces have been requested by the client 213 faceidx idx;
214 uint32_t ofs; // if != 0, need to send remaining bytes of partial_face
215 };
216 std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix
241 217
242 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx 218 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
243 MTH void flush_fx (); // send fx if required 219 MTH void flush_fx (); // send fx if required
244 220
245 void do_destroy (); 221 void do_destroy ();
246 void gather_callbacks (AV *&callbacks, event_type event) const; 222 void gather_callbacks (AV *&callbacks, event_type event) const;
247 223
248 iow socket_ev; void socket_cb (iow &w, int got); 224 iow socket_ev; void socket_cb (iow &w, int got);
249 iw cmd_ev; void cmd_cb (iw &w); 225 iw cmd_ev; void cmd_cb (iw &w);
250 client_container cc_inv, cc_other;
251 226
252 std::deque< command, slice_allocator<command> > cmd_queue; 227 std::deque< command, slice_allocator<command> > cmd_queue;
253 228
254 // large structures at the end please 229 // large structures at the end please
255 struct Map lastmap; 230 struct Map lastmap;
256 std::bitset<MAXANIMNUM> anims_sent; 231 std::bitset<MAXANIMNUM> anims_sent;
257 std::bitset<MAX_FACES> faces_sent; 232 std::bitset<MAX_FACES> faces_sent;
233 std::bitset<FT_NUM> fx_want;
258 234
259 // if we get an incomplete packet, this is used to hold the data. 235 // if we get an incomplete packet, this is used to hold the data.
260 // we add 2 byte for the header, one for the trailing 0 byte 236 // we add 2 byte for the header, one for the trailing 0 byte
261 uint8 inbuf[MAXSOCKBUF + 2 + 1]; 237 uint8 inbuf[MAXSOCKBUF + 2 + 1];
262 238
294 void send_packet (const char *buf, int len); 270 void send_packet (const char *buf, int len);
295 void send_packet_printf (const char *format, ...); 271 void send_packet_printf (const char *format, ...);
296 void send_packet (packet &sl); 272 void send_packet (packet &sl);
297 273
298 void send_drawinfo (const char *msg, int flags = NDI_BLACK); 274 void send_drawinfo (const char *msg, int flags = NDI_BLACK);
275
299 MTH void send_face (faceidx facenum); 276 MTH void send_face (faceidx facenum, int pri = 0);
300 MTH void send_image (faceidx facenum); 277 MTH void send_image (faceidx facenum);
301 MTH void send_faces (object *ob); 278 MTH void send_faces (object *ob);
302 MTH void send_animation (short anim_num); 279 MTH void send_animation (short anim_num);
303 MTH void send_msg (int color, const char *type, const char *msg); 280 void send_msg (int color, const char *type, const char *msg);
304 281
305 // called when something under the player changes 282 // called when something under the player changes
306 MTH void floorbox_update () { update_look = 1; } 283 MTH void floorbox_update () { update_look = 1; }
307 // called when the player has been moved 284 // called when the player has been moved
308 MTH void floorbox_reset () { look_position = 0; floorbox_update (); } 285 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
351#define PNG_FACE_INDEX 0 328#define PNG_FACE_INDEX 0
352 329
353#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 330#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
354#define VERSION_SC 1026 331#define VERSION_SC 1026
355//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible 332//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
356#define VERSION_INFO "Crossfire+ Server" 333#define VERSION_INFO "Crossfire TRT Server"
357 334
358typedef object_vector<client, &client::active> sockvec; 335typedef object_vector<client, &client::active> sockvec;
359 336
360extern sockvec clients; 337extern sockvec clients;
361 338
362#define for_all_clients(var) \ 339#define for_all_clients(var) \
363 for (int _i = 0; _i < clients.size (); ++_i) \ 340 for (int _i = 0; _i < clients.size (); ++_i) \
364 declvar (client *, var, clients [_i]) 341 statementvar (client *, var, clients [_i])
365 342
366#endif 343#endif
367 344

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines