make infobar height configurable
[divverent/darkplaces.git] / netconn.h
index f158e35..f93d297 100755 (executable)
--- a/netconn.h
+++ b/netconn.h
@@ -34,82 +34,102 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 #define NETFLAG_EOM                    0x00080000
 #define NETFLAG_UNRELIABLE     0x00100000
 #define NETFLAG_CTL                    0x80000000
+#define NETFLAG_CRYPTO         0x40000000
 
 
 #define NET_PROTOCOL_VERSION   3
 #define NET_EXTRESPONSE_MAX 16
 
-// This is the network info/connection protocol.  It is used to find Quake
-// servers, get info about them, and connect to them.  Once connected, the
-// Quake game protocol (documented elsewhere) is used.
-//
-//
-// General notes:
-//     game_name is currently always "QUAKE", but is there so this same protocol
-//             can be used for future games as well; can you say Quake2?
-//
-// CCREQ_CONNECT
-//             string  game_name                               "QUAKE"
-//             byte    net_protocol_version    NET_PROTOCOL_VERSION
-//
-// CCREQ_SERVER_INFO
-//             string  game_name                               "QUAKE"
-//             byte    net_protocol_version    NET_PROTOCOL_VERSION
-//
-// CCREQ_PLAYER_INFO
-//             byte    player_number
-//
-// CCREQ_RULE_INFO
-//             string  rule
-//
-//
-//
-// CCREP_ACCEPT
-//             long    port
-//
-// CCREP_REJECT
-//             string  reason
-//
-// CCREP_SERVER_INFO
-//             string  server_address
-//             string  host_name
-//             string  level_name
-//             byte    current_players
-//             byte    max_players
-//             byte    protocol_version        NET_PROTOCOL_VERSION
-//
-// CCREP_PLAYER_INFO
-//             byte    player_number
-//             string  name
-//             long    colors
-//             long    frags
-//             long    connect_time
-//             string  address
-//
-// CCREP_RULE_INFO
-//             string  rule
-//             string  value
-
-//     note:
-//             There are two address forms used above.  The short form is just a
-//             port number.  The address that goes along with the port is defined as
-//             "whatever address you receive this reponse from".  This lets us use
-//             the host OS to solve the problem of multiple host addresses (possibly
-//             with no routing between them); the host will use the right address
-//             when we reply to the inbound connection request.  The long from is
-//             a full address and port in a string.  It is used for returning the
-//             address of a server that is not running locally.
+/// \page netconn The network info/connection protocol.
+/// It is used to find Quake
+/// servers, get info about them, and connect to them.  Once connected, the
+/// Quake game protocol (documented elsewhere) is used.
+///
+///
+/// General notes:\code
+///    game_name is currently always "QUAKE", but is there so this same protocol
+///            can be used for future games as well; can you say Quake2?
+///
+/// CCREQ_CONNECT
+///            string  game_name                               "QUAKE"
+///            byte    net_protocol_version    NET_PROTOCOL_VERSION
+///
+/// CCREQ_SERVER_INFO
+///            string  game_name                               "QUAKE"
+///            byte    net_protocol_version    NET_PROTOCOL_VERSION
+///
+/// CCREQ_PLAYER_INFO
+///            byte    player_number
+///
+/// CCREQ_RULE_INFO
+///            string  rule
+///
+/// CCREQ_RCON
+///            string  password
+///            string  command
+///
+///
+///
+/// CCREP_ACCEPT
+///            long    port
+///
+/// CCREP_REJECT
+///            string  reason
+///
+/// CCREP_SERVER_INFO
+///            string  server_address
+///            string  host_name
+///            string  level_name
+///            byte    current_players
+///            byte    max_players
+///            byte    protocol_version        NET_PROTOCOL_VERSION
+///
+/// CCREP_PLAYER_INFO
+///            byte    player_number
+///            string  name
+///            long    colors
+///            long    frags
+///            long    connect_time
+///            string  address
+///
+/// CCREP_RULE_INFO
+///            string  rule
+///            string  value
+///
+/// CCREP_RCON
+///            string  reply
+/// \endcode
+///    \note
+///            There are two address forms used above.  The short form is just a
+///            port number.  The address that goes along with the port is defined as
+///            "whatever address you receive this reponse from".  This lets us use
+///            the host OS to solve the problem of multiple host addresses (possibly
+///            with no routing between them); the host will use the right address
+///            when we reply to the inbound connection request.  The long from is
+///            a full address and port in a string.  It is used for returning the
+///            address of a server that is not running locally.
 
 #define CCREQ_CONNECT          0x01
 #define CCREQ_SERVER_INFO      0x02
 #define CCREQ_PLAYER_INFO      0x03
 #define CCREQ_RULE_INFO                0x04
