server/include/client.h

/*
 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
 * 
 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
 * Copyright (©) 1992,2007 Frank Tore Johansen
 * 
 * Crossfire TRT 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 3 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, see <http://www.gnu.org/licenses/>.
 * 
 * The authors 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
};

// face type.s bit 0 means "has meta info prepended"
enum {
  FT_FACE  = 0 * 2 + 0, // faces (images)
  FT_MUSIC = 1 * 2 + 1, // background music
  FT_SOUND = 2 * 2 + 1, // effects
  FT_RSRC  = 3 * 2 + 0, // generic data files
  FT_NUM,
};

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);
  }
};

/* 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;
  object_vector_index ACC (RO, active);
  player_ptr ACC (RO, pl);

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

  tstamp ACC (RW, last_send);             // last data send on socket.

  int ACC (RW, rtt), ACC (RW, rttvar);    /* round-trip time and -variance, if known */
  int ACC (RW, outq);                     // current socket outq length, or 0 if indeterminable

  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

  struct ixsend {
    int16_t pri; // unused
    faceidx idx;
    uint32_t ofs;  // if != 0, need to send remaining bytes of partial_face
  };
  std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix

  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);

  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;
  std::bitset<FT_NUM> fx_want;

  // 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, int pri = 0);
  MTH void send_image (faceidx facenum);
  MTH void send_faces (object *ob);
  MTH void send_animation (short anim_num);
  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 TRT Server"

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

extern sockvec clients;

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

#endif

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