server/include/client.h

/*
 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
 *
 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
 *
 * 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

#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

//+GPL

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

// 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 types. 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;
};

//-GPL

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

/* This contains basic information on the socket connection.  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.
 */
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[CS_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, bumpmsg);                 /* give message when bumping into walls */

  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, need_delinv0);            /* If true, we need to delinv 0 before sending new floorbox */

  bool ACC (RW, update_look);             /* If true, we need to send the look window */
  bool ACC (RW, update_spells);           // If true, we need to esrv_update_spells
  bool ACC (RW, has_readable_type);       /* If true client accept additional text information */
  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
  uint16 ACC (RW, look_position);         /* start of drawing of look window */
  uint16 ACC (RW, mss);                   // likely tcp maximum segment size
  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 */
  uint8 ACC (RW, faceset);                // CF+ selected faceset
  uint8 ACC (RW, ws_version);             // websocket protocol versio for framing

  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

  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;

  // websocket frame buffer
  uint8 ws_inbuf_type; // current frame type
  uint8 *ws_inbuf;
  uint32 ws_inbuf_len;
  uint32 ws_inbuf_alloc;

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

  struct ixsend {
    int16_t pri; // higher means faces are sent earlier, default 0
    faceidx idx;
    uint32_t ofs;  // if != 0, need to send remaining bytes of partial_face
    refcnt_buf data;
  };
  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

  MTH void invalidate_face (faceidx idx);
  MTH void invalidate_all_faces ();

  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];
  void inbuf_handle ();

  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_utf8_string 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_raw (void *buf_, int len);

  void send (void *buf_, int len);
  void send_packet (const_octet_string buf);
  void send_packet (const_octet_string buf, int len);
  void send_packet_printf (const_utf8_string format, ...) attribute ((format (printf, 2, 3)));
  void send_packet (packet &sl);

  void send_drawinfo (const_utf8_string 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_utf8_string type, const_utf8_string 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 ();

  MTH void run (); // start handshake after init

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

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_any_string msg, bool nl_special = true)
{   
  return msg [strcspn (msg, nl_special ? "<&\n" : "<&")];
}

#endif

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