+#define CCREQ_RCON             0x05 // RocketGuy: ProQuake rcon support
 
 #define CCREP_ACCEPT           0x81
 #define CCREP_REJECT           0x82
 #define CCREP_SERVER_INFO      0x83
 #define CCREP_PLAYER_INFO      0x84
 #define CCREP_RULE_INFO                0x85
+#define CCREP_RCON             0x86 // RocketGuy: ProQuake rcon support
+
+typedef struct netgraphitem_s
+{
+       double time;
+       int reliablebytes;
+       int unreliablebytes;
+       int ackbytes;
+}
+netgraphitem_t;
 
 typedef struct netconn_s
 {
@@ -120,33 +140,37 @@ typedef struct netconn_s
 
        // this is mostly identical to qsocket_t from quake
 
-       // if this time is reached, kick off peer
+       /// if this time is reached, kick off peer
        double connecttime;
        double timeout;
        double lastMessageTime;
        double lastSendTime;
 
-       // writing buffer to send to peer as the next reliable message
-       // can be added to at any time, copied into sendMessage buffer when it is
-       // possible to send a reliable message and then cleared
+       /// writing buffer to send to peer as the next reliable message
+       /// can be added to at any time, copied into sendMessage buffer when it is
+       /// possible to send a reliable message and then cleared
+       /// @{
        sizebuf_t message;
        unsigned char messagedata[NET_MAXMESSAGE];
+       /// @}
 
-       // reliable message that is currently sending
-       // (for building fragments)
+       /// reliable message that is currently sending
+       /// (for building fragments)
        int sendMessageLength;
        unsigned char sendMessage[NET_MAXMESSAGE];
 
-       // reliable message that is currently being received
-       // (for putting together fragments)
+       /// reliable message that is currently being received
+       /// (for putting together fragments)
        int receiveMessageLength;
        unsigned char receiveMessage[NET_MAXMESSAGE];
 
+       /// used by both NQ and QW protocols
+       unsigned int outgoing_unreliable_sequence;
+
        struct netconn_nq_s
        {
                unsigned int ackSequence;
                unsigned int sendSequence;
-               unsigned int unreliableSendSequence;
 
                unsigned int receiveSequence;
                unsigned int unreliableReceiveSequence;
@@ -164,33 +188,39 @@ typedef struct netconn_s
                float           frame_latency;          // rolling average
                float           frame_rate;
 
-               int                     drop_count;                     // dropped packets, cleared each level
-               int                     good_count;                     // cleared each level
+               int                     drop_count;                     ///< dropped packets, cleared each level
+               int                     good_count;                     ///< cleared each level
 
                int                     qport;
 
-       // bandwidth estimator
-               double          cleartime;                      // if realtime > nc->cleartime, free to go
-               double          rate;                           // seconds / byte
-
        // sequencing variables
                int                     incoming_sequence;
                int                     incoming_acknowledged;
-               int                     incoming_reliable_acknowledged; // single bit
+               int                     incoming_reliable_acknowledged; ///< single bit
 
-               int                     incoming_reliable_sequence;             // single bit, maintained local
+               int                     incoming_reliable_sequence;             ///< single bit, maintained local
 
-               int                     outgoing_sequence;
-               int                     reliable_sequence;                      // single bit
-               int                     last_reliable_sequence;         // sequence number of last send
+               int                     reliable_sequence;                      ///< single bit
+               int                     last_reliable_sequence;         ///< sequence number of last send
        }
        qw;
 
-       // this tracks which of the last 100 received packet sequence numbers were lost
-       int packetlostcounter;
-       unsigned char packetlost[100];
+       // bandwidth estimator
+       double          cleartime;                      // if realtime > nc->cleartime, free to go
+
+       // this tracks packet loss and packet sizes on the most recent packets
+       // used by shownetgraph feature
+#define NETGRAPH_PACKETS 256
+#define NETGRAPH_NOPACKET 0
+#define NETGRAPH_LOSTPACKET -1
+#define NETGRAPH_CHOKEDPACKET -2
+       int incoming_packetcounter;
+       netgraphitem_t incoming_netgraph[NETGRAPH_PACKETS];
+       int outgoing_packetcounter;
+       netgraphitem_t outgoing_netgraph[NETGRAPH_PACKETS];
 
        char address[128];
+       crypto_t crypto;
 } netconn_t;
 
 extern netconn_t *netconn_list;
@@ -216,34 +246,48 @@ typedef enum serverlist_maskop_e
        SLMO_EQUAL,
        SLMO_GREATER,
        SLMO_GREATEREQUAL,
-       SLMO_NOTEQUAL
+       SLMO_NOTEQUAL,
+       SLMO_STARTSWITH,
+       SLMO_NOTSTARTSWITH
 } serverlist_maskop_t;
 
-// struct with all fields that you can search for or sort by
+/// struct with all fields that you can search for or sort by
 typedef struct serverlist_info_s
 {
-       // address for connecting
+       /// address for connecting
        char cname[128];
-       // ping time for sorting servers
+       /// ping time for sorting servers
        int ping;
-       // name of the game
+       /// name of the game
        char game[32];
-       // name of the mod
+       /// name of the mod
        char mod[32];
-       // name of the map
+       /// name of the map
        char map[32];
-       // name of the session
+       /// name of the session
        char name[128];
-       // max client number
+       /// qc-defined short status string
+       char qcstatus[128];
+       /// frags/ping/name list (if they fit in the packet)
+       char players[1400];
+       /// max client number
        int maxplayers;
-       // number of currently connected players
+       /// number of currently connected players (including bots)
        int numplayers;
-       // protocol version
+       /// number of currently connected players that are bots
+       int numbots;
+       /// number of currently connected players that are not bots
+       int numhumans;
+       /// number of free slots
+       int freeslots;
+       /// protocol version
        int protocol;
-       // game data version
-       // (an integer that is used for filtering incompatible servers,
-       //  not filterable by QC)
+       /// game data version
+       /// (an integer that is used for filtering incompatible servers,
+       ///  not filterable by QC)
        int gameversion;
+       /// favorite server flag
+       qboolean isfavorite;
 } serverlist_info_t;
 
 typedef enum
@@ -257,27 +301,40 @@ typedef enum
        SLIF_MAXPLAYERS,
        SLIF_NUMPLAYERS,
        SLIF_PROTOCOL,
+       SLIF_NUMBOTS,
+       SLIF_NUMHUMANS,
+       SLIF_FREESLOTS,
+       SLIF_QCSTATUS,
+       SLIF_PLAYERS,
+       SLIF_ISFAVORITE,
        SLIF_COUNT
 } serverlist_infofield_t;
 
+typedef enum
+{
+       SLSF_DESCENDING = 1,
+       SLSF_FAVORITESFIRST = 2
+} serverlist_sortflags_t;
+
 typedef enum
 {
        SQS_NONE = 0,
        SQS_QUERYING,
        SQS_QUERIED,
-       SQS_TIMEDOUT
+       SQS_TIMEDOUT,
+       SQS_REFRESHING
 } serverlist_query_state;
 
 typedef struct serverlist_entry_s
 {
-       // used to determine whether this entry should be included into the final view
+       /// used to determine whether this entry should be included into the final view
        serverlist_query_state query;
-       // used to count the number of times the host has tried to query this server already
+       /// used to count the number of times the host has tried to query this server already
        unsigned querycounter;
-       // used to calculate ping when update comes in
+       /// used to calculate ping when update comes in
        double querytime;
-       // query protocol to use on this server
-       int protocol; // may be PROTOCOL_QUAKEWORLD or PROTOCOL_DARKPLACES7
+       /// query protocol to use on this server, may be PROTOCOL_QUAKEWORLD or PROTOCOL_DARKPLACES7
+       int protocol;
 
        serverlist_info_t info;
 
@@ -293,28 +350,41 @@ typedef struct serverlist_mask_s
        serverlist_info_t info;
 } serverlist_mask_t;
 
