NetworkDiscovery.cs
18.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
using System;
using System.Collections.Generic;
using UnityEngine;
namespace UnityEngine.Networking
{
/// <summary>
/// A structure that contains data from a NetworkDiscovery server broadcast.
/// </summary>
[Obsolete("The high level API classes are deprecated and will be removed in the future.")]
public struct NetworkBroadcastResult
{
/// <summary>
/// The IP address of the server that broadcasts this data.
/// </summary>
public string serverAddress;
/// <summary>
/// The data broadcast by the server.
/// </summary>
public byte[] broadcastData;
}
/// <summary>
/// The NetworkDiscovery component allows Unity games to find each other on a local network. It can broadcast presence and listen for broadcasts, and optionally join matching games using the NetworkManager.
/// <para>This component can run in server mode (by calling StartAsServer) where it broadcasts to other computers on the local network, or in client mode (by calling StartAsClient) where it listens for broadcasts from a server. This class should be override to receive calls from OnReceivedBroadcast.</para>
/// <para><b>Note :</b> Do not use void Update() in a class that inherits from NetworkDiscovery. If needed, you must override it and call base.Update() instead.</para>
/// <code>
/// using UnityEngine;
/// using UnityEngine.Networking;
/// using System.Collections;
///
/// public class OverriddenNetworkDiscovery : NetworkDiscovery
/// {
/// public override void OnReceivedBroadcast(string fromAddress, string data)
/// {
/// NetworkManager.singleton.networkAddress = fromAddress;
/// NetworkManager.singleton.StartClient();
/// }
/// }
/// </code>
/// </summary>
[DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkDiscovery")]
[Obsolete("The high level API classes are deprecated and will be removed in the future.")]
public class NetworkDiscovery : MonoBehaviour
{
const int k_MaxBroadcastMsgSize = 1024;
// config data
[SerializeField]
int m_BroadcastPort = 47777;
[SerializeField]
int m_BroadcastKey = 2222;
[SerializeField]
int m_BroadcastVersion = 1;
[SerializeField]
int m_BroadcastSubVersion = 1;
[SerializeField]
int m_BroadcastInterval = 1000;
[SerializeField]
bool m_UseNetworkManager = false;
[SerializeField]
string m_BroadcastData = "HELLO";
[SerializeField]
bool m_ShowGUI = true;
[SerializeField]
int m_OffsetX;
[SerializeField]
int m_OffsetY;
// runtime data
int m_HostId = -1;
bool m_Running;
bool m_IsServer;
bool m_IsClient;
byte[] m_MsgOutBuffer;
byte[] m_MsgInBuffer;
HostTopology m_DefaultTopology;
Dictionary<string, NetworkBroadcastResult> m_BroadcastsReceived;
/// <summary>
/// The network port to broadcast on and listen to.
/// </summary>
public int broadcastPort
{
get { return m_BroadcastPort; }
set { m_BroadcastPort = value; }
}
/// <summary>
/// A key to identify this application in broadcasts.
/// </summary>
public int broadcastKey
{
get { return m_BroadcastKey; }
set { m_BroadcastKey = value; }
}
/// <summary>
/// The version of the application to broadcast. This is used to match versions of the same application.
/// </summary>
public int broadcastVersion
{
get { return m_BroadcastVersion; }
set { m_BroadcastVersion = value; }
}
/// <summary>
/// The sub-version of the application to broadcast. This is used to match versions of the same application.
/// </summary>
public int broadcastSubVersion
{
get { return m_BroadcastSubVersion; }
set { m_BroadcastSubVersion = value; }
}
/// <summary>
/// How often in milliseconds to broadcast when running as a server.
/// </summary>
public int broadcastInterval
{
get { return m_BroadcastInterval; }
set { m_BroadcastInterval = value; }
}
/// <summary>
/// True to integrate with the NetworkManager.
/// <para>When running as a server, this will include the NetworkManager's address in broadcast messages. When running as a client, this will be able to join matching games found by using the NetworkManager.</para>
/// </summary>
public bool useNetworkManager
{
get { return m_UseNetworkManager; }
set { m_UseNetworkManager = value; }
}
/// <summary>
/// The data to include in the broadcast message when running as a server.
/// <para>If using NetworkManager integration, this will be overriden with the NetworkManager's address.</para>
/// </summary>
public string broadcastData
{
get { return m_BroadcastData; }
set
{
m_BroadcastData = value;
m_MsgOutBuffer = StringToBytes(m_BroadcastData);
if (m_UseNetworkManager)
{
if (LogFilter.logWarn) { Debug.LogWarning("NetworkDiscovery broadcast data changed while using NetworkManager. This can prevent clients from finding the server. The format of the broadcast data must be 'NetworkManager:IPAddress:Port'."); }
}
}
}
/// <summary>
/// True to draw the default Broacast control UI.
/// </summary>
public bool showGUI
{
get { return m_ShowGUI; }
set { m_ShowGUI = value; }
}
/// <summary>
/// The horizontal offset of the GUI if active.
/// </summary>
public int offsetX
{
get { return m_OffsetX; }
set { m_OffsetX = value; }
}
/// <summary>
/// The vertical offset of the GUI if active.
/// </summary>
public int offsetY
{
get { return m_OffsetY; }
set { m_OffsetY = value; }
}
/// <summary>
/// The TransportLayer hostId being used (read-only).
/// </summary>
public int hostId
{
get { return m_HostId; }
set { m_HostId = value; }
}
/// <summary>
/// True is broadcasting or listening (read-only).
/// </summary>
public bool running
{
get { return m_Running; }
set { m_Running = value; }
}
/// <summary>
/// True if running in server mode (read-only).
/// </summary>
public bool isServer
{
get { return m_IsServer; }
set { m_IsServer = value; }
}
/// <summary>
/// True if running in client mode (read-only).
/// </summary>
public bool isClient
{
get { return m_IsClient; }
set { m_IsClient = value; }
}
/// <summary>
/// A dictionary of broadcasts received from servers.
/// <para>The key is the server address, and the value is a NetworkBroadcastResult object that contains the data sent by the server.</para>
/// </summary>
public Dictionary<string, NetworkBroadcastResult> broadcastsReceived
{
get { return m_BroadcastsReceived; }
}
static byte[] StringToBytes(string str)
{
byte[] bytes = new byte[str.Length * sizeof(char)];
Buffer.BlockCopy(str.ToCharArray(), 0, bytes, 0, bytes.Length);
return bytes;
}
static string BytesToString(byte[] bytes)
{
char[] chars = new char[bytes.Length / sizeof(char)];
Buffer.BlockCopy(bytes, 0, chars, 0, bytes.Length);
return new string(chars);
}
/// <summary>
/// Initializes the NetworkDiscovery component.
/// </summary>
/// <returns>Return true if the network port was available.</returns>
public bool Initialize()
{
if (m_BroadcastData.Length >= k_MaxBroadcastMsgSize)
{
if (LogFilter.logError) { Debug.LogError("NetworkDiscovery Initialize - data too large. max is " + k_MaxBroadcastMsgSize); }
return false;
}
if (!NetworkManager.activeTransport.IsStarted)
{
NetworkManager.activeTransport.Init();
}
if (m_UseNetworkManager && NetworkManager.singleton != null)
{
m_BroadcastData = "NetworkManager:" + NetworkManager.singleton.networkAddress + ":" + NetworkManager.singleton.networkPort;
if (LogFilter.logInfo) { Debug.Log("NetworkDiscovery set broadcast data to:" + m_BroadcastData); }
}
m_MsgOutBuffer = StringToBytes(m_BroadcastData);
m_MsgInBuffer = new byte[k_MaxBroadcastMsgSize];
m_BroadcastsReceived = new Dictionary<string, NetworkBroadcastResult>();
ConnectionConfig cc = new ConnectionConfig();
cc.AddChannel(QosType.Unreliable);
m_DefaultTopology = new HostTopology(cc, 1);
if (m_IsServer)
StartAsServer();
if (m_IsClient)
StartAsClient();
return true;
}
/// <summary>
/// Starts listening for broadcasts messages.
/// </summary>
/// <returns>True is able to listen.</returns>
// listen for broadcasts
public bool StartAsClient()
{
if (m_HostId != -1 || m_Running)
{
if (LogFilter.logWarn) { Debug.LogWarning("NetworkDiscovery StartAsClient already started"); }
return false;
}
if (m_MsgInBuffer == null)
{
if (LogFilter.logError) { Debug.LogError("NetworkDiscovery StartAsClient, NetworkDiscovery is not initialized"); }
return false;
}
m_HostId = NetworkManager.activeTransport.AddHost(m_DefaultTopology, m_BroadcastPort, null);
if (m_HostId == -1)
{
if (LogFilter.logError) { Debug.LogError("NetworkDiscovery StartAsClient - addHost failed"); }
return false;
}
NetworkTransport.SetMulticastLock(true);
byte error;
NetworkManager.activeTransport.SetBroadcastCredentials(m_HostId, m_BroadcastKey, m_BroadcastVersion, m_BroadcastSubVersion, out error);
m_Running = true;
m_IsClient = true;
if (LogFilter.logDebug) { Debug.Log("StartAsClient Discovery listening"); }
return true;
}
/// <summary>
/// Starts sending broadcast messages.
/// </summary>
/// <returns>True is able to broadcast.</returns>
// perform actual broadcasts
public bool StartAsServer()
{
if (m_HostId != -1 || m_Running)
{
if (LogFilter.logWarn) { Debug.LogWarning("NetworkDiscovery StartAsServer already started"); }
return false;
}
m_HostId = NetworkManager.activeTransport.AddHost(m_DefaultTopology, 0, null);
if (m_HostId == -1)
{
if (LogFilter.logError) { Debug.LogError("NetworkDiscovery StartAsServer - addHost failed"); }
return false;
}
NetworkTransport.SetMulticastLock(true);
byte err;
if (!NetworkManager.activeTransport.StartBroadcastDiscovery(m_HostId, m_BroadcastPort, m_BroadcastKey, m_BroadcastVersion, m_BroadcastSubVersion, m_MsgOutBuffer, m_MsgOutBuffer.Length, m_BroadcastInterval, out err))
{
NetworkTransport.RemoveHost(m_HostId);
m_HostId = -1;
if (LogFilter.logError) { Debug.LogError("NetworkDiscovery StartBroadcast failed err: " + err); }
return false;
}
m_Running = true;
m_IsServer = true;
if (LogFilter.logDebug) { Debug.Log("StartAsServer Discovery broadcasting"); }
DontDestroyOnLoad(gameObject);
return true;
}
/// <summary>
/// Stops listening and broadcasting.
/// </summary>
public void StopBroadcast()
{
if (m_HostId == -1)
{
if (LogFilter.logError) { Debug.LogError("NetworkDiscovery StopBroadcast not initialized"); }
return;
}
if (!m_Running)
{
Debug.LogWarning("NetworkDiscovery StopBroadcast not started");
return;
}
if (m_IsServer)
{
NetworkManager.activeTransport.StopBroadcastDiscovery();
}
NetworkManager.activeTransport.RemoveHost(m_HostId);
NetworkTransport.SetMulticastLock(false);
m_HostId = -1;
m_Running = false;
m_IsServer = false;
m_IsClient = false;
m_MsgInBuffer = null;
m_BroadcastsReceived = null;
if (LogFilter.logDebug) { Debug.Log("Stopped Discovery broadcasting"); }
}
void Update()
{
if (m_HostId == -1)
return;
if (m_IsServer)
return;
NetworkEventType networkEvent;
do
{
int connectionId;
int channelId;
int receivedSize;
byte error;
networkEvent = NetworkManager.activeTransport.ReceiveFromHost(m_HostId, out connectionId, out channelId, m_MsgInBuffer, k_MaxBroadcastMsgSize, out receivedSize, out error);
if (networkEvent == NetworkEventType.BroadcastEvent)
{
NetworkManager.activeTransport.GetBroadcastConnectionMessage(m_HostId, m_MsgInBuffer, k_MaxBroadcastMsgSize, out receivedSize, out error);
string senderAddr;
int senderPort;
NetworkManager.activeTransport.GetBroadcastConnectionInfo(m_HostId, out senderAddr, out senderPort, out error);
var recv = new NetworkBroadcastResult();
recv.serverAddress = senderAddr;
recv.broadcastData = new byte[receivedSize];
Buffer.BlockCopy(m_MsgInBuffer, 0, recv.broadcastData, 0, receivedSize);
m_BroadcastsReceived[senderAddr] = recv;
OnReceivedBroadcast(senderAddr, BytesToString(m_MsgInBuffer));
}
}
while (networkEvent != NetworkEventType.Nothing);
}
void OnDestroy()
{
if (m_IsServer && m_Running && m_HostId != -1)
{
NetworkManager.activeTransport.StopBroadcastDiscovery();
NetworkManager.activeTransport.RemoveHost(m_HostId);
}
if (m_IsClient && m_Running && m_HostId != -1)
{
NetworkManager.activeTransport.RemoveHost(m_HostId);
}
if (m_Running)
NetworkTransport.SetMulticastLock(false);
}
/// <summary>
/// This is a virtual function that can be implemented to handle broadcast messages when running as a client.
/// </summary>
/// <param name="fromAddress">The IP address of the server.</param>
/// <param name="data">The data broadcast by the server.</param>
public virtual void OnReceivedBroadcast(string fromAddress, string data)
{
//Debug.Log("Got broadcast from [" + fromAddress + "] " + data);
}
void OnGUI()
{
if (!m_ShowGUI)
return;
int xpos = 10 + m_OffsetX;
int ypos = 40 + m_OffsetY;
const int spacing = 24;
if (UnityEngine.Application.platform == RuntimePlatform.WebGLPlayer)
{
GUI.Box(new Rect(xpos, ypos, 200, 20), "( WebGL cannot broadcast )");
return;
}
if (m_MsgInBuffer == null)
{
if (GUI.Button(new Rect(xpos, ypos, 200, 20), "Initialize Broadcast"))
{
Initialize();
}
return;
}
string suffix = "";
if (m_IsServer)
suffix = " (server)";
if (m_IsClient)
suffix = " (client)";
GUI.Label(new Rect(xpos, ypos, 200, 20), "initialized" + suffix);
ypos += spacing;
if (m_Running)
{
if (GUI.Button(new Rect(xpos, ypos, 200, 20), "Stop"))
{
StopBroadcast();
}
ypos += spacing;
if (m_BroadcastsReceived != null)
{
foreach (var addr in m_BroadcastsReceived.Keys)
{
var value = m_BroadcastsReceived[addr];
if (GUI.Button(new Rect(xpos, ypos + 20, 200, 20), "Game at " + addr) && m_UseNetworkManager)
{
string dataString = BytesToString(value.broadcastData);
var items = dataString.Split(':');
if (items.Length == 3 && items[0] == "NetworkManager")
{
if (NetworkManager.singleton != null && NetworkManager.singleton.client == null)
{
NetworkManager.singleton.networkAddress = items[1];
NetworkManager.singleton.networkPort = Convert.ToInt32(items[2]);
NetworkManager.singleton.StartClient();
}
}
}
ypos += spacing;
}
}
}
else
{
if (GUI.Button(new Rect(xpos, ypos, 200, 20), "Start Broadcasting"))
{
StartAsServer();
}
ypos += spacing;
if (GUI.Button(new Rect(xpos, ypos, 200, 20), "Listen for Broadcast"))
{
StartAsClient();
}
ypos += spacing;
}
}
}
}