merged NetConn_SendReliableMessage into NetConn_SendUnreliableMessage, and also merge...
[xonotic/darkplaces.git] / 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
130         // writing buffer to send to peer as the next reliable message
131         // can be added to at any time, copied into sendMessage buffer when it is
132         // possible to send a reliable message and then cleared
133         sizebuf_t message;
134         unsigned char messagedata[NET_MAXMESSAGE];
135
136         // reliable message that is currently sending
137         // (for building fragments)
138         unsigned int ackSequence;
139         unsigned int sendSequence;
140         unsigned int unreliableSendSequence;
141         int sendMessageLength;
142         unsigned char sendMessage[NET_MAXMESSAGE];
143
144         // reliable message that is currently being received
145         // (for putting together fragments)
146         unsigned int receiveSequence;
147         unsigned int unreliableReceiveSequence;
148         int receiveMessageLength;
149         unsigned char receiveMessage[NET_MAXMESSAGE];
150
151         char address[128];
152 } netconn_t;
153
154 extern netconn_t *netconn_list;
155 extern mempool_t *netconn_mempool;
156
157 extern cvar_t hostname;
158 extern cvar_t developer_networking;
159 extern char playername[];
160 extern int playercolor;
161
162 #define SERVERLIST_TOTALSIZE            2048
163 #define SERVERLIST_VIEWLISTSIZE         SERVERLIST_TOTALSIZE
164 #define SERVERLIST_ANDMASKCOUNT         5
165 #define SERVERLIST_ORMASKCOUNT          5
166
167 typedef enum serverlist_maskop_e
168 {
169         // SLMO_CONTAINS is the default for strings
170         // SLMO_GREATEREQUAL is the default for numbers (also used when OP == CONTAINS or NOTCONTAINS
171         SLMO_CONTAINS,
172         SLMO_NOTCONTAIN,
173
174         SLMO_LESSEQUAL,
175         SLMO_LESS,
176         SLMO_EQUAL,
177         SLMO_GREATER,
178         SLMO_GREATEREQUAL,
179         SLMO_NOTEQUAL
180 } serverlist_maskop_t;
181
182 // struct with all fields that you can search for or sort by
183 typedef struct serverlist_info_s
184 {
185         // address for connecting
186         char cname[128];
187         // ping time for sorting servers
188         int ping;
189         // name of the game
190         char game[32];
191         // name of the mod
192         char mod[32];
193         // name of the map
194         char map[32];
195         // name of the session
196         char name[128];
197         // max client number
198         int maxplayers;
199         // number of currently connected players
200         int numplayers;
201         // protocol version
202         int protocol;
203 } serverlist_info_t;
204
205 typedef enum
206 {
207         SLIF_CNAME,
208         SLIF_PING,
209         SLIF_GAME,
210         SLIF_MOD,
211         SLIF_MAP,
212         SLIF_NAME,
213         SLIF_MAXPLAYERS,
214         SLIF_NUMPLAYERS,
215         SLIF_PROTOCOL,
216         SLIF_COUNT
217 } serverlist_infofield_t;
218
219 typedef enum
220 {
221         SQS_NONE = 0,
222         SQS_QUERYING,
223         SQS_QUERIED,
224         SQS_TIMEDOUT
225 } serverlist_query_state;
226
227 typedef struct serverlist_entry_s
228 {
229         // used to determine whether this entry should be included into the final view
230         serverlist_query_state query;
231         // used to count the number of times the host has tried to query this server already
232         unsigned querycounter;
233         // used to calculate ping when update comes in
234         double querytime;
235
236         serverlist_info_t info;
237
238         // legacy stuff
239         char line1[128];
240         char line2[128];
241 } serverlist_entry_t;
242
243 typedef struct serverlist_mask_s
244 {
245         qboolean                        active;
246         serverlist_maskop_t  tests[SLIF_COUNT];
247         serverlist_info_t info;
248 } serverlist_mask_t;
249
250 extern serverlist_mask_t serverlist_andmasks[SERVERLIST_ANDMASKCOUNT];
251 extern serverlist_mask_t serverlist_ormasks[SERVERLIST_ORMASKCOUNT];
252
253 extern serverlist_infofield_t serverlist_sortbyfield;
254 extern qboolean serverlist_sortdescending;
255
256 extern int serverlist_viewcount;
257 extern serverlist_entry_t *serverlist_viewlist[SERVERLIST_VIEWLISTSIZE];
258
259 extern int serverlist_cachecount;
260
261 extern qboolean serverlist_consoleoutput;
262
263 #if !defined(_WIN32) && !defined(__linux__) && !defined(SUNOS)
264 #ifndef htonl
265 extern unsigned long htonl (unsigned long hostlong);
266 #endif
267 #ifndef htons
268 extern unsigned short htons (unsigned short hostshort);
269 #endif
270 #ifndef ntohl
271 extern unsigned long ntohl (unsigned long netlong);
272 #endif
273 #ifndef ntohs
274 extern unsigned short ntohs (unsigned short netshort);
275 #endif
276 #endif
277
278 //============================================================================
279 //
280 // public network functions
281 //
282 //============================================================================
283
284 extern double masterquerytime;
285 extern int masterquerycount;
286 extern int masterreplycount;
287 extern int serverquerycount;
288 extern int serverreplycount;
289
290 extern sizebuf_t net_message;
291
292 extern cvar_t cl_netlocalping;
293
294 int NetConn_SendUnreliableMessage(netconn_t *conn, sizebuf_t *data);
295 void NetConn_CloseClientPorts(void);
296 void NetConn_OpenClientPorts(void);
297 void NetConn_CloseServerPorts(void);
298 void NetConn_OpenServerPorts(int opennetports);
299 void NetConn_UpdateSockets(void);
300 lhnetsocket_t *NetConn_ChooseClientSocketForAddress(lhnetaddress_t *address);
301 lhnetsocket_t *NetConn_ChooseServerSocketForAddress(lhnetaddress_t *address);
302 void NetConn_Init(void);
303 void NetConn_Shutdown(void);
304 netconn_t *NetConn_Open(lhnetsocket_t *mysocket, lhnetaddress_t *peeraddress);
305 void NetConn_Close(netconn_t *conn);
306 void NetConn_Listen(qboolean state);
307 int NetConn_IsLocalGame(void);
308 void NetConn_ClientFrame(void);
309 void NetConn_ServerFrame(void);
310 void NetConn_QueryMasters(void);
311 void NetConn_Heartbeat(int priority);
312 void NetConn_QueryQueueFrame(void);
313 void Net_Stats_f(void);
314 void Net_Slist_f(void);
315
316 // ServerList interface (public)
317 // manually refresh the view set, do this after having changed the mask or any other flag
318 void ServerList_RebuildViewList(void);
319 void ServerList_ResetMasks(void);
320 void ServerList_QueryList(void);
321
322 #endif
323