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.47 by root, Wed Apr 18 09:38:58 2007 UTC vs.
Revision 1.61 by root, Thu Jul 12 19:36:58 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
68 * instead of having a bunch of different fields that needed to 67 * instead of having a bunch of different fields that needed to
69 * get toggled. 68 * get toggled.
70 */ 69 */
71enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; 70enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
72 71
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
83// states the socket can be in 72// states the socket can be in
84enum { 73enum {
85 ST_DEAD, // socket is dead 74 ST_DEAD, // socket is dead
86 ST_SETUP, // initial handshake / setup / login 75 ST_SETUP, // initial handshake / setup / login
87 ST_PLAYING, // logged in an playing 76 ST_PLAYING, // logged in an playing
88 ST_CUSTOM, // waiting for custom reply 77 ST_CUSTOM, // waiting for custom reply
89 78
90 ST_CHANGE_CLASS,
91 ST_GET_PARTY_PASSWORD, 79 ST_GET_PARTY_PASSWORD,
92}; 80};
93 81
94// a handler for a specific type of packet 82// a handler for a specific type of packet
95enum { 83enum {
117 { 105 {
118 sfree<char> (data, datalen + 1); 106 sfree<char> (data, datalen + 1);
119 } 107 }
120}; 108};
121 109
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. */ 110/* how many times we are allowed to give the wrong password before being kicked. */
160#define MAX_PASSWORD_FAILURES 5 111#define MAX_PASSWORD_FAILURES 5
161 112
162INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player 113INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
163struct client : zero_initialised, attachable 114struct client : zero_initialised, attachable
164{ 115{
165 int ACC (RW, fd); 116 int ACC (RW, fd);
166 unsigned int inbuf_len; // number of bytes valid in inbuf 117 unsigned int inbuf_len; // number of bytes valid in inbuf
167 statsinfo stats; 118 statsinfo stats;
168 int ACC (RO, active); 119 object_vector_index ACC (RO, active);
120 player_ptr ACC (RO, pl);
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 */
200 bool ACC (RW, extcmd); // call into extensions/plugins 160 bool ACC (RW, extcmd); // call into extensions/plugins
201 bool ACC (RW, extmap); // extend map comamnd with extra data 161 bool ACC (RW, extmap); // extend map comamnd with extra data
202 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls 162 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls
203 bool ACC (RW, darkness); /* True if client wants darkness information */ 163 bool ACC (RW, darkness); /* True if client wants darkness information */
204 bool ACC (RW, image2); /* Client wants image2/face2 commands */ 164 bool ACC (RW, image2); /* Client wants image2/face2 commands */
205 bool ACC (RW, fxix); // client implements fx and ix (face|image extended) commands 165 uint8_t ACC (RW, fxix); // client implements fx and ix (face|image extended) commands
206 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 */
207 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 */
208 /* used to arrange text in books, scrolls, or scripted dialogs */ 168 /* used to arrange text in books, scrolls, or scripted dialogs */
209 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 */
210 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 */
211 /* Below are flags for extedend infos to pass to client 171 /* Below are flags for extedend infos to pass to client
212 * with S->C mapextended command */ 172 * with S->C mapextended command */
213 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ 173 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
214 bool ACC (RW, smoothing); // cfplus-style smoothing 174 bool ACC (RW, smoothing); // trt-style smoothing
175 bool ACC (RW, can_msg); // trt-style text messages
215 176
216 bool ACC (RW, force_newmap); // force a newmap before next map update 177 bool ACC (RW, force_newmap); // force a newmap before next map update
217 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 */
218 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 */
219 uint16 ACC (RW, look_position); /* start of drawing of look window */ 180 uint16 ACC (RW, look_position); /* start of drawing of look window */
223 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 */
224 185
225 maptile *ACC (RW, current_map); // CF+ last/current player map 186 maptile *ACC (RW, current_map); // CF+ last/current player map
226 region *ACC (RW, current_region); // CF+ last/current player region 187 region *ACC (RW, current_region); // CF+ last/current player region
227 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
228 char ACC (RW, version)[64]; // CF+ client name/version 189 shstr ACC (RW, version); // CF+ client name/version
229 uint8 ACC (RW, faceset); // CF+ selected faceset 190 uint8 ACC (RW, faceset); // CF+ selected faceset
230 191
231 player_ptr ACC (RO, pl); 192 tstamp ACC (RW, last_send); // last data send on socket.
232 193
233 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 int ACC (RW, outq); // current socket outq length, or 0 if indeterminable
234 196
235 int ACC (RW, rate_avail); // current rate balance 197 int ACC (RW, rate_avail); // current rate balance
236 int ACC (RW, max_rate); // max. # of bytes to send per tick 198 int ACC (RW, max_rate); // max. # of bytes to send per tick
237 faceidx ACC (RW, scrub_idx); // which face to send next 199 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 200 int ACC (RW, bg_scrub); // how many ticks till the next background face send
239 201
240 faceidx partial_face; 202 struct ixsend {
241 uint32 partial_face_ofs; // if != 0, need to send remaining bytes of partial_face 203 int16_t pri; // unused
242 std::vector<faceidx, slice_allocator<faceidx> > askface; // which faces have been requested by the client 204 faceidx idx;
205 uint32_t ofs; // if != 0, need to send remaining bytes of partial_face
206 };
207 std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix
243 208
244 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx 209 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
245 MTH void flush_fx (); // send fx if required 210 MTH void flush_fx (); // send fx if required
246 211
247 void do_destroy (); 212 void do_destroy ();
248 void gather_callbacks (AV *&callbacks, event_type event) const; 213 void gather_callbacks (AV *&callbacks, event_type event) const;
249 214
250 iow socket_ev; void socket_cb (iow &w, int got); 215 iow socket_ev; void socket_cb (iow &w, int got);
251 iw cmd_ev; void cmd_cb (iw &w); 216 iw cmd_ev; void cmd_cb (iw &w);
252 client_container cc_inv, cc_other;
253 217
254 std::deque< command, slice_allocator<command> > cmd_queue; 218 std::deque< command, slice_allocator<command> > cmd_queue;
255 219
256 // large structures at the end please 220 // large structures at the end please
257 struct Map lastmap; 221 struct Map lastmap;
259 std::bitset<MAX_FACES> faces_sent; 223 std::bitset<MAX_FACES> faces_sent;
260 224
261 // if we get an incomplete packet, this is used to hold the data. 225 // if we get an incomplete packet, this is used to hold the data.
262 // we add 2 byte for the header, one for the trailing 0 byte 226 // we add 2 byte for the header, one for the trailing 0 byte
263 uint8 inbuf[MAXSOCKBUF + 2 + 1]; 227 uint8 inbuf[MAXSOCKBUF + 2 + 1];
228
229 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
230 struct msg_buf
231 {
232 tick_t expire;
233 int len;
234 int count;
235 char msg[MSG_BUF_SIZE];
236 } msgbuf[MSG_BUF_COUNT];
237
238 MTH bool msg_suppressed (const char *msg);
264 239
265 bool may_execute (const packet_type *pkt) const; 240 bool may_execute (const packet_type *pkt) const;
266 void execute (const packet_type *pkt, char *data, int datalen); 241 void execute (const packet_type *pkt, char *data, int datalen);
267 242
268 void queue_command (packet_type *handler, char *data, int datalen); 243 void queue_command (packet_type *handler, char *data, int datalen);
285 void send_packet (const char *buf, int len); 260 void send_packet (const char *buf, int len);
286 void send_packet_printf (const char *format, ...); 261 void send_packet_printf (const char *format, ...);
287 void send_packet (packet &sl); 262 void send_packet (packet &sl);
288 263
289 void send_drawinfo (const char *msg, int flags = NDI_BLACK); 264 void send_drawinfo (const char *msg, int flags = NDI_BLACK);
265
266 MTH bool must_send_face (faceidx facenum)
267 {
268 if (faces_sent[facenum])
269 return false;
270
271 faces_sent[facenum] = true;
272 return true;
273 }
274
290 MTH void send_face (faceidx facenum); 275 MTH void send_face (faceidx facenum);
291 MTH void send_image (faceidx facenum); 276 MTH void send_image (faceidx facenum);
292 MTH void send_faces (object *ob); 277 MTH void send_faces (object *ob);
293 MTH void send_animation (short anim_num); 278 MTH void send_animation (short anim_num);
279 void send_msg (int color, const char *type, const char *msg);
294 280
295 // called when something under the player changes 281 // called when something under the player changes
296 MTH void floorbox_update () { update_look = 1; } 282 MTH void floorbox_update () { update_look = 1; }
297 // called when the player has been moved 283 // called when the player has been moved
298 MTH void floorbox_reset () { look_position = 0; floorbox_update (); } 284 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
341#define PNG_FACE_INDEX 0 327#define PNG_FACE_INDEX 0
342 328
343#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 329#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
344#define VERSION_SC 1026 330#define VERSION_SC 1026
345//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible 331//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
346#define VERSION_INFO "Crossfire+ Server" 332#define VERSION_INFO "Crossfire TRT Server"
347 333
348typedef object_vector<client, &client::active> sockvec; 334typedef object_vector<client, &client::active> sockvec;
349 335
350extern sockvec clients; 336extern sockvec clients;
351 337
352#define for_all_clients(var) \ 338#define for_all_clients(var) \
353 for (int _i = 0; _i < clients.size (); ++_i) \ 339 for (int _i = 0; _i < clients.size (); ++_i) \
354 declvar (client *, var, clients [_i]) 340 statementvar (client *, var, clients [_i])
355 341
356#endif 342#endif
357 343

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines