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.1 by root, Fri Dec 15 19:59:19 2006 UTC vs.
Revision 1.13 by root, Wed Dec 20 09:14:22 2006 UTC

1
2/* 1/*
3 CrossFire, A Multiplayer game for the X Window System 2 CrossFire, A Multiplayer game for the X Window System
4 3
5 Copyright (C) 2002 Mark Wedel & Crossfire Development Team 4 Copyright (C) 2002 Mark Wedel & Crossfire Development Team
6 Copyright (C) 1992 Frank Tore Johansen 5 Copyright (C) 1992 Frank Tore Johansen
… …
17 16
18 You should have received a copy of the GNU General Public License 17 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software 18 along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 20
22 The author can be reached via e-mail to crossfire-devel@real-time.com 21 The author can be reached via e-mail to crossfire@schmorp.de
23*/
24
25/*
26 newserver.h defines various structures and values that are use for the
27 new client server communication method. Values defined here are only
28 used on the server side code. For shared client/server values, see
29 newclient.h
30*/ 22*/
31 23
32#ifndef CLIENT_H 24#ifndef CLIENT_H
33#define CLIENT_H 25#define CLIENT_H
34 26
35/* Reduce this from 50 to 5 - as it is now, there will never be more 27#include <deque>
36 * than 3 anyways. 28#include <bitset>
37 */ 29#include <tr1/unordered_set>
38 30
39#define NUM_LOOK_OBJECTS 50 31// (possibly) max. number of objects "per page" in the ground container
32#define FLOORBOX_PAGESIZE 50
40 33
41struct MapCell 34struct MapCell
42{ 35{
43 UUID player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient 36 UUID player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
44 int count; /* This is really darkness in the map1 command */ 37 int count; /* This is really darkness in the map1 command */
… …
83 * instead of having a bunch of different fields that needed to 76 * instead of having a bunch of different fields that needed to
84 * get toggled. 77 * get toggled.
85 */ 78 */
86enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; 79enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
87 80
88/* The following is the setup for a ring buffer for storing outbut 81/* The following is the setup for a ring buffer for storing output
89 * data that the OS can't handle right away. 82 * data that the OS can't handle right away.
90 */ 83 */
91 84
92struct Buffer 85struct Buffer
93{ 86{
94 char data[SOCKETBUFSIZE]; 87 char data[SOCKETBUFSIZE];
95 int start; 88 int start;
96 int len; 89 int len;
97}; 90};
98 91
92// a handler for a specific type of packet
93enum {
94 PF_PLAYER = 0x01, // must have valid player / will by synchronised
95 PF_PLAYING = 0x02, // must be in playing state
96};
97
98struct packet_type
99{
100 const char *name;
101 void *cb;
102 int flags;
103};
104
105struct command
106{
107 tstamp stamp;
108 const packet_type *handler;
109 char *data;
110 int datalen;
111
112 ~command ()
113 {
114 sfree<char> (data, datalen + 1);
115 }
116};
117
118struct refitem
119{
120 object_ptr op;
121};
122
123// this represents a container on the client side.
124// right now, there are only ever two of them:
125// the inventory and the floor/open container
126//TODO: unused as of yet
127struct client_container : vector< refitem, slice_allocator<refitem> >
128{
129 client *ns;
130 enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type;
131
132 bool item_changed; // one of the items in here possibly changed
133
134 // for mapspace and container
135 int x, y;
136 maptile *map;
137
138 // for container
139 object *env;
140
141 client_container (client *ns)
142 : ns (ns), type (CC_NONE) { }
143
144 tag_t tag () const;
145
146 inline iterator merge_item (iterator i, object *op);
147
148 void clear ();
149 void update ();
150
151 void set_mapspace (maptile *map, int x, int y);
152 void set_container (object *env);
153};
154
99/* how many times we are allowed to give the wrong password before being kicked. */ 155/* how many times we are allowed to give the wrong password before being kicked. */
100#define MAX_PASSWORD_FAILURES 5 156#define MAX_PASSWORD_FAILURES 5
101 157
102ACC_CLASS (client) // should become player when newsocket is a baseclass of player 158ACC_CLASS (client) // should become player when newsocket is a baseclass of player
103struct client : zero_initialised, attachable_base 159struct client : zero_initialised, attachable_base
104{ 160{
105 enum Sock_Status status; 161 enum Sock_Status status;
106 int ACC (RW, fd); 162 int ACC (RW, fd);
107 unsigned int inbuf_len; // number of bytes valid in inbuf 163 unsigned int inbuf_len; // number of bytes valid in inbuf
108 struct Map lastmap;
109 size_t faces_sent_len; /* This is the number of elements allocated in faces_sent[] */
110 uint8 *faces_sent; /* This is a bitmap on sent face status */ 164 uint8 *faces_sent; // This is a bitmap on sent face status
111 uint8 anims_sent[MAXANIMNUM]; 165 statsinfo stats;
112 struct statsinfo stats; 166
167 client_container cc_inv, cc_other;
113 168
114 char *ACC (RW, host); /* Which host it is connected from (ip address) */ 169 char *ACC (RW, host); /* Which host it is connected from (ip address) */
115 uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */ 170 uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */
116 Buffer outputbuffer; /* For undeliverable data */ 171 Buffer outputbuffer;
117 172
118 bool ACC (RW, facecache); /* If true, client is caching images */ 173 bool ACC (RW, facecache); /* If true, client is caching images */
119 bool ACC (RW, sent_scroll); 174 bool ACC (RW, sent_scroll);
120 bool ACC (RW, sound); /* does the client want sound */ 175 bool ACC (RW, sound); /* does the client want sound */
121 bool ACC (RW, exp64); /* Client wants 64 bit exp data, as well as skill data */ 176 bool ACC (RW, exp64); /* Client wants 64 bit exp data, as well as skill data */
122 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ 177 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
123 bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ 178 bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */
124 bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ 179 bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */
125 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ 180 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */
126 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ 181 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */
127 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ 182 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */
128 bool ACC (RW, darkness); /* True if client wants darkness information */ 183 bool ACC (RW, darkness); /* True if client wants darkness information */
129 bool ACC (RW, image2); /* Client wants image2/face2 commands */ 184 bool ACC (RW, image2); /* Client wants image2/face2 commands */
130 bool ACC (RW, update_look); /* If true, we need to send the look window */ 185 bool ACC (RW, update_look); /* If true, we need to send the look window */
131 bool ACC (RW, has_readable_type); /* If true client accept additional text information */ 186 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
132 /* used to arrange text in books, scrolls, or scripted dialogs */ 187 /* used to arrange text in books, scrolls, or scripted dialogs */
133 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ 188 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
134 bool ACC (RW, ext_mapinfos); /* If true client accept additionnal info on maps */ 189 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
135 /* Below are flags for extedend infos to pass to client 190 /* Below are flags for extedend infos to pass to client
136 * with S->C mapextended command */ 191 * with S->C mapextended command */
137 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ 192 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
138 193
139 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 */
140 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 */
141 enum MapMode mapmode; /* Type of map commands the client wants. */ 196 enum MapMode mapmode; /* Type of map commands the client wants. */
142 uint16 ACC (RW, look_position); /* start of drawing of look window */ 197 uint16 ACC (RW, look_position); /* start of drawing of look window */
… …
144 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ 199 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
145 uint8 ACC (RW, faceset); /* Set the client is using, default 0 */ 200 uint8 ACC (RW, faceset); /* Set the client is using, default 0 */
146 201
147 maptile *ACC (RW, current_map); // CF+ last/current player map 202 maptile *ACC (RW, current_map); // CF+ last/current player map
148 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position 203 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
149 char ACC (RW, version)[64]; // CF+ client name/version 204 char ACC (RW, version)[64]; // CF+ client name/version
150 205
151 /* If we get an incomplete packet, this is used to hold the data. */
152 uint8 inbuf[MAXSOCKBUF];
153 player *ACC (RO, pl);//TODO should not be here, preferably 206 player *ACC (RO, pl);//TODO should not be here, preferably
154 207
155 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ 208 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
156
157 iow socket_ev; void socket_cb (iow &w, int got);
158 209
159 client (int fd, const char *from_ip); 210 client (int fd, const char *from_ip);
160 ~client (); 211 ~client ();
212 void destroy ();
161 213
214 iw cmd_ev; void cmd_cb (iw &w);
215 iow socket_ev; void socket_cb (iow &w, int got);
216
217 std::deque< command, slice_allocator<command> > cmd_queue;
218
219 // resets movement state
220 bool may_execute (const packet_type *pkt) const;
221 void execute (const packet_type *pkt, char *data, int datalen);
222
223 void queue_command (packet_type *handler, char *data, int datalen);
224 bool handle_command ();
225 void reset_state ();
226
227 bool handle_packet ();
162 int read_packet (); // returns length of packet or 0 228 int next_packet (); // returns length of packet or 0
163 void skip_packet (int len); // we have processed the packet, skip it 229 void skip_packet (int len); // we have processed the packet, skip it
164 230
165 void flush (); 231 void flush ();
166 void write_outputbuffer (); 232 void write_outputbuffer ();
167 void send (void *buf_, int len); 233 void send (void *buf_, int len);
168 234
169 void send_packet (const char *buf); 235 void send_packet (const char *buf);
170 void send_packet (const char *buf, int len); 236 void send_packet (const char *buf, int len);
237 void send_packet_printf (const char *format, ...);
171 void send_packet (packet &sl); 238 void send_packet (packet &sl);
239
240 // called when something under the player changes
241 void floorbox_update () { update_look = 1; }
242 // called when the player has been moved
243 void floorbox_reset () { look_position = 0; floorbox_update (); }
244
245 // large structures at the end please
246 struct Map lastmap;
247 std::bitset<MAXANIMNUM> anims_sent;
248 // if we get an incomplete packet, this is used to hold the data.
249 // we add 2 byte for the header, one for the trailing 0 byte
250 uint8 inbuf[MAXSOCKBUF + 2 + 1];
172}; 251};
173 252
174#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 253#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
175 ( ((__type)>0) &&\ 254 ( ((__type)>0) &&\
176 ((__sockPtr)->has_readable_type) && \ 255 ((__sockPtr)->has_readable_type) && \

Diff Legend

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