server/include/client.h

/*
 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
 * 
 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
 * Copyright (©) 1992,2007 Frank Tore Johansen
 * 
 * Deliantra is free software: you can redistribute it and/or modify it under
 * the terms of the Affero 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 Affero GNU General Public License
 * and 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 <support@deliantra.net>
 */

#ifndef CLIENT_H
#define CLIENT_H

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

#if HAVE_TCP_INFO
# include <netinet/tcp.h>
#else
  struct tcp_info {
    // dummy
    int tcpi_state;
    int tcpi_ca_state;
    int tcpi_retransmits;
    int tcpi_probes;
    int tcpi_backoff;
    int tcpi_options;
    int tcpi_snd_wscale;
    int tcpi_rcv_wscale;
    int tcpi_rto;
    int tcpi_ato;
    int tcpi_snd_mss;
    int tcpi_rcv_mss;
    int tcpi_unacked;
    int tcpi_sacked;
    int tcpi_lost;
    int tcpi_retrans;
    int tcpi_fackets;
    int tcpi_last_data_sent;
    int tcpi_last_ack_sent;
    int tcpi_last_data_recv;
    int tcpi_last_ack_recv;
    int tcpi_pmtu;
    int tcpi_rcv_ssthresh;
    int tcpi_rtt;
    int tcpi_rttvar;
    int tcpi_snd_ssthresh;
    int tcpi_snd_cwnd;
    int tcpi_advmss;
    int tcpi_reordering;
  };
#endif

// (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;
};

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

  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, afk);                     /* player is afk */
  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, 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, smoothing);               // deliantra-style smoothing

  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_ptr ACC (RW, current_map);      // CF+ last/current player map
  region_ptr 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.

  float ACC (RW, socket_timeout);         /* after how many seconds of no ack do we declare dead */
  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 tcp_info tcpi;
  tstamp next_rate_adjust;

  unordered_vector<char *> mapinfo_queue;
  void mapinfo_queue_clear ();
  void mapinfo_queue_run ();
  bool mapinfo_try (char *buf);

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

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

  /* The following is the setup for a ring buffer for storing output
   * data that the OS can't handle right away.
   * TODO: this member is enourmously large - optimise?
   */
  struct
  {
    char data[SOCKETBUFSIZE];
    int start;
    int len;
  } outputbuffer;

  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_faces (object *ob);
  MTH void send_animation (short anim_num);
  void send_msg (int color, const char *type, const char *msg);

  MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
  // 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);
  MTH static void clock ();
  MTH static void flush_sockets ();

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

#if FOR_PERL
  ACC (RW, tcpi.tcpi_state);
  ACC (RW, tcpi.tcpi_ca_state);
  ACC (RW, tcpi.tcpi_retransmits);
  ACC (RW, tcpi.tcpi_probes);
  ACC (RW, tcpi.tcpi_backoff);
  ACC (RW, tcpi.tcpi_options);
  ACC (RO, tcpi.tcpi_snd_wscale);
  ACC (RO, tcpi.tcpi_rcv_wscale);
  ACC (RW, tcpi.tcpi_rto);
  ACC (RW, tcpi.tcpi_ato);
  ACC (RW, tcpi.tcpi_snd_mss);
  ACC (RW, tcpi.tcpi_rcv_mss);
  ACC (RW, tcpi.tcpi_unacked);
  ACC (RW, tcpi.tcpi_sacked);
  ACC (RW, tcpi.tcpi_lost);
  ACC (RW, tcpi.tcpi_retrans);
  ACC (RW, tcpi.tcpi_fackets);
  ACC (RW, tcpi.tcpi_last_data_sent);
  ACC (RW, tcpi.tcpi_last_ack_sent);
  ACC (RW, tcpi.tcpi_last_data_recv);
  ACC (RW, tcpi.tcpi_last_ack_recv);
  ACC (RW, tcpi.tcpi_pmtu);
  ACC (RW, tcpi.tcpi_rcv_ssthresh);
  ACC (RW, tcpi.tcpi_rtt);
  ACC (RW, tcpi.tcpi_rttvar);
  ACC (RW, tcpi.tcpi_snd_ssthresh);
  ACC (RW, tcpi.tcpi_snd_cwnd);
  ACC (RW, tcpi.tcpi_advmss);
  ACC (RW, tcpi.tcpi_reordering);
