netconn.h

   1 /*
   2 Copyright (C) 1996-1997 Id Software, Inc.
   3 Copyright (C) 2003 Forest Hale
   4
   5 This program is free software; you can redistribute it and/or
   6 modify it under the terms of the GNU General Public License
   7 as published by the Free Software Foundation; either version 2
   8 of the License, or (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  13
  14 See the GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program; if not, write to the Free Software
  18 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19
  20 */
  21
  22 #ifndef NET_H
  23 #define NET_H
  24
  25 #include "lhnet.h"
  26
  27 #define NET_HEADERSIZE          (2 * sizeof(unsigned int))
  28
  29 // NetHeader flags
  30 #define NETFLAG_LENGTH_MASK     0x0000ffff
  31 #define NETFLAG_DATA            0x00010000
  32 #define NETFLAG_ACK                     0x00020000
  33 #define NETFLAG_NAK                     0x00040000
  34 #define NETFLAG_EOM                     0x00080000
  35 #define NETFLAG_UNRELIABLE      0x00100000
  36 #define NETFLAG_CTL                     0x80000000
  37
  38
  39 #define NET_PROTOCOL_VERSION    3
  40 #define NET_EXTRESPONSE_MAX 16
  41
  42 // This is the network info/connection protocol.  It is used to find Quake
  43 // servers, get info about them, and connect to them.  Once connected, the
  44 // Quake game protocol (documented elsewhere) is used.
  45 //
  46 //
  47 // General notes:
  48 //      game_name is currently always "QUAKE", but is there so this same protocol
  49 //              can be used for future games as well; can you say Quake2?
  50 //
  51 // CCREQ_CONNECT
  52 //              string  game_name                               "QUAKE"
  53 //              byte    net_protocol_version    NET_PROTOCOL_VERSION
  54 //
  55 // CCREQ_SERVER_INFO
  56 //              string  game_name                               "QUAKE"
  57 //              byte    net_protocol_version    NET_PROTOCOL_VERSION
  58 //
  59 // CCREQ_PLAYER_INFO
  60 //              byte    player_number
  61 //
  62 // CCREQ_RULE_INFO
  63 //              string  rule
  64 //
  65 //
  66 //
  67 // CCREP_ACCEPT
  68 //              long    port
  69 //
  70 // CCREP_REJECT
  71 //              string  reason
  72 //
  73 // CCREP_SERVER_INFO
  74 //              string  server_address
  75 //              string  host_name
  76 //              string  level_name
  77 //              byte    current_players
  78 //              byte    max_players
  79 //              byte    protocol_version        NET_PROTOCOL_VERSION
  80 //
  81 // CCREP_PLAYER_INFO
  82 //              byte    player_number
  83 //              string  name
  84 //              long    colors
  85 //              long    frags
  86 //              long    connect_time
  87 //              string  address
  88 //
  89 // CCREP_RULE_INFO
  90 //              string  rule
  91 //              string  value
  92
  93 //      note:
  94 //              There are two address forms used above.  The short form is just a
  95 //              port number.  The address that goes along with the port is defined as
  96 //              "whatever address you receive this reponse from".  This lets us use
  97 //              the host OS to solve the problem of multiple host addresses (possibly
  98 //              with no routing between them); the host will use the right address
  99 //              when we reply to the inbound connection request.  The long from is
 100 //              a full address and port in a string.  It is used for returning the
 101 //              address of a server that is not running locally.
 102
 103 #define CCREQ_CONNECT           0x01
 104 #define CCREQ_SERVER_INFO       0x02
 105 #define CCREQ_PLAYER_INFO       0x03
 106 #define CCREQ_RULE_INFO         0x04
 107
 108 #define CCREP_ACCEPT            0x81
 109 #define CCREP_REJECT            0x82
 110 #define CCREP_SERVER_INFO       0x83
 111 #define CCREP_PLAYER_INFO       0x84
 112 #define CCREP_RULE_INFO         0x85
 113
 114 typedef struct netconn_s
 115 {
 116         struct netconn_s *next;
 117
 118         lhnetsocket_t *mysocket;
 119         lhnetaddress_t peeraddress;
 120
 121         // this is mostly identical to qsocket_t from quake
 122
 123         // if this time is reached, kick off peer
 124         double connecttime;
 125         double timeout;
 126         double lastMessageTime;
 127         double lastSendTime;
 128
 129         // writing buffer to send to peer as the next reliable message
 130         // can be added to at any time, copied into sendMessage buffer when it is
 131         // possible to send a reliable message and then cleared
 132         sizebuf_t message;
 133         unsigned char messagedata[NET_MAXMESSAGE];
 134
 135         // reliable message that is currently sending
 136         // (for building fragments)
 137         int sendMessageLength;
 138         unsigned char sendMessage[NET_MAXMESSAGE];
 139
 140         // reliable message that is currently being received
 141         // (for putting together fragments)
 142         int receiveMessageLength;
 143         unsigned char receiveMessage[NET_MAXMESSAGE];
 144
 145         struct netconn_nq_s
 146         {
 147                 unsigned int ackSequence;
 148                 unsigned int sendSequence;
 149                 unsigned int unreliableSendSequence;
 150
 151                 unsigned int receiveSequence;
 152                 unsigned int unreliableReceiveSequence;
 153         }
 154         nq;
 155         struct netconn_qw_s
 156         {
 157                 // QW protocol
 158                 qboolean        fatal_error;
 159
 160                 float           last_received;          // for timeouts
 161
 162         // the statistics are cleared at each client begin, because
 163         // the server connecting process gives a bogus picture of the data
 164                 float           frame_latency;          // rolling average
 165                 float           frame_rate;
 166
 167                 int                     drop_count;                     // dropped packets, cleared each level
 168                 int                     good_count;                     // cleared each level
 169
 170                 int                     qport;
 171
 172         // sequencing variables
 173                 int                     incoming_sequence;
 174                 int                     incoming_acknowledged;
 175                 int                     incoming_reliable_acknowledged; // single bit
 176
 177                 int                     incoming_reliable_sequence;             // single bit, maintained local
 178
 179                 int                     outgoing_sequence;
 180                 int                     reliable_sequence;                      // single bit
 181                 int                     last_reliable_sequence;         // sequence number of last send
 182         }
 183         qw;
 184
 185         // bandwidth estimator
 186         double          cleartime;                      // if realtime > nc->cleartime, free to go
 187
 188         // this tracks packet loss and packet sizes on the most recent packets
 189         // used by shownetgraph feature
 190 #define NETGRAPH_PACKETS 100
 191 #define NETGRAPH_NOPACKET 0
 192 #define NETGRAPH_LOSTPACKET -1
 193 #define NETGRAPH_CHOKEDPACKET -2
 194         int incoming_packetcounter;
 195         int incoming_reliablesize[NETGRAPH_PACKETS];
 196         int incoming_unreliablesize[NETGRAPH_PACKETS];
 197         int incoming_acksize[NETGRAPH_PACKETS];
 198         int outgoing_packetcounter;
 199         int outgoing_reliablesize[NETGRAPH_PACKETS];
 200         int outgoing_unreliablesize[NETGRAPH_PACKETS];
 201         int outgoing_acksize[NETGRAPH_PACKETS];
 202
 203         char address[128];
 204 } netconn_t;
 205
 206 extern netconn_t *netconn_list;
 207 extern mempool_t *netconn_mempool;
 208
 209 extern cvar_t hostname;
 210 extern cvar_t developer_networking;
 211
 212 #define SERVERLIST_TOTALSIZE            2048
 213 #define SERVERLIST_VIEWLISTSIZE         SERVERLIST_TOTALSIZE
 214 #define SERVERLIST_ANDMASKCOUNT         5
 215 #define SERVERLIST_ORMASKCOUNT          5
 216
 217 typedef enum serverlist_maskop_e
 218 {
 219         // SLMO_CONTAINS is the default for strings
 220         // SLMO_GREATEREQUAL is the default for numbers (also used when OP == CONTAINS or NOTCONTAINS
 221         SLMO_CONTAINS,
 222         SLMO_NOTCONTAIN,
 223
 224         SLMO_LESSEQUAL,
 225         SLMO_LESS,
 226         SLMO_EQUAL,
 227         SLMO_GREATER,
 228         SLMO_GREATEREQUAL,
 229         SLMO_NOTEQUAL
 230 } serverlist_maskop_t;
 231
 232 // struct with all fields that you can search for or sort by
 233 typedef struct serverlist_info_s
 234 {
 235         // address for connecting
 236         char cname[128];
 237         // ping time for sorting servers
 238         int ping;
 239         // name of the game
 240         char game[32];
 241         // name of the mod
 242         char mod[32];
 243         // name of the map
 244         char map[32];
 245         // name of the session
 246         char name[128];
 247         // max client number
 248         int maxplayers;
 249         // number of currently connected players (including bots)
 250         int numplayers;
 251         // number of currently connected players that are bots
 252         int numbots;
 253         // number of currently connected players that are not bots
 254         int numhumans;
 255         // protocol version
 256         int protocol;
 257         // game data version
 258         // (an integer that is used for filtering incompatible servers,
 259         //  not filterable by QC)
 260         int gameversion;
 261 } serverlist_info_t;
 262
 263 typedef enum
 264 {
 265         SLIF_CNAME,
 266         SLIF_PING,
 267         SLIF_GAME,
 268         SLIF_MOD,
 269         SLIF_MAP,
 270         SLIF_NAME,
 271         SLIF_MAXPLAYERS,
 272         SLIF_NUMPLAYERS,
 273         SLIF_PROTOCOL,
 274         SLIF_NUMBOTS,
 275         SLIF_NUMHUMANS,
 276         SLIF_COUNT
 277 } serverlist_infofield_t;
 278
 279 typedef enum
 280 {
 281         SQS_NONE = 0,
 282         SQS_QUERYING,
 283         SQS_QUERIED,
 284         SQS_TIMEDOUT
 285 } serverlist_query_state;
 286
 287 typedef struct serverlist_entry_s
 288 {
 289         // used to determine whether this entry should be included into the final view
 290         serverlist_query_state query;
 291         // used to count the number of times the host has tried to query this server already
 292         unsigned querycounter;
 293         // used to calculate ping when update comes in
 294         double querytime;
 295         // query protocol to use on this server
 296         int protocol; // may be PROTOCOL_QUAKEWORLD or PROTOCOL_DARKPLACES7
 297
 298         serverlist_info_t info;
 299
 300         // legacy stuff
 301         char line1[128];
 302         char line2[128];
 303 } serverlist_entry_t;
 304
 305 typedef struct serverlist_mask_s
 306 {
 307         qboolean                        active;
 308         serverlist_maskop_t  tests[SLIF_COUNT];
 309         serverlist_info_t info;
 310 } serverlist_mask_t;
 311
 312 extern serverlist_mask_t serverlist_andmasks[SERVERLIST_ANDMASKCOUNT];
 313 extern serverlist_mask_t serverlist_ormasks[SERVERLIST_ORMASKCOUNT];
 314
 315 extern serverlist_infofield_t serverlist_sortbyfield;
 316 extern qboolean serverlist_sortdescending;
 317
 318 extern int serverlist_viewcount;
 319 extern serverlist_entry_t *serverlist_viewlist[SERVERLIST_VIEWLISTSIZE];
 320
 321 extern int serverlist_cachecount;
 322
 323 extern qboolean serverlist_consoleoutput;
 324
 325 //============================================================================
 326 //
 327 // public network functions
 328 //
 329 //============================================================================
 330
 331 extern char net_extresponse[NET_EXTRESPONSE_MAX][1400];
 332 extern int net_extresponse_count;
 333 extern int net_extresponse_last;
 334
 335 extern double masterquerytime;
 336 extern int masterquerycount;
 337 extern int masterreplycount;
 338 extern int serverquerycount;
 339 extern int serverreplycount;
 340
 341 extern sizebuf_t net_message;
 342
 343 extern cvar_t sv_public;
 344
 345 extern cvar_t cl_netlocalping;
 346
 347 extern cvar_t cl_netport;
 348 extern cvar_t sv_netport;
 349 extern cvar_t net_address;
 350 //extern cvar_t net_netaddress_ipv6;
 351
 352 qboolean NetConn_CanSend(netconn_t *conn);
 353 int NetConn_SendUnreliableMessage(netconn_t *conn, sizebuf_t *data, protocolversion_t protocol, int rate, qboolean quakesignon_suppressreliables);
 354 qboolean NetConn_HaveClientPorts(void);
 355 qboolean NetConn_HaveServerPorts(void);
 356 void NetConn_CloseClientPorts(void);
 357 void NetConn_OpenClientPorts(void);
 358 void NetConn_CloseServerPorts(void);
 359 void NetConn_OpenServerPorts(int opennetports);
 360 void NetConn_UpdateSockets(void);
 361 lhnetsocket_t *NetConn_ChooseClientSocketForAddress(lhnetaddress_t *address);
 362 lhnetsocket_t *NetConn_ChooseServerSocketForAddress(lhnetaddress_t *address);
 363 void NetConn_Init(void);
 364 void NetConn_Shutdown(void);
 365 netconn_t *NetConn_Open(lhnetsocket_t *mysocket, lhnetaddress_t *peeraddress);
 366 void NetConn_Close(netconn_t *conn);
 367 void NetConn_Listen(qboolean state);
 368 int NetConn_Read(lhnetsocket_t *mysocket, void *data, int maxlength, lhnetaddress_t *peeraddress);
 369 int NetConn_Write(lhnetsocket_t *mysocket, const void *data, int length, const lhnetaddress_t *peeraddress);
 370 int NetConn_WriteString(lhnetsocket_t *mysocket, const char *string, const lhnetaddress_t *peeraddress);
 371 int NetConn_IsLocalGame(void);
 372 void NetConn_ClientFrame(void);
 373 void NetConn_ServerFrame(void);
 374 void NetConn_SleepMicroseconds(int microseconds);
 375 void NetConn_QueryMasters(qboolean querydp, qboolean queryqw);
 376 void NetConn_Heartbeat(int priority);
 377 void NetConn_QueryQueueFrame(void);
 378 void Net_Stats_f(void);
 379 void Net_Slist_f(void);
 380 void Net_SlistQW_f(void);
 381
 382 // ServerList interface (public)
 383 // manually refresh the view set, do this after having changed the mask or any other flag
 384 void ServerList_RebuildViewList(void);
 385 void ServerList_ResetMasks(void);
 386 void ServerList_QueryList(qboolean querydp, qboolean queryqw);
 387
 388 #endif
 389