9684aa68dbcb579e75d91896066cec017822d5a3
[xonotic/darkplaces.git] / net.h
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
12
13 See the GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18
19 */
20 // net.h -- quake's interface to the networking layer
21
22 struct qsockaddr
23 {
24         short sa_family;
25         unsigned char sa_data[14];
26 };
27
28
29 #define NET_NAMELEN                     64
30
31 #define NET_MAXMESSAGE          16384
32 #define NET_HEADERSIZE          (2 * sizeof(unsigned int))
33 #define NET_DATAGRAMSIZE        (MAX_DATAGRAM + NET_HEADERSIZE)
34
35 // NetHeader flags
36 #define NETFLAG_LENGTH_MASK     0x0000ffff
37 #define NETFLAG_DATA            0x00010000
38 #define NETFLAG_ACK                     0x00020000
39 #define NETFLAG_NAK                     0x00040000
40 #define NETFLAG_EOM                     0x00080000
41 #define NETFLAG_UNRELIABLE      0x00100000
42 #define NETFLAG_CTL                     0x80000000
43
44
45 #define NET_PROTOCOL_VERSION    3
46
47 // This is the network info/connection protocol.  It is used to find Quake
48 // servers, get info about them, and connect to them.  Once connected, the
49 // Quake game protocol (documented elsewhere) is used.
50 //
51 //
52 // General notes:
53 //      game_name is currently always "QUAKE", but is there so this same protocol
54 //              can be used for future games as well; can you say Quake2?
55 //
56 // CCREQ_CONNECT
57 //              string  game_name                               "QUAKE"
58 //              byte    net_protocol_version    NET_PROTOCOL_VERSION
59 //
60 // CCREQ_SERVER_INFO
61 //              string  game_name                               "QUAKE"
62 //              byte    net_protocol_version    NET_PROTOCOL_VERSION
63 //
64 // CCREQ_PLAYER_INFO
65 //              byte    player_number
66 //
67 // CCREQ_RULE_INFO
68 //              string  rule
69 //
70 //
71 //
72 // CCREP_ACCEPT
73 //              long    port
74 //
75 // CCREP_REJECT
76 //              string  reason
77 //
78 // CCREP_SERVER_INFO
79 //              string  server_address
80 //              string  host_name
81 //              string  level_name
82 //              byte    current_players
83 //              byte    max_players
84 //              byte    protocol_version        NET_PROTOCOL_VERSION
85 //
86 // CCREP_PLAYER_INFO
87 //              byte    player_number
88 //              string  name
89 //              long    colors
90 //              long    frags
91 //              long    connect_time
92 //              string  address
93 //
94 // CCREP_RULE_INFO
95 //              string  rule
96 //              string  value
97
98 //      note:
99 //              There are two address forms used above.  The short form is just a
100 //              port number.  The address that goes along with the port is defined as
101 //              "whatever address you receive this reponse from".  This lets us use
102 //              the host OS to solve the problem of multiple host addresses (possibly
103 //              with no routing between them); the host will use the right address
104 //              when we reply to the inbound connection request.  The long from is
105 //              a full address and port in a string.  It is used for returning the
106 //              address of a server that is not running locally.
107
108 #define CCREQ_CONNECT           0x01
109 #define CCREQ_SERVER_INFO       0x02
110 #define CCREQ_PLAYER_INFO       0x03
111 #define CCREQ_RULE_INFO         0x04
112
113 #define CCREP_ACCEPT            0x81
114 #define CCREP_REJECT            0x82
115 #define CCREP_SERVER_INFO       0x83
116 #define CCREP_PLAYER_INFO       0x84
117 #define CCREP_RULE_INFO         0x85
118
119 typedef struct qsocket_s
120 {
121         struct qsocket_s        *next;
122         double                  connecttime;
123         double                  lastMessageTime;
124         double                  lastSendTime;
125
126         qboolean                disconnected;
127         qboolean                canSend;
128         qboolean                sendNext;
129
130         int                             driver;
131         int                             landriver;
132         int                             socket;
133         void                    *driverdata;
134
135         unsigned int    ackSequence;
136         unsigned int    sendSequence;
137         unsigned int    unreliableSendSequence;
138         int                             sendMessageLength;
139         qbyte                   sendMessage [NET_MAXMESSAGE];
140
141         unsigned int    receiveSequence;
142         unsigned int    unreliableReceiveSequence;
143         int                             receiveMessageLength;
144         qbyte                   receiveMessage [NET_MAXMESSAGE];
145
146         struct qsockaddr        addr;
147         char                            address[NET_NAMELEN];
148
149 } qsocket_t;
150
151 extern qsocket_t        *net_activeSockets;
152 // LordHavoc: sockets are dynamically allocated now
153 //extern qsocket_t      *net_freeSockets;
154 //extern int                    net_numsockets;
155 extern mempool_t *net_mempool;
156
157 typedef struct
158 {
159         char            *name;
160         qboolean        initialized;
161         int                     controlSock;
162         int                     (*Init) (void);
163         void            (*Shutdown) (void);
164         void            (*Listen) (qboolean state);
165         int             (*OpenSocket) (int port);
166         int             (*CloseSocket) (int socket);
167         int             (*Connect) (int socket, struct qsockaddr *addr);
168         int             (*CheckNewConnections) (void);
169         int             (*Read) (int socket, qbyte *buf, int len, struct qsockaddr *addr);
170         int             (*Write) (int socket, qbyte *buf, int len, struct qsockaddr *addr);
171         int             (*Broadcast) (int socket, qbyte *buf, int len);
172         char *          (*AddrToString) (struct qsockaddr *addr);
173         int             (*StringToAddr) (char *string, struct qsockaddr *addr);
174         int             (*GetSocketAddr) (int socket, struct qsockaddr *addr);
175         int             (*GetNameFromAddr) (struct qsockaddr *addr, char *name);
176         int             (*GetAddrFromName) (char *name, struct qsockaddr *addr);
177         int                     (*AddrCompare) (struct qsockaddr *addr1, struct qsockaddr *addr2);
178         int                     (*GetSocketPort) (struct qsockaddr *addr);
179         int                     (*SetSocketPort) (struct qsockaddr *addr, int port);
180 } net_landriver_t;
181
182 #define MAX_NET_DRIVERS         8
183 extern int                              net_numlandrivers;
184 extern net_landriver_t  net_landrivers[MAX_NET_DRIVERS];
185
186 typedef struct
187 {
188         char            *name;
189         qboolean        initialized;
190         int                     (*Init) (void);
191         void            (*Listen) (qboolean state);
192         void            (*SearchForHosts) (qboolean xmit);
193         qsocket_t       *(*Connect) (char *host);
194         qsocket_t       *(*CheckNewConnections) (void);
195         int                     (*QGetMessage) (qsocket_t *sock);
196         int                     (*QSendMessage) (qsocket_t *sock, sizebuf_t *data);
197         int                     (*SendUnreliableMessage) (qsocket_t *sock, sizebuf_t *data);
198         qboolean        (*CanSendMessage) (qsocket_t *sock);
199         qboolean        (*CanSendUnreliableMessage) (qsocket_t *sock);
200         void            (*Close) (qsocket_t *sock);
201         void            (*Shutdown) (void);
202         int                     controlSock;
203 } net_driver_t;
204
205 extern int                      net_numdrivers;
206 extern net_driver_t     net_drivers[MAX_NET_DRIVERS];
207
208 extern int                      DEFAULTnet_hostport;
209 extern int                      net_hostport;
210
211 extern int net_driverlevel;
212 extern cvar_t           hostname;
213 extern char                     playername[];
214 extern int                      playercolor;
215
216 extern int              messagesSent;
217 extern int              messagesReceived;
218 extern int              unreliableMessagesSent;
219 extern int              unreliableMessagesReceived;
220
221 qsocket_t *NET_NewQSocket (void);
222 void NET_FreeQSocket(qsocket_t *);
223 double SetNetTime(void);
224
225
226 #define HOSTCACHESIZE   8
227
228 typedef struct
229 {
230         char    name[16];
231         char    map[16];
232         char    cname[32];
233         int             users;
234         int             maxusers;
235         int             driver;
236         int             ldriver;
237         struct qsockaddr addr;
238 } hostcache_t;
239
240 extern int hostCacheCount;
241 extern hostcache_t hostcache[HOSTCACHESIZE];
242
243 #if !defined(_WIN32 ) && !defined (__linux__) && !defined (__sun__)
244 #ifndef htonl
245 extern unsigned long htonl (unsigned long hostlong);
246 #endif
247 #ifndef htons
248 extern unsigned short htons (unsigned short hostshort);
249 #endif
250 #ifndef ntohl
251 extern unsigned long ntohl (unsigned long netlong);
252 #endif
253 #ifndef ntohs
254 extern unsigned short ntohs (unsigned short netshort);
255 #endif
256 #endif
257
258 //============================================================================
259 //
260 // public network functions
261 //
262 //============================================================================
263
264 extern  double          net_time;
265 extern  sizebuf_t       net_message;
266 extern  int                     net_activeconnections;
267
268 void            NET_Init (void);
269 void            NET_Shutdown (void);
270
271 struct qsocket_s        *NET_CheckNewConnections (void);
272 // returns a new connection number if there is one pending, else -1
273
274 struct qsocket_s        *NET_Connect (char *host);
275 // called by client to connect to a host.  Returns -1 if not able to
276
277 qboolean NET_CanSendMessage (qsocket_t *sock);
278 // Returns true or false if the given qsocket can currently accept a
279 // message to be transmitted.
280
281 int                     NET_GetMessage (struct qsocket_s *sock);
282 // returns data in net_message sizebuf
283 // returns 0 if no data is waiting
284 // returns 1 if a message was received
285 // returns 2 if an unreliable message was received
286 // returns -1 if the connection died
287
288 int                     NET_SendMessage (struct qsocket_s *sock, sizebuf_t *data);
289 int                     NET_SendUnreliableMessage (struct qsocket_s *sock, sizebuf_t *data);
290 // returns 0 if the message connot be delivered reliably, but the connection
291 //              is still considered valid
292 // returns 1 if the message was sent properly
293 // returns -1 if the connection died
294
295 int                     NET_SendToAll(sizebuf_t *data, int blocktime);
296 // This is a reliable *blocking* send to all attached clients.
297
298
299 void            NET_Close (struct qsocket_s *sock);
300 // if a dead connection is returned by a get or send function, this function
301 // should be called when it is convenient
302
303 // Server calls when a client is kicked off for a game related misbehavior
304 // like an illegal protocal conversation.  Client calls when disconnecting
305 // from a server.
306 // A netcon_t number will not be reused until this function is called for it
307
308 void NET_Poll(void);
309
310
311 typedef struct _PollProcedure
312 {
313         struct _PollProcedure   *next;
314         double                                  nextTime;
315         void                                    (*procedure)();
316         void                                    *arg;
317 } PollProcedure;
318
319 void SchedulePollProcedure(PollProcedure *pp, double timeOffset);
320
321 extern  qboolean        ipxAvailable;
322 extern  qboolean        tcpipAvailable;
323 extern  char            my_ipx_address[NET_NAMELEN];
324 extern  char            my_tcpip_address[NET_NAMELEN];
325
326 extern  qboolean        slistInProgress;
327 extern  qboolean        slistSilent;
328 extern  qboolean        slistLocal;
329
330 extern cvar_t hostname;
331
332 void NET_Slist_f (void);