+#define ServerList_GetCacheEntry(x) (&serverlist_cache[(x)])
+#define ServerList_GetViewEntry(x) (ServerList_GetCacheEntry(serverlist_viewlist[(x)]))
+
 extern serverlist_mask_t serverlist_andmasks[SERVERLIST_ANDMASKCOUNT];
 extern serverlist_mask_t serverlist_ormasks[SERVERLIST_ORMASKCOUNT];
 
 extern serverlist_infofield_t serverlist_sortbyfield;
-extern qboolean serverlist_sortdescending;
+extern int serverlist_sortflags; // not using the enum, as it is a bitmask
 
+#if SERVERLIST_TOTALSIZE > 65536
+#error too many servers, change type of index array
+#endif
 extern int serverlist_viewcount;
-extern serverlist_entry_t *serverlist_viewlist[SERVERLIST_VIEWLISTSIZE];
+extern unsigned short serverlist_viewlist[SERVERLIST_VIEWLISTSIZE];
 
 extern int serverlist_cachecount;
+extern serverlist_entry_t *serverlist_cache;
 
 extern qboolean serverlist_consoleoutput;
 
+void ServerList_GetPlayerStatistics(int *numplayerspointer, int *maxplayerspointer);
+
 //============================================================================
 //
 // public network functions
 //
 //============================================================================
 
-extern char net_extresponse[NET_EXTRESPONSE_MAX][1400];
-extern int net_extresponse_count;
-extern int net_extresponse_last;
+extern char cl_net_extresponse[NET_EXTRESPONSE_MAX][1400];
+extern int cl_net_extresponse_count;
+extern int cl_net_extresponse_last;
+
+extern char sv_net_extresponse[NET_EXTRESPONSE_MAX][1400];
+extern int sv_net_extresponse_count;
+extern int sv_net_extresponse_last;
 
 extern double masterquerytime;
 extern int masterquerycount;
@@ -324,14 +394,19 @@ extern int serverreplycount;
 
 extern sizebuf_t net_message;
 
+extern cvar_t sv_public;
+
 extern cvar_t cl_netlocalping;
 
 extern cvar_t cl_netport;
 extern cvar_t sv_netport;
 extern cvar_t net_address;
-//extern cvar_t net_netaddress_ipv6;
+extern cvar_t net_address_ipv6;
 
-int NetConn_SendUnreliableMessage(netconn_t *conn, sizebuf_t *data, protocolversion_t protocol);
+qboolean NetConn_CanSend(netconn_t *conn);
+int NetConn_SendUnreliableMessage(netconn_t *conn, sizebuf_t *data, protocolversion_t protocol, int rate, qboolean quakesignon_suppressreliables);
+qboolean NetConn_HaveClientPorts(void);
+qboolean NetConn_HaveServerPorts(void);
 void NetConn_CloseClientPorts(void);
 void NetConn_OpenClientPorts(void);
 void NetConn_CloseServerPorts(void);
@@ -350,18 +425,34 @@ int NetConn_WriteString(lhnetsocket_t *mysocket, const char *string, const lhnet
 int NetConn_IsLocalGame(void);
 void NetConn_ClientFrame(void);
 void NetConn_ServerFrame(void);
+void NetConn_SleepMicroseconds(int microseconds);
 void NetConn_QueryMasters(qboolean querydp, qboolean queryqw);
 void NetConn_Heartbeat(int priority);
 void NetConn_QueryQueueFrame(void);
 void Net_Stats_f(void);
 void Net_Slist_f(void);
 void Net_SlistQW_f(void);
+void Net_Refresh_f(void);
 
-// ServerList interface (public)
-// manually refresh the view set, do this after having changed the mask or any other flag
+/// ServerList interface (public)
+/// manually refresh the view set, do this after having changed the mask or any other flag
 void ServerList_RebuildViewList(void);
 void ServerList_ResetMasks(void);
-void ServerList_QueryList(qboolean querydp, qboolean queryqw);
+void ServerList_QueryList(qboolean resetcache, qboolean querydp, qboolean queryqw, qboolean consoleoutput);
+
+/// called whenever net_slist_favorites changes
+void NetConn_UpdateFavorites(void);
+
+#define MAX_CHALLENGES 128
+typedef struct challenge_s
+{
+       lhnetaddress_t address;
+       double time;
+       char string[12];
+}
+challenge_t;
+
+extern challenge_t challenge[MAX_CHALLENGES];
 
 #endif