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.6 by root, Sat Dec 16 18:39:26 2006 UTC vs.
Revision 1.23 by pippijn, Sat Jan 6 14:42:30 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
… …
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>
29#include <bitset>
30#include <tr1/unordered_set>
28 31
29// (possibly) max. number of objects "per page" in the ground container 32// (possibly) max. number of objects "per page" in the ground container
30#define NUM_LOOK_OBJECTS 50 33#define FLOORBOX_PAGESIZE 50
31 34
32struct MapCell 35struct MapCell
33{ 36{
34 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
35 int count; /* This is really darkness in the map1 command */ 38 int count; /* This is really darkness in the map1 command */
… …
66 * 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
67 * 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
68 * are using. 71 * are using.
69 */ 72 */
70 73
71enum Sock_Status { Ns_Add, Ns_Dead };
72
73/* 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
74 * instead of having a bunch of different fields that needed to 75 * instead of having a bunch of different fields that needed to
75 * get toggled. 76 * get toggled.
76 */ 77 */
77enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; 78enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
78 79
79/* 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
80 * data that the OS can't handle right away. 81 * data that the OS can't handle right away.
81 */ 82 */
82
83struct Buffer 83struct Buffer
84{ 84{
85 char data[SOCKETBUFSIZE]; 85 char data[SOCKETBUFSIZE];
86 int start; 86 int start;
87 int len; 87 int len;
88}; 88};
89 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_CONFIRM_QUIT,
98 ST_CHANGE_CLASS,
99 ST_GET_PARTY_PASSWORD,
100};
101
90// a handler for a specific type of packet 102// a handler for a specific type of packet
91enum { 103enum {
92 PF_PLAYER = 0x01, // must have valid player 104 PF_PLAYER = 0x01, // must have valid player / will by synchronised
93 PF_IMMEDIATE = 0x02, // TODO: hack, can be executed immediately
94 PF_PLAYING = 0x04, // must be in playing state 105 PF_PLAYING = 0x02, // must be in playing state
95}; 106};
96 107
97struct packet_type 108struct packet_type
98{ 109{
99 const char *name; 110 const char *name;
… …
108 char *data; 119 char *data;
109 int datalen; 120 int datalen;
110 121
111 ~command () 122 ~command ()
112 { 123 {
113 sfree (data, datalen); 124 sfree<char> (data, datalen + 1);
114 } 125 }
126};
127
128struct refitem
129{
130 object_ptr op;
131};
132
133// this represents a container on the client side.
134// right now, there are only ever two of them:
135// the inventory and the floor/open container
136//TODO: unused as of yet
137struct client_container : vector< refitem, slice_allocator<refitem> >
138{
139 client *ns;
140 enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type;
141
142 bool item_changed; // one of the items in here possibly changed
143
144 // for mapspace and container
145 int x, y;
146 maptile *map;
147
148 // for container
149 object *env;
150
151 client_container (client *ns)
152 : ns (ns), type (CC_NONE) { }
153
154 tag_t tag () const;
155
156 inline iterator merge_item (iterator i, object *op);
157
158 void clear ();
159 void update ();
160
161 void set_mapspace (maptile *map, int x, int y);
162 void set_container (object *env);
115}; 163};
116 164
117/* how many times we are allowed to give the wrong password before being kicked. */ 165/* how many times we are allowed to give the wrong password before being kicked. */
118#define MAX_PASSWORD_FAILURES 5 166#define MAX_PASSWORD_FAILURES 5
119 167
120ACC_CLASS (client) // should become player when newsocket is a baseclass of player 168INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
121struct client : zero_initialised, attachable_base 169struct client : zero_initialised, attachable
122{ 170{
123 enum Sock_Status status;
124 int ACC (RW, fd); 171 int ACC (RW, fd);
125 unsigned int inbuf_len; // number of bytes valid in inbuf 172 unsigned int inbuf_len; // number of bytes valid in inbuf
126 struct Map lastmap;
127 size_t faces_sent_len; /* This is the number of elements allocated in faces_sent[] */
128 uint8 *faces_sent; /* This is a bitmap on sent face status */ 173 uint8 *faces_sent; // This is a bitmap on sent face status
129 uint8 anims_sent[MAXANIMNUM];
130 struct statsinfo stats; 174 statsinfo stats;
175
176 client_container cc_inv, cc_other;
177 Buffer outputbuffer;
131 178
132 char *ACC (RW, host); /* Which host it is connected from (ip address) */ 179 char *ACC (RW, host); /* Which host it is connected from (ip address) */
180 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
133 uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */ 181 uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */
134 Buffer outputbuffer; /* For undeliverable data */
135 182
183 bool ACC (RW, afk); /* player is afk */
136 bool ACC (RW, facecache); /* If true, client is caching images */ 184 bool ACC (RW, facecache); /* If true, client is caching images */
137 bool ACC (RW, sent_scroll); 185 bool ACC (RW, sent_scroll);
138 bool ACC (RW, sound); /* does the client want sound */ 186 bool ACC (RW, sound); /* does the client want sound */
139 bool ACC (RW, exp64); /* Client wants 64 bit exp data, as well as skill data */
140 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ 187 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
141 bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ 188 bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */
142 bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ 189 bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */
143 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ 190 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */
144 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ 191 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */
145 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ 192 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */
146 bool ACC (RW, darkness); /* True if client wants darkness information */ 193 bool ACC (RW, darkness); /* True if client wants darkness information */
147 bool ACC (RW, image2); /* Client wants image2/face2 commands */ 194 bool ACC (RW, image2); /* Client wants image2/face2 commands */
148 bool ACC (RW, update_look); /* If true, we need to send the look window */ 195 bool ACC (RW, update_look); /* If true, we need to send the look window */
149 bool ACC (RW, has_readable_type); /* If true client accept additional text information */ 196 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
150 /* used to arrange text in books, scrolls, or scripted dialogs */ 197 /* used to arrange text in books, scrolls, or scripted dialogs */
151 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ 198 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
152 bool ACC (RW, ext_mapinfos); /* If true client accept additionnal info on maps */ 199 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
153 /* Below are flags for extedend infos to pass to client 200 /* Below are flags for extedend infos to pass to client
154 * with S->C mapextended command */ 201 * with S->C mapextended command */
155 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ 202 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
156 203
157 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ 204 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
158 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ 205 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
159 enum MapMode mapmode; /* Type of map commands the client wants. */ 206 enum MapMode mapmode; /* Type of map commands the client wants. */
160 uint16 ACC (RW, look_position); /* start of drawing of look window */ 207 uint16 ACC (RW, look_position); /* start of drawing of look window */
… …
162 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ 209 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
163 uint8 ACC (RW, faceset); /* Set the client is using, default 0 */ 210 uint8 ACC (RW, faceset); /* Set the client is using, default 0 */
164 211
165 maptile *ACC (RW, current_map); // CF+ last/current player map 212 maptile *ACC (RW, current_map); // CF+ last/current player map
166 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position 213 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
167 char ACC (RW, version)[64]; // CF+ client name/version 214 char ACC (RW, version)[64]; // CF+ client name/version
168 215
216 player_ptr ACC (RO, pl);
217
218 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
219
220 void do_destroy ();
221 void gather_callbacks (AV *&callbacks, event_type event) const;
222
223 iw cmd_ev; void cmd_cb (iw &w);
224 iow socket_ev; void socket_cb (iow &w, int got);
225
226 std::deque< command, slice_allocator<command> > cmd_queue;
227
228 // large structures at the end please
229 struct Map lastmap;
230 std::bitset<MAXANIMNUM> anims_sent;
169 // if we get an incomplete packet, this is used to hold the data. 231 // if we get an incomplete packet, this is used to hold the data.
170 // we add 2 byte for the header, one for the trailing 0 byte 232 // we add 2 byte for the header, one for the trailing 0 byte
171 uint8 inbuf[MAXSOCKBUF + 2 + 1]; 233 uint8 inbuf[MAXSOCKBUF + 2 + 1];
172 player *ACC (RO, pl);//TODO should not be here, preferably
173 234
174 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
175
176 client (int fd, const char *from_ip);
177 ~client ();
178 void destroy ();
179
180 iw cmd_ev; void cmd_cb (iw &w);
181 iow socket_ev; void socket_cb (iow &w, int got);
182
183 std::deque< command, slice_allocator<command> > cmd_queue;
184
185 // resets movement state
186 bool may_execute (const packet_type *pkt) const; 235 bool may_execute (const packet_type *pkt) const;
187 void execute (const packet_type *pkt, char *data, int datalen); 236 void execute (const packet_type *pkt, char *data, int datalen);
188 237
189 void queue_command (packet_type *handler, char *data, int datalen); 238 void queue_command (packet_type *handler, char *data, int datalen);
190 bool handle_command (); 239 MTH bool handle_command ();
240 // resets movement state
191 void reset_state (); 241 MTH void reset_state ();
192 242
193 bool handle_packet (); 243 MTH bool handle_packet ();
194 int next_packet (); // returns length of packet or 0 244 int next_packet (); // returns length of packet or 0
195 void skip_packet (int len); // we have processed the packet, skip it 245 void skip_packet (int len); // we have processed the packet, skip it
196 246
197 void flush (); 247 MTH void flush ();
198 void write_outputbuffer (); 248 MTH void write_outputbuffer ();
199 void send (void *buf_, int len); 249 void send (void *buf_, int len);
200 250
201 void send_packet (const char *buf); 251 void send_packet (const char *buf);
202 void send_packet (const char *buf, int len); 252 void send_packet (const char *buf, int len);
203 void send_packet_printf (const char *format, ...); 253 void send_packet_printf (const char *format, ...);
204 void send_packet (packet &sl); 254 void send_packet (packet &sl);
255
256 // called when something under the player changes
257 MTH void floorbox_update () { update_look = 1; }
258 // called when the player has been moved
259 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
260
261 MTH static client *create (int fd, const char *peername);
262
263protected:
264 client (int fd, const char *from_ip);
265 ~client ();
205}; 266};
206 267
207#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 268#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
208 ( ((__type)>0) &&\ 269 ( ((__type)>0) &&\
209 ((__sockPtr)->has_readable_type) && \ 270 ((__sockPtr)->has_readable_type) && \

Diff Legend

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