369
[divverent/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         // requested rate in bytes per second
121         int rate;
122
123         // this is mostly identical to qsocket_t from quake
124
125         // if this time is reached, kick off peer
126         double connecttime;
127         double timeout;
128         double lastMessageTime;
129         double lastSendTime;
130
131         qboolean canSend;
132         qboolean sendNext;
133
134         unsigned int ackSequence;
135         unsigned int sendSequence;
136         unsigned int unreliableSendSequence;
137         int sendMessageLength;
138         qbyte sendMessage[NET_MAXMESSAGE];
139
140         unsigned int receiveSequence;
141         unsigned int unreliableReceiveSequence;
142         int receiveMessageLength;
143         qbyte receiveMessage[NET_MAXMESSAGE];
144
145         char address[128];
146 } netconn_t;
147
148 extern netconn_t *netconn_list;
149 extern mempool_t *netconn_mempool;
150
151 extern cvar_t hostname;
152 extern cvar_t developer_networking;
153 extern char playername[];
154 extern int playercolor;
155
156 #define HOSTCACHESIZE   128
157
158 typedef struct
159 {
160         // ping time for sorting servers
161         int ping;
162         // used to calculate ping when update comes in
163         double querytime;
164         // address for connecting
165         char cname[128];
166         // description (seen by user)
167         char line1[128];
168         char line2[128];
169 } hostcache_t;
170
171 extern int hostCacheCount;
172 extern hostcache_t hostcache[HOSTCACHESIZE];
173
174 #if !defined(_WIN32 ) && !defined (__linux__) && !defined (__sun__)
175 #ifndef htonl
176 extern unsigned long htonl (unsigned long hostlong);
177 #endif
178 #ifndef htons
179 extern unsigned short htons (unsigned short hostshort);
180 #endif
181 #ifndef ntohl
182 extern unsigned long ntohl (unsigned long netlong);
183 #endif
184 #ifndef ntohs
185 extern unsigned short ntohs (unsigned short netshort);
186 #endif
187 #endif
188
189 //============================================================================
190 //
191 // public network functions
192 //
193 //============================================================================
194
195 extern double masterquerytime;
196 extern int masterquerycount;
197 extern int masterreplycount;
198 extern int serverquerycount;
199 extern int serverreplycount;
200
201 extern sizebuf_t net_message;
202
203 extern cvar_t cl_netlocalping_min;
204 extern cvar_t cl_netlocalping_max;
205
206 int NetConn_SendReliableMessage(netconn_t *conn, sizebuf_t *data);
207 //void NetConn_SendMessageNext(netconn_t *conn);
208 //void NetConn_ReSendMessage(netconn_t *conn);
209 qboolean NetConn_CanSendMessage(netconn_t *conn);
210 int NetConn_SendUnreliableMessage(netconn_t *conn, sizebuf_t *data);
211 void NetConn_CloseClientPorts(void);
212 void NetConn_OpenClientPorts(void);
213 void NetConn_CloseServerPorts(void);
214 void NetConn_OpenServerPorts(int opennetports);
215 lhnetsocket_t *NetConn_ChooseClientSocketForAddress(lhnetaddress_t *address);
216 lhnetsocket_t *NetConn_ChooseServerSocketForAddress(lhnetaddress_t *address);
217 void NetConn_Init(void);
218 void NetConn_Shutdown(void);
219 netconn_t *NetConn_Open(lhnetsocket_t *mysocket, lhnetaddress_t *peeraddress);
220 void NetConn_Close(netconn_t *conn);
221 void NetConn_Listen(qboolean state);
222 int NetConn_IsLocalGame(void);
223 //int NetConn_ReceivedMessage(netconn_t *conn, qbyte *data, int length);
224 //int NetConn_ClientParsePacket(lhnetsocket_t *mysocket, qbyte *data, int length, lhnetaddress_t *peeraddress);
225 //int NetConn_ServerParsePacket(lhnetsocket_t *mysocket, qbyte *data, int length, lhnetaddress_t *peeraddress);
226 void NetConn_ClientFrame(void);
227 void NetConn_ServerFrame(void);
228 void NetConn_QueryMasters(void);
229 void NetConn_Heartbeat(int priority);
230 int NetConn_SendToAll(sizebuf_t *data, double blocktime);
231 void Net_Stats_f(void);
232 void Net_Slist_f(void);
233
234 #endif
235