aboutsummaryrefslogtreecommitdiff
path: root/RSSDP/DeviceAvailableEventArgs.cs
blob: 39f07e1d75a79421cc4d646204cb971493a5af8c (plain)
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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Rssdp
{
	/// <summary>
	/// Event arguments for the <see cref="Rssdp.Infrastructure.SsdpDeviceLocatorBase.DeviceAvailable"/> event.
	/// </summary>
	public sealed class DeviceAvailableEventArgs : EventArgs
	{

		#region Fields

		private readonly DiscoveredSsdpDevice _DiscoveredDevice;
		private readonly bool _IsNewlyDiscovered;

		#endregion

		#region Constructors

		/// <summary>
		/// Full constructor.
		/// </summary>
		/// <param name="discoveredDevice">A <see cref="DiscoveredSsdpDevice"/> instance representing the available device.</param>
		/// <param name="isNewlyDiscovered">A boolean value indicating whether or not this device came from the cache. See <see cref="IsNewlyDiscovered"/> for more detail.</param>
		/// <exception cref="System.ArgumentNullException">Thrown if the <paramref name="discoveredDevice"/> parameter is null.</exception>
		public DeviceAvailableEventArgs(DiscoveredSsdpDevice discoveredDevice, bool isNewlyDiscovered)
		{
			if (discoveredDevice == null) throw new ArgumentNullException("discoveredDevice");

			_DiscoveredDevice = discoveredDevice;
			_IsNewlyDiscovered = isNewlyDiscovered;
		}

		#endregion

		#region Public Properties

		/// <summary>
		/// Returns true if the device was discovered due to an alive notification, or a search and was not already in the cache. Returns false if the item came from the cache but matched the current search request.
		/// </summary>
		public bool IsNewlyDiscovered
		{
			get { return _IsNewlyDiscovered; }
		}

		/// <summary>
		/// A reference to a <see cref="Rssdp.DiscoveredSsdpDevice"/> instance containing the discovered details and allowing access to the full device description.
		/// </summary>
		public DiscoveredSsdpDevice DiscoveredDevice
		{
			get { return _DiscoveredDevice; }
		} 

		#endregion
		
	}
}