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 #define NETFLAG_CRYPTO          0x40000000
  38
  39
  40 #define NET_PROTOCOL_VERSION    3
  41 #define NET_EXTRESPONSE_MAX 16
  42
  43 /// \page netconn The network info/connection protocol.
  44 /// It is used to find Quake
  45 /// servers, get info about them, and connect to them.  Once connected, the
  46 /// Quake game protocol (documented elsewhere) is used.
  47 ///
  48 ///
  49 /// General notes:\code
  50 ///     game_name is currently always "QUAKE", but is there so this same protocol
  51 ///             can be used for future games as well; can you say Quake2?
  52 ///
  53 /// CCREQ_CONNECT
  54 ///             string  game_name                               "QUAKE"
  55 ///             byte    net_protocol_version    NET_PROTOCOL_VERSION
  56 ///
  57 /// CCREQ_SERVER_INFO
  58 ///             string  game_name                               "QUAKE"
  59 ///             byte    net_protocol_version    NET_PROTOCOL_VERSION
  60 ///
  61 /// CCREQ_PLAYER_INFO
  62 ///             byte    player_number
  63 ///
  64 /// CCREQ_RULE_INFO
  65 ///             string  rule
  66 ///
  67 /// CCREQ_RCON
  68 ///             string  password
  69 ///             string  command
  70 ///
  71 ///
  72 ///
  73 /// CCREP_ACCEPT
  74 ///             long    port
  75 ///
  76 /// CCREP_REJECT
  77 ///             string  reason
  78 ///
  79 /// CCREP_SERVER_INFO
  80 ///             string  server_address
  81 ///             string  host_name
  82 ///             string  level_name
  83 ///             byte    current_players
  84 ///             byte    max_players
  85 ///             byte    protocol_version        NET_PROTOCOL_VERSION
  86 ///
  87 /// CCREP_PLAYER_INFO
  88 ///             byte    player_number
  89 ///             string  name
  90 ///             long    colors
  91 ///             long    frags
  92 ///             long    connect_time
  93 ///             string  address
  94 ///
  95 /// CCREP_RULE_INFO
  96 ///             string  rule
  97 ///             string  value
  98 ///
  99 /// CCREP_RCON
 100 ///             string  reply
 101 /// \endcode
 102 ///     \note
 103 ///             There are two address forms used above.  The short form is just a
 104 ///             port number.  The address that goes along with the port is defined as
 105 ///             "whatever address you receive this reponse from".  This lets us use
 106 ///             the host OS to solve the problem of multiple host addresses (possibly
 107 ///             with no routing between them); the host will use the right address
 108 ///             when we reply to the inbound connection request.  The long from is
 109 ///             a full address and port in a string.  It is used for returning the
 110 ///             address of a server that is not running locally.
 111
 112 #define CCREQ_CONNECT           0x01
 113 #define CCREQ_SERVER_INFO       0x02
 114 #define CCREQ_PLAYER_INFO       0x03
 115 #define CCREQ_RULE_INFO         0x04
 116 #define CCREQ_RCON              0x05 // RocketGuy: ProQuake rcon support
 117
 118 #define CCREP_ACCEPT            0x81
 119 #define CCREP_REJECT            0x82
 120 #define CCREP_SERVER_INFO       0x83
 121 #define CCREP_PLAYER_INFO       0x84
 122 #define CCREP_RULE_INFO         0x85
 123 #define CCREP_RCON              0x86 // RocketGuy: ProQuake rcon support
 124
 125 typedef struct netgraphitem_s
 126 {
 127         double time;
 128         int reliablebytes;
 129         int unreliablebytes;
 130         int ackbytes;
 131 }
 132 netgraphitem_t;
 133
 134 typedef struct netconn_s
 135 {
 136         struct netconn_s *next;
 137
 138         lhnetsocket_t *mysocket;
 139         lhnetaddress_t peeraddress;
 140
 141         // this is mostly identical to qsocket_t from quake
 142
 143         /// if this time is reached, kick off peer
 144         double connecttime;
 145         double timeout;
 146         double lastMessageTime;
 147         double lastSendTime;
 148
 149         /// writing buffer to send to peer as the next reliable message
 150         /// can be added to at any time, copied into sendMessage buffer when it is
 151         /// possible to send a reliable message and then cleared
 152         /// @{
 153         sizebuf_t message;
 154         unsigned char messagedata[NET_MAXMESSAGE];
 155         /// @}
 156
 157         /// reliable message that is currently sending
 158         /// (for building fragments)
 159         int sendMessageLength;
 160         unsigned char sendMessage[NET_MAXMESSAGE];
 161
 162         /// reliable message that is currently being received
 163         /// (for putting together fragments)
 164         int receiveMessageLength;
 165         unsigned char receiveMessage[NET_MAXMESSAGE];
 166
 167         /// used by both NQ and QW protocols
 168         unsigned int outgoing_unreliable_sequence;
 169
 170         struct netconn_nq_s
 171         {
 172                 unsigned int ackSequence;
 173                 unsigned int sendSequence;
 174
 175                 unsigned int receiveSequence;
 176                 unsigned int unreliableReceiveSequence;
 177         }
 178         nq;
 179         struct netconn_qw_s
 180         {
 181                 // QW protocol
 182                 qboolean        fatal_error;
 183
 184                 float           last_received;          // for timeouts
 185
 186         // the statistics are cleared at each client begin, because
 187         // the server connecting process gives a bogus picture of the data
 188                 float           frame_latency;          // rolling average
 189                 float           frame_rate;
 190
 191                 int                     drop_count;                     ///< dropped packets, cleared each level
 192                 int                     good_count;                     ///< cleared each level
 193
 194                 int                     qport;
 195
 196         // sequencing variables
 197                 int                     incoming_sequence;
 198                 int                     incoming_acknowledged;
 199                 int                     incoming_reliable_acknowledged; ///< single bit
 200
 201                 int                     incoming_reliable_sequence;             ///< single bit, maintained local
 202
 203                 int                     reliable_sequence;                      ///< single bit
 204                 int                     last_reliable_sequence;         ///< sequence number of last send
 205         }
 206         qw;
 207
 208         // bandwidth estimator
 209         double          cleartime;                      // if realtime > nc->cleartime, free to go
 210
 211         // this tracks packet loss and packet sizes on the most recent packets
 212         // used by shownetgraph feature
 213 #define NETGRAPH_PACKETS 256
 214 #define NETGRAPH_NOPACKET 0
 215 #define NETGRAPH_LOSTPACKET -1
 216 #define NETGRAPH_CHOKEDPACKET -2
 217         int incoming_packetcounter;
 218         netgraphitem_t incoming_netgraph[NETGRAPH_PACKETS];
 219         int outgoing_packetcounter;
 220         netgraphitem_t outgoing_netgraph[NETGRAPH_PACKETS];
 221
 222         char address[128];
 223         crypto_t crypto;
 224
 225         // statistic counters
 226         int packetsSent;
 227         int packetsReSent;
 228         int packetsReceived;
 229         int receivedDuplicateCount;
 230         int droppedDatagrams;
 231         int unreliableMessagesSent;
 232         int unreliableMessagesReceived;
 233         int reliableMessagesSent;
 234         int reliableMessagesReceived;
 235 } netconn_t;
 236
 237 extern netconn_t *netconn_list;
 238 extern mempool_t *netconn_mempool;
 239
 240 extern cvar_t hostname;
 241 extern cvar_t developer_networking;
 242
 243 #define SERVERLIST_VIEWLISTSIZE         SERVERLIST_TOTALSIZE
 244
 245 typedef enum serverlist_maskop_e
 246 {
 247         // SLMO_CONTAINS is the default for strings
 248         // SLMO_GREATEREQUAL is the default for numbers (also used when OP == CONTAINS or NOTCONTAINS
 249         SLMO_CONTAINS,
 250         SLMO_NOTCONTAIN,
 251
 252         SLMO_LESSEQUAL,
 253         SLMO_LESS,
 254         SLMO_EQUAL,
 255         SLMO_GREATER,
 256         SLMO_GREATEREQUAL,
 257         SLMO_NOTEQUAL,
 258         SLMO_STARTSWITH,
 259         SLMO_NOTSTARTSWITH
 260 } serverlist_maskop_t;
 261
 262 /// struct with all fields that you can search for or sort by
 263 typedef struct serverlist_info_s
 264 {
 265         /// address for connecting
 266         char cname[128];
 267         /// ping time for sorting servers
 268         int ping;
 269         /// name of the game
 270         char game[32];
 271         /// name of the mod
 272         char mod[32];
 273         /// name of the map
 274         char map[32];
 275         /// name of the session
 276         char name[128];
 277         /// qc-defined short status string
 278         char qcstatus[128];
 279         /// frags/ping/name list (if they fit in the packet)
 280         char players[1400];
 281         /// max client number
 282         int maxplayers;
 283         /// number of currently connected players (including bots)
 284         int numplayers;
 285         /// number of currently connected players that are bots
 286         int numbots;
 287         /// number of currently connected players that are not bots
 288         int numhumans;
 289         /// number of free slots
 290         int freeslots;
 291         /// protocol version
 292         int protocol;
 293         /// game data version
 294         /// (an integer that is used for filtering incompatible servers,
 295         ///  not filterable by QC)
 296         int gameversion;
 297         /// favorite server flag
 298         qboolean isfavorite;
 299 } serverlist_info_t;
 300
 301 typedef enum
 302 {
 303         SLIF_CNAME,
 304         SLIF_PING,
 305         SLIF_GAME,
 306         SLIF_MOD,
 307         SLIF_MAP,
 308         SLIF_NAME,
 309         SLIF_MAXPLAYERS,
 310         SLIF_NUMPLAYERS,
 311         SLIF_PROTOCOL,
 312         SLIF_NUMBOTS,
 313         SLIF_NUMHUMANS,
 314         SLIF_FREESLOTS,
 315         SLIF_QCSTATUS,
 316         SLIF_PLAYERS,
 317         SLIF_ISFAVORITE,
 318         SLIF_COUNT
 319 } serverlist_infofield_t;
 320
 321 typedef enum
 322 {
 323         SLSF_DESCENDING = 1,
 324         SLSF_FAVORITESFIRST = 2
 325 } serverlist_sortflags_t;
 326
 327 typedef enum
 328 {
 329         SQS_NONE = 0,
 330         SQS_QUERYING,
 331         SQS_QUERIED,
 332         SQS_TIMEDOUT,
 333         SQS_REFRESHING
 334 } serverlist_query_state;
 335
 336 typedef struct serverlist_entry_s
 337 {
 338         /// used to determine whether this entry should be included into the final view
 339         serverlist_query_state query;
 340         /// used to count the number of times the host has tried to query this server already
 341         unsigned querycounter;
 342         /// used to calculate ping when update comes in
 343         double querytime;
 344         /// query protocol to use on this server, may be PROTOCOL_QUAKEWORLD or PROTOCOL_DARKPLACES7
 345         int protocol;
 346
 347         serverlist_info_t info;
 348
 349         // legacy stuff
 350         char line1[128];
 351         char line2[128];
 352 } serverlist_entry_t;
 353
 354 typedef struct serverlist_mask_s
 355 {
 356         qboolean                        active;
 357         serverlist_maskop_t  tests[SLIF_COUNT];
 358         serverlist_info_t info;
 359 } serverlist_mask_t;
 360
 361 #define ServerList_GetCacheEntry(x) (&serverlist_cache[(x)])
 362 #define ServerList_GetViewEntry(x) (ServerList_GetCacheEntry(serverlist_viewlist[(x)]))
 363
 364 extern serverlist_mask_t serverlist_andmasks[SERVERLIST_ANDMASKCOUNT];
 365 extern serverlist_mask_t serverlist_ormasks[SERVERLIST_ORMASKCOUNT];
 366
 367 extern serverlist_infofield_t serverlist_sortbyfield;
 368 extern int serverlist_sortflags; // not using the enum, as it is a bitmask
 369
 370 #if SERVERLIST_TOTALSIZE > 65536
 371 #error too many servers, change type of index array
 372 #endif
 373 extern int serverlist_viewcount;
 374 extern unsigned short serverlist_viewlist[SERVERLIST_VIEWLISTSIZE];
 375
 376 extern int serverlist_cachecount;
 377 extern serverlist_entry_t *serverlist_cache;
 378
 379 extern qboolean serverlist_consoleoutput;
 380
 381 void ServerList_GetPlayerStatistics(int *numplayerspointer, int *maxplayerspointer);
 382
 383 //============================================================================
 384 //
 385 // public network functions
 386 //
 387 //============================================================================
 388
 389 extern char cl_net_extresponse[NET_EXTRESPONSE_MAX][1400];
 390 extern int cl_net_extresponse_count;
 391 extern int cl_net_extresponse_last;
 392
 393 extern char sv_net_extresponse[NET_EXTRESPONSE_MAX][1400];
 394 extern int sv_net_extresponse_count;
 395 extern int sv_net_extresponse_last;
 396
 397 extern double masterquerytime;
 398 extern int masterquerycount;
 399 extern int masterreplycount;
 400 extern int serverquerycount;
 401 extern int serverreplycount;
 402
 403 extern sizebuf_t cl_message;
 404 extern sizebuf_t sv_message;
 405 extern char cl_readstring[MAX_INPUTLINE];
 406 extern char sv_readstring[MAX_INPUTLINE];
 407
 408 extern cvar_t sv_public;
 409
 410 extern cvar_t cl_netlocalping;
 411
 412 extern cvar_t cl_netport;
 413 extern cvar_t sv_netport;
 414 extern cvar_t net_address;
 415 extern cvar_t net_address_ipv6;
 416
 417 qboolean NetConn_CanSend(netconn_t *conn);
 418 int NetConn_SendUnreliableMessage(netconn_t *conn, sizebuf_t *data, protocolversion_t protocol, int rate, qboolean quakesignon_suppressreliables);
 419 qboolean NetConn_HaveClientPorts(void);
 420 qboolean NetConn_HaveServerPorts(void);
 421 void NetConn_CloseClientPorts(void);
 422 void NetConn_OpenClientPorts(void);
 423 void NetConn_CloseServerPorts(void);
 424 void NetConn_OpenServerPorts(int opennetports);
 425 void NetConn_UpdateSockets(void);
 426 lhnetsocket_t *NetConn_ChooseClientSocketForAddress(lhnetaddress_t *address);
 427 lhnetsocket_t *NetConn_ChooseServerSocketForAddress(lhnetaddress_t *address);
 428 void NetConn_Init(void);
 429 void NetConn_Shutdown(void);
 430 netconn_t *NetConn_Open(lhnetsocket_t *mysocket, lhnetaddress_t *peeraddress);
 431 void NetConn_Close(netconn_t *conn);
 432 void NetConn_Listen(qboolean state);
 433 int NetConn_Read(lhnetsocket_t *mysocket, void *data, int maxlength, lhnetaddress_t *peeraddress);
 434 int NetConn_Write(lhnetsocket_t *mysocket, const void *data, int length, const lhnetaddress_t *peeraddress);
 435 int NetConn_WriteString(lhnetsocket_t *mysocket, const char *string, const lhnetaddress_t *peeraddress);
 436 int NetConn_IsLocalGame(void);
 437 void NetConn_ClientFrame(void);
 438 void NetConn_ServerFrame(void);
 439 void NetConn_SleepMicroseconds(int microseconds);
 440 void NetConn_QueryMasters(qboolean querydp, qboolean queryqw);
 441 void NetConn_Heartbeat(int priority);
 442 void NetConn_QueryQueueFrame(void);
 443 void Net_Stats_f(void);
 444 void Net_Slist_f(void);
 445 void Net_SlistQW_f(void);
 446 void Net_Refresh_f(void);
 447
 448 /// ServerList interface (public)
 449 /// manually refresh the view set, do this after having changed the mask or any other flag
 450 void ServerList_RebuildViewList(void);
 451 void ServerList_ResetMasks(void);
 452 void ServerList_QueryList(qboolean resetcache, qboolean querydp, qboolean queryqw, qboolean consoleoutput);
 453
 454 /// called whenever net_slist_favorites changes
 455 void NetConn_UpdateFavorites(void);
 456
 457 #define MAX_CHALLENGES 128
 458 typedef struct challenge_s
 459 {
 460         lhnetaddress_t address;
 461         double time;
 462         char string[12];
 463 }
 464 challenge_t;
 465
 466 extern challenge_t challenge[MAX_CHALLENGES];
 467
 468 #endif
 469