Merge pull request #177 from alexdrenea/feature-SharingAutoDiscovery

AutoDiscover in Sharing Stage

Author: jwittner

Assets/HoloToolkit/Sharing/Scripts/SharingStage.cs

@@ -1,9 +1,15 @@
-using UnityEngine;
+using System;
+using UnityEngine;
 
 namespace HoloToolkit.Sharing
 {
     public class SharingStage : MonoBehaviour
     {
+        /// <summary>
+        /// SharingManagerConnected event notifies when the sharing manager is created and connected.
+        /// </summary>
+        public event EventHandler SharingManagerConnected;
+
         public static SharingStage Instance = null;
 
         /// <summary>
@@ -24,45 +30,81 @@ public class SharingStage : MonoBehaviour
         /// </summary>
         public bool IsAudioEndpoint = true;
 
+        public bool AutoDiscoverServer = false;
+
+        [Tooltip("Determines how often the discovery service should ping the network in search of a server.")]
+        public float PingIntervalSec = 2;
+
         /// <summary>
         /// Pipes XTools console output to Unity's output window for debugging
         /// </summary>
         private ConsoleLogWriter logWriter;
 
+        /// <summary>
+        /// Enables Server Discovery on the network
+        /// </summary>
+        private DiscoveryClient discoveryClient;
+        /// <summary>
+        /// Provides callbacks when server is discovered or lost.
+        /// </summary>
+        private DiscoveryClientAdapter discoveryClientAdapter;
+    
+        private float pingIntervalCurrent = 0;
+        private bool isTryingToFindServer = false;
+
         private void Awake()
         {
             Instance = this;
 
             this.logWriter = new ConsoleLogWriter();
 
-            ClientConfig config = new ClientConfig(this.ClientRole);
-            config.SetIsAudioEndpoint(this.IsAudioEndpoint);
-            config.SetLogWriter(this.logWriter);
-            config.SetServerAddress(this.ServerAddress);
-            config.SetServerPort(this.ServerPort);
-            config.SetProfilerEnabled(false);
-
-            this.sharingMgr = SharingManager.Create(config);
+            if (AutoDiscoverServer)
+            {
+                AutoDiscoverInit();
+            }
+            else
+            {
+                Connect();
+            }
         }
 
         protected void OnDestroy()
         {
             Instance = null;
 
-            // Force a disconnection so that we can stop and start Unity without connections hanging around
-            this.sharingMgr.GetPairedConnection().Disconnect();
-            this.sharingMgr.GetServerConnection().Disconnect();
+            if (this.discoveryClient != null)
+            {
+                discoveryClient.RemoveListener(discoveryClientAdapter);
+                discoveryClient.Dispose();
+                discoveryClient = null;
+
+                if (discoveryClientAdapter != null)
+                {
+                    discoveryClientAdapter.Dispose();
+                    discoveryClientAdapter = null;
+                }
+            }
 
-            // Release the XTools manager so that it cleans up the C++ copy
-            this.sharingMgr.Dispose();
-            this.sharingMgr = null;
+            if (this.sharingMgr != null)
+            {
+                // Force a disconnection so that we can stop and start Unity without connections hanging around
+                this.sharingMgr.GetPairedConnection().Disconnect();
+                this.sharingMgr.GetServerConnection().Disconnect();
 
+                // Release the XTools manager so that it cleans up the C++ copy
+                this.sharingMgr.Dispose();
+                this.sharingMgr = null;
+            }
             // Forces a garbage collection to try to clean up any additional reference to SWIG-wrapped objects
             System.GC.Collect();
         }
 
         private void LateUpdate()
         {
+            if (this.isTryingToFindServer)
+            {
+                AutoDiscoverUpdate();
+            }
             if (this.sharingMgr != null)
             {
                 // Update the XToolsManager to processes any network messages that have arrived
@@ -80,6 +122,75 @@ private void OnDisable()
             Application.logMessageReceived -= HandleLog;
         }
 
+        private void Connect()
+        {
+            ClientConfig config = new ClientConfig(this.ClientRole);
+            config.SetIsAudioEndpoint(this.IsAudioEndpoint);
+            config.SetLogWriter(this.logWriter);
+            config.SetServerAddress(this.ServerAddress);
+            config.SetServerPort(this.ServerPort);
+            config.SetProfilerEnabled(false);
+
+            this.sharingMgr = SharingManager.Create(config);
+
+            //delay sending notification so everything is initialized properly
+            Invoke("SendConnectedNotification", 1);
+        }
+
+        private void SendConnectedNotification()
+        {
+            if (Manager.GetServerConnection().IsConnected())
+            {
+                //Send notification that we're connected
+                EventHandler connectedEvent = SharingManagerConnected;
+                if (connectedEvent != null)
+                {
+                    connectedEvent(this, EventArgs.Empty);
+                }
+            }
+            else
+            {
+                Log.Error(string.Format("Cannot connect to server {0}:{1}", ServerAddress, ServerPort));
+            }
+        }
+
+        private void AutoDiscoverInit()
+        {
+            discoveryClientAdapter = new DiscoveryClientAdapter();
+            discoveryClientAdapter.DiscoveredEvent += OnSystemDiscovered;
+
+            discoveryClient = DiscoveryClient.Create();
+            discoveryClient.AddListener(discoveryClientAdapter);
+
+            //Start Finding Server
+            isTryingToFindServer = true;
+        }
+
+        private void AutoDiscoverUpdate()
+        {
+            //Searching Enabled-> Update DiscoveryClient to check results, Wait Interval then Ping network.
+            pingIntervalCurrent += Time.deltaTime;
+            if (pingIntervalCurrent > PingIntervalSec)
+            {
+                pingIntervalCurrent = 0;
+                discoveryClient.Ping();
+            }
+            discoveryClient.Update();
+        }
+
+        private void OnSystemDiscovered(DiscoveredSystem obj)
+        {
+            if (obj.GetRole() == SystemRole.SessionDiscoveryServerRole)
+            {
+                //Found a server. Stop pinging the network and connect
+                isTryingToFindServer = false;
+                this.ServerAddress = obj.GetAddress();
+                Debug.Log("System Discovered at: " + this.ServerAddress);
+                Connect();
+                Debug.Log(string.Format("Connected to: {0}:{1}", this.ServerAddress, this.ServerPort));
+            }
+        }
+
         void HandleLog(string logString, string stackTrace, LogType type)
         {
             switch (type)

Assets/HoloToolkit/Sharing/Tests/CustomMessages.cs

@@ -54,6 +54,11 @@ public Dictionary<TestMessageID, MessageCallback> MessageHandlers
     NetworkConnection serverConnection;
 
     void Start()
+    {
+        SharingStage.Instance.SharingManagerConnected += SharingManagerConnected;
+    }
+
+    private void SharingManagerConnected(object sender, System.EventArgs e)
     {
         InitializeMessageHandlers();
     }

Assets/HoloToolkit/Sharing/Tests/ImportExportAnchorManager.cs

@@ -126,17 +126,8 @@ void Start()
         currentState = ImportExportState.AnchorStore_Initializing;
         WorldAnchorStore.GetAsync(AnchorStoreReady);
 
-        // We will register for session joined to indicate when the sharing service
-        // is ready for us to make room related requests.
-        SharingSessionTracker.Instance.SessionJoined += Instance_SessionJoined;
-
-        // Setup the room manager callbacks.
-        roomManager = SharingStage.Instance.Manager.GetRoomManager();
-        roomManagerCallbacks = new RoomManagerAdapter();
-
-        roomManagerCallbacks.AnchorsDownloadedEvent += RoomManagerCallbacks_AnchorsDownloaded;
-        roomManagerCallbacks.AnchorUploadedEvent += RoomManagerCallbacks_AnchorUploaded;
-        roomManager.AddListener(roomManagerCallbacks);
+        //Wait for a notification that the sharing manager has been initialized (connected to sever)
+        SharingStage.Instance.SharingManagerConnected += SharingManagerConnected;
     }
 
     void OnDestroy()
@@ -153,6 +144,21 @@ void OnDestroy()
         }
     }
 
+    private void SharingManagerConnected(object sender, EventArgs e)
+    {
+        // Setup the room manager callbacks.
+        roomManager = SharingStage.Instance.Manager.GetRoomManager();
+        roomManagerCallbacks = new RoomManagerAdapter();
+
+        roomManagerCallbacks.AnchorsDownloadedEvent += RoomManagerCallbacks_AnchorsDownloaded;
+        roomManagerCallbacks.AnchorUploadedEvent += RoomManagerCallbacks_AnchorUploaded;
+        roomManager.AddListener(roomManagerCallbacks);
+
+        // We will register for session joined to indicate when the sharing service
+        // is ready for us to make room related requests.
+        SharingSessionTracker.Instance.SessionJoined += Instance_SessionJoined;
+    }
+
     /// <summary>
     /// Called when anchor upload operations complete.
     /// </summary>