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.10 by root, Tue Dec 19 05:12:52 2006 UTC vs.
Revision 1.107 by root, Mon Oct 29 23:55:53 2012 UTC

1/* 1/*
2 CrossFire, A Multiplayer game for the X Window System 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 3 *
4 Copyright (C) 2002 Mark Wedel & Crossfire Development Team 4 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 Copyright (C) 1992 Frank Tore Johansen 5 *
6 6 * Deliantra is free software: you can redistribute it and/or modify it under
7 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 7 * the terms of the Affero GNU General Public License as published by the
9 the Free Software Foundation; either version 2 of the License, or 8 * Free Software Foundation, either version 3 of the License, or (at your
10 (at your option) any later version. 9 * option) any later version.
11 10 *
12 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,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details. 14 * GNU General Public License for more details.
16 15 *
17 You should have received a copy of the GNU General Public License 16 * You should have received a copy of the Affero GNU General Public License
18 along with this program; if not, write to the Free Software 17 * and the GNU General Public License along with this program. If not, see
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 18 * <http://www.gnu.org/licenses/>.
20 19 *
21 The author can be reached via e-mail to crossfire@schmorp.de 20 * The authors can be reached via e-mail to <support@deliantra.net>
22*/ 21 */
23 22
24#ifndef CLIENT_H 23#ifndef CLIENT_H
25#define CLIENT_H 24#define CLIENT_H
26 25
27#include <deque> 26#if HAVE_TCP_INFO
28#include <bitset> 27# include <netinet/tcp.h>
28#else
29 struct tcp_info {
30 // dummy
31 int tcpi_state;
32 int tcpi_ca_state;
33 int tcpi_retransmits;
34 int tcpi_probes;
35 int tcpi_backoff;
36 int tcpi_options;
37 int tcpi_snd_wscale;
38 int tcpi_rcv_wscale;
39 int tcpi_rto;
40 int tcpi_ato;
41 int tcpi_snd_mss;
42 int tcpi_rcv_mss;
43 int tcpi_unacked;
44 int tcpi_sacked;
45 int tcpi_lost;
46 int tcpi_retrans;
47 int tcpi_fackets;
48 int tcpi_last_data_sent;
49 int tcpi_last_ack_sent;
50 int tcpi_last_data_recv;
51 int tcpi_last_ack_recv;
52 int tcpi_pmtu;
53 int tcpi_rcv_ssthresh;
54 int tcpi_rtt;
55 int tcpi_rttvar;
56 int tcpi_snd_ssthresh;
57 int tcpi_snd_cwnd;
58 int tcpi_advmss;
59 int tcpi_reordering;
60 };
61#endif
62
63//+GPL
29 64
30// (possibly) max. number of objects "per page" in the ground container 65// (possibly) max. number of objects "per page" in the ground container
31#define NUM_LOOK_OBJECTS 50 66#define FLOORBOX_PAGESIZE 50
32 67
33struct MapCell 68struct MapCell
34{ 69{
35 UUID player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient 70 tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
36 int count; /* This is really darkness in the map1 command */ 71 int count; /* This is really darkness in the map1 command */
37 uint16 faces[MAP_LAYERS]; 72 faceidx faces[MAP_LAYERS];
38 uint16 smooth[MAP_LAYERS];
39 unsigned char stat_hp; // health of something in this space, or 0 73 unsigned char stat_hp; // health of something in this space, or 0
40 unsigned char flags; 74 unsigned char flags;
75 uint8_t smooth[MAP_LAYERS];
41}; 76};
42 77
43/* This basically defines the largest size an
44 * archetype may be - it is used for allocation of
45 * some structures, as well as determining how far
46 * we should look for the heads of big images.
47 */
48#define MAX_HEAD_OFFSET 8
49
50#define MAX_CLIENT_X (MAP_CLIENT_X + MAX_HEAD_OFFSET) 78#define MAX_CLIENT_X MAP_CLIENT_X
51#define MAX_CLIENT_Y (MAP_CLIENT_Y + MAX_HEAD_OFFSET) 79#define MAX_CLIENT_Y MAP_CLIENT_Y
52 80
53struct Map 81struct Map
54{ 82{
55 struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y]; 83 struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y];
56}; 84};
57 85
58/* True max is 16383 given current map compaction method */ 86/* True max is 16383 given current map compaction method */
59# define MAXANIMNUM 2000 87#define MAXANIMNUM 10000
60 88
61struct statsinfo 89struct statsinfo
62{ 90{
63 char *range, *title; 91 char *range, *title;
64}; 92};
… …
67 * current state. we set up our on buffers for sending/receiving, so we can 95 * current state. we set up our on buffers for sending/receiving, so we can
68 * handle some higher level functions. fd is the actual file descriptor we 96 * handle some higher level functions. fd is the actual file descriptor we
69 * are using. 97 * are using.
70 */ 98 */
71 99
72enum Sock_Status { Ns_Add, Ns_Dead }; 100// states the socket can be in
101enum {
102 ST_DEAD, // socket is dead
103 ST_SETUP, // initial handshake / setup / login
104 ST_PLAYING, // logged in an playing
105 ST_CUSTOM, // waiting for custom reply
73 106
74/* Only one map mode can actually be used, so lets make it a switch 107 ST_GET_PARTY_PASSWORD,
75 * instead of having a bunch of different fields that needed to
76 * get toggled.
77 */
78enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
79
80/* The following is the setup for a ring buffer for storing outbut
81 * data that the OS can't handle right away.
82 */
83
84struct Buffer
85{
86 char data[SOCKETBUFSIZE];
87 int start;
88 int len;
89}; 108};
90 109
91// a handler for a specific type of packet 110// a handler for a specific type of packet
92enum { 111enum {
93 PF_PLAYER = 0x01, // must have valid player / will by synchronised 112 PF_PLAYER = 0x01, // must have valid player / will by synchronised
94 PF_PLAYING = 0x02, // must be in playing state 113 PF_PLAYING = 0x02, // must be in playing state
114 PF_COMMAND0 = 0x04, // command starts at offset 0
115 PF_COMMAND6 = 0x08, // command starts at offset 6
116};
117
118// face type.s bit 0 means "has meta info prepended"
119enum {
120 FT_FACE = 0 * 2 + 0, // faces (images)
121 FT_MUSIC = 1 * 2 + 1, // background music
122 FT_SOUND = 2 * 2 + 1, // effects
123 FT_RSRC = 3 * 2 + 0, // generic data files
124 FT_NUM,
95}; 125};
96 126
97struct packet_type 127struct packet_type
98{ 128{
99 const char *name; 129 const char *name;
… …
105{ 135{
106 tstamp stamp; 136 tstamp stamp;
107 const packet_type *handler; 137 const packet_type *handler;
108 char *data; 138 char *data;
109 int datalen; 139 int datalen;
110
111 ~command ()
112 {
113 sfree<char> (data, datalen + 1);
114 }
115}; 140};
141
142//-GPL
116 143
117/* how many times we are allowed to give the wrong password before being kicked. */ 144/* how many times we are allowed to give the wrong password before being kicked. */
118#define MAX_PASSWORD_FAILURES 5 145#define MAX_PASSWORD_FAILURES 5
119 146
120ACC_CLASS (client) // should become player when newsocket is a baseclass of player 147INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
121struct client : zero_initialised, attachable_base 148struct client : zero_initialised, attachable
122{ 149{
123 enum Sock_Status status;
124 int ACC (RW, fd); 150 int ACC (RW, fd);
125 unsigned int inbuf_len; // number of bytes valid in inbuf 151 unsigned int inbuf_len; // number of bytes valid in inbuf
126 uint8 *faces_sent; // This is a bitmap on sent face status 152 statsinfo stats;
127 struct statsinfo stats; 153 object_vector_index ACC (RO, active);
154 player_ptr ACC (RO, pl);
128 155
129 char *ACC (RW, host); /* Which host it is connected from (ip address) */ 156 char *ACC (RW, host); /* Which host it is connected from (ip address) */
130 uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */ 157 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
131 Buffer outputbuffer;
132 158
133 bool ACC (RW, facecache); /* If true, client is caching images */ 159 sint8 ACC (RW, last_level); /* Last level we sent to client */
160 uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */
161 float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */
162 sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */
163 sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */
164 uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */
165 uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */
166 uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */
167 living ACC (RO, last_stats); /* Last stats as sent to client */
168 float ACC (RW, last_speed); /* Last speed as sent to client */
169 sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
170 sint64 ACC (RW, last_skill_exp[CS_NUM_SKILLS]);/* shadow register. if != exp. obj update client */
171
172 bool ACC (RW, afk); /* player is afk */
134 bool ACC (RW, sent_scroll); 173 bool ACC (RW, sent_scroll);
135 bool ACC (RW, sound); /* does the client want sound */ 174 bool ACC (RW, sound); /* does the client want sound */
136 bool ACC (RW, exp64); /* Client wants 64 bit exp data, as well as skill data */ 175 bool ACC (RW, bumpmsg); /* give message when bumping into walls */
137 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ 176
138 bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ 177 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
139 bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ 178 bool ACC (RW, mapinfocmd); // return map info and send map change info
140 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ 179 uint8_t ACC (RW, extcmd); // call into extensions/plugins
141 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ 180 bool ACC (RW, need_delinv0); /* If true, we need to delinv 0 before sending new floorbox */
142 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ 181
143 bool ACC (RW, darkness); /* True if client wants darkness information */
144 bool ACC (RW, image2); /* Client wants image2/face2 commands */
145 bool ACC (RW, update_look); /* If true, we need to send the look window */ 182 bool ACC (RW, update_look); /* If true, we need to send the look window */
183 bool ACC (RW, update_spells); // If true, we need to esrv_update_spells
146 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 */
147 /* used to arrange text in books, scrolls, or scripted dialogs */
148 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ 185 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
149 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
150 /* Below are flags for extedend infos to pass to client
151 * with S->C mapextended command */
152 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
153 186
154 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ 187 bool ACC (RW, smoothing); // deliantra-style smoothing
155 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ 188 bool ACC (RW, force_newmap); // force a newmap before next map update
156 enum MapMode mapmode; /* Type of map commands the client wants. */
157 uint16 ACC (RW, look_position); /* start of drawing of look window */ 189 uint16 ACC (RW, look_position); /* start of drawing of look window */
190 uint16 ACC (RW, mss); // likely tcp maximum segment size
158 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ 191 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
159 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ 192 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
160 uint8 ACC (RW, faceset); /* Set the client is using, default 0 */ 193 uint8 ACC (RW, faceset); // CF+ selected faceset
161 194
162 maptile *ACC (RW, current_map); // CF+ last/current player map 195 maptile_ptr ACC (RW, current_map); // CF+ last/current player map
196 region_ptr ACC (RW, current_region); // CF+ last/current player region
163 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
164 char ACC (RW, version)[64]; // CF+ client name/version
165 198
166 player *ACC (RO, pl);//TODO should not be here, preferably 199 tstamp ACC (RW, last_send); // last data send on socket.
167 200
168 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ 201 float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */
202 int ACC (RW, rate_avail); // current rate balance
203 int ACC (RW, max_rate); // max. # of bytes to send per tick
204 faceidx ACC (RW, scrub_idx); // which face to send next
205 int ACC (RW, bg_scrub); // how many ticks till the next background face send
169 206
170 client (int fd, const char *from_ip); 207 struct tcp_info tcpi;
171 ~client (); 208 tstamp next_rate_adjust;
209
210 unordered_vector<char *> mapinfo_queue;
211 void mapinfo_queue_clear ();
212 void mapinfo_queue_run ();
213 bool mapinfo_try (char *buf);
214
215 struct ixsend {
216 int16_t pri; // higher means faces are sent earlier, default 0
217 faceidx idx;
218 uint32_t ofs; // if != 0, need to send remaining bytes of partial_face
219 };
220 std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix
221
222 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
223 MTH void flush_fx (); // send fx if required
224
225 MTH void invalidate_face (faceidx idx);
226 MTH void invalidate_all_faces ();
227
172 void destroy (); 228 void do_destroy ();
229 void gather_callbacks (AV *&callbacks, event_type event) const;
173 230
174 iw cmd_ev; void cmd_cb (iw &w);
175 iow socket_ev; void socket_cb (iow &w, int got); 231 iow socket_ev; void socket_cb (iow &w, int revents);
176 232
177 std::deque< command, slice_allocator<command> > cmd_queue; 233 std::deque< command, slice_allocator<command> > cmd_queue;
178
179 // resets movement state
180 bool may_execute (const packet_type *pkt) const;
181 void execute (const packet_type *pkt, char *data, int datalen);
182
183 void queue_command (packet_type *handler, char *data, int datalen);
184 bool handle_command ();
185 void reset_state ();
186
187 bool handle_packet ();
188 int next_packet (); // returns length of packet or 0
189 void skip_packet (int len); // we have processed the packet, skip it
190
191 void flush ();
192 void write_outputbuffer ();
193 void send (void *buf_, int len);
194
195 void send_packet (const char *buf);
196 void send_packet (const char *buf, int len);
197 void send_packet_printf (const char *format, ...);
198 void send_packet (packet &sl);
199
200 // called when something under the player changes
201 void floorbox_update () { update_look = 1; }
202 // called when the player has been moved
203 void floorbox_reset () { look_position = 0; floorbox_update (); }
204 234
205 // large structures at the end please 235 // large structures at the end please
206 struct Map lastmap; 236 struct Map lastmap;
207 std::bitset<MAXANIMNUM> anims_sent; 237 std::bitset<MAXANIMNUM> anims_sent;
238 std::bitset<MAX_FACES> faces_sent;
239 std::bitset<FT_NUM> fx_want;
240
208 // if we get an incomplete packet, this is used to hold the data. 241 // if we get an incomplete packet, this is used to hold the data.
209 // we add 2 byte for the header, one for the trailing 0 byte 242 // we add 2 byte for the header, one for the trailing 0 byte
210 uint8 inbuf[MAXSOCKBUF + 2 + 1]; 243 uint8 inbuf[MAXSOCKBUF + 2 + 1];
211};
212 244
213#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 245 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
214 ( ((__type)>0) &&\ 246 struct msg_buf
215 ((__sockPtr)->has_readable_type) && \ 247 {
216 ((__sockPtr)->supported_readables & (1<<(__type))) ) 248 tick_t expire;
249 int len;
250 int count;
251 char msg[MSG_BUF_SIZE];
252 } msgbuf[MSG_BUF_COUNT];
217 253
218/* Bitmask for the faces_sent[] array - what 254 MTH bool msg_suppressed (const_utf8_string msg);
219 * portion of the face have we sent? 255
256 /* The following is the setup for a ring buffer for storing output
257 * data that the OS can't handle right away.
258 * TODO: this member is enourmously large - optimise?
220 */ 259 */
221#define NS_FACESENT_FACE 0x1 260 struct
222#define NS_FACESENT_SMOOTH 0x2 261 {
262 char data[SOCKETBUFSIZE];
263 int start;
264 int len;
265 } outputbuffer;
223 266
224/* Constants in the form EMI_ is for extended map infos. 267 bool may_execute (const packet_type *pkt) const;
225 * Even if the client select the additionnal infos it wants 268 void execute (const packet_type *pkt, char *data, int datalen);
226 * on the map, there may exist cases where this whole info
227 * is not given in one buch but in separate bunches. This
228 * is done performance reasons (imagine some info related to
229 * a visible object and another info related to a 4 square
230 * width and height area). At the begin of an extended info packet
231 * is a bit field. A bit is activated for each extended info
232 * present in the data
233 */
234 269
235/* Meanings: 270 void queue_command (packet_type *handler, char *data, int datalen);
236 * EMI_NOREDRAW Take extended infos into account but don't redraw, 271 MTH bool handle_command ();
237 * some additionnal datas will follow in a new packet 272 // resets movement state
238 * EMI_SMOOTH Datas about smoothing 273 MTH void reset_state ();
239 */ 274 // resets variable data used to send stat diffs
240#define EMI_NOREDRAW 0x01 275 MTH void reset_stats ();
241#define EMI_SMOOTH 0x02
242 276
243/* this last one says the bitfield continue un next byte 277 MTH bool handle_packet ();
244 * There may be several on contiguous bytes. So there is 7 278 int next_packet (); // returns length of packet or 0
245 * actual bits used per byte, and the number of bytes 279 void skip_packet (int len); // we have processed the packet, skip it
246 * is not fixed in protocol
247 */
248#define EMI_HASMOREBITS 0x80
249 280
250#define FACE_TYPES 1 281 MTH void flush ();
251#define PNG_FACE_INDEX 0 282 MTH void write_outputbuffer ();
283 MTH int outputbuffer_len () const { return outputbuffer.len; }
284 void send (void *buf_, int len);
252 285
253#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 286 void send_packet (const_octet_string buf);
254#define VERSION_SC 1027 287 void send_packet (const_octet_string buf, int len);
255#define VERSION_INFO "Crossfire+ Server" 288 void send_packet_printf (const_utf8_string format, ...) attribute ((format (printf, 2, 3)));
289 void send_packet (packet &sl);
256 290
257typedef unordered_vector<client *> sockvec; 291 void send_drawinfo (const_utf8_string msg, int flags = NDI_BLACK);
292
293 MTH void send_face (faceidx facenum, int pri = 0);
294 MTH void send_faces (object *ob);
295 MTH void send_animation (short anim_num);
296 void send_msg (int color, const_utf8_string type, const_utf8_string msg);
297
298 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
299 // called when something under the player changes
300 MTH void floorbox_update () { update_look = 1; }
301 // called when the player has been moved
302 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
303
304 MTH void tick (); // called every server tick to do housekeeping etc.
305
306 MTH static client *create (int fd, const char *peername);
307 MTH static void clock ();
308 MTH static void flush_sockets ();
309
310protected:
311 client (int fd, const char *from_ip);
312 ~client ();
313};
314
315#if FOR_PERL
316 ACC (RW, tcpi.tcpi_state);
317 ACC (RW, tcpi.tcpi_ca_state);
318 ACC (RW, tcpi.tcpi_retransmits);
319 ACC (RW, tcpi.tcpi_probes);
320 ACC (RW, tcpi.tcpi_backoff);
321 ACC (RW, tcpi.tcpi_options);
322 ACC (RO, tcpi.tcpi_snd_wscale);
323 ACC (RO, tcpi.tcpi_rcv_wscale);
324 ACC (RW, tcpi.tcpi_rto);
325 ACC (RW, tcpi.tcpi_ato);
326 ACC (RW, tcpi.tcpi_snd_mss);
327 ACC (RW, tcpi.tcpi_rcv_mss);
328 ACC (RW, tcpi.tcpi_unacked);
329 ACC (RW, tcpi.tcpi_sacked);
330 ACC (RW, tcpi.tcpi_lost);
331 ACC (RW, tcpi.tcpi_retrans);
332 ACC (RW, tcpi.tcpi_fackets);
333 ACC (RW, tcpi.tcpi_last_data_sent);
334 ACC (RW, tcpi.tcpi_last_ack_sent);
335 ACC (RW, tcpi.tcpi_last_data_recv);
336 ACC (RW, tcpi.tcpi_last_ack_recv);
337 ACC (RW, tcpi.tcpi_pmtu);
338 ACC (RW, tcpi.tcpi_rcv_ssthresh);
339 ACC (RW, tcpi.tcpi_rtt);
340 ACC (RW, tcpi.tcpi_rttvar);
341 ACC (RW, tcpi.tcpi_snd_ssthresh);
342 ACC (RW, tcpi.tcpi_snd_cwnd);
343 ACC (RW, tcpi.tcpi_advmss);
344 ACC (RW, tcpi.tcpi_reordering);
345#endif
346
347typedef object_vector<client, &client::active> sockvec;
258 348
259extern sockvec clients; 349extern sockvec clients;
260extern int nrofpixmaps; //TODO: hrmpf, should go 350
351#define for_all_clients(var) \
352 for (int _i = 0; _i < clients.size (); ++_i) \
353 statementvar (client *, var, clients [_i])
354
355// returns true when the message needs special (read: perl) treatment
356static inline bool
357msg_is_special (const_any_string msg, bool nl_special = true)
358{
359 return msg [strcspn (msg, nl_special ? "<&\n" : "<&")];
360}
261 361
262#endif 362#endif
263 363

Diff Legend

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