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.9 by root, Tue Dec 19 04:58:04 2006 UTC vs.
Revision 1.30 by pippijn, Thu Mar 1 12:28:16 2007 UTC

1/* 1/*
2 CrossFire, A Multiplayer game for the X Window System 2 * CrossFire, A Multiplayer game for the X Window System
3 3 *
4 * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team
4 Copyright (C) 2002 Mark Wedel & Crossfire Development Team 5 * Copyright (C) 2002 Mark Wedel & Crossfire Development Team
5 Copyright (C) 1992 Frank Tore Johansen 6 * Copyright (C) 1992 Frank Tore Johansen
6 7 *
7 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
8 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
9 the Free Software Foundation; either version 2 of the License, or 10 * the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version. 11 * (at your option) any later version.
11 12 *
12 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,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details. 16 * GNU General Public License for more details.
16 17 *
17 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
18 along with this program; if not, write to the Free Software 19 * along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 21 *
21 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
22*/ 23 */
23 24
24#ifndef CLIENT_H 25#ifndef CLIENT_H
25#define CLIENT_H 26#define CLIENT_H
26 27
27#include <deque> 28#include <deque>
28#include <bitset> 29#include <bitset>
30#include <tr1/unordered_set>
29 31
30// (possibly) max. number of objects "per page" in the ground container 32// (possibly) max. number of objects "per page" in the ground container
31#define NUM_LOOK_OBJECTS 50 33#define FLOORBOX_PAGESIZE 50
32 34
33struct MapCell 35struct MapCell
34{ 36{
35 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
36 int count; /* This is really darkness in the map1 command */ 38 int count; /* This is really darkness in the map1 command */
… …
67 * 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
68 * 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
69 * are using. 71 * are using.
70 */ 72 */
71 73
72enum Sock_Status { Ns_Add, Ns_Dead };
73
74/* 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
75 * instead of having a bunch of different fields that needed to 75 * instead of having a bunch of different fields that needed to
76 * get toggled. 76 * get toggled.
77 */ 77 */
78enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; 78enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
79 79
80/* 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
81 * data that the OS can't handle right away. 81 * data that the OS can't handle right away.
82 */ 82 */
83
84struct Buffer 83struct Buffer
85{ 84{
86 char data[SOCKETBUFSIZE]; 85 char data[SOCKETBUFSIZE];
87 int start; 86 int start;
88 int len; 87 int len;
89}; 88};
90 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
91// a handler for a specific type of packet 101// a handler for a specific type of packet
92enum { 102enum {
93 PF_PLAYER = 0x01, // must have valid player / will by synchronised 103 PF_PLAYER = 0x01, // must have valid player / will by synchronised
94 PF_PLAYING = 0x02, // must be in playing state 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
95}; 107};
96 108
97struct packet_type 109struct packet_type
98{ 110{
99 const char *name; 111 const char *name;
… …
112 { 124 {
113 sfree<char> (data, datalen + 1); 125 sfree<char> (data, datalen + 1);
114 } 126 }
115}; 127};
116 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
117/* 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. */
118#define MAX_PASSWORD_FAILURES 5 167#define MAX_PASSWORD_FAILURES 5
119 168
120ACC_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
121struct client : zero_initialised, attachable_base 170struct client : zero_initialised, attachable
122{ 171{
123 enum Sock_Status status;
124 int ACC (RW, fd); 172 int ACC (RW, fd);
125 unsigned int inbuf_len; // number of bytes valid in inbuf 173 unsigned int inbuf_len; // number of bytes valid in inbuf
126 uint8 *faces_sent; // This is a bitmap on sent face status 174 uint8 *faces_sent; // This is a bitmap on sent face status
127 struct statsinfo stats; 175 statsinfo stats;
176 int ACC (RO, active);
128 177
178 Buffer outputbuffer;
179
129 char *ACC (RW, host); /* Which host it is connected from (ip address) */ 180 char *ACC (RW, host); /* Which host it is connected from (ip address) */
130 uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */ 181 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
131 Buffer outputbuffer;
132 182
183 sint8 ACC (RW, last_level); /* Last level we sent to client */
184 uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */
185 float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */
186 sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */
187 sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */
188 uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */
189 uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */
190 uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */
191 living ACC (RO, last_stats); /* Last stats as sent to client */
192 float ACC (RW, last_speed); /* Last speed as sent to client */
193 sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
194 sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */
195
196 bool ACC (RW, afk); /* player is afk */
133 bool ACC (RW, facecache); /* If true, client is caching images */ 197 bool ACC (RW, facecache); /* If true, client is caching images */
134 bool ACC (RW, sent_scroll); 198 bool ACC (RW, sent_scroll);
135 bool ACC (RW, sound); /* does the client want sound */ 199 bool ACC (RW, sound); /* does the client want sound */
136 bool ACC (RW, exp64); /* Client wants 64 bit exp data, as well as skill data */
137 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ 200 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
138 bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ 201 bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */
139 bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ 202 bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */
140 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ 203 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */
141 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ 204 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */
142 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ 205 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */
143 bool ACC (RW, darkness); /* True if client wants darkness information */ 206 bool ACC (RW, darkness); /* True if client wants darkness information */
144 bool ACC (RW, image2); /* Client wants image2/face2 commands */ 207 bool ACC (RW, image2); /* Client wants image2/face2 commands */
145 bool ACC (RW, update_look); /* If true, we need to send the look window */ 208 bool ACC (RW, update_look); /* If true, we need to send the look window */
146 bool ACC (RW, has_readable_type); /* If true client accept additional text information */ 209 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
147 /* used to arrange text in books, scrolls, or scripted dialogs */ 210 /* used to arrange text in books, scrolls, or scripted dialogs */
148 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ 211 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
149 bool ACC (RW, ext_mapinfos); /* If true client accept additionnal info on maps */ 212 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
150 /* Below are flags for extedend infos to pass to client 213 /* Below are flags for extedend infos to pass to client
151 * with S->C mapextended command */ 214 * with S->C mapextended command */
152 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ 215 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
153 216
154 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ 217 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
155 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ 218 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
156 enum MapMode mapmode; /* Type of map commands the client wants. */ 219 enum MapMode mapmode; /* Type of map commands the client wants. */
157 uint16 ACC (RW, look_position); /* start of drawing of look window */ 220 uint16 ACC (RW, look_position); /* start of drawing of look window */
158 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ 221 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
159 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ 222 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
160 uint8 ACC (RW, faceset); /* Set the client is using, default 0 */ 223 uint8 ACC (RW, faceset); /* Set the client is using, default 0 */
161 224
162 maptile *ACC (RW, current_map); // CF+ last/current player map 225 maptile *ACC (RW, current_map); // CF+ last/current player map
226 region *ACC (RW, current_region); // CF+ last/current player region
163 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position 227 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
164 char ACC (RW, version)[64]; // CF+ client name/version 228 char ACC (RW, version)[64]; // CF+ client name/version
165 229
166 player *ACC (RO, pl);//TODO should not be here, preferably 230 player_ptr ACC (RO, pl);
167 231
168 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ 232 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
169 233
170 client (int fd, const char *from_ip);
171 ~client ();
172 void destroy (); 234 void do_destroy ();
235 void gather_callbacks (AV *&callbacks, event_type event) const;
173 236
237 iow socket_ev; void socket_cb (iow &w, int got);
174 iw cmd_ev; void cmd_cb (iw &w); 238 iw cmd_ev; void cmd_cb (iw &w);
175 iow socket_ev; void socket_cb (iow &w, int got); 239 client_container cc_inv, cc_other;
176 240
177 std::deque< command, slice_allocator<command> > cmd_queue; 241 std::deque< command, slice_allocator<command> > cmd_queue;
178
179 // resets movement state
180 bool may_execute (const packet_type *pkt) const;
181 void execute (const packet_type *pkt, char *data, int datalen);
182
183 void queue_command (packet_type *handler, char *data, int datalen);
184 bool handle_command ();
185 void reset_state ();
186
187 bool handle_packet ();
188 int next_packet (); // returns length of packet or 0
189 void skip_packet (int len); // we have processed the packet, skip it
190
191 void flush ();
192 void write_outputbuffer ();
193 void send (void *buf_, int len);
194
195 void send_packet (const char *buf);
196 void send_packet (const char *buf, int len);
197 void send_packet_printf (const char *format, ...);
198 void send_packet (packet &sl);
199 242
200 // large structures at the end please 243 // large structures at the end please
201 struct Map lastmap; 244 struct Map lastmap;
202 std::bitset<MAXANIMNUM> anims_sent; 245 std::bitset<MAXANIMNUM> anims_sent;
203 // if we get an incomplete packet, this is used to hold the data. 246 // if we get an incomplete packet, this is used to hold the data.
204 // we add 2 byte for the header, one for the trailing 0 byte 247 // we add 2 byte for the header, one for the trailing 0 byte
205 uint8 inbuf[MAXSOCKBUF + 2 + 1]; 248 uint8 inbuf[MAXSOCKBUF + 2 + 1];
206 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:
281 client (int fd, const char *from_ip);
282 ~client ();
207}; 283};
208 284
209#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 285#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
210 ( ((__type)>0) &&\ 286 ( ((__type)>0) &&\
211 ((__sockPtr)->has_readable_type) && \ 287 ((__sockPtr)->has_readable_type) && \
… …
248 324
249#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 325#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
250#define VERSION_SC 1027 326#define VERSION_SC 1027
251#define VERSION_INFO "Crossfire+ Server" 327#define VERSION_INFO "Crossfire+ Server"
252 328
253typedef unordered_vector<client *> sockvec; 329typedef object_vector<client, &client::active> sockvec;
254 330
255extern sockvec clients; 331extern sockvec clients;
332
333#define for_all_clients(var) \
334 for (int _i = 0; _i < clients.size (); ++_i) \
335 declvar (client *, var, clients [_i])
336
256extern int nrofpixmaps; //TODO: hrmpf, should go 337extern int nrofpixmaps; //TODO: hrmpf, should go
257 338
258#endif 339#endif
259 340

Diff Legend

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