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
  41 // This is the network info/connection protocol.  It is used to find Quake
  42 // servers, get info about them, and connect to them.  Once connected, the
  43 // Quake game protocol (documented elsewhere) is used.
  44 //
  45 //
  46 // General notes:
  47 //      game_name is currently always "QUAKE", but is there so this same protocol
  48 //              can be used for future games as well; can you say Quake2?
  49 //
  50 // CCREQ_CONNECT
  51 //              string  game_name                               "QUAKE"
  52 //              byte    net_protocol_version    NET_PROTOCOL_VERSION
  53 //
  54 // CCREQ_SERVER_INFO
  55 //              string  game_name                               "QUAKE"
  56 //              byte    net_protocol_version    NET_PROTOCOL_VERSION
  57 //
  58 // CCREQ_PLAYER_INFO
  59 //              byte    player_number
  60 //
  61 // CCREQ_RULE_INFO
  62 //              string  rule
  63 //
  64 //
  65 //
  66 // CCREP_ACCEPT
  67 //              long    port
  68 //
  69 // CCREP_REJECT
  70 //              string  reason
  71 //
  72 // CCREP_SERVER_INFO
  73 //              string  server_address
  74 //              string  host_name
  75 //              string  level_name
  76 //              byte    current_players
  77 //              byte    max_players
  78 //              byte    protocol_version        NET_PROTOCOL_VERSION
  79 //
  80 // CCREP_PLAYER_INFO
  81 //              byte    player_number
  82 //              string  name
  83 //              long    colors
  84 //              long    frags
  85 //              long    connect_time
  86 //              string  address
  87 //
  88 // CCREP_RULE_INFO
  89 //              string  rule
  90 //              string  value
  91
  92 //      note:
  93 //              There are two address forms used above.  The short form is just a
  94 //              port number.  The address that goes along with the port is defined as
  95 //              "whatever address you receive this reponse from".  This lets us use
  96 //              the host OS to solve the problem of multiple host addresses (possibly
  97 //              with no routing between them); the host will use the right address
  98 //              when we reply to the inbound connection request.  The long from is
  99 //              a full address and port in a string.  It is used for returning the
 100 //              address of a server that is not running locally.
 101
 102 #define CCREQ_CONNECT           0x01
 103 #define CCREQ_SERVER_INFO       0x02
 104 #define CCREQ_PLAYER_INFO       0x03
 105 #define CCREQ_RULE_INFO         0x04
 106
 107 #define CCREP_ACCEPT            0x81
 108 #define CCREP_REJECT            0x82
 109 #define CCREP_SERVER_INFO       0x83
 110 #define CCREP_PLAYER_INFO       0x84
 111 #define CCREP_RULE_INFO         0x85
 112
 113 typedef struct netconn_s
 114 {
 115         struct netconn_s *next;
 116
 117         lhnetsocket_t *mysocket;
 118         lhnetaddress_t peeraddress;
 119
 120         // this is mostly identical to qsocket_t from quake
 121
 122         // if this time is reached, kick off peer
 123         double connecttime;
 124         double timeout;
 125         double lastMessageTime;
 126         double lastSendTime;
 127
 128         qboolean canSend;
 129         qboolean sendNext;
 130
 131         // writing buffer to send to peer as the next reliable message
 132         // can be added to at any time, copied into sendMessage buffer when it is
 133         // possible to send a reliable message and then cleared
 134         sizebuf_t message;
 135         unsigned char messagedata[NET_MAXMESSAGE];
 136
 137         // reliable message that is currently sending
 138         // (for building fragments)
 139         unsigned int ackSequence;
 140         unsigned int sendSequence;
 141         unsigned int unreliableSendSequence;
 142         int sendMessageLength;
 143         unsigned char sendMessage[NET_MAXMESSAGE];
 144
 145         // reliable message that is currently being received
 146         // (for putting together fragments)
 147         unsigned int receiveSequence;
 148         unsigned int unreliableReceiveSequence;
 149         int receiveMessageLength;
 150         unsigned char receiveMessage[NET_MAXMESSAGE];
 151
 152         char address[128];
 153 } netconn_t;
 154
 155 extern netconn_t *netconn_list;
 156 extern mempool_t *netconn_mempool;
 157
 158 extern cvar_t hostname;
 159 extern cvar_t developer_networking;
 160 extern char playername[];
 161 extern int playercolor;
 162
 163 #define SERVERLIST_TOTALSIZE            2048
 164 #define SERVERLIST_VIEWLISTSIZE         SERVERLIST_TOTALSIZE
 165 #define SERVERLIST_ANDMASKCOUNT         5
 166 #define SERVERLIST_ORMASKCOUNT          5
 167
 168 typedef enum serverlist_maskop_e
 169 {
 170         // SLMO_CONTAINS is the default for strings
 171         // SLMO_GREATEREQUAL is the default for numbers (also used when OP == CONTAINS or NOTCONTAINS
 172         SLMO_CONTAINS,
 173         SLMO_NOTCONTAIN,
 174
 175         SLMO_LESSEQUAL,
 176         SLMO_LESS,
 177         SLMO_EQUAL,
 178         SLMO_GREATER,
 179         SLMO_GREATEREQUAL,
 180         SLMO_NOTEQUAL
 181 } serverlist_maskop_t;
 182
 183 // struct with all fields that you can search for or sort by
 184 typedef struct serverlist_info_s
 185 {
 186         // address for connecting
 187         char cname[128];
 188         // ping time for sorting servers
 189         int ping;
 190         // name of the game
 191         char game[32];
 192         // name of the mod
 193         char mod[32];
 194         // name of the map
 195         char map[32];
 196         // name of the session
 197         char name[128];
 198         // max client number
 199         int maxplayers;
 200         // number of currently connected players
 201         int numplayers;
 202         // protocol version
 203         int protocol;
 204 } serverlist_info_t;
 205
 206 typedef enum
 207 {
 208         SLIF_CNAME,
 209         SLIF_PING,
 210         SLIF_GAME,
 211         SLIF_MOD,
 212         SLIF_MAP,
 213         SLIF_NAME,
 214         SLIF_MAXPLAYERS,
 215         SLIF_NUMPLAYERS,
 216         SLIF_PROTOCOL,
 217         SLIF_COUNT
 218 } serverlist_infofield_t;
 219
 220 typedef enum
 221 {
 222         SQS_NONE = 0,
 223         SQS_QUERYING,
 224         SQS_QUERIED,
 225         SQS_TIMEDOUT
 226 } serverlist_query_state;
 227
 228 typedef struct serverlist_entry_s
 229 {
 230         // used to determine whether this entry should be included into the final view
 231         serverlist_query_state query;
 232         // used to count the number of times the host has tried to query this server already
 233         unsigned querycounter;
 234         // used to calculate ping when update comes in
 235         double querytime;
 236
 237         serverlist_info_t info;
 238
 239         // legacy stuff
 240         char line1[128];
 241         char line2[128];
 242 } serverlist_entry_t;
 243
 244 typedef struct serverlist_mask_s
 245 {
 246         qboolean                        active;
 247         serverlist_maskop_t  tests[SLIF_COUNT];
 248         serverlist_info_t info;
 249 } serverlist_mask_t;
 250
 251 extern serverlist_mask_t serverlist_andmasks[SERVERLIST_ANDMASKCOUNT];
 252 extern serverlist_mask_t serverlist_ormasks[SERVERLIST_ORMASKCOUNT];
 253
 254 extern serverlist_infofield_t serverlist_sortbyfield;
 255 extern qboolean serverlist_sortdescending;
 256
 257 extern int serverlist_viewcount;
 258 extern serverlist_entry_t *serverlist_viewlist[SERVERLIST_VIEWLISTSIZE];
 259
 260 extern int serverlist_cachecount;
 261
 262 extern qboolean serverlist_consoleoutput;
 263
 264 #if !defined(_WIN32) && !defined(__linux__) && !defined(SUNOS)
 265 #ifndef htonl
 266 extern unsigned long htonl (unsigned long hostlong);
 267 #endif
 268 #ifndef htons
 269 extern unsigned short htons (unsigned short hostshort);
 270 #endif
 271 #ifndef ntohl
 272 extern unsigned long ntohl (unsigned long netlong);
 273 #endif
 274 #ifndef ntohs
 275 extern unsigned short ntohs (unsigned short netshort);
 276 #endif
 277 #endif
 278
 279 //============================================================================
 280 //
 281 // public network functions
 282 //
 283 //============================================================================
 284
 285 extern double masterquerytime;
 286 extern int masterquerycount;
 287 extern int masterreplycount;
 288 extern int serverquerycount;
 289 extern int serverreplycount;
 290
 291 extern sizebuf_t net_message;
 292
 293 extern cvar_t cl_netlocalping;
 294
 295 int NetConn_SendReliableMessage(netconn_t *conn, sizebuf_t *data);
 296 //void NetConn_SendMessageNext(netconn_t *conn);
 297 //void NetConn_ReSendMessage(netconn_t *conn);
 298 qboolean NetConn_CanSendMessage(netconn_t *conn);
 299 int NetConn_SendUnreliableMessage(netconn_t *conn, sizebuf_t *data);
 300 void NetConn_CloseClientPorts(void);
 301 void NetConn_OpenClientPorts(void);
 302 void NetConn_CloseServerPorts(void);
 303 void NetConn_OpenServerPorts(int opennetports);
 304 lhnetsocket_t *NetConn_ChooseClientSocketForAddress(lhnetaddress_t *address);
 305 lhnetsocket_t *NetConn_ChooseServerSocketForAddress(lhnetaddress_t *address);
 306 void NetConn_Init(void);
 307 void NetConn_Shutdown(void);
 308 netconn_t *NetConn_Open(lhnetsocket_t *mysocket, lhnetaddress_t *peeraddress);
 309 void NetConn_Close(netconn_t *conn);
 310 void NetConn_Listen(qboolean state);
 311 int NetConn_IsLocalGame(void);
 312 //int NetConn_ReceivedMessage(netconn_t *conn, unsigned char *data, int length);
 313 //int NetConn_ClientParsePacket(lhnetsocket_t *mysocket, unsigned char *data, int length, lhnetaddress_t *peeraddress);
 314 //int NetConn_ServerParsePacket(lhnetsocket_t *mysocket, unsigned char *data, int length, lhnetaddress_t *peeraddress);
 315 void NetConn_ClientFrame(void);
 316 void NetConn_ServerFrame(void);
 317 void NetConn_QueryMasters(void);
 318 void NetConn_Heartbeat(int priority);
 319 void NetConn_QueryQueueFrame(void);
 320 void Net_Stats_f(void);
 321 void Net_Slist_f(void);
 322
 323 // ServerList interface (public)
 324 // manually refresh the view set, do this after having changed the mask or any other flag
 325 void ServerList_RebuildViewList(void);
 326 void ServerList_ResetMasks(void);
 327 void ServerList_QueryList(void);
 328
 329 #endif
 330