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.89 by root, Thu Nov 5 15:57:15 2009 UTC vs.
Revision 1.117 by root, Sat Jan 28 23:58:52 2017 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 Marc Alexander Lehmann / Robin Redeker / the Deliantra team 4 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,2015,2016 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
25
26#include <deque>
27#include <bitset>
28#include <tr1/unordered_set>
29 25
30#if HAVE_TCP_INFO 26#if HAVE_TCP_INFO
31# include <netinet/tcp.h> 27# include <netinet/tcp.h>
32#else 28#else
33 struct tcp_info { 29 struct tcp_info {
93struct statsinfo 89struct statsinfo
94{ 90{
95 char *range, *title; 91 char *range, *title;
96}; 92};
97 93
98/* This contains basic information on the socket structure. status is its
99 * current state. we set up our on buffers for sending/receiving, so we can
100 * handle some higher level functions. fd is the actual file descriptor we
101 * are using.
102 */
103
104/* Only one map mode can actually be used, so lets make it a switch
105 * instead of having a bunch of different fields that needed to
106 * get toggled.
107 */
108enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
109
110// states the socket can be in 94// states the socket can be in
111enum { 95enum {
112 ST_DEAD, // socket is dead 96 ST_DEAD, // socket is dead
113 ST_SETUP, // initial handshake / setup / login 97 ST_SETUP, // initial handshake / setup / login
114 ST_PLAYING, // logged in an playing 98 ST_PLAYING, // logged in an playing
117 ST_GET_PARTY_PASSWORD, 101 ST_GET_PARTY_PASSWORD,
118}; 102};
119 103
120// a handler for a specific type of packet 104// a handler for a specific type of packet
121enum { 105enum {
122 PF_PLAYER = 0x01, // must have valid player / will by synchronised 106 PF_PLAYER = 0x01, // must have valid player / will by synchronised
123 PF_PLAYING = 0x02, // must be in playing state 107 PF_PLAYING = 0x02, // must be in playing state
124 PF_COMMAND0 = 0x04, // command starts at offset 0 108 PF_COMMAND = 0x04, // is a user command
125 PF_COMMAND6 = 0x08, // command starts at offset 6
126}; 109};
127 110
128// face type.s bit 0 means "has meta info prepended" 111// face types. bit 0 means "has meta info prepended"
129enum { 112enum {
130 FT_FACE = 0 * 2 + 0, // faces (images) 113 FT_IMAGE = 0 * 2 + 0, // images
131 FT_MUSIC = 1 * 2 + 1, // background music 114 FT_MUSIC = 1 * 2 + 1, // background music
132 FT_SOUND = 2 * 2 + 1, // effects 115 FT_SOUND = 2 * 2 + 1, // effects
133 FT_RSRC = 3 * 2 + 0, // generic data files 116 FT_RSRC = 3 * 2 + 0, // generic data files
134 FT_NUM, 117 FT_NUM,
135}; 118};
152//-GPL 135//-GPL
153 136
154/* how many times we are allowed to give the wrong password before being kicked. */ 137/* how many times we are allowed to give the wrong password before being kicked. */
155#define MAX_PASSWORD_FAILURES 5 138#define MAX_PASSWORD_FAILURES 5
156 139
140/* This contains basic information on the socket connection. status is its
141 * current state. we set up our on buffers for sending/receiving, so we can
142 * handle some higher level functions. fd is the actual file descriptor we
143 * are using.
144 */
157INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player 145INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
158struct client : zero_initialised, attachable 146struct client : zero_initialised, attachable
159{ 147{
160 int ACC (RW, fd); 148 int ACC (RW, fd);
161 unsigned int inbuf_len; // number of bytes valid in inbuf 149 unsigned int inbuf_len; // number of bytes valid in inbuf
175 uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */ 163 uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */
176 uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */ 164 uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */
177 living ACC (RO, last_stats); /* Last stats as sent to client */ 165 living ACC (RO, last_stats); /* Last stats as sent to client */
178 float ACC (RW, last_speed); /* Last speed as sent to client */ 166 float ACC (RW, last_speed); /* Last speed as sent to client */
179 sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ 167 sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
180 sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */ 168 sint64 ACC (RW, last_skill_exp[CS_NUM_SKILLS]);/* shadow register. if != exp. obj update client */
181 169
182 bool ACC (RW, afk); /* player is afk */ 170 bool ACC (RW, afk); /* player is afk */
183 bool ACC (RW, sent_scroll); 171 bool ACC (RW, sent_scroll);
184 bool ACC (RW, sound); /* does the client want sound */ 172 bool ACC (RW, sound); /* does the client want sound */
185 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ 173 bool ACC (RW, bumpmsg); /* give message when bumping into walls */
174
186 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ 175 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
187 bool ACC (RW, mapinfocmd); // return map info and send map change info 176 bool ACC (RW, mapinfocmd); // return map info and send map change info
188 uint8_t ACC (RW, extcmd); // call into extensions/plugins 177 uint8 ACC (RW, extcmd); // call into extensions/plugins
178 bool ACC (RW, need_delinv0); /* If true, we need to delinv 0 before sending new floorbox */
179
189 bool ACC (RW, update_look); /* If true, we need to send the look window */ 180 bool ACC (RW, update_look); /* If true, we need to send the look window */
181 bool ACC (RW, update_spells); // If true, we need to esrv_update_spells
190 bool ACC (RW, has_readable_type); /* If true client accept additional text information */ 182 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
191 /* used to arrange text in books, scrolls, or scripted dialogs */
192 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ 183 uint8 ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
184
193 bool ACC (RW, smoothing); // deliantra-style smoothing 185 bool ACC (RW, smoothing); // deliantra-style smoothing
194
195 bool ACC (RW, force_newmap); // force a newmap before next map update 186 bool ACC (RW, force_newmap); // force a newmap before next map update
196 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
197 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
198 uint16 ACC (RW, look_position); /* start of drawing of look window */ 187 uint16 ACC (RW, look_position); /* start of drawing of look window */
199 uint16 ACC (RW, mss); // likely tcp maximum segment size 188 uint16 ACC (RW, mss); // likely tcp maximum segment size
200 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
201 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ 189 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
202 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ 190 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
191 uint8 ACC (RW, tileset); // selected tileset
192 uint8 ACC (RW, ws_version); // websocket protocol versio for framing
203 193
204 maptile_ptr ACC (RW, current_map); // CF+ last/current player map 194 maptile_ptr ACC (RW, current_map); // last/current player map
205 region_ptr ACC (RW, current_region); // CF+ last/current player region 195 region_ptr ACC (RW, current_region); // last/current player region
206 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position 196 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
207 shstr ACC (RW, version); // CF+ client name/version
208 uint8 ACC (RW, faceset); // CF+ selected faceset
209 197
210 tstamp ACC (RW, last_send); // last data send on socket. 198 tstamp ACC (RW, last_send); // last data send on socket.
211 199
212 float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */ 200 float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */
213 int ACC (RW, rate_avail); // current rate balance 201 int ACC (RW, rate_avail); // current rate balance
216 int ACC (RW, bg_scrub); // how many ticks till the next background face send 204 int ACC (RW, bg_scrub); // how many ticks till the next background face send
217 205
218 struct tcp_info tcpi; 206 struct tcp_info tcpi;
219 tstamp next_rate_adjust; 207 tstamp next_rate_adjust;
220 208
209 // websocket frame buffer
210 uint8 ws_inbuf_type; // current frame type
211 uint8 *ws_inbuf;
212 uint32 ws_inbuf_len;
213 uint32 ws_inbuf_alloc;
214
221 unordered_vector<char *> mapinfo_queue; 215 unordered_vector<char *> mapinfo_queue;
222 void mapinfo_queue_clear (); 216 void mapinfo_queue_clear ();
223 void mapinfo_queue_run (); 217 void mapinfo_queue_run ();
224 bool mapinfo_try (char *buf); 218 bool mapinfo_try (char *buf);
225 219
226 struct ixsend { 220 struct ixsend {
227 int16_t pri; // unused 221 sint16 pri; // higher means faces are sent earlier, default 0
228 faceidx idx; 222 faceidx idx;
229 uint32_t ofs; // if != 0, need to send remaining bytes of partial_face 223 uint32 ofs; // if != 0, need to send remaining bytes of partial_face
224 uint8 *data;
225 SV *data_sv;
230 }; 226 };
231 std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix 227 std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix
228 MTH void ix_send (faceidx idx, sint16 pri, SV *data_sv); // keeps a copy of data_sv
229 void ix_pop (); // pops topmost ixsend
232 230
233 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx 231 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
234 MTH void flush_fx (); // send fx if required 232 MTH void flush_fx (); // send fx if required
233
234 MTH void invalidate_face (faceidx idx);
235 MTH void invalidate_all_faces ();
235 236
236 void do_destroy (); 237 void do_destroy ();
237 void gather_callbacks (AV *&callbacks, event_type event) const; 238 void gather_callbacks (AV *&callbacks, event_type event) const;
238 239
239 iow socket_ev; void socket_cb (iow &w, int revents); 240 iow socket_ev; void socket_cb (iow &w, int revents);
247 std::bitset<FT_NUM> fx_want; 248 std::bitset<FT_NUM> fx_want;
248 249
249 // if we get an incomplete packet, this is used to hold the data. 250 // if we get an incomplete packet, this is used to hold the data.
250 // we add 2 byte for the header, one for the trailing 0 byte 251 // we add 2 byte for the header, one for the trailing 0 byte
251 uint8 inbuf[MAXSOCKBUF + 2 + 1]; 252 uint8 inbuf[MAXSOCKBUF + 2 + 1];
253 void inbuf_handle ();
252 254
253 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 }; 255 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
254 struct msg_buf 256 struct msg_buf
255 { 257 {
256 tick_t expire; 258 tick_t expire;
257 int len; 259 int len;
258 int count; 260 int count;
259 char msg[MSG_BUF_SIZE]; 261 char msg[MSG_BUF_SIZE];
260 } msgbuf[MSG_BUF_COUNT]; 262 } msgbuf[MSG_BUF_COUNT];
261 263
262 MTH bool msg_suppressed (const char *msg); 264 MTH bool msg_suppressed (const_utf8_string msg);
263 265
264 /* The following is the setup for a ring buffer for storing output 266 /* The following is the setup for a ring buffer for storing output
265 * data that the OS can't handle right away. 267 * data that the OS can't handle right away.
266 * TODO: this member is enourmously large - optimise? 268 * TODO: this member is enourmously large - optimise?
267 */ 269 */
287 void skip_packet (int len); // we have processed the packet, skip it 289 void skip_packet (int len); // we have processed the packet, skip it
288 290
289 MTH void flush (); 291 MTH void flush ();
290 MTH void write_outputbuffer (); 292 MTH void write_outputbuffer ();
291 MTH int outputbuffer_len () const { return outputbuffer.len; } 293 MTH int outputbuffer_len () const { return outputbuffer.len; }
294 void send_raw (void *buf_, int len);
295
292 void send (void *buf_, int len); 296 void send (void *buf_, int len);
293
294 void send_packet (const char *buf); 297 void send_packet (const_octet_string buf);
295 void send_packet (const char *buf, int len); 298 void send_packet (const_octet_string buf, int len);
296 void send_packet_printf (const char *format, ...); 299 void send_packet_printf (const_utf8_string format, ...) attribute ((format (printf, 2, 3)));
297 void send_packet (packet &sl); 300 void send_packet (packet &sl);
298
299 void send_drawinfo (const char *msg, int flags = NDI_BLACK);
300 301
301 MTH void send_face (faceidx facenum, int pri = 0); 302 MTH void send_face (faceidx facenum, int pri = 0);
302 MTH void send_faces (object *ob); 303 MTH void send_faces (object *ob);
303 MTH void send_animation (short anim_num); 304 MTH void send_animation (short anim_num);
304 void send_msg (int color, const char *type, const char *msg); 305 void send_msg (int color, const_utf8_string type, const_utf8_string msg);
305 306
306 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); 307 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
307 // called when something under the player changes 308 // called when something under the player changes
308 MTH void floorbox_update () { update_look = 1; } 309 MTH void floorbox_update () { update_look = 1; }
309 // called when the player has been moved 310 // called when the player has been moved
312 MTH void tick (); // called every server tick to do housekeeping etc. 313 MTH void tick (); // called every server tick to do housekeeping etc.
313 314
314 MTH static client *create (int fd, const char *peername); 315 MTH static client *create (int fd, const char *peername);
315 MTH static void clock (); 316 MTH static void clock ();
316 MTH static void flush_sockets (); 317 MTH static void flush_sockets ();
318
319 MTH void run (); // start handshake after init
317 320
318protected: 321protected:
319 client (int fd, const char *from_ip); 322 client (int fd, const char *from_ip);
320 ~client (); 323 ~client ();
321}; 324};
350 ACC (RW, tcpi.tcpi_snd_cwnd); 353 ACC (RW, tcpi.tcpi_snd_cwnd);
351 ACC (RW, tcpi.tcpi_advmss); 354 ACC (RW, tcpi.tcpi_advmss);
352 ACC (RW, tcpi.tcpi_reordering); 355 ACC (RW, tcpi.tcpi_reordering);
353#endif 356#endif
354 357
355//+GPL
356
357#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
358 ( ((__type)>0) &&\
359 ((__sockPtr)->has_readable_type) && \
360 ((__sockPtr)->supported_readables & (1<<(__type))) )
361
362#define FACE_TYPES 1
363#define PNG_FACE_INDEX 0
364
365#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
366#define VERSION_SC 1026
367//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
368#define VERSION_INFO "Deliantra Server"
369
370//-GPL
371
372typedef object_vector<client, &client::active> sockvec; 358typedef object_vector<client, &client::active> sockvec;
373 359
374extern sockvec clients; 360extern sockvec clients;
375 361
376#define for_all_clients(var) \ 362#define for_all_clients(var) \
377 for (int _i = 0; _i < clients.size (); ++_i) \ 363 for (int _i = 0; _i < clients.size (); ++_i) \
378 statementvar (client *, var, clients [_i]) 364 statementvar (client *, var, clients [_i])
379 365
380// returns true when the message needs special (read: perl) treatment 366// returns true when the message needs special (read: perl) treatment
381static inline bool 367static inline bool
382msg_is_special (const char *msg, bool nl_special = true) 368msg_is_special (const_any_string msg, bool nl_special = true)
383{ 369{
384 return msg [strcspn (msg, nl_special ? "<&\n" : "<&")]; 370 return msg [strcspn (msg, nl_special ? "<&\n" : "<&")];
385} 371}
386 372
387#endif 373#endif

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines