--- deliantra/server/include/client.h 2007/01/07 02:39:14 1.24
+++ deliantra/server/include/client.h 2007/10/01 01:09:10 1.68
@@ -1,26 +1,25 @@
/*
- 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
-*/
+ * 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 .
+ *
+ * The authors can be reached via e-mail to
+ */
#ifndef CLIENT_H
#define CLIENT_H
@@ -29,28 +28,58 @@
#include
#include
+#if HAVE_TCP_INFO
+# include
+#else
+ struct tcpi_info {
+ // dummy
+ char tcpi_state;
+ char tcpi_ca_state;
+ char tcpi_retransmits;
+ char tcpi_probes;
+ char tcpi_backoff;
+ char tcpi_options;
+ char tcpi_snd_wscale;
+ char tcpi_rcv_wscale;
+ char tcpi_rto;
+ char tcpi_ato;
+ char tcpi_snd_mss;
+ char tcpi_rcv_mss;
+ char tcpi_unacked;
+ char tcpi_sacked;
+ char tcpi_lost;
+ char tcpi_retrans;
+ char tcpi_fackets;
+ char tcpi_last_data_sent;
+ char tcpi_last_ack_sent;
+ char tcpi_last_data_recv;
+ char tcpi_last_ack_recv;
+ char tcpi_pmtu;
+ char tcpi_rcv_ssthresh;
+ char tcpi_rtt;
+ char tcpi_rttvar;
+ char tcpi_snd_ssthresh;
+ char tcpi_snd_cwnd;
+ char tcpi_advmss;
+ char tcpi_reordering;
+ };
+#endif
+
// (possibly) max. number of objects "per page" in the ground container
#define FLOORBOX_PAGESIZE 50
struct MapCell
{
- UUID player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
- int count; /* This is really darkness in the map1 command */
- uint16 faces[MAP_LAYERS];
- uint16 smooth[MAP_LAYERS];
- unsigned char stat_hp; // health of something in this space, or 0
+ tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
+ 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];
};
-/* This basically defines the largest size an
- * archetype may be - it is used for allocation of
- * some structures, as well as determining how far
- * we should look for the heads of big images.
- */
-#define MAX_HEAD_OFFSET 8
-
-#define MAX_CLIENT_X (MAP_CLIENT_X + MAX_HEAD_OFFSET)
-#define MAX_CLIENT_Y (MAP_CLIENT_Y + MAX_HEAD_OFFSET)
+#define MAX_CLIENT_X MAP_CLIENT_X
+#define MAX_CLIENT_Y MAP_CLIENT_Y
struct Map
{
@@ -58,7 +87,7 @@
};
/* True max is 16383 given current map compaction method */
-# define MAXANIMNUM 2000
+#define MAXANIMNUM 10000
struct statsinfo
{
@@ -75,17 +104,7 @@
* instead of having a bunch of different fields that needed to
* get toggled.
*/
-enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
-
-/* The following is the setup for a ring buffer for storing output
- * data that the OS can't handle right away.
- */
-struct Buffer
-{
- char data[SOCKETBUFSIZE];
- int start;
- int len;
-};
+enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
// states the socket can be in
enum {
@@ -94,14 +113,24 @@
ST_PLAYING, // logged in an playing
ST_CUSTOM, // waiting for custom reply
- ST_CHANGE_CLASS,
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_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
@@ -124,43 +153,6 @@
}
};
-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 >
-{
- 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
@@ -169,29 +161,54 @@
{
int ACC (RW, fd);
unsigned int inbuf_len; // number of bytes valid in inbuf
- uint8 *faces_sent; // This is a bitmap on sent face status
statsinfo stats;
- int ACC (RO, active);
+ object_vector_index ACC (RO, active);
+ player_ptr ACC (RO, pl);
- client_container cc_inv, cc_other;
- Buffer outputbuffer;
+ /* 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 */
- uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */
+
+ 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); /* CF+ extend the protocol through a plug-in */
- bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */
- bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */
- bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */
- bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */
+ 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 */
@@ -200,27 +217,52 @@
/* 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 */
- enum MapMode mapmode; /* Type of map commands the client wants. */
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 */
- uint8 ACC (RW, faceset); /* Set the client is using, default 0 */
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
- char ACC (RW, version)[64]; // CF+ client name/version
+ shstr ACC (RW, version); // CF+ client name/version
+ uint8 ACC (RW, faceset); // CF+ selected faceset
- player_ptr ACC (RO, pl);
+ 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, 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 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 > ixface; // which faces to send to the client using ix
+
+ std::vector > 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;
- iw cmd_ev; void cmd_cb (iw &w);
iow socket_ev; void socket_cb (iow &w, int got);
std::deque< command, slice_allocator > cmd_queue;
@@ -228,10 +270,24 @@
// large structures at the end please
struct Map lastmap;
std::bitset anims_sent;
+ std::bitset faces_sent;
+ std::bitset 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);
@@ -239,6 +295,8 @@
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
@@ -246,6 +304,7 @@
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);
@@ -253,29 +312,68 @@
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);
+
+ 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))) )
-/* Bitmask for the faces_sent[] array - what
- * portion of the face have we sent?
- */
-#define NS_FACESENT_FACE 0x1
-#define NS_FACESENT_SMOOTH 0x2
-
/* Constants in the form EMI_ is for extended map infos.
* Even if the client select the additionnal infos it wants
* on the map, there may exist cases where this whole info
@@ -306,8 +404,9 @@
#define PNG_FACE_INDEX 0
#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
-#define VERSION_SC 1027
-#define VERSION_INFO "Crossfire+ Server"
+#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 sockvec;
@@ -315,9 +414,7 @@
#define for_all_clients(var) \
for (int _i = 0; _i < clients.size (); ++_i) \
- declvar (client *, var, clients [_i])
-
-extern int nrofpixmaps; //TODO: hrmpf, should go
+ statementvar (client *, var, clients [_i])
#endif