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.97 by root, Thu Apr 8 20:05:35 2010 UTC vs.
Revision 1.111 by root, Sun Nov 11 04:29:11 2012 UTC

1/* 1/*
2 * This file is part of Deliantra, the Roguelike Realtime MMORPG. 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (©) 2005,2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team 4 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * 5 *
6 * Deliantra is free software: you can redistribute it and/or modify it under 6 * Deliantra is free software: you can redistribute it and/or modify it under
7 * the terms of the Affero GNU General Public License as published by the 7 * the terms of the Affero GNU General Public License as published by the
8 * Free Software Foundation, either version 3 of the License, or (at your 8 * Free Software Foundation, either version 3 of the License, or (at your
9 * option) any later version. 9 * option) any later version.
10 * 10 *
11 * This program is distributed in the hope that it will be useful, 11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details. 14 * GNU General Public License for more details.
15 * 15 *
16 * You should have received a copy of the Affero GNU General Public License 16 * You should have received a copy of the Affero GNU General Public License
17 * and the GNU General Public License along with this program. If not, see 17 * and the GNU General Public License along with this program. If not, see
18 * <http://www.gnu.org/licenses/>. 18 * <http://www.gnu.org/licenses/>.
19 * 19 *
20 * The authors can be reached via e-mail to <support@deliantra.net> 20 * The authors can be reached via e-mail to <support@deliantra.net>
21 */ 21 */
22 22
23#ifndef CLIENT_H 23#ifndef CLIENT_H
24#define CLIENT_H 24#define CLIENT_H
89struct statsinfo 89struct statsinfo
90{ 90{
91 char *range, *title; 91 char *range, *title;
92}; 92};
93 93
94/* This contains basic information on the socket structure. status is its
95 * current state. we set up our on buffers for sending/receiving, so we can
96 * handle some higher level functions. fd is the actual file descriptor we
97 * are using.
98 */
99
100/* Only one map mode can actually be used, so lets make it a switch
101 * instead of having a bunch of different fields that needed to
102 * get toggled.
103 */
104enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
105
106// states the socket can be in 94// states the socket can be in
107enum { 95enum {
108 ST_DEAD, // socket is dead 96 ST_DEAD, // socket is dead
109 ST_SETUP, // initial handshake / setup / login 97 ST_SETUP, // initial handshake / setup / login
110 ST_PLAYING, // logged in an playing 98 ST_PLAYING, // logged in an playing
119 PF_PLAYING = 0x02, // must be in playing state 107 PF_PLAYING = 0x02, // must be in playing state
120 PF_COMMAND0 = 0x04, // command starts at offset 0 108 PF_COMMAND0 = 0x04, // command starts at offset 0
121 PF_COMMAND6 = 0x08, // command starts at offset 6 109 PF_COMMAND6 = 0x08, // command starts at offset 6
122}; 110};
123 111
124// face type.s bit 0 means "has meta info prepended" 112// face types. bit 0 means "has meta info prepended"
125enum { 113enum {
126 FT_FACE = 0 * 2 + 0, // faces (images) 114 FT_FACE = 0 * 2 + 0, // faces (images)
127 FT_MUSIC = 1 * 2 + 1, // background music 115 FT_MUSIC = 1 * 2 + 1, // background music
128 FT_SOUND = 2 * 2 + 1, // effects 116 FT_SOUND = 2 * 2 + 1, // effects
129 FT_RSRC = 3 * 2 + 0, // generic data files 117 FT_RSRC = 3 * 2 + 0, // generic data files
148//-GPL 136//-GPL
149 137
150/* how many times we are allowed to give the wrong password before being kicked. */ 138/* how many times we are allowed to give the wrong password before being kicked. */
151#define MAX_PASSWORD_FAILURES 5 139#define MAX_PASSWORD_FAILURES 5
152 140
141/* This contains basic information on the socket connection. status is its
142 * current state. we set up our on buffers for sending/receiving, so we can
143 * handle some higher level functions. fd is the actual file descriptor we
144 * are using.
145 */
153INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player 146INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
154struct client : zero_initialised, attachable 147struct client : zero_initialised, attachable
155{ 148{
156 int ACC (RW, fd); 149 int ACC (RW, fd);
157 unsigned int inbuf_len; // number of bytes valid in inbuf 150 unsigned int inbuf_len; // number of bytes valid in inbuf
171 uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */ 164 uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */
172 uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */ 165 uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */
173 living ACC (RO, last_stats); /* Last stats as sent to client */ 166 living ACC (RO, last_stats); /* Last stats as sent to client */
174 float ACC (RW, last_speed); /* Last speed as sent to client */ 167 float ACC (RW, last_speed); /* Last speed as sent to client */
175 sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ 168 sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
176 sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */ 169 sint64 ACC (RW, last_skill_exp[CS_NUM_SKILLS]);/* shadow register. if != exp. obj update client */
177 170
178 bool ACC (RW, afk); /* player is afk */ 171 bool ACC (RW, afk); /* player is afk */
179 bool ACC (RW, sent_scroll); 172 bool ACC (RW, sent_scroll);
180 bool ACC (RW, sound); /* does the client want sound */ 173 bool ACC (RW, sound); /* does the client want sound */
181 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ 174 bool ACC (RW, bumpmsg); /* give message when bumping into walls */
175
182 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ 176 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
183 bool ACC (RW, mapinfocmd); // return map info and send map change info 177 bool ACC (RW, mapinfocmd); // return map info and send map change info
184 uint8_t ACC (RW, extcmd); // call into extensions/plugins 178 uint8 ACC (RW, extcmd); // call into extensions/plugins
179 bool ACC (RW, need_delinv0); /* If true, we need to delinv 0 before sending new floorbox */
180
185 bool ACC (RW, update_look); /* If true, we need to send the look window */ 181 bool ACC (RW, update_look); /* If true, we need to send the look window */
186 bool ACC (RW, update_spells); // If true, we need to esrv_update_spells 182 bool ACC (RW, update_spells); // If true, we need to esrv_update_spells
187 bool ACC (RW, has_readable_type); /* If true client accept additional text information */ 183 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
188 /* used to arrange text in books, scrolls, or scripted dialogs */
189 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ 184 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
185
190 bool ACC (RW, smoothing); // deliantra-style smoothing 186 bool ACC (RW, smoothing); // deliantra-style smoothing
191
192 bool ACC (RW, force_newmap); // force a newmap before next map update 187 bool ACC (RW, force_newmap); // force a newmap before next map update
193 uint16 ACC (RW, look_position); /* start of drawing of look window */ 188 uint16 ACC (RW, look_position); /* start of drawing of look window */
194 uint16 ACC (RW, mss); // likely tcp maximum segment size 189 uint16 ACC (RW, mss); // likely tcp maximum segment size
195 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
196 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ 190 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
197 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ 191 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
192 uint8 ACC (RW, faceset); // CF+ selected faceset
193 uint8 ACC (RW, ws_version); // websocket protocol versio for framing
198 194
199 maptile_ptr ACC (RW, current_map); // CF+ last/current player map 195 maptile_ptr ACC (RW, current_map); // CF+ last/current player map
200 region_ptr ACC (RW, current_region); // CF+ last/current player region 196 region_ptr ACC (RW, current_region); // CF+ last/current player region
201 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position 197 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
202 uint8 ACC (RW, faceset); // CF+ selected faceset
203 198
204 tstamp ACC (RW, last_send); // last data send on socket. 199 tstamp ACC (RW, last_send); // last data send on socket.
205 200
206 float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */ 201 float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */
207 int ACC (RW, rate_avail); // current rate balance 202 int ACC (RW, rate_avail); // current rate balance
210 int ACC (RW, bg_scrub); // how many ticks till the next background face send 205 int ACC (RW, bg_scrub); // how many ticks till the next background face send
211 206
212 struct tcp_info tcpi; 207 struct tcp_info tcpi;
213 tstamp next_rate_adjust; 208 tstamp next_rate_adjust;
214 209
210 // websocket frame buffer
211 uint8 ws_inbuf_type; // current frame type
212 uint8 *ws_inbuf;
213 uint32 ws_inbuf_len;
214 uint32 ws_inbuf_alloc;
215
215 unordered_vector<char *> mapinfo_queue; 216 unordered_vector<char *> mapinfo_queue;
216 void mapinfo_queue_clear (); 217 void mapinfo_queue_clear ();
217 void mapinfo_queue_run (); 218 void mapinfo_queue_run ();
218 bool mapinfo_try (char *buf); 219 bool mapinfo_try (char *buf);
219 220
220 struct ixsend { 221 struct ixsend {
221 int16_t pri; // unused 222 sint16 pri; // higher means faces are sent earlier, default 0
222 faceidx idx; 223 faceidx idx;
223 uint32_t ofs; // if != 0, need to send remaining bytes of partial_face 224 uint32 ofs; // if != 0, need to send remaining bytes of partial_face
225 uint8 *data;
226 SV *data_sv;
224 }; 227 };
225 std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix 228 std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix
229 MTH void ix_send (faceidx idx, sint16 pri, SV *data_sv); // keeps a copy of data_sv
230 void ix_pop (); // pops topmost ixsend
226 231
227 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx 232 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
228 MTH void flush_fx (); // send fx if required 233 MTH void flush_fx (); // send fx if required
234
235 MTH void invalidate_face (faceidx idx);
236 MTH void invalidate_all_faces ();
229 237
230 void do_destroy (); 238 void do_destroy ();
231 void gather_callbacks (AV *&callbacks, event_type event) const; 239 void gather_callbacks (AV *&callbacks, event_type event) const;
232 240
233 iow socket_ev; void socket_cb (iow &w, int revents); 241 iow socket_ev; void socket_cb (iow &w, int revents);
241 std::bitset<FT_NUM> fx_want; 249 std::bitset<FT_NUM> fx_want;
242 250
243 // if we get an incomplete packet, this is used to hold the data. 251 // if we get an incomplete packet, this is used to hold the data.
244 // we add 2 byte for the header, one for the trailing 0 byte 252 // we add 2 byte for the header, one for the trailing 0 byte
245 uint8 inbuf[MAXSOCKBUF + 2 + 1]; 253 uint8 inbuf[MAXSOCKBUF + 2 + 1];
254 void inbuf_handle ();
246 255
247 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 }; 256 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
248 struct msg_buf 257 struct msg_buf
249 { 258 {
250 tick_t expire; 259 tick_t expire;
281 void skip_packet (int len); // we have processed the packet, skip it 290 void skip_packet (int len); // we have processed the packet, skip it
282 291
283 MTH void flush (); 292 MTH void flush ();
284 MTH void write_outputbuffer (); 293 MTH void write_outputbuffer ();
285 MTH int outputbuffer_len () const { return outputbuffer.len; } 294 MTH int outputbuffer_len () const { return outputbuffer.len; }
295 void send_raw (void *buf_, int len);
296
286 void send (void *buf_, int len); 297 void send (void *buf_, int len);
287
288 void send_packet (const_octet_string buf); 298 void send_packet (const_octet_string buf);
289 void send_packet (const_octet_string buf, int len); 299 void send_packet (const_octet_string buf, int len);
290 void send_packet_printf (const_utf8_string format, ...) attribute ((format (printf, 2, 3))); 300 void send_packet_printf (const_utf8_string format, ...) attribute ((format (printf, 2, 3)));
291 void send_packet (packet &sl); 301 void send_packet (packet &sl);
292 302
306 MTH void tick (); // called every server tick to do housekeeping etc. 316 MTH void tick (); // called every server tick to do housekeeping etc.
307 317
308 MTH static client *create (int fd, const char *peername); 318 MTH static client *create (int fd, const char *peername);
309 MTH static void clock (); 319 MTH static void clock ();
310 MTH static void flush_sockets (); 320 MTH static void flush_sockets ();
321
322 MTH void run (); // start handshake after init
311 323
312protected: 324protected:
313 client (int fd, const char *from_ip); 325 client (int fd, const char *from_ip);
314 ~client (); 326 ~client ();
315}; 327};
344 ACC (RW, tcpi.tcpi_snd_cwnd); 356 ACC (RW, tcpi.tcpi_snd_cwnd);
345 ACC (RW, tcpi.tcpi_advmss); 357 ACC (RW, tcpi.tcpi_advmss);
346 ACC (RW, tcpi.tcpi_reordering); 358 ACC (RW, tcpi.tcpi_reordering);
347#endif 359#endif
348 360
349//+GPL
350
351#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
352 ( ((__type)>0) &&\
353 ((__sockPtr)->has_readable_type) && \
354 ((__sockPtr)->supported_readables & (1<<(__type))) )
355
356#define FACE_TYPES 1
357#define PNG_FACE_INDEX 0
358
359//-GPL
360
361typedef object_vector<client, &client::active> sockvec; 361typedef object_vector<client, &client::active> sockvec;
362 362
363extern sockvec clients; 363extern sockvec clients;
364 364
365#define for_all_clients(var) \ 365#define for_all_clients(var) \

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines