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.2 by root, Fri Dec 15 20:07:02 2006 UTC vs.
Revision 1.14 by root, Thu Dec 21 06:12:36 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.de 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 */
… …
75 * current state. we set up our on buffers for sending/receiving, so we can 68 * current state. we set up our on buffers for sending/receiving, so we can
76 * handle some higher level functions. fd is the actual file descriptor we 69 * handle some higher level functions. fd is the actual file descriptor we
77 * are using. 70 * are using.
78 */ 71 */
79 72
80enum Sock_Status { Ns_Add, Ns_Dead };
81
82/* Only one map mode can actually be used, so lets make it a switch 73/* Only one map mode can actually be used, so lets make it a switch
83 * instead of having a bunch of different fields that needed to 74 * instead of having a bunch of different fields that needed to
84 * get toggled. 75 * get toggled.
85 */ 76 */
86enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; 77enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
87 78
88/* The following is the setup for a ring buffer for storing outbut 79/* The following is the setup for a ring buffer for storing output
89 * data that the OS can't handle right away. 80 * data that the OS can't handle right away.
90 */ 81 */
91 82
92struct Buffer 83struct Buffer
93{ 84{
94 char data[SOCKETBUFSIZE]; 85 char data[SOCKETBUFSIZE];
95 int start; 86 int start;
96 int len; 87 int len;
97}; 88};
98 89
90// a handler for a specific type of packet
91enum {
92 PF_PLAYER = 0x01, // must have valid player / will by synchronised
93 PF_PLAYING = 0x02, // must be in playing state
94};
95
96struct packet_type
97{
98 const char *name;
99 void *cb;
100 int flags;
101};
102
103struct command
104{
105 tstamp stamp;
106 const packet_type *handler;
107 char *data;
108 int datalen;
109
110 ~command ()
111 {
112 sfree<char> (data, datalen + 1);
113 }
114};
115
116struct refitem
117{
118 object_ptr op;
119};
120
121// this represents a container on the client side.
122// right now, there are only ever two of them:
123// the inventory and the floor/open container
124//TODO: unused as of yet
125struct client_container : vector< refitem, slice_allocator<refitem> >
126{
127 client *ns;
128 enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type;
129
130 bool item_changed; // one of the items in here possibly changed
131
132 // for mapspace and container
133 int x, y;
134 maptile *map;
135
136 // for container
137 object *env;
138
139 client_container (client *ns)
140 : ns (ns), type (CC_NONE) { }
141
142 tag_t tag () const;
143
144 inline iterator merge_item (iterator i, object *op);
145
146 void clear ();
147 void update ();
148
149 void set_mapspace (maptile *map, int x, int y);
150 void set_container (object *env);
151};
152
99/* how many times we are allowed to give the wrong password before being kicked. */ 153/* how many times we are allowed to give the wrong password before being kicked. */
100#define MAX_PASSWORD_FAILURES 5 154#define MAX_PASSWORD_FAILURES 5
101 155
102ACC_CLASS (client) // should become player when newsocket is a baseclass of player 156ACC_CLASS (client) // should become player when newsocket is a baseclass of player
103struct client : zero_initialised, attachable_base 157struct client : zero_initialised, attachable<client>
104{ 158{
105 enum Sock_Status status;
106 int ACC (RW, fd); 159 int ACC (RW, fd);
107 unsigned int inbuf_len; // number of bytes valid in inbuf 160 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 */ 161 uint8 *faces_sent; // This is a bitmap on sent face status
111 uint8 anims_sent[MAXANIMNUM]; 162 statsinfo stats;
112 struct statsinfo stats; 163
164 client_container cc_inv, cc_other;
113 165
114 char *ACC (RW, host); /* Which host it is connected from (ip address) */ 166 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 */ 167 uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */
116 Buffer outputbuffer; /* For undeliverable data */ 168 bool destroyed; // set when this socket is to be destroyed
169 Buffer outputbuffer;
117 170
118 bool ACC (RW, facecache); /* If true, client is caching images */ 171 bool ACC (RW, facecache); /* If true, client is caching images */
119 bool ACC (RW, sent_scroll); 172 bool ACC (RW, sent_scroll);
120 bool ACC (RW, sound); /* does the client want sound */ 173 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 */ 174 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 */ 175 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 */ 176 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 */ 177 bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */
125 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ 178 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */
126 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ 179 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */
127 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ 180 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */
128 bool ACC (RW, darkness); /* True if client wants darkness information */ 181 bool ACC (RW, darkness); /* True if client wants darkness information */
129 bool ACC (RW, image2); /* Client wants image2/face2 commands */ 182 bool ACC (RW, image2); /* Client wants image2/face2 commands */
130 bool ACC (RW, update_look); /* If true, we need to send the look window */ 183 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 */ 184 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
132 /* used to arrange text in books, scrolls, or scripted dialogs */ 185 /* 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 */ 186 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 */ 187 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
135 /* Below are flags for extedend infos to pass to client 188 /* Below are flags for extedend infos to pass to client
136 * with S->C mapextended command */ 189 * with S->C mapextended command */
137 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ 190 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
138 191
139 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ 192 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 */ 193 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
141 enum MapMode mapmode; /* Type of map commands the client wants. */ 194 enum MapMode mapmode; /* Type of map commands the client wants. */
142 uint16 ACC (RW, look_position); /* start of drawing of look window */ 195 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 */ 197 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 */ 198 uint8 ACC (RW, faceset); /* Set the client is using, default 0 */
146 199
147 maptile *ACC (RW, current_map); // CF+ last/current player map 200 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 201 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
149 char ACC (RW, version)[64]; // CF+ client name/version 202 char ACC (RW, version)[64]; // CF+ client name/version
150 203
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 204 player *ACC (RO, pl);//TODO should not be here, preferably
154 205
155 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ 206 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 207
159 client (int fd, const char *from_ip); 208 client (int fd, const char *from_ip);
160 ~client (); 209 ~client ();
210 void destroy ();
161 211
212 iw cmd_ev; void cmd_cb (iw &w);
213 iow socket_ev; void socket_cb (iow &w, int got);
214
215 std::deque< command, slice_allocator<command> > cmd_queue;
216
217 // large structures at the end please
218 struct Map lastmap;
219 std::bitset<MAXANIMNUM> anims_sent;
220 // if we get an incomplete packet, this is used to hold the data.
221 // we add 2 byte for the header, one for the trailing 0 byte
222 uint8 inbuf[MAXSOCKBUF + 2 + 1];
223
224 bool may_execute (const packet_type *pkt) const;
225 void execute (const packet_type *pkt, char *data, int datalen);
226
227 void queue_command (packet_type *handler, char *data, int datalen);
228 bool handle_command ();
229 // resets movement state
230 void reset_state ();
231
232 bool handle_packet ();
162 int read_packet (); // returns length of packet or 0 233 int next_packet (); // returns length of packet or 0
163 void skip_packet (int len); // we have processed the packet, skip it 234 void skip_packet (int len); // we have processed the packet, skip it
164 235
165 void flush (); 236 void flush ();
166 void write_outputbuffer (); 237 void write_outputbuffer ();
167 void send (void *buf_, int len); 238 void send (void *buf_, int len);
168 239
169 void send_packet (const char *buf); 240 void send_packet (const char *buf);
170 void send_packet (const char *buf, int len); 241 void send_packet (const char *buf, int len);
242 void send_packet_printf (const char *format, ...);
171 void send_packet (packet &sl); 243 void send_packet (packet &sl);
244
245 // called when something under the player changes
246 void floorbox_update () { update_look = 1; }
247 // called when the player has been moved
248 void floorbox_reset () { look_position = 0; floorbox_update (); }
249
250 static client *create (int fd, const char *peername);
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