server/include/client.h

/*
 * CrossFire, A Multiplayer game for the X Window System
 * 
 * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team
 * 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@schmorp.de
 */

#ifndef CLIENT_H
#define CLIENT_H

#include <deque>
#include <bitset>
#include <tr1/unordered_set>

// (possibly) max. number of objects "per page" in the ground container
#define FLOORBOX_PAGESIZE 50

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

#define MAX_CLIENT_X MAP_CLIENT_X
#define MAX_CLIENT_Y MAP_CLIENT_Y

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

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

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.
 */

/* 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 { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };

// states the socket can be in
enum {
 ST_DEAD,     // socket is dead
 ST_SETUP,    // initial handshake / setup / login
 ST_PLAYING,  // logged in an playing
 ST_CUSTOM,   // waiting for custom reply

 ST_GET_PARTY_PASSWORD,
};

// a handler for a specific type of packet
enum {
  PF_PLAYER   = 0x01, // must have valid player / will by synchronised
  PF_PLAYING  = 0x02, // must be in playing state
  PF_COMMAND0 = 0x04, // command starts at offset 0
  PF_COMMAND6 = 0x08, // command starts at offset 6
};

struct packet_type
{
  const char *name;
  void *cb;
  int flags;
};

struct command
{
  tstamp stamp;
  const packet_type *handler;
  char *data;
  int datalen;

  ~command ()
  {
    sfree<char> (data, datalen + 1);
  }
};

struct refitem
{
  object_ptr op;
};

// this represents a container on the client side.
// right now, there are only ever two of them:
// the inventory and the floor/open container
//TODO: unused as of yet
struct client_container : vector< refitem, slice_allocator<refitem> >
{
  client *ns;
  enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type;

  bool item_changed; // one of the items in here possibly changed

  // for mapspace and container
  int x, y;
  maptile *map;

  // for container
  object *env;

  client_container (client *ns)
  : ns (ns), type (CC_NONE) { }

  tag_t tag () const;

  inline iterator merge_item (iterator i, object *op);

  void clear ();
  void update ();

  void set_mapspace (maptile *map, int x, int y);
  void set_container (object *env);
};

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

INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
struct client : zero_initialised, attachable
{
  int ACC (RW, fd);
  unsigned int inbuf_len;                 // number of bytes valid in inbuf
  statsinfo stats;
  int ACC (RO, active);

  /* The following is the setup for a ring buffer for storing output
   * data that the OS can't handle right away.
   */
  struct
  {
    char data[SOCKETBUFSIZE];
    int start;
    int len;
  } outputbuffer;

  char *ACC (RW, host);                   /* Which host it is connected from (ip address) */
  uint8 ACC (RW, state);                  /* Input state of the player (name, password, etc */

  sint8 ACC (RW, last_level);             /* Last level we sent to client */
  uint16 ACC (RW, last_flags);            /* fire/run on flags for last tick */
  float ACC (RW, last_weapon_sp);         /* if diff than weapon_sp, update client */
  sint32 ACC (RW, last_weight);           /* Last weight as sent to client; -1 means do not send weight */
  sint32 ACC (RW, last_weight_limit);     /* Last weight limit transmitted to client */
  uint32 ACC (RW, last_path_attuned);     /* Last spell attunment sent to client */
  uint32 ACC (RW, last_path_repelled);    /* Last spell repelled sent to client */
  uint32 ACC (RW, last_path_denied);      /* Last spell denied sent to client */
  living ACC (RO, last_stats);            /* Last stats as sent to client */
  float ACC (RW, last_speed);             /* Last speed as sent to client */
  sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
  sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */

  bool ACC (RW, force_face0);             // client workaround for buggy checksum calculation in gcfclient
  bool ACC (RW, force_bad_checksum);      // client workaround for buggy checksum calculation in gcfclient
  bool ACC (RW, force_image_newmap);      // client workaround for client not redrawing map on image upload
  bool ACC (RW, enable_bg_scrub);         // client workaround, gcfclient becomes unusable if you send it images

  bool ACC (RW, afk);                     /* player is afk */
  bool ACC (RW, facecache);               /* If true, client is caching images */
  bool ACC (RW, sent_scroll);             
  bool ACC (RW, sound);                   /* does the client want sound */
  bool ACC (RW, newmapcmd);               /* Send newmap command when entering new map SMACFIGGEN */
  bool ACC (RW, plugincmd);               // extend the protocol through a plug-in */
  bool ACC (RW, mapinfocmd);              // return map info and send map change info
  bool ACC (RW, extcmd);                  // call into extensions/plugins
  bool ACC (RW, extmap);                  // extend map comamnd with extra data
  bool ACC (RW, buggy_mapscroll);         // client crashes on large mapscrolls
  bool ACC (RW, darkness);                /* True if client wants darkness information */
  bool ACC (RW, image2);                  /* Client wants image2/face2 commands */
  bool ACC (RW, fxix);                    // client implements fx and ix (face|image extended) commands
  bool ACC (RW, update_look);             /* If true, we need to send the look window */
  bool ACC (RW, has_readable_type);       /* If true client accept additional text information */
                                          /* used to arrange text in books, scrolls, or scripted dialogs */
  bool ACC (RW, monitor_spells);          /* Client wishes to be informed when their spell list changes */
  bool ACC (RW, ext_mapinfos);            /* If true client accepts additional info on maps */
                                          /* Below are flags for extedend infos to pass to client 
                                           * with S->C mapextended command */
  bool ACC (RW, EMI_smooth);              /* Send smooth in extendmapinfos */
  bool ACC (RW, smoothing);               // trt-style smoothing
  bool ACC (RW, can_msg);                 // trt-style text messages

  bool ACC (RW, force_newmap);            // force a newmap before next map update
  uint32 ACC (RW, supported_readables);   /* each bit is a readable supported by client */
  uint32 ACC (RW, cs_version), ACC (RW, sc_version);        /* versions of the client */
  uint16 ACC (RW, look_position);         /* start of drawing of look window */
  uint16 ACC (RW, mss);                   // likely tcp maximum segment size
  uint8 ACC (RW, mapmode);                /* Type of map commands the client wants. */
  uint8 ACC (RW, mapx), ACC (RW, mapy);             /* How large a map the client wants */
  uint8 ACC (RW, itemcmd);                /* What version of the 'item' protocol command to use */

  maptile *ACC (RW, current_map);         // CF+ last/current player map
  region *ACC (RW, current_region);       // CF+ last/current player region
  int ACC (RW, current_x), ACC (RW, current_y);     // CF+ last/current map position
  shstr ACC (RW, version);                // CF+ client name/version
  uint8 ACC (RW, faceset);                // CF+ selected faceset

  player_ptr ACC (RO, pl);

  int ACC (RW, rtt), ACC (RW, rttvar);    /* round-trip time and -variance, if known */

  int ACC (RW, rate_avail);               // current rate balance
  int ACC (RW, max_rate);                 // max. # of bytes to send per tick
  faceidx ACC (RW, scrub_idx);            // which face to send next
  int ACC (RW, bg_scrub);                 // how many ticks till the next background face send

  faceidx partial_face;
  uint32 partial_face_ofs;  // if != 0, need to send remaining bytes of partial_face
  std::vector<faceidx, slice_allocator<faceidx> > askface; // which faces have been requested by the client

  std::vector<faceidx, slice_allocator<faceidx> > fxface;  // which faces to send using fx
  MTH void flush_fx (); // send fx if required

  void do_destroy ();
  void gather_callbacks (AV *&callbacks, event_type event) const;

  iow socket_ev; void socket_cb (iow &w, int got);
  iw  cmd_ev;    void cmd_cb (iw &w);
  client_container cc_inv, cc_other;

  std::deque< command, slice_allocator<command> > cmd_queue;

  // large structures at the end please
  struct Map lastmap;
  std::bitset<MAXANIMNUM> anims_sent;
  std::bitset<MAX_FACES> faces_sent;

  // if we get an incomplete packet, this is used to hold the data.
  // we add 2 byte for the header, one for the trailing 0 byte
  uint8 inbuf[MAXSOCKBUF + 2 + 1];

  enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
  struct msg_buf
  {
    tick_t expire;
    int len;
    int count;
    char msg[MSG_BUF_SIZE];
  } msgbuf[MSG_BUF_COUNT];

  MTH bool msg_suppressed (const char *msg);

  bool may_execute (const packet_type *pkt) const;
  void execute (const packet_type *pkt, char *data, int datalen);

  void queue_command (packet_type *handler, char *data, int datalen);
  MTH bool handle_command ();
  // resets movement state
  MTH void reset_state ();
  // resets variable data used to send stat diffs
  MTH void reset_stats ();

  MTH bool handle_packet ();
  int next_packet ();                     // returns length of packet or 0
  void skip_packet (int len);             // we have processed the packet, skip it

  MTH void flush ();
  MTH void write_outputbuffer ();
  MTH int outputbuffer_len () const { return outputbuffer.len; }
  void send (void *buf_, int len);

  void send_packet (const char *buf);
  void send_packet (const char *buf, int len);
  void send_packet_printf (const char *format, ...);
  void send_packet (packet &sl);

  void send_drawinfo (const char *msg, int flags = NDI_BLACK);
  MTH void send_face (faceidx facenum);
  MTH void send_image (faceidx facenum);
  MTH void send_faces (object *ob);
  MTH void send_animation (short anim_num);
  MTH void send_msg (int color, const char *type, const char *msg);

  // called when something under the player changes
  MTH void floorbox_update () { update_look = 1; }
  // called when the player has been moved
  MTH void floorbox_reset  () { look_position = 0; floorbox_update (); }

  MTH void tick (); // called every server tick to do housekeeping etc.

  MTH static client *create (int fd, const char *peername);

