BluetoothClient.InquiryLength (Win32 only). Added some missing docume…

…ntation tags. 4.0.16

InTheHand.Net.Bluetooth/BluetoothClient.cs

@@ -8,6 +8,7 @@
 using InTheHand.Net.Bluetooth;
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Net.Sockets;
 
 namespace InTheHand.Net.Sockets
@@ -71,28 +72,56 @@ public void Close()
             DoClose();
         }
 
+        /// <summary>
+        /// Sets whether an authenticated connection is required.
+        /// </summary>
         public bool Authenticate
         {
             get => GetAuthenticate();
             set => SetAuthenticate(value);
         }
 
+        /// <summary>
+        /// Gets the underlying Socket.
+        /// </summary>
         public Socket Client
         {
             get => GetClient();
         }
 
+        /// <summary>
+        /// Gets a value indicating whether the underlying Socket for a BluetoothClient is connected to a remote host.
+        /// </summary>
         public bool Connected
         {
             get => GetConnected();
         }
 
+        /// <summary>
+        /// Sets whether an encrypted connection is required.
+        /// </summary>
         public bool Encrypt
         {
             get => GetEncrypt();
             set => SetEncrypt(value);
         }
 
+        /// <summary>
+        /// Amount of time allowed to perform the query.
+        /// </summary>
+        /// <remarks>On Windows the actual value used is expressed in units of 1.28 seconds, so will be the nearest match for the value supplied.
+        /// The default value is 10 seconds. The maximum is 61 seconds.</remarks>
+        public TimeSpan InquiryLength
+        {
+            [DebuggerStepThrough]
+            get { return GetInquiryLength(); }
+            [DebuggerStepThrough]
+            set { SetInquiryLength(value); }
+        }
+
+        /// <summary>
+        /// Gets the name of the remote device.
+        /// </summary>
         public string RemoteMachineName
         {
             get
@@ -101,11 +130,18 @@ public string RemoteMachineName
             }
         }
 
+        /// <summary>
+        /// Gets the underlying stream of data.
+        /// </summary>
+        /// <returns></returns>
         public NetworkStream GetStream()
         {
             return DoGetStream();
         }
 
+        /// <summary>
+        /// Closes the BluetoothClient and the underlying connection.
+        /// </summary>
         public void Dispose()
         {
             // Do not change this code. Put cleanup code in Dispose(bool disposing) above.

InTheHand.Net.Bluetooth/BluetoothDeviceInfo.cs

@@ -2,7 +2,7 @@
 //
 // InTheHand.Net.Sockets.BluetoothDeviceInfo
 // 
-// Copyright (c) 2003-2020 In The Hand Ltd, All rights reserved.
+// Copyright (c) 2003-2021 In The Hand Ltd, All rights reserved.
 // This source code is licensed under the MIT License
 
 using InTheHand.Net.Bluetooth;
@@ -11,13 +11,22 @@
 
 namespace InTheHand.Net.Sockets
 {
+    /// <summary>
+    /// Provides information about an available device obtained by the client during device discovery.
+    /// </summary>
     public sealed partial class BluetoothDeviceInfo : IEquatable<BluetoothDeviceInfo>
     {
+        /// <summary>
+        /// Forces the system to refresh the device information.
+        /// </summary>
         public void Refresh()
         {
             DoRefresh();
         }
 
+        /// <summary>
+        /// Gets the device identifier.
+        /// </summary>
         public BluetoothAddress DeviceAddress
         {
             get
@@ -26,6 +35,9 @@ public BluetoothAddress DeviceAddress
             }
         }
 
+        /// <summary>
+        /// Gets the name of a device.
+        /// </summary>
         public string DeviceName
         {
             get
@@ -34,6 +46,9 @@ public string DeviceName
             }
         }
 
+        /// <summary>
+        /// Returns the Class of Device of the remote device.
+        /// </summary>
         public ClassOfDevice ClassOfDevice
         {
             get
@@ -42,6 +57,9 @@ public ClassOfDevice ClassOfDevice
             }
         }
 
+        /// <summary>
+        /// Returns a list of services which are already installed for use on the calling machine.
+        /// </summary>
         public IReadOnlyCollection<Guid> InstalledServices
         {
             get
@@ -50,6 +68,9 @@ public IReadOnlyCollection<Guid> InstalledServices
             }
         }
 
+        /// <summary>
+        /// Specifies whether the device is connected.
+        /// </summary>
         public bool Connected
         {
             get
@@ -58,6 +79,9 @@ public bool Connected
             }
         }
 
+        /// <summary>
+        /// Specifies whether the device is authenticated, paired, or bonded. All authenticated devices are remembered.
+        /// </summary>
         public bool Authenticated
         {
             get
@@ -66,17 +90,38 @@ public bool Authenticated
             }
         }
 
+        /// <summary>
+        /// Enables or disables services for a Bluetooth device.
+        /// </summary>
+        /// <remarks>Only applies to Windows platform.</remarks>
+        /// <param name="service"></param>
+        /// <param name="state"></param>
         public void SetServiceState(Guid service, bool state)
         {
             DoSetServiceState(service, state);
         }
 
+        /// <summary>
+        /// Compares two BluetoothDeviceInfo instances for equality.
+        /// </summary>
+        /// <param name="other"></param>
+        /// <returns></returns>
         public bool Equals(BluetoothDeviceInfo other)
         {
             if (other is null)
                 return false;
 
             return DeviceAddress == other.DeviceAddress;
         }
+
+        public override bool Equals(object obj)
+        {
+            if(obj is BluetoothDeviceInfo)
+            {
+                return Equals((BluetoothDeviceInfo)obj);
+            }
+
+            return false;
+        }
     }
 }

InTheHand.Net.Bluetooth/InTheHand.Net.Bluetooth.csproj

@@ -6,7 +6,7 @@
     <Company>In The Hand Ltd</Company>
     <Authors>Peter Foot</Authors>
     <Product>32feet.NET</Product>
-    <Version>4.0.15</Version>
+    <Version>4.0.16</Version>
     <RepositoryUrl>https://github.com/inthehand/32feet</RepositoryUrl>
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
     <IncludeSymbols>true</IncludeSymbols>
@@ -17,7 +17,7 @@
     <PackageLicenseUrl></PackageLicenseUrl>
     <Copyright>Copyright (c) 2004-2021 In The Hand Ltd</Copyright>
     <Description>32feet.NET is an open-source project to make personal area networking technologies such as Bluetooth easily accessible from .NET code.</Description>
-    <FileVersion>4.0.15.0215</FileVersion>
+    <FileVersion>4.0.16.0304</FileVersion>
     <AssemblyVersion>4.0.0.0</AssemblyVersion>
     <AssemblyName>InTheHand.Net.Bluetooth</AssemblyName>
     <GenerateDocumentationFile Condition=" '$(Configuration)' == 'Release' ">true</GenerateDocumentationFile>

InTheHand.Net.Bluetooth/Platforms/Android/BluetoothClient.android.cs

@@ -168,6 +168,16 @@ void SetEncrypt(bool value)
             _encrypt = value;
         }
 
+        TimeSpan GetInquiryLength()
+        {
+            return TimeSpan.Zero;
+        }
+
+        void SetInquiryLength(TimeSpan length)
+        {
+
+        }
+
         public string GetRemoteMachineName()
         {
             if(_socket is object && _socket.IsConnected)

InTheHand.Net.Bluetooth/Platforms/Standard/BluetoothClient.standard.cs

@@ -65,6 +65,16 @@ void SetEncrypt(bool value)
         {
         }
 
+        TimeSpan GetInquiryLength()
+        {
+            return TimeSpan.Zero;
+        }
+
+        void SetInquiryLength(TimeSpan length)
+        {
+
+        }
+
         public string GetRemoteMachineName()
         {
             return string.Empty;

InTheHand.Net.Bluetooth/Platforms/Win32/BluetoothClient.win32.cs

@@ -59,13 +59,13 @@ IReadOnlyCollection<BluetoothDeviceInfo> DoDiscoverDevices(int maxDevices)
             List<BluetoothDeviceInfo> devices = new List<BluetoothDeviceInfo>();
 
             BLUETOOTH_DEVICE_SEARCH_PARAMS search = BLUETOOTH_DEVICE_SEARCH_PARAMS.Create();
-            search.cTimeoutMultiplier = 8;
             search.fReturnAuthenticated = false;
             search.fReturnRemembered = true;
             search.fReturnUnknown = true;
             search.fReturnConnected = true;
             search.fIssueInquiry = true;
-
+            search.cTimeoutMultiplier = Convert.ToByte(inquiryLength.TotalSeconds / 1.28);
+
             BLUETOOTH_DEVICE_INFO device = BLUETOOTH_DEVICE_INFO.Create();
             IntPtr searchHandle = NativeMethods.BluetoothFindFirstDevice(ref search, ref device);
             if(searchHandle != IntPtr.Zero)
@@ -197,7 +197,28 @@ void SetEncrypt(bool value)
                 _encrypt = value;
             }
         }
