ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/network.h
Revision: 1.4
Committed: Sat Dec 16 03:08:26 2006 UTC (17 years, 5 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.3: +13 -3 lines
Log Message:
- socket i/o is completely asynchronous now
- some command sare handled immediately
- others (most palying related commands) are queued
  for later (as of now synchronous) processing
- specifying a max queue length (in seconds) is possible, but disabled
- also add some syntax sugar for network code

File Contents

# User Rev Content
1 root 1.1 /*
2     CrossFire, A Multiplayer game for X-windows
3    
4     Copyright (C) 1992 Frank Tore Johansen
5     Copyright (C) 2002 Mark Wedel & Crossfire Development Team
6     Copyright (C) 2005, 2006 The Crossfire+ Development Team
7    
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
10     the Free Software Foundation; either version 2 of the License, or
11     (at your option) any later version.
12    
13     This program is distributed in the hope that it will be useful,
14     but WITHOUT ANY WARRANTY; without even the implied warranty of
15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16     GNU General Public License for more details.
17    
18     You should have received a copy of the GNU General Public License
19     along with this program; if not, write to the Free Software
20     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21    
22 root 1.3 The authors can be reached via e-mail at crossfire@schmorp.de
23 root 1.1 */
24    
25     /* This file defines various flags that both the new client and
26     * newserver uses. These should never be changed, only expanded.
27     * Changing them will likely cause all old clients to not work properly.
28     * While called newclient, it is really used by both the client and
29     * server to keep some values the same.
30     *
31     * Name format is CS_(command)_(flag)
32     * CS = Client/Server.
33     * (command) is protocol command, ie ITEM
34     * (flag) is the flag name
35     */
36    
37     /* It is trivial to keep a link of copy of this file in the client
38     * or server area. But keeping one common file should make things
39     * more reliable, as both the client and server will definately be
40     * talking about the same values.
41     */
42    
43    
44 root 1.4 #ifndef NETWORK_H
45     #define NETWORK_H
46    
47     #include <cstdarg>
48 root 1.1
49     /* Maximum size of any packet we expect. Using this makes it so we don't need to
50     * allocated and deallocated the same buffer over and over again and the price
51     * of using a bit of extra memory. It also makes the code simpler.
52     *
53     * The size must be the same in the server and the client (stupid), and its also NOT
54     * the maximum buffer size as one would expect, but the maximum buffer size + 1.
55     */
56     #define MAXSOCKBUF 10240
57    
58    
59     #define CS_QUERY_YESNO 0x1 /* Yes/no question */
60     #define CS_QUERY_SINGLECHAR 0x2 /* Single character response expected */
61     #define CS_QUERY_HIDEINPUT 0x4 /* Hide input being entered */
62    
63     #define CS_SAY_NORMAL 0x1 /* Normal say command */
64     #define CS_SAY_SHOUT 0x2 /* Text is shouted. */
65     #define CS_SAY_GSAY 0x4 /* Text is group say command */
66    
67     /* These are multiplication values that should be used when changing
68     * floats to ints, and vice version. MULTI is integer representatin
69     * (float to int), MULTF is float, for going from int to float.
70     */
71     #define FLOAT_MULTI 100000
72     #define FLOAT_MULTF 100000.0
73    
74     /* ID's for the various stats that get sent across. */
75    
76     #define CS_STAT_HP 1
77     #define CS_STAT_MAXHP 2
78     #define CS_STAT_SP 3
79     #define CS_STAT_MAXSP 4
80     #define CS_STAT_STR 5
81     #define CS_STAT_INT 6
82     #define CS_STAT_WIS 7
83     #define CS_STAT_DEX 8
84     #define CS_STAT_CON 9
85     #define CS_STAT_CHA 10
86     #define CS_STAT_EXP 11
87     #define CS_STAT_LEVEL 12
88     #define CS_STAT_WC 13
89     #define CS_STAT_AC 14
90     #define CS_STAT_DAM 15
91     #define CS_STAT_ARMOUR 16
92     #define CS_STAT_SPEED 17
93     #define CS_STAT_FOOD 18
94     #define CS_STAT_WEAP_SP 19
95     #define CS_STAT_RANGE 20
96     #define CS_STAT_TITLE 21
97     #define CS_STAT_POW 22
98     #define CS_STAT_GRACE 23
99     #define CS_STAT_MAXGRACE 24
100     #define CS_STAT_FLAGS 25
101     #define CS_STAT_WEIGHT_LIM 26
102     #define CS_STAT_EXP64 28
103     #define CS_STAT_SPELL_ATTUNE 29
104     #define CS_STAT_SPELL_REPEL 30
105     #define CS_STAT_SPELL_DENY 31
106    
107     /* Start & end of resistances, inclusive. */
108     #define CS_STAT_RESIST_START 100
109     #define CS_STAT_RESIST_END 117
110     #define CS_STAT_RES_PHYS 100
111     #define CS_STAT_RES_MAG 101
112     #define CS_STAT_RES_FIRE 102
113     #define CS_STAT_RES_ELEC 103
114     #define CS_STAT_RES_COLD 104
115     #define CS_STAT_RES_CONF 105
116     #define CS_STAT_RES_ACID 106
117     #define CS_STAT_RES_DRAIN 107
118     #define CS_STAT_RES_GHOSTHIT 108
119     #define CS_STAT_RES_POISON 109
120     #define CS_STAT_RES_SLOW 110
121     #define CS_STAT_RES_PARA 111
122     #define CS_STAT_TURN_UNDEAD 112
123     #define CS_STAT_RES_FEAR 113
124     #define CS_STAT_RES_DEPLETE 114
125     #define CS_STAT_RES_DEATH 115
126     #define CS_STAT_RES_HOLYWORD 116
127     #define CS_STAT_RES_BLIND 117
128    
129     /* Start & end of skill experience + skill level, inclusive. */
130     #define CS_STAT_SKILLEXP_START 118
131     #define CS_STAT_SKILLEXP_END 129
132     #define CS_STAT_SKILLEXP_AGILITY 118
133     #define CS_STAT_SKILLEXP_AGLEVEL 119
134     #define CS_STAT_SKILLEXP_PERSONAL 120
135     #define CS_STAT_SKILLEXP_PELEVEL 121
136     #define CS_STAT_SKILLEXP_MENTAL 122
137     #define CS_STAT_SKILLEXP_MELEVEL 123
138     #define CS_STAT_SKILLEXP_PHYSIQUE 124
139     #define CS_STAT_SKILLEXP_PHLEVEL 125
140     #define CS_STAT_SKILLEXP_MAGIC 126
141     #define CS_STAT_SKILLEXP_MALEVEL 127
142     #define CS_STAT_SKILLEXP_WISDOM 128
143     #define CS_STAT_SKILLEXP_WILEVEL 129
144    
145     /* CS_STAT_SKILLINFO is used as the starting index point. Skill number->name
146     * map is generated dynamically for the client, so a bunch of entries will
147     * be used here. CS_NUM_SKILLS does not match how many skills there really
148     * are - instead, it is used as a range of values so that the client
149     * can have some idea how many skill categories there may be.
150     */
151     #define CS_STAT_SKILLINFO 140
152     #define CS_NUM_SKILLS 50
153    
154     /* These are used with CS_STAT_FLAGS above to communicate S->C what the
155     * server thinks the fireon & runon states are.
156     */
157     #define SF_FIREON 0x01
158     #define SF_RUNON 0x02
159    
160     /* The following are the color flags passed to new_draw_info.
161     *
162     * We also set up some control flags
163     *
164     * NDI = New Draw Info
165     */
166    
167     /* Color specifications - note these match the order in xutil.c */
168     /* Note 2: Black, the default color, is 0. Thus, it does not need to
169     * be implicitly specified.
170     */
171     #define NDI_BLACK 0
172     #define NDI_WHITE 1
173     #define NDI_NAVY 2
174     #define NDI_RED 3
175     #define NDI_ORANGE 4
176     #define NDI_BLUE 5 /* Actually, it is Dodger Blue */
177     #define NDI_DK_ORANGE 6 /* DarkOrange2 */
178     #define NDI_GREEN 7 /* SeaGreen */
179     #define NDI_LT_GREEN 8 /* DarkSeaGreen, which is actually paler */
180     /* Than seagreen - also background color */
181     #define NDI_GREY 9
182     #define NDI_BROWN 10 /* Sienna */
183     #define NDI_GOLD 11
184     #define NDI_TAN 12 /* Khaki */
185    
186     #define NDI_MAX_COLOR 12 /* Last value in */
187     #define NDI_COLOR_MASK 0xff /* Gives lots of room for expansion - we are */
188     /* using an int anyways, so we have the space */
189     /* to still do all the flags */
190    
191    
192     #define NDI_UNIQUE 0x100 /* Print this out immediately, don't buffer */
193     #define NDI_ALL 0x200 /* Inform all players of this message */
194    
195     /* Flags for the item command */
196     enum {a_none, a_readied, a_wielded, a_worn, a_active, a_applied};
197     #define F_APPLIED 0x000F
198     #define F_LOCATION 0x00F0
199     #define F_UNPAID 0x0200
200     #define F_MAGIC 0x0400
201     #define F_CURSED 0x0800
202     #define F_DAMNED 0x1000
203     #define F_OPEN 0x2000
204     #define F_NOPICK 0x4000
205     #define F_LOCKED 0x8000
206    
207     #define CF_FACE_NONE 0
208     #define CF_FACE_BITMAP 1
209     #define CF_FACE_XPM 2
210     #define CF_FACE_PNG 3
211     #define CF_FACE_CACHE 0x10
212    
213     /* Used in the new_face structure on the magicmap field. Low bits
214     * are color informatin. For now, only high bit information we need
215     * is floor information.
216     */
217     #define FACE_FLOOR 0x80
218     #define FACE_WALL 0x40 /* Or'd into the color value by the server
219     * right before sending.
220     */
221     #define FACE_COLOR_MASK 0xf
222    
223     #define UPD_LOCATION 0x01
224     #define UPD_FLAGS 0x02
225     #define UPD_WEIGHT 0x04
226     #define UPD_FACE 0x08
227     #define UPD_NAME 0x10
228     #define UPD_ANIM 0x20
229     #define UPD_ANIMSPEED 0x40
230     #define UPD_NROF 0x80
231    
232     /* The flag values sent by the updspell command */
233     #define UPD_SP_MANA 0x01
234     #define UPD_SP_GRACE 0x02
235     #define UPD_SP_DAMAGE 0x04
236    
237     #define SOUND_NORMAL 0
238     #define SOUND_SPELL 1
239    
240     struct data
241     {
242     unsigned int len;
243     const void *ptr;
244    
245     data (const void *ptr, int len) : len (len), ptr (ptr) { }
246     data (const char *str) : len (strlen (str ? str : 0)), ptr ((void *)str) { }
247     data (const shstr &sh) : len (sh.length ()), ptr ((void *)&sh) { }
248     };
249    
250     struct data8
251     {
252     unsigned int len;
253     const void *ptr;
254    
255     data8 (const void *ptr, int len) : len (len), ptr (ptr) { }
256     data8 (const char *str) : len (strlen (str ? str : 0)), ptr ((void *)str) { }
257     data8 (const shstr &sh) : len (sh.length ()), ptr ((void *)&sh) { }
258     };
259    
260     struct data16
261     {
262     unsigned int len;
263     const void *ptr;
264    
265     data16 (const void *ptr, int len) : len (len), ptr (ptr) { }
266     data16 (const char *str) : len (strlen (str ? str : 0)), ptr ((void *)str) { }
267     data16 (const shstr &sh) : len (sh.length ()), ptr ((void *)&sh) { }
268     };
269    
270     /* Contains the base information we use to make up a packet we want to send. */
271     struct packet
272     {
273     enum { bufsize = MAXSOCKBUF };
274     enum { hdrlen = 2 }; // keep this many bytes free at the front
275    
276     // strategy: only check on variable-length adds
277     // and allow 256 bytes for any headers.
278     uint8 *cur;
279     uint8 buf_ [hdrlen + bufsize + 256];
280    
281     packet () { reset (); }
282    
283     uint8 operator [](unsigned int i) const { return buf_ [i + hdrlen]; }
284     uint8 &operator [](unsigned int i) { return buf_ [i + hdrlen]; }
285    
286     uint8 *buf () { return buf_ + hdrlen; }
287     const uint8 *buf () const { return buf_ + hdrlen; }
288    
289     void reset (int offset = 0) { cur = buf () + offset; }
290     int length () const { return cur - buf (); }
291     int room () { return bufsize - (cur - buf ()); }
292    
293     // unchecked
294     packet &operator <<(uint8 v) { *cur++ = v; return *this; }
295    
296     packet &operator <<(uint16 v) { return *this << uint8 (v >> 8) << uint8 (v); }
297     packet &operator <<(uint32 v) { return *this << uint16 (v >> 16) << uint16 (v); }
298     packet &operator <<(uint64 v) { return *this << uint32 (v >> 32) << uint32 (v); }
299    
300     packet &operator <<(sint8 v) { return *this << (uint8 )v; }
301     packet &operator <<(sint16 v) { return *this << (uint16)v; }
302     packet &operator <<(sint32 v) { return *this << (uint32)v; }
303     packet &operator <<(sint64 v) { return *this << (uint64)v; }
304    
305     // checked
306     packet &operator <<(const data &v);
307     packet &operator <<(const data8 &v);
308     packet &operator <<(const data16 &v);
309    
310     packet &operator <<(const char *v);
311     packet &operator <<(const shstr &sh) { return *this << data (&sh, sh.length ()); }
312    
313 root 1.4 void vprintf (const char *format, va_list ap);
314    
315     void printf (const char *format, ...)
316     {
317     va_list ap;
318     va_start (ap, format);
319     vprintf (format, ap);
320     va_end (ap);
321     }
322 root 1.1 };
323    
324     inline uint16 net_uint16 (uint8 *data) { return (data [0] << 8) | data [1]; }
325     inline uint32 net_uint32 (uint8 *data) { return (net_uint16 (data) << 16) | net_uint16 (data + 2); }
326     inline sint16 net_sint16 (uint8 *data) { return sint16 (net_uint16 (data)); }
327     inline sint16 net_sint32 (uint8 *data) { return sint32 (net_uint32 (data)); }
328    
329     struct CS_Stats
330     {
331     int ibytes; /* ibytes, obytes are bytes in, out */
332     int obytes;
333     short max_conn; /* Maximum connections received */
334     time_t time_start; /* When we started logging this */
335     };
336    
337     extern CS_Stats cst_tot, cst_lst;
338    
339     #endif
340