protected:
  client (int fd, const char *from_ip);
  ~client ();
};

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

/* 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

#define VERSION_CS 1023        /* version >= 1023 understand setup cmd */
#define VERSION_SC 1026
//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
#define VERSION_INFO "Crossfire+ Server"

typedef object_vector<client, &client::active> sockvec;

extern sockvec clients;

#define for_all_clients(var)                    \
  for (int _i = 0; _i < clients.size (); ++_i)  \
    declvar (client *, var, clients [_i])

#endif

Revision:	1.49
Committed:	Wed Apr 25 18:47:50 2007 UTC (17 years, 1 month ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.48:	+21 -12 lines
Log Message:	rewrote output buffer handling. the new system: - outputs messages immediately. - suppresses following duplicates. - enforces a minimum setting. - is, as usual, faster and leaner. the only problem is that the code worked out of the box, which is not reassuring.
#	User	Rev	Content
1	root	1.1	/*
2	pippijn	1.26	* CrossFire, A Multiplayer game for the X Window System
3			*
4			* Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team
5			* Copyright (C) 2002 Mark Wedel & Crossfire Development Team
6			* Copyright (C) 1992 Frank Tore Johansen
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			* The author can be reached via e-mail to crossfire@schmorp.de
23			*/
24	root	1.1
25			#ifndef CLIENT_H
26			#define CLIENT_H
27
28	root	1.4	#include <deque>
29	root	1.7	#include <bitset>
30	root	1.13	#include <tr1/unordered_set>
31	root	1.1
32	root	1.4	// (possibly) max. number of objects "per page" in the ground container
33	root	1.11	#define FLOORBOX_PAGESIZE 50
34	root	1.1
35			struct MapCell
36			{
37	root	1.47	tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
38	root	1.37	int count; /* This is really darkness in the map1 command */
39	root	1.32	faceidx faces[MAP_LAYERS];
40	root	1.36	unsigned char stat_hp; // health of something in this space, or 0
41	root	1.1	unsigned char flags;
42	root	1.37	uint8_t smooth[MAP_LAYERS];
43	root	1.1	};
44
45	root	1.33	#define MAX_CLIENT_X MAP_CLIENT_X
46			#define MAX_CLIENT_Y MAP_CLIENT_Y
47	root	1.1
48			struct Map
49			{
50			struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y];
51			};
52
53			/* True max is 16383 given current map compaction method */
54	root	1.33	#define MAXANIMNUM 10000
55	root	1.1
56			struct statsinfo
57			{
58			char range, title;
59			};
60
61			/* This contains basic information on the socket structure. status is its
62			* current state. we set up our on buffers for sending/receiving, so we can
63			* handle some higher level functions. fd is the actual file descriptor we
64			* are using.
65			*/
66
67			/* Only one map mode can actually be used, so lets make it a switch
68			* instead of having a bunch of different fields that needed to
69			* get toggled.
70			*/
71	root	1.42	enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
72	root	1.1
73	root	1.15	// states the socket can be in
74			enum {
75			ST_DEAD, // socket is dead
76			ST_SETUP, // initial handshake / setup / login
77			ST_PLAYING, // logged in an playing
78			ST_CUSTOM, // waiting for custom reply
79
80			ST_GET_PARTY_PASSWORD,
81			};
82
83	root	1.4	// a handler for a specific type of packet
84			enum {
85	root	1.28	PF_PLAYER = 0x01, // must have valid player / will by synchronised
86			PF_PLAYING = 0x02, // must be in playing state
87			PF_COMMAND0 = 0x04, // command starts at offset 0
88			PF_COMMAND6 = 0x08, // command starts at offset 6
89	root	1.4	};
90
91			struct packet_type
92			{
93			const char *name;
94			void *cb;
95			int flags;
96			};
97
98			struct command
99			{
100			tstamp stamp;
101			const packet_type *handler;
102			char *data;
103			int datalen;
104
105	root	1.6	~command ()
106	root	1.4	{
107	root	1.8	sfree<char> (data, datalen + 1);
108	root	1.4	}
109			};
110
111	root	1.13	struct refitem
112			{
113			object_ptr op;
114			};
115
116	root	1.12	// this represents a container on the client side.
117			// right now, there are only ever two of them:
118			// the inventory and the floor/open container
119			//TODO: unused as of yet
120	root	1.13	struct client_container : vector< refitem, slice_allocator<refitem> >
121	root	1.12	{
122	root	1.13	client *ns;
123	root	1.12	enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type;
124
125	root	1.13	bool item_changed; // one of the items in here possibly changed
126
127	root	1.12	// for mapspace and container
128	root	1.13	int x, y;
129	root	1.12	maptile *map;
130
131			// for container
132			object *env;
133	root	1.13
134			client_container (client *ns)
135			: ns (ns), type (CC_NONE) { }
136
137			tag_t tag () const;
138
139			inline iterator merge_item (iterator i, object *op);
140
141			void clear ();
142			void update ();
143
144			void set_mapspace (maptile *map, int x, int y);
145			void set_container (object *env);
146	root	1.12	};
147
148	root	1.1	/* how many times we are allowed to give the wrong password before being kicked. */
149			#define MAX_PASSWORD_FAILURES 5
150
151	root	1.21	INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
152			struct client : zero_initialised, attachable
153	root	1.1	{
154			int ACC (RW, fd);
155	root	1.10	unsigned int inbuf_len; // number of bytes valid in inbuf
156	root	1.20	statsinfo stats;
157	root	1.24	int ACC (RO, active);
158	root	1.12
159	root	1.49	/* The following is the setup for a ring buffer for storing output
160			* data that the OS can't handle right away.
161			*/
162			struct
163			{
164			char data[SOCKETBUFSIZE];
165			int start;
166			int len;
167			} outputbuffer;
168	root	1.10
169			char ACC (RW, host); / Which host it is connected from (ip address) */
170	root	1.15	uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
171	root	1.25
172			sint8 ACC (RW, last_level); /* Last level we sent to client */
173			uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */
174			float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */
175			sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */
176			sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */
177			uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */
178			uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */
179			uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */
180			living ACC (RO, last_stats); /* Last stats as sent to client */
181			float ACC (RW, last_speed); /* Last speed as sent to client */
182			sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
183			sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */
184	root	1.10
185	root	1.42	bool ACC (RW, force_face0); // client workaround for buggy checksum calculation in gcfclient
186			bool ACC (RW, force_bad_checksum); // client workaround for buggy checksum calculation in gcfclient
187			bool ACC (RW, force_image_newmap); // client workaround for client not redrawing map on image upload
188			bool ACC (RW, enable_bg_scrub); // client workaround, gcfclient becomes unusable if you send it images
189
190	root	1.20	bool ACC (RW, afk); /* player is afk */
191	root	1.10	bool ACC (RW, facecache); /* If true, client is caching images */
192			bool ACC (RW, sent_scroll);
193			bool ACC (RW, sound); /* does the client want sound */
194			bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
195	root	1.40	bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
196			bool ACC (RW, mapinfocmd); // return map info and send map change info
197			bool ACC (RW, extcmd); // call into extensions/plugins
198			bool ACC (RW, extmap); // extend map comamnd with extra data
199			bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls
200	root	1.10	bool ACC (RW, darkness); /* True if client wants darkness information */
201			bool ACC (RW, image2); /* Client wants image2/face2 commands */
202	root	1.44	bool ACC (RW, fxix); // client implements fx and ix (face\|image extended) commands
203	root	1.10	bool ACC (RW, update_look); /* If true, we need to send the look window */
204			bool ACC (RW, has_readable_type); /* If true client accept additional text information */
205			/* used to arrange text in books, scrolls, or scripted dialogs */
206			bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
207			bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
208			/* Below are flags for extedend infos to pass to client
209			* with S->C mapextended command */
210			bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
211	root	1.48	bool ACC (RW, smoothing); // trt-style smoothing
212			bool ACC (RW, can_msg); // trt-style text messages
213	root	1.1
214	root	1.40	bool ACC (RW, force_newmap); // force a newmap before next map update
215	root	1.1	uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
216			uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
217			uint16 ACC (RW, look_position); /* start of drawing of look window */
218	root	1.43	uint16 ACC (RW, mss); // likely tcp maximum segment size
219	root	1.42	uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
220	root	1.1	uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
221			uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
222
223			maptile *ACC (RW, current_map); // CF+ last/current player map
224	root	1.29	region *ACC (RW, current_region); // CF+ last/current player region
225	root	1.1	int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
226	root	1.49	shstr ACC (RW, version); // CF+ client name/version
227	root	1.32	uint8 ACC (RW, faceset); // CF+ selected faceset
228	root	1.1
229	root	1.18	player_ptr ACC (RO, pl);
230	root	1.1
231	root	1.38	int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
232
233	root	1.44	int ACC (RW, rate_avail); // current rate balance
234	root	1.38	int ACC (RW, max_rate); // max. # of bytes to send per tick
235	root	1.39	faceidx ACC (RW, scrub_idx); // which face to send next
236			int ACC (RW, bg_scrub); // how many ticks till the next background face send
237	root	1.45
238			faceidx partial_face;
239			uint32 partial_face_ofs; // if != 0, need to send remaining bytes of partial_face
240			std::vector<faceidx, slice_allocator<faceidx> > askface; // which faces have been requested by the client
241
242			std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
243			MTH void flush_fx (); // send fx if required
244	root	1.1
245	root	1.21	void do_destroy ();
246			void gather_callbacks (AV *&callbacks, event_type event) const;
247	root	1.4
248	pippijn	1.30	iow socket_ev; void socket_cb (iow &w, int got);
249	root	1.4	iw cmd_ev; void cmd_cb (iw &w);
250	pippijn	1.30	client_container cc_inv, cc_other;
251	root	1.1
252	root	1.4	std::deque< command, slice_allocator<command> > cmd_queue;
253
254	root	1.14	// large structures at the end please
255			struct Map lastmap;
256			std::bitset<MAXANIMNUM> anims_sent;
257	root	1.36	std::bitset<MAX_FACES> faces_sent;
258
259	root	1.14	// if we get an incomplete packet, this is used to hold the data.
260			// we add 2 byte for the header, one for the trailing 0 byte
261			uint8 inbuf[MAXSOCKBUF + 2 + 1];
262
263	root	1.49	enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
264			struct msg_buf
265			{
266			tick_t expire;
267			int len;
268			int count;
269			char msg[MSG_BUF_SIZE];
270			} msgbuf[MSG_BUF_COUNT];
271
272			MTH bool msg_suppressed (const char *msg);
273
274	root	1.4	bool may_execute (const packet_type *pkt) const;
275			void execute (const packet_type pkt, char data, int datalen);
276
277			void queue_command (packet_type handler, char data, int datalen);
278	root	1.22	MTH bool handle_command ();
279	root	1.14	// resets movement state
280	root	1.22	MTH void reset_state ();
281	root	1.25	// resets variable data used to send stat diffs
282			MTH void reset_stats ();
283	root	1.1
284	root	1.22	MTH bool handle_packet ();
285	root	1.4	int next_packet (); // returns length of packet or 0
286	root	1.1	void skip_packet (int len); // we have processed the packet, skip it
287
288	root	1.22	MTH void flush ();
289			MTH void write_outputbuffer ();
290	root	1.38	MTH int outputbuffer_len () const { return outputbuffer.len; }
291	root	1.1	void send (void *buf_, int len);
292
293			void send_packet (const char *buf);
294			void send_packet (const char *buf, int len);
295	root	1.4	void send_packet_printf (const char *format, ...);
296	root	1.1	void send_packet (packet &sl);
297	root	1.7
298	root	1.35	void send_drawinfo (const char *msg, int flags = NDI_BLACK);
299	root	1.38	MTH void send_face (faceidx facenum);
300			MTH void send_image (faceidx facenum);
301	root	1.35	MTH void send_faces (object *ob);
302			MTH void send_animation (short anim_num);
303	root	1.48	MTH void send_msg (int color, const char type, const char msg);
304	root	1.35
305	root	1.10	// called when something under the player changes
306	root	1.22	MTH void floorbox_update () { update_look = 1; }
307	root	1.10	// called when the player has been moved
308	root	1.22	MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
309
310	root	1.39	MTH void tick (); // called every server tick to do housekeeping etc.
311
312	root	1.22	MTH static client create (int fd, const char peername);
313	root	1.10
314	root	1.22	protected:
315			client (int fd, const char *from_ip);
316			~client ();
317	root	1.1	};
318
319			#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
320			( ((__type)>0) &&\
321			((__sockPtr)->has_readable_type) && \
322			((__sockPtr)->supported_readables & (1<<(__type))) )
323
324			/* Constants in the form EMI_ is for extended map infos.
325			* Even if the client select the additionnal infos it wants
326			* on the map, there may exist cases where this whole info
327			* is not given in one buch but in separate bunches. This
328			* is done performance reasons (imagine some info related to
329			* a visible object and another info related to a 4 square
330			* width and height area). At the begin of an extended info packet
331			* is a bit field. A bit is activated for each extended info
332			* present in the data
333			*/
334
335			/* Meanings:
336			* EMI_NOREDRAW Take extended infos into account but don't redraw,
337			* some additionnal datas will follow in a new packet
338			* EMI_SMOOTH Datas about smoothing
339			*/
340			#define EMI_NOREDRAW 0x01
341			#define EMI_SMOOTH 0x02
342
343			/* this last one says the bitfield continue un next byte
344			* There may be several on contiguous bytes. So there is 7
345			* actual bits used per byte, and the number of bytes
346			* is not fixed in protocol
347			*/
348			#define EMI_HASMOREBITS 0x80
349
350			#define FACE_TYPES 1
351			#define PNG_FACE_INDEX 0
352
353			#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
354	root	1.31	#define VERSION_SC 1026
355			//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
356	root	1.1	#define VERSION_INFO "Crossfire+ Server"
357
358	root	1.24	typedef object_vector<client, &client::active> sockvec;
359	root	1.1
360			extern sockvec clients;
361	root	1.24
362			#define for_all_clients(var) \
363			for (int _i = 0; _i < clients.size (); ++_i) \
364			declvar (client *, var, clients [_i])
365
366	root	1.1	#endif
367