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.100 by root, Thu Apr 15 00:36:51 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines