server/include/newserver.h

/*
 * static char *rcsid_newserver_h =
 *   "$Id$";
 */

/*
    CrossFire, A Multiplayer game for X-windows

    Copyright (C) 2002 Mark Wedel & Crossfire Development Team
    Copyright (C) 1992 Frank Tore Johansen

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

    The author can be reached via e-mail to crossfire-devel@real-time.com
*/

/*
    newserver.h defines various structures and values that are use for the
    new client server communication method.  Values defined here are only
    used on the server side code.  For shared client/server values, see
    newclient.h
*/


#ifndef NEWSERVER_H
#define NEWSERVER_H

/* Reduce this from 50 to 5 - as it is now, there will never be more
 * than 3 anyways.
 */

#define NUM_LOOK_OBJECTS 50

struct MapCell {
  short faces[MAP_LAYERS];
  uint16 smooth[MAP_LAYERS];
  int count;    /* This is really darkness in the map1 command */
  unsigned char stat_hp; // health of something in this space, or 0
  tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
};

/* This basically defines the largest size an 
 * archetype may be - it is used for allocation of
 * some structures, as well as determining how far
 * we should look for the heads of big images.
 */
#define MAX_HEAD_OFFSET     8

#define MAX_CLIENT_X (MAP_CLIENT_X + MAX_HEAD_OFFSET)
#define MAX_CLIENT_Y (MAP_CLIENT_Y + MAX_HEAD_OFFSET)

struct Map {
  struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y];
};

/* True max is 16383 given current map compaction method */
#define MAXANIMNUM  2000

struct statsinfo {
    char *range, *title;
};


/* This contains basic information on the socket structure.  status is its
 * current state.  we set up our on buffers for sending/receiving, so we can
 * handle some higher level functions.  fd is the actual file descriptor we
 * are using.
 */

enum Sock_Status {Ns_Avail, Ns_Add, Ns_Dead, Ns_Old};

/* Reserver 0 for neither of these being set */
enum Old_Mode {Old_Listen=1, Old_Player=2};

/* Only one map mode can actually be used, so lets make it a switch
 * instead of having a bunch of different fields that needed to
 * get toggled.
 */
enum MapMode {Map0Cmd = 0, Map1Cmd = 1, Map1aCmd=2 };

/* The following is the setup for a ring buffer for storing outbut
 * data that the OS can't handle right away.
 */

typedef struct Buffer {
    char    data[SOCKETBUFSIZE];
    int     start;
    int     len;
} Buffer;

/* how many times we are allowed to give the wrong password before being kicked. */
#define MAX_PASSWORD_FAILURES 5 

typedef struct NewSocket {
    enum Sock_Status status;
    int fd;
    struct Map lastmap;
    size_t faces_sent_len;  /* This is the number of elements allocated in faces_sent[] */
    uint8 *faces_sent;      /* This is a bitmap on sent face status */
    uint8 anims_sent[MAXANIMNUM];
    struct statsinfo stats;
    /* If we get an incomplete packet, this is used to hold the data. */
    SockList    inbuf;
    char    *host;          /* Which host it is connected from (ip address)*/
    uint8   password_fails; /* how many times the player has failed to give the right password */
    Buffer  outputbuffer;   /* For undeliverable data */
    uint32  facecache:1;    /* If true, client is caching images */
    uint32  sent_scroll:1;
    uint32  sound:1;        /* does the client want sound */
    uint32  exp64:1;        /* Client wants 64 bit exp data, as well as skill data */
    uint32  newmapcmd:1;    /* Send newmap command when entering new map SMACFIGGEN*/
    uint32  plugincmd:1;    /* CF+ extend the protocol through a plug-in */
    uint32  mapinfocmd:1;   /* CF+ return map info and send map change info */
    uint32  extcmd:1;       /* CF+ call into extensions/plugins */
    uint32  extmap:1;       /* CF+ extend map comamnd with extra data */
    uint32  buggy_mapscroll:1; /* CF+ client crashes on large mapscrolls */
    uint32  darkness:1;     /* True if client wants darkness information */
    uint32  image2:1;       /* Client wants image2/face2 commands */
    uint32  update_look:1;  /* If true, we need to send the look window */
    uint32  can_write:1;    /* Can we write to this socket? */
    uint32  has_readable_type:1; /* If true client accept additional text information
                                    used to arrange text in books, scrolls, or scripted dialogs */
    uint32  monitor_spells:1; /* Client wishes to be informed when their spell list changes */
    uint32  supported_readables; /* each bit is a readable supported by client */                    
    uint32  cs_version, sc_version; /* versions of the client */
    enum MapMode mapmode;   /* Type of map commands the client wants. */
    uint16  look_position;  /* start of drawing of look window */
    uint8   mapx, mapy;     /* How large a map the client wants */
    uint8   itemcmd;        /* What version of the 'item' protocol command to use */
    uint8   faceset;        /* Set the client is using, default 0 */
    uint32  ext_mapinfos:1;  /* If true client accept additionnal info on maps*/
    /* Below are flags for extedend infos to pass to client 
     * with S->C mapextended command */
    uint32  EMI_smooth:1;   /* Send smooth in extendmapinfos*/    

    struct mapstruct *current_map; // CF+ last/current player map
    int current_x, current_y;      // CF+ last/current map position
    char client[64];               // CF+ client name/version

    /* Below here is information only relevant for old sockets */
    char    *comment;       /* name or listen comment */
    enum Old_Mode old_mode;
} NewSocket;


#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
        ( ((__type)>0) &&\
          ((__sockPtr)->has_readable_type) && \
          ((__sockPtr)->supported_readables & (1<<(__type))) )


/* Bitmask for the faces_sent[] array - what
 * portion of the face have we sent?
 */
#define NS_FACESENT_FACE        0x1
#define NS_FACESENT_SMOOTH      0x2

/* Constants in the form EMI_ is for extended map infos.
 * Even if the client select the additionnal infos it wants
 * on the map, there may exist cases where this whole info
 * is not given in one buch but in separate bunches. This 
 * is done performance reasons (imagine some info related to
 * a visible object and another info related to a 4 square
 * width and height area). At the begin of an extended info packet
 * is a bit field. A bit is activated for each extended info
 * present in the data 
 */
/* Meanings:
 * EMI_NOREDRAW  Take extended infos into account but don't redraw,
 *               some additionnal datas will follow in a new packet
 * EMI_SMOOTH    Datas about smoothing  
 */ 
#define EMI_NOREDRAW        0x01  
#define EMI_SMOOTH          0x02

/* this last one says the bitfield continue un next byte
 * There may be several on contiguous bytes. So there is 7
 * actual bits used per byte, and the number of bytes
 * is not fixed in protocol
 */
#define EMI_HASMOREBITS     0x80

#define FACE_TYPES  1
#define PNG_FACE_INDEX  0

typedef struct Socket_Info {
    struct timeval timeout;     /* Timeout for select */
    int     max_filedescriptor; /* max filedescriptor on the system */
    int     nconns;             /* Number of connections */
    int     allocated_sockets;  /* number of allocated in init_sockets */
} Socket_Info;

extern Socket_Info socket_info;

#define VERSION_CS 1023    /* version >= 1023 understand setup cmd */
#define VERSION_SC 1027
#define VERSION_INFO "Crossfire+ Server"