#endif

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

#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 "Deliantra 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])

// returns true when the message needs special (read: perl) treatment
static inline bool
msg_is_special (const char *msg, bool nl_special = true)
{   
  return msg [strcspn (msg, nl_special ? "<&\n" : "<&")];
}

#endif

Revision:	1.87
Committed:	Mon Oct 12 14:00:58 2009 UTC (14 years, 7 months ago) by root
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-2_82, rel-2_81
Changes since 1.86:	+7 -6 lines
Log Message:	clarify license
#	User	Rev	Content
1	root	1.1	/*
2	root	1.69	* This file is part of Deliantra, the Roguelike Realtime MMORPG.
3	pippijn	1.26	*
4	root	1.77	* Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5	root	1.51	* Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
6			* Copyright (©) 1992,2007 Frank Tore Johansen
7	pippijn	1.26	*
8	root	1.87	* Deliantra is free software: you can redistribute it and/or modify it under
9			* the terms of the Affero GNU General Public License as published by the
10			* Free Software Foundation, either version 3 of the License, or (at your
11			* 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.87	* You should have received a copy of the Affero GNU General Public License
19			* and the GNU General Public License along with this program. If not, see
20			* <http://www.gnu.org/licenses/>.
21	root	1.51	*
22	root	1.69	* The authors can be reached via e-mail to <support@deliantra.net>
23	pippijn	1.26	*/
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.65	#if HAVE_TCP_INFO
33			# include <netinet/tcp.h>
34			#else
35	root	1.74	struct tcp_info {
36	root	1.65	// dummy
37	root	1.75	int tcpi_state;
38			int tcpi_ca_state;
39			int tcpi_retransmits;
40			int tcpi_probes;
41			int tcpi_backoff;
42			int tcpi_options;
43			int tcpi_snd_wscale;
44			int tcpi_rcv_wscale;
45			int tcpi_rto;
46			int tcpi_ato;
47			int tcpi_snd_mss;
48			int tcpi_rcv_mss;
49			int tcpi_unacked;
50			int tcpi_sacked;
51			int tcpi_lost;
52			int tcpi_retrans;
53			int tcpi_fackets;
54			int tcpi_last_data_sent;
55			int tcpi_last_ack_sent;
56			int tcpi_last_data_recv;
57			int tcpi_last_ack_recv;
58			int tcpi_pmtu;
59			int tcpi_rcv_ssthresh;
60			int tcpi_rtt;
61			int tcpi_rttvar;
62			int tcpi_snd_ssthresh;
63			int tcpi_snd_cwnd;
64			int tcpi_advmss;
65			int tcpi_reordering;
66	root	1.65	};
67			#endif
68
69	root	1.4	// (possibly) max. number of objects "per page" in the ground container
70	root	1.11	#define FLOORBOX_PAGESIZE 50
71	root	1.1
72			struct MapCell
73			{
74	root	1.79	tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
75	root	1.37	int count; /* This is really darkness in the map1 command */
76	root	1.32	faceidx faces[MAP_LAYERS];
77	root	1.36	unsigned char stat_hp; // health of something in this space, or 0
78	root	1.1	unsigned char flags;
79	root	1.37	uint8_t smooth[MAP_LAYERS];
80	root	1.1	};
81
82	root	1.33	#define MAX_CLIENT_X MAP_CLIENT_X
83			#define MAX_CLIENT_Y MAP_CLIENT_Y
84	root	1.1
85			struct Map
86			{
87			struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y];
88			};
89
90			/* True max is 16383 given current map compaction method */
91	root	1.33	#define MAXANIMNUM 10000
92	root	1.1
93			struct statsinfo
94			{
95			char range, title;
96			};
97
98			/* This contains basic information on the socket structure. status is its
99			* current state. we set up our on buffers for sending/receiving, so we can
100			* handle some higher level functions. fd is the actual file descriptor we
101			* are using.
102			*/
103
104			/* Only one map mode can actually be used, so lets make it a switch
105			* instead of having a bunch of different fields that needed to
106			* get toggled.
107			*/
108	root	1.42	enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
109	root	1.1
110	root	1.15	// states the socket can be in
111			enum {
112			ST_DEAD, // socket is dead
113			ST_SETUP, // initial handshake / setup / login
114			ST_PLAYING, // logged in an playing
115			ST_CUSTOM, // waiting for custom reply
116
117			ST_GET_PARTY_PASSWORD,
118			};
119
120	root	1.4	// a handler for a specific type of packet
121			enum {
122	root	1.28	PF_PLAYER = 0x01, // must have valid player / will by synchronised
123			PF_PLAYING = 0x02, // must be in playing state
124			PF_COMMAND0 = 0x04, // command starts at offset 0
125			PF_COMMAND6 = 0x08, // command starts at offset 6
126	root	1.4	};
127
128	root	1.63	// face type.s bit 0 means "has meta info prepended"
129			enum {
130			FT_FACE = 0 * 2 + 0, // faces (images)
131			FT_MUSIC = 1 * 2 + 1, // background music
132			FT_SOUND = 2 * 2 + 1, // effects
133			FT_RSRC = 3 * 2 + 0, // generic data files
134			FT_NUM,
135			};
136
137	root	1.4	struct packet_type
138			{
139			const char *name;
140			void *cb;
141			int flags;
142			};
143
144			struct command
145			{
146			tstamp stamp;
147			const packet_type *handler;
148			char *data;
149			int datalen;
150			};
151
152	root	1.1	/* how many times we are allowed to give the wrong password before being kicked. */
153			#define MAX_PASSWORD_FAILURES 5
154
155	root	1.21	INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
156			struct client : zero_initialised, attachable
157	root	1.1	{
158			int ACC (RW, fd);
159	root	1.10	unsigned int inbuf_len; // number of bytes valid in inbuf
160	root	1.20	statsinfo stats;
161	root	1.54	object_vector_index ACC (RO, active);
162	root	1.53	player_ptr ACC (RO, pl);
163	root	1.12
164	root	1.10	char ACC (RW, host); / Which host it is connected from (ip address) */
165	root	1.15	uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
166	root	1.25
167			sint8 ACC (RW, last_level); /* Last level we sent to client */
168			uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */
169			float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */
170	root	1.76	sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */
171	root	1.25	sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */
172			uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */
173			uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */
174			uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */
175			living ACC (RO, last_stats); /* Last stats as sent to client */
176			float ACC (RW, last_speed); /* Last speed as sent to client */
177			sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
178			sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */
179	root	1.10
180	root	1.20	bool ACC (RW, afk); /* player is afk */
181	root	1.10	bool ACC (RW, sent_scroll);
182			bool ACC (RW, sound); /* does the client want sound */
183			bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
184	root	1.40	bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
185			bool ACC (RW, mapinfocmd); // return map info and send map change info
186	root	1.85	uint8_t ACC (RW, extcmd); // call into extensions/plugins
187	root	1.10	bool ACC (RW, update_look); /* If true, we need to send the look window */
188			bool ACC (RW, has_readable_type); /* If true client accept additional text information */
189			/* used to arrange text in books, scrolls, or scripted dialogs */
190			bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
191	root	1.84	bool ACC (RW, smoothing); // deliantra-style smoothing
192	root	1.1
193	root	1.40	bool ACC (RW, force_newmap); // force a newmap before next map update
194	root	1.1	uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
195			uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
196			uint16 ACC (RW, look_position); /* start of drawing of look window */
197	root	1.43	uint16 ACC (RW, mss); // likely tcp maximum segment size
198	root	1.42	uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
199	root	1.1	uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
200			uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
201
202	root	1.80	maptile_ptr ACC (RW, current_map); // CF+ last/current player map
203			region_ptr ACC (RW, current_region); // CF+ last/current player region
204	root	1.1	int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
205	root	1.49	shstr ACC (RW, version); // CF+ client name/version
206	root	1.32	uint8 ACC (RW, faceset); // CF+ selected faceset
207	root	1.1
208	root	1.53	tstamp ACC (RW, last_send); // last data send on socket.
209	root	1.1
210	root	1.86	float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */
211	root	1.44	int ACC (RW, rate_avail); // current rate balance
212	root	1.38	int ACC (RW, max_rate); // max. # of bytes to send per tick
213	root	1.39	faceidx ACC (RW, scrub_idx); // which face to send next
214			int ACC (RW, bg_scrub); // how many ticks till the next background face send
215	root	1.45
216	root	1.65	struct tcp_info tcpi;
217			tstamp next_rate_adjust;
218	root	1.67
219			unordered_vector<char *> mapinfo_queue;
220			void mapinfo_queue_clear ();
221			void mapinfo_queue_run ();
222			bool mapinfo_try (char *buf);
223	root	1.65
224	root	1.58	struct ixsend {
225			int16_t pri; // unused
226			faceidx idx;
227			uint32_t ofs; // if != 0, need to send remaining bytes of partial_face
228			};
229			std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix
230	root	1.45
231	root	1.57	std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
232	root	1.45	MTH void flush_fx (); // send fx if required
233	root	1.1
234	root	1.21	void do_destroy ();
235			void gather_callbacks (AV *&callbacks, event_type event) const;
236	root	1.4
237	root	1.70	iow socket_ev; void socket_cb (iow &w, int revents);
238	root	1.1
239	root	1.4	std::deque< command, slice_allocator<command> > cmd_queue;
240
241	root	1.14	// large structures at the end please
242			struct Map lastmap;
243			std::bitset<MAXANIMNUM> anims_sent;
244	root	1.36	std::bitset<MAX_FACES> faces_sent;
245	root	1.63	std::bitset<FT_NUM> fx_want;
246	root	1.36
247	root	1.14	// if we get an incomplete packet, this is used to hold the data.
248			// we add 2 byte for the header, one for the trailing 0 byte
249			uint8 inbuf[MAXSOCKBUF + 2 + 1];
250
251	root	1.49	enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
252			struct msg_buf
253			{
254			tick_t expire;
255			int len;
256			int count;
257			char msg[MSG_BUF_SIZE];
258			} msgbuf[MSG_BUF_COUNT];
259
260			MTH bool msg_suppressed (const char *msg);
261
262	root	1.82	/* The following is the setup for a ring buffer for storing output
263			* data that the OS can't handle right away.
264			* TODO: this member is enourmously large - optimise?
265			*/
266			struct
267			{
268			char data[SOCKETBUFSIZE];
269			int start;
270			int len;
271			} outputbuffer;
272
273	root	1.4	bool may_execute (const packet_type *pkt) const;
274			void execute (const packet_type pkt, char data, int datalen);
275
276			void queue_command (packet_type handler, char data, int datalen);
277	root	1.22	MTH bool handle_command ();
278	root	1.14	// resets movement state
279	root	1.22	MTH void reset_state ();
280	root	1.25	// resets variable data used to send stat diffs
281			MTH void reset_stats ();
282	root	1.1
283	root	1.22	MTH bool handle_packet ();
284	root	1.4	int next_packet (); // returns length of packet or 0
285	root	1.1	void skip_packet (int len); // we have processed the packet, skip it
286
287	root	1.22	MTH void flush ();
288			MTH void write_outputbuffer ();
289	root	1.38	MTH int outputbuffer_len () const { return outputbuffer.len; }
290	root	1.1	void send (void *buf_, int len);
291
292			void send_packet (const char *buf);
293			void send_packet (const char *buf, int len);
294	root	1.4	void send_packet_printf (const char *format, ...);
295	root	1.1	void send_packet (packet &sl);
296	root	1.7
297	root	1.35	void send_drawinfo (const char *msg, int flags = NDI_BLACK);
298	root	1.60
299	root	1.63	MTH void send_face (faceidx facenum, int pri = 0);
300	root	1.35	MTH void send_faces (object *ob);
301			MTH void send_animation (short anim_num);
302	root	1.55	void send_msg (int color, const char type, const char msg);
303	root	1.35
304	root	1.64	MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
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.66	MTH static void clock ();
314			MTH static void flush_sockets ();
315	root	1.10
316	root	1.22	protected:
317			client (int fd, const char *from_ip);
318			~client ();
319	root	1.1	};
320
321	root	1.67	#if FOR_PERL
322			ACC (RW, tcpi.tcpi_state);
323			ACC (RW, tcpi.tcpi_ca_state);
324			ACC (RW, tcpi.tcpi_retransmits);
325			ACC (RW, tcpi.tcpi_probes);
326			ACC (RW, tcpi.tcpi_backoff);
327			ACC (RW, tcpi.tcpi_options);
328			ACC (RO, tcpi.tcpi_snd_wscale);
329			ACC (RO, tcpi.tcpi_rcv_wscale);
330			ACC (RW, tcpi.tcpi_rto);
331			ACC (RW, tcpi.tcpi_ato);
332			ACC (RW, tcpi.tcpi_snd_mss);
333			ACC (RW, tcpi.tcpi_rcv_mss);
334			ACC (RW, tcpi.tcpi_unacked);
335			ACC (RW, tcpi.tcpi_sacked);
336			ACC (RW, tcpi.tcpi_lost);
337			ACC (RW, tcpi.tcpi_retrans);
338			ACC (RW, tcpi.tcpi_fackets);
339			ACC (RW, tcpi.tcpi_last_data_sent);
340			ACC (RW, tcpi.tcpi_last_ack_sent);
341			ACC (RW, tcpi.tcpi_last_data_recv);
342			ACC (RW, tcpi.tcpi_last_ack_recv);
343			ACC (RW, tcpi.tcpi_pmtu);
344			ACC (RW, tcpi.tcpi_rcv_ssthresh);
345			ACC (RW, tcpi.tcpi_rtt);
346			ACC (RW, tcpi.tcpi_rttvar);
347			ACC (RW, tcpi.tcpi_snd_ssthresh);
348			ACC (RW, tcpi.tcpi_snd_cwnd);
349			ACC (RW, tcpi.tcpi_advmss);
350			ACC (RW, tcpi.tcpi_reordering);
351			#endif
352
353	root	1.1	#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
354			( ((__type)>0) &&\
355			((__sockPtr)->has_readable_type) && \
356			((__sockPtr)->supported_readables & (1<<(__type))) )
357
358			#define FACE_TYPES 1
359			#define PNG_FACE_INDEX 0
360
361			#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
362	root	1.31	#define VERSION_SC 1026
363			//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
364	root	1.69	#define VERSION_INFO "Deliantra Server"
365	root	1.1
366	root	1.24	typedef object_vector<client, &client::active> sockvec;
367	root	1.1
368			extern sockvec clients;
369	root	1.24
370			#define for_all_clients(var) \
371			for (int _i = 0; _i < clients.size (); ++_i) \
372	root	1.52	statementvar (client *, var, clients [_i])
373	root	1.24
374	root	1.78	// returns true when the message needs special (read: perl) treatment
375			static inline bool
376			msg_is_special (const char *msg, bool nl_special = true)
377			{
378	root	1.81	return msg [strcspn (msg, nl_special ? "<&\n" : "<&")];
379	root	1.78	}
380
381	root	1.1	#endif
382