-
+
+        //length of time for query
+        private TimeSpan inquiryLength = new TimeSpan(0, 0, 10);
+
+        TimeSpan GetInquiryLength()
+        {
+            return inquiryLength;
+        }
+
+        void SetInquiryLength(TimeSpan length)
+        {
+            if ((length.TotalSeconds > 0) && (length.TotalSeconds <= 61))
+            {
+                inquiryLength = length;
+            }
+            else
+            {
+                throw new ArgumentOutOfRangeException("length",
+                    "InquiryLength must be a positive TimeSpan between 0 and 61 seconds.");
+            }
+        }
+
         internal const AddressFamily AddressFamilyBluetooth = (AddressFamily)32;
         private const SocketOptionLevel SocketOptionLevelRFComm = (SocketOptionLevel)0x03;
         private const SocketOptionName SocketOptionNameAuthenticate = unchecked((SocketOptionName)0x80000001);

InTheHand.Net.Bluetooth/Platforms/Win32/BluetoothDeviceInfo.win32.cs

@@ -2,7 +2,7 @@
 //
 // InTheHand.Net.Sockets.BluetoothDeviceInfo (Win32)
 // 
-// Copyright (c) 2003-2020 In The Hand Ltd, All rights reserved.
+// Copyright (c) 2003-2021 In The Hand Ltd, All rights reserved.
 // This source code is licensed under the MIT License
 
 using InTheHand.Net.Bluetooth;
@@ -21,6 +21,10 @@ internal BluetoothDeviceInfo(BLUETOOTH_DEVICE_INFO info)
             _info = info;
         }
 
+        /// <summary>
+        /// Initializes an instance of the BluetoothDeviceInfo class for the device with the given address.
+        /// </summary>
+        /// <param name="address">The BluetoothAddress.</param>
         public BluetoothDeviceInfo(BluetoothAddress address)
         {
             _info = BLUETOOTH_DEVICE_INFO.Create();
@@ -83,5 +87,27 @@ void DoRefresh()
         {
             NativeMethods.BluetoothGetDeviceInfo(IntPtr.Zero, ref _info);
         }
+
+        /// <summary>
+        /// Date and Time this device was last seen by the system.
+        /// </summary>
+        public DateTime LastSeen
+        {
+            get
+            {
+                return _info.LastSeen;
+            }
+        }
+
+        /// <summary>
+        /// Date and Time this device was last used by the system.
+        /// </summary>
+        public DateTime LastUsed
+        {
+            get
+            {
+                return _info.LastUsed;
+            }
+        }
     }
 }

InTheHand.Net.Bluetooth/Platforms/Windows/BluetoothClient.Windows.cs

@@ -87,6 +87,16 @@ bool GetEncrypt()
             return false;
         }
 
+        TimeSpan GetInquiryLength()
+        {
+            return TimeSpan.Zero;
+        }
+
+        void SetInquiryLength(TimeSpan length)
+        {
+
+        }
+
         void SetEncrypt(bool value)
         {
         }

InTheHand.Net.Bluetooth/Platforms/iOS/BluetoothClient.iOS.cs

@@ -94,6 +94,16 @@ void SetEncrypt(bool value)
         {
         }
 
+        TimeSpan GetInquiryLength()
+        {
+            return TimeSpan.Zero;
+        }
+
+        void SetInquiryLength(TimeSpan length)
+        {
+
+        }
+
         public string GetRemoteMachineName()
         {
             return _accessory?.Name;