#endif
Revision:	1.10
Committed:	Tue Aug 29 08:01:36 2006 UTC (20 years, 1 month ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.9:	+3 -3 lines
Log Message:	expand initial tabs to spaces
#	User	Rev	Content
1	root	1.1	/*
2			* static char *rcsid_newserver_h =
3	root	1.2	* "$Id$";
4	root	1.1	*/
5
6			/*
7			CrossFire, A Multiplayer game for X-windows
8
9			Copyright (C) 2002 Mark Wedel & Crossfire Development Team
10			Copyright (C) 1992 Frank Tore Johansen
11
12			This program is free software; you can redistribute it and/or modify
13			it under the terms of the GNU General Public License as published by
14			the Free Software Foundation; either version 2 of the License, or
15			(at your option) any later version.
16
17			This program is distributed in the hope that it will be useful,
18			but WITHOUT ANY WARRANTY; without even the implied warranty of
19			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20			GNU General Public License for more details.
21
22			You should have received a copy of the GNU General Public License
23			along with this program; if not, write to the Free Software
24			Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25
26			The author can be reached via e-mail to crossfire-devel@real-time.com
27			*/
28
29			/*
30			newserver.h defines various structures and values that are use for the
31			new client server communication method. Values defined here are only
32			used on the server side code. For shared client/server values, see
33			newclient.h
34			*/
35
36
37			#ifndef NEWSERVER_H
38			#define NEWSERVER_H
39
40			/* Reduce this from 50 to 5 - as it is now, there will never be more
41			* than 3 anyways.
42			*/
43
44			#define NUM_LOOK_OBJECTS 50
45
46			struct MapCell {
47			short faces[MAP_LAYERS];
48			uint16 smooth[MAP_LAYERS];
49			int count; /* This is really darkness in the map1 command */
50	root	1.7	unsigned char stat_hp; // health of something in this space, or 0
51	root	1.9	tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
52	root	1.1	};
53
54			/* This basically defines the largest size an
55			* archetype may be - it is used for allocation of
56			* some structures, as well as determining how far
57			* we should look for the heads of big images.
58			*/
59			#define MAX_HEAD_OFFSET 8
60
61			#define MAX_CLIENT_X (MAP_CLIENT_X + MAX_HEAD_OFFSET)
62			#define MAX_CLIENT_Y (MAP_CLIENT_Y + MAX_HEAD_OFFSET)
63
64			struct Map {
65			struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y];
66			};
67
68			/* True max is 16383 given current map compaction method */
69			#define MAXANIMNUM 2000
70
71			struct statsinfo {
72			char range, title;
73			};
74
75
76			/* This contains basic information on the socket structure. status is its
77			* current state. we set up our on buffers for sending/receiving, so we can
78			* handle some higher level functions. fd is the actual file descriptor we
79			* are using.
80			*/
81
82			enum Sock_Status {Ns_Avail, Ns_Add, Ns_Dead, Ns_Old};
83
84			/* Reserver 0 for neither of these being set */
85			enum Old_Mode {Old_Listen=1, Old_Player=2};
86
87			/* Only one map mode can actually be used, so lets make it a switch
88			* instead of having a bunch of different fields that needed to
89			* get toggled.
90			*/
91			enum MapMode {Map0Cmd = 0, Map1Cmd = 1, Map1aCmd=2 };
92
93			/* The following is the setup for a ring buffer for storing outbut
94			* data that the OS can't handle right away.
95			*/
96
97			typedef struct Buffer {
98			char data[SOCKETBUFSIZE];
99			int start;
100			int len;
101			} Buffer;
102
103			/* how many times we are allowed to give the wrong password before being kicked. */
104			#define MAX_PASSWORD_FAILURES 5
105
106			typedef struct NewSocket {
107			enum Sock_Status status;
108			int fd;
109			struct Map lastmap;
110			size_t faces_sent_len; /* This is the number of elements allocated in faces_sent[] */
111			uint8 faces_sent; / This is a bitmap on sent face status */
112			uint8 anims_sent[MAXANIMNUM];
113			struct statsinfo stats;
114			/* If we get an incomplete packet, this is used to hold the data. */
115			SockList inbuf;
116			char host; / Which host it is connected from (ip address)*/
117			uint8 password_fails; /* how many times the player has failed to give the right password */
118			Buffer outputbuffer; /* For undeliverable data */
119			uint32 facecache:1; /* If true, client is caching images */
120			uint32 sent_scroll:1;
121			uint32 sound:1; /* does the client want sound */
122			uint32 exp64:1; /* Client wants 64 bit exp data, as well as skill data */
123			uint32 newmapcmd:1; /* Send newmap command when entering new map SMACFIGGEN*/
124	root	1.2	uint32 plugincmd:1; /* CF+ extend the protocol through a plug-in */
125			uint32 mapinfocmd:1; /* CF+ return map info and send map change info */
126	root	1.3	uint32 extcmd:1; /* CF+ call into extensions/plugins */
127	root	1.7	uint32 extmap:1; /* CF+ extend map comamnd with extra data */
128	root	1.8	uint32 buggy_mapscroll:1; /* CF+ client crashes on large mapscrolls */
129	root	1.1	uint32 darkness:1; /* True if client wants darkness information */
130			uint32 image2:1; /* Client wants image2/face2 commands */
131			uint32 update_look:1; /* If true, we need to send the look window */
132			uint32 can_write:1; /* Can we write to this socket? */
133			uint32 has_readable_type:1; /* If true client accept additional text information
134			used to arrange text in books, scrolls, or scripted dialogs */
135			uint32 monitor_spells:1; /* Client wishes to be informed when their spell list changes */
136			uint32 supported_readables; /* each bit is a readable supported by client */
137			uint32 cs_version, sc_version; /* versions of the client */
138			enum MapMode mapmode; /* Type of map commands the client wants. */
139			uint16 look_position; /* start of drawing of look window */
140			uint8 mapx, mapy; /* How large a map the client wants */
141			uint8 itemcmd; /* What version of the 'item' protocol command to use */
142			uint8 faceset; /* Set the client is using, default 0 */
143			uint32 ext_mapinfos:1; /* If true client accept additionnal info on maps*/
144			/* Below are flags for extedend infos to pass to client
145			* with S->C mapextended command */
146			uint32 EMI_smooth:1; /* Send smooth in extendmapinfos*/
147
148	root	1.7	struct mapstruct *current_map; // CF+ last/current player map
149			int current_x, current_y; // CF+ last/current map position
150	root	1.8	char client[64]; // CF+ client name/version
151	root	1.2
152	root	1.1	/* Below here is information only relevant for old sockets */
153			char comment; / name or listen comment */
154			enum Old_Mode old_mode;
155			} NewSocket;
156
157
158			#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
159	root	1.10	( ((__type)>0) &&\
160			((__sockPtr)->has_readable_type) && \
161			((__sockPtr)->supported_readables & (1<<(__type))) )
162	root	1.1
163
164			/* Bitmask for the faces_sent[] array - what
165			* portion of the face have we sent?
166			*/
167			#define NS_FACESENT_FACE 0x1
168			#define NS_FACESENT_SMOOTH 0x2
169
170			/* Constants in the form EMI_ is for extended map infos.
171			* Even if the client select the additionnal infos it wants
172			* on the map, there may exist cases where this whole info
173			* is not given in one buch but in separate bunches. This
174			* is done performance reasons (imagine some info related to
175			* a visible object and another info related to a 4 square
176			* width and height area). At the begin of an extended info packet
177			* is a bit field. A bit is activated for each extended info
178			* present in the data
179			*/
180			/* Meanings:
181			* EMI_NOREDRAW Take extended infos into account but don't redraw,
182			* some additionnal datas will follow in a new packet
183			* EMI_SMOOTH Datas about smoothing
184			*/
185			#define EMI_NOREDRAW 0x01
186			#define EMI_SMOOTH 0x02
187
188			/* this last one says the bitfield continue un next byte
189			* There may be several on contiguous bytes. So there is 7
190			* actual bits used per byte, and the number of bytes
191			* is not fixed in protocol
192			*/
193			#define EMI_HASMOREBITS 0x80
194
195			#define FACE_TYPES 1
196			#define PNG_FACE_INDEX 0
197
198			typedef struct Socket_Info {
199			struct timeval timeout; /* Timeout for select */
200			int max_filedescriptor; /* max filedescriptor on the system */
201			int nconns; /* Number of connections */
202			int allocated_sockets; /* number of allocated in init_sockets */
203			} Socket_Info;
204
205			extern Socket_Info socket_info;
206
207			#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
208			#define VERSION_SC 1027
209	root	1.4	#define VERSION_INFO "Crossfire+ Server"
210	root	1.1
